Appearance

Users Object ​


id
string
REQUIRED · 

The unique identifier for a user

external_id
string

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

identifiers
object

The identifiers of the user.

first_name
string

The first name of the user

last_name
string

The last name of the user

title
string

The title of the user

name
string

The name of the user

username
string

The username of the user

emails
object[]

The emails of the user

email
string

The email address

type
string

The type of email address

is_primary
boolean

Whether the email address is primary

phones
object[]

The phones of the user

number
string

The phone number

extension
string

The extension of the phone number

type
string

The type of phone number

status
string

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

All possible enum values:
  • active
  • inactive
  • deleted
  • invited
is_email_verified
boolean

Whether the user's email has been verified

is_2fa_enabled
boolean

Whether the user has 2FA enabled

roles
object[]

The roles of the user

id
string

The unique identifier for a role

name
string

The name of the role

group
string

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.

organization
string

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

workspace
string

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

organizations
object[]

The organizations of the user

id
string

The unique identifier for an organization

name
string

The name of the organization

user_type
string

The type of user

licenses
object[]

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

id
string

The unique identifier for a license

name
string

The name of the license

organization
string

The unique identifier of the organization to which the license belongs

last_active_at
string · date-time

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

groups
object[]

The groups of the user

id
string

The unique identifier for a group

name
string

The name of the group

organization
string

The unique identifier of the organization to which the group belongs

workspaces
object[]

The workspaces of the user

id
string

The unique identifier for a workspace

name
string

The name of the workspaces

avatar
string

The avatar of the user

timezone
string

The timezone of the user

languages
string[]

The languages preferred by the user

bio
string

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

created_at
string · date-time

The date and time the user was created

updated_at
string · date-time

The date and time the user was last updated

last_active_at
string · date-time

The date and time the user was last active

last_login_at
string · date-time

The date and time the user was last logged in

status_changed_at
string · date-time

The date and time the user's status was last changed

activated_at
string · date-time

The date and time the user was activated

urls
object[]

The URLs of the user

url
string

The URL

type
string

The type of URL

remote_data
object

Raw data returned from the remote API call.