users

Overview

Name	users
Type	Resource
Id	pagerduty.users.users

Fields

Name	Datatype	Description
id	string
name	string	The name of the user.
description	string	The user's bio.
_type	string	The type of object being created.
avatar_url	string	The URL of the user's avatar.
color	string	The schedule color.
contact_methods	array	The list of contact methods for the user.
email	string	The user's email address.
html_url	string	a URL at which the entity is uniquely displayed in the Web app
invitation_sent	boolean	If true, the user has an outstanding invitation.
job_title	string	The user's title.
license	object	The License assigned to the User
notification_rules	array	The list of notification rules for the user.
role	string	The user role. Account must have the read_only_users ability to set a user as a read_only_user or a read_only_limited_user, and must have advanced permissions abilities to set a user as observer or restricted_access.
self	string	the API show URL at which the object is accessible
summary	string	A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to name, though it is not intended to be an identifier.
teams	array	The list of teams to which the user belongs. Account must have the teams ability to set this.
time_zone	string	The preferred time zone name. If null, the account's time zone will be used.
type	string	A string that determines the schema of the object. This must be the standard name for the entity, suffixed by _reference if the object is a reference.

Methods

Name	Accessible by	Required Params	Description
get_user	SELECT	id	Get details about an existing user. Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account. For more information see the API Concepts Document Scoped OAuth requires: users.read
list_users	SELECT		List users of your PagerDuty account, optionally filtered by a search query. Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account. For more information see the API Concepts Document Scoped OAuth requires: users.read
create_user	INSERT	From, data__user	Create a new user. Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account. For more information see the API Concepts Document Scoped OAuth requires: users.write
delete_user	DELETE	id	Remove an existing user. Returns 400 if the user has assigned incidents unless your pricing plan has the offboarding feature and the account is configured appropriately. Note that the incidents reassignment process is asynchronous and has no guarantee to complete before the api call return. Learn more about offboarding feature. Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account. For more information see the API Concepts Document Scoped OAuth requires: users.write
_get_user	EXEC	id	Get details about an existing user. Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account. For more information see the API Concepts Document Scoped OAuth requires: users.read
_list_users	EXEC		List users of your PagerDuty account, optionally filtered by a search query. Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account. For more information see the API Concepts Document Scoped OAuth requires: users.read
update_user	EXEC	id, data__user	Update an existing user. Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account. For more information see the API Concepts Document Scoped OAuth requires: users.write