Skip to content

Properties

idstring
required·

The unique identifier for a user

avatarstring

The avatar of the user

biostring

The bio of the user. Usually a short description set by the user about them.

created_atstring · date-time

The date and time the user was created

emailsobject[]

The emails of the user

emailstring

The email address

is_primaryboolean

Whether the email address is primary

typestring

The type of email address

external_idstring

The external identifier for a user. This is set when the SCIM API is being used.

first_namestring

The first name of the user

groupsobject[]

The groups of the user

idstring

The unique identifier for a group

namestring

The name of the group

organizationstring

The unique identifier of the organization to which the group belongs

identifiersRecord<string, any>

The identifiers of the user.

languagesstring[]

The languages preferred by the user

last_namestring

The last name of the user

licensesobject[]

The licenses of the user or the products the user has access to

idstring

The unique identifier for a license

last_active_atstring · date-time

The date and time the user was last active for the license

namestring

The name of the license

organizationstring

The unique identifier of the organization to which the license belongs

namestring

The name of the user

phonesobject[]

The phones of the user

extensionstring

The extension of the phone number

numberstring

The phone number

typestring

The type of phone number

remote_dataRecord<string, any>

Raw data returned from the remote API call.

rolesobject[]

The roles of the user

groupstring

The role of the user in the group. This is available when the user can have different roles in different groups or teams in an application.

idstring

The unique identifier for a role

namestring

The name of the role

organizationstring

The role of the user in the organization. This is available when the user can have different roles in different organizations in an application.

workspacestring

The role of the user in the workspace. This is available when the user can have different roles in different workspaces in an application.

statusstring

The status of the user. If no clear mapping is available, then the raw value is returned.

Possible values:
activeinactivedeletedinvited
timezonestring

The timezone of the user

titlestring

The title of the user

updated_atstring · date-time

The date and time the user was last updated

urlsobject[]

The URLs of the user

typestring

The type of URL

urlstring

The URL

user_typestring

The type of user

usernamestring

The username of the user