PagerDuty Elixir v0.0.1 PagerDuty.User
PagerDuty users are members of a PagerDuty account that have the ability to interact with incidents and other data on the account.
Users are fundamental agents of different types of actions in PagerDuty. A user can, among other things:
- acknowlege, reassign, snooze, escalate, and resolve incidents
- configure services, escalation policies, integrations, on-call schedules,teams, and more.
- go on call for one or more schedules or escalation policies
- receive notifications
Depending on a user’s role, he or she may have access to different parts of the account’s data.
Read more about users in the PagerDuty Knowledge Base.
Attributes
@id
: id@summary
: 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 toname
, though it is not intended to be an identifier.@type
: eitherincident
orincident_reference
@self
: the API show URL at which the object is accessible@html_url
: a URL at which the entity is uniquely displayed in the Web app@name
: The name of the user. maxLength: 100@email
: The user’s email address. minLength: 6 / maxLength: 100@time_zone
: The preferred time zone name. If null, the account’s time zone will be used.@color
: The schedule color.@role:
: The user role. One ofadmin
,limited_user
,owner
,read_only_user
oruser
. Account must have theread_only_users
ability to set a user as aread_only_user
.@avatar_url
: The URL of the user’s avatar.@description
: The user’s bio.@invitation_sent
: If true, the user has an outstanding invitation.@job_title
: The user’s title. maxLength: 100@teams
: The list of teams to which the user belongs. Account must have theteams
ability to set this.@contact_methods
: The list of contact methods for the user.@notification_rules
: The list of notification rules for the user.
Summary
Functions
Generates a new PagerDuty.User
from a map
Types
t()
t() :: %PagerDuty.User{avatar_url: String.t, color: String.t, contact_methods: [%PagerDuty.ContactMethod{address: term, html_url: term, id: term, label: term, self: term, summary: term, type: term}], description: String.t, email: String.t, html_url: String.t, id: String.t, invitation_sent: boolean, job_title: String.t, name: String.t, notification_rules: [%PagerDuty.NotificationRule{html_url: term, id: term, self: term, summary: term, type: term}], role: String.t, self: String.t, summary: String.t, teams: [%PagerDuty.Team{html_url: term, id: term, self: term, summary: term, type: term}], time_zone: String.t, type: String.t}
Functions
Generates a new PagerDuty.User
from a map