Person Object

Represents the content to be delivered to a User.

Creation Method: This object represents a User within xMatters, and is used as a method of retrieving information about a User. This object does not allow modification of the underlying recipient, and is not shared between processes.

Reference Name: User-defined reference name for static content delivery.

Scope: Event lifecycle.

Reserved object variables

Variable

Type

Description

id

String

Numeric database index that uniquely identifies the User

description

String

Description of the User

devices

List

List of the User's Devices, in the targetName format (<UserId>|<DeviceName>). The Devices are listed in the same order in which they appear in the web user interface.

site

String

Name of the Site to which the User is assigned

country

String

User's country

language

String

User's preferred language

firstName

String

User's first name

lastName

String

User's surname

login

String

User's web login ID (from the User ID field in the xMatters web user interface)

password

String

User's web login password

phoneLogin

String

User's phone login ID

phonePassword

String

User's phone login password

timezone

String

User's time zone

recordedName

String

User's recorded name

targetName

String

Target name used to identify the User for notifications

companyName

String

Name of the Company to which the User is assigned

supervisedGroups

List

List of Groups this User supervises

supervisors

List

List of this User's Supervisors

groupMemberships

List

List of Groups to which this User belongs

roles

List

List of Roles assigned to this User

attributes

List

List of this User's attributes

customFields

List

List of custom field names configured for this User

hasMobileAccess

Boolean

Indicates whether a User has permission to access the mobile access component

Person object methods

The following methods are available with the Person script object:

getAccessibleIntegrationServices

getActiveScenarioMsgDetails

getActiveScenarioMsgIds

getCompany

getCustomFieldValue

getFastAccessMenuItems

getRecipientCategory

haltActiveScenario

hasActiveScenarios

hasFastAccessMenu

hasPhoneCredentials

launchFastAccessScenario

report