/ home / community / community.general / 8.5.0 / module / pagerduty_user

community.general.pagerduty_user (8.5.0) — module

Manage a user account on PagerDuty

| "added in version" 1.3.0 of community.general"

Authors: Zainab Alsaffar (@zanssa)

Install collection

Install with ansible-galaxy collection install community.general:==8.5.0

Add to requirements.yml

  collections:
    - name: community.general
      version: 8.5.0

Description

This module manages the creation/removal of a user account on PagerDuty.

Requirements

pdpyras python module = 4.1.1
PagerDuty API Access

Usage examples

Scanned by Steampunk Spotter

- name: Create a user account on PagerDuty
  community.general.pagerduty_user:
    access_token: 'Your_Access_token'
    pd_user: user_full_name
    pd_email: user_email
    pd_role: user_pd_role
    pd_teams: user_pd_teams
    state: "present"

Scanned by Steampunk Spotter

- name: Remove a user account from PagerDuty
  community.general.pagerduty_user:
    access_token: 'Your_Access_token'
    pd_user: user_full_name
    pd_email: user_email
    state: "absent"

Inputs

    
state:
    choices:
    - present
    - absent
    default: present
    description:
    - State of the user.
    - On V(present), it creates a user if the user doesn't exist.
    - On V(absent), it removes a user if the account exists.
    type: str

pd_role:
    choices:
    - global_admin
    - manager
    - responder
    - observer
    - stakeholder
    - limited_stakeholder
    - restricted_access
    default: responder
    description:
    - The user's role.
    type: str

pd_user:
    description:
    - Name of the user in PagerDuty.
    required: true
    type: str

pd_email:
    description:
    - The user's email address.
    - O(pd_email) is the unique identifier used and cannot be updated using this module.
    required: true
    type: str

pd_teams:
    description:
    - The teams to which the user belongs.
    - Required if O(state=present).
    elements: str
    type: list

access_token:
    description:
    - An API access token to authenticate with the PagerDuty REST API.
    required: true
    type: str