The user object

Attributes


Id string

Unique identifier for the account user.


FirstName string

First name of the account user.


LastName string

Last name of the account user.


State enum

The account state of the user.

Possible enum values
ACTIVEUser is currently active and can access your partner account.
PENDINGUser has accepted an invitation but is pending approval from an account administrator.
INVITEDUser has been invited and needs to accept the invitation sent to their email account.

Language string

The account language preference of the user.


ProductRoles array

An object containing the roles and associated permissions the user has. Each permission value is associated with a specific role—if a user has that permission, that role will be listed.

View child attributes…

Role string

Lists the role associated with the permissions the user has.


Permissions array

Lists the permissions the user has.

Possible enum values
ACCOUNT_ADMINISTRATORThe Account Administration role.

JoinedDate datetime

Date and time the user joined the partner account, expressed in ISO 8416 format.


DateLastUpdated datetime

Date and time the user's information was last updated, expressed in ISO 8416 format.


CreatedBy string

Only relevant for direct programs—the name of the brand user that created the partner account user.


Uri string

The direct URI to the user.

{
  "Id": "I-1234567",
  "FirstName": "Wile",
  "LastName": "Coyote",
  "Username": "WileECoyote",
  "State": "ACTIVE",
  "Language": "en_US",
  "ProductRoles": [
    {
      "Product":"RADIUS",
      "AccessibleCampaigns":["10123"],
      "Role":"ACCOUNT_ADMINISTRATOR"
    }
  ],
  "JoinedDate": "2020-04-29T16:24:13-07:00",
  "DateLastUpdated": "2020-12-09T08:34:06-08:00",
  "LastUpdatedBy": "WileECoyote",
  "CreatedBy": "RoadRunner",
  "Uri": "/Advertisers/<AccountSID>/Users/I-1234567"
}