Appearance

List Roles ​

Endpoint ​

http
GET /unified/user-directory/roles
Integrations supported
  • Adobe
  • Adobe Marketo Engage
  • Datadog
  • DocuSign
  • Freshdesk
  • HubSpot
  • Jira
  • Okta
  • Salesforce
  • Snowflake
  • Zendesk
  • Zoho CRM
  • Zoom

Query parameters ​

integrated_account_id
string · uuid
REQUIRED · The ID of the integrated account to use for the request.
Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d

Response Body ​

result
object[]
List of Roles
id
string
REQUIRED · The unique identifier for a role
Supported in
  • Adobe
  • Adobe Marketo Engage
  • Datadog
  • DocuSign
  • Freshdesk
  • HubSpot
  • Jira
  • Okta
  • Salesforce
  • Snowflake
  • Zoho CRM
  • Zoom
name
string
The name of the role
Supported in
  • Adobe
  • Adobe Marketo Engage
  • Datadog
  • DocuSign
  • Freshdesk
  • HubSpot
  • Jira
  • Okta
  • Salesforce
  • Snowflake
  • Zoho CRM
  • Zoom
label
string
The display label of the role
Supported in
  • Okta
description
string
The description of the role
Supported in
  • Okta
created_at
string
The date and time the role was created
Supported in
  • Adobe Marketo Engage
  • Datadog
  • Freshdesk
  • Okta
  • Snowflake
updated_at
string
The date and time the role was last updated
Supported in
  • Adobe Marketo Engage
  • Datadog
  • DocuSign
  • Freshdesk
  • Okta
remote_data
object
Raw data returned from the remote API call.
next_cursor
string
The cursor to use for the next page of results. Pass this value as `next_cursor` in the query parameter in the next request to get the next page of results.