Skip to content

List Roles

Endpoint

http
GET /unified/user-directory/roles
Integrations supported
  • Adobe
  • Adobe Marketo Engage
  • Azure Active Directory
  • Bitbucket
  • BrowserStack
  • ClickUp
  • Close
  • Confluent
  • Datadog
  • DocuSign
  • Eventbrite
  • Fivetran
  • Freshdesk
  • Freshservice
  • Dropbox Sign (HelloSign)
  • HubSpot
  • Jamf
  • JFrog
  • Jira
  • LastPass
  • Leadsquared
  • Looker
  • New Relic
  • Okta
  • Outreach
  • PagerDuty
  • Pipedrive
  • Power BI
  • Qlik Sense
  • Salesforce
  • Salesloft
  • Segment
  • Sendoso
  • Showpad
  • Snowflake
  • Snyk
  • Tableau
  • Trello
  • Vercel
  • Webex
  • WordPress
  • Zendesk
  • Zoho CRM
  • Zoho Desk
  • Zoom

Query parameters

Refer Specifying query parameters in Truto APIs

integrated_account_id
string · uuid
REQUIRED · 

The ID of the integrated account to use for the request.

Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d
truto_response_format
string

The format of the response.

  • unified will return the response with unified mappings applied.
  • raw will return the raw response from the remote API.
  • normalized will apply the unified mappings and return the data in a normalized format.

Defaults to unified.

All possible enum values:
  • unified
  • raw
  • normalized
Example: unified
truto_key_by
string

By default the result attribute is an array of objects. This parameter allows you to specify a field in each result objects to use as key, which transforms the result array into an object with the array items keyed by the field. This is useful for when you want to use the result as a lookup table.

Example: id
truto_ignore_limit
boolean

Ignores the limit query parameter.

truto_ignore_remote_data
boolean

Excludes the remote_data attribute from the response.

truto_exclude_fields
array

Array of fields to exclude from the response.

Example: truto_exclude_fields[]=id&truto_exclude_fields[]=name
remote_query
object

Query parameters to pass to the underlying API without any transformations. Refer this guide to see how to structure the query parameters.

Example: remote_query[foo]=bar
organization_id
string

The unique identifier for an organization

Required in
  • ClickUp
sort_by
string

The field to sort the resource by. Should be in format { fieldName: direction }. The direction can be asc or desc.

Supported in
  • Qlik Sense
organizations
Supported in
  • Eventbrite

Response Body

result
object[]

List of Roles

id
string
REQUIRED · 

The unique identifier for a role

Supported in
  • Adobe
  • Adobe Marketo Engage
  • Azure Active Directory
  • ClickUp
  • Close
  • Confluent
  • Datadog
  • DocuSign
  • Eventbrite
  • Fivetran
  • Freshdesk
  • Freshservice
  • HubSpot
  • JFrog
  • Jira
  • Leadsquared
  • Looker
  • New Relic
  • Okta
  • Outreach
  • Pipedrive
  • Qlik Sense
  • Salesforce
  • Salesloft
  • Segment
  • Snowflake
  • Webex
  • Zoho CRM
  • Zoho Desk
  • Zoom
name
string

The name of the role

Supported in
  • Adobe
  • Adobe Marketo Engage
  • Azure Active Directory
  • ClickUp
  • Close
  • Confluent
  • Datadog
  • DocuSign
  • Eventbrite
  • Fivetran
  • Freshdesk
  • Freshservice
  • HubSpot
  • JFrog
  • Jira
  • Leadsquared
  • Looker
  • New Relic
  • Okta
  • Outreach
  • Pipedrive
  • Qlik Sense
  • Salesforce
  • Salesloft
  • Segment
  • Snowflake
  • Webex
  • Zoho CRM
  • Zoho Desk
  • Zoom
label
string

The display label of the role

Supported in
  • New Relic
  • Okta
description
string

The description of the role

Supported in
  • Azure Active Directory
  • Eventbrite
  • Fivetran
  • Freshservice
  • JFrog
  • Okta
  • Pipedrive
  • Qlik Sense
  • Segment
  • Zoho Desk
applicable_in
string

The context in which the role is applicable

All possible enum values:
  • group
  • workspace
created_at
string · date-time

The date and time the role was created

Supported in
  • Adobe Marketo Engage
  • ClickUp
  • Close
  • Confluent
  • Datadog
  • Freshdesk
  • Freshservice
  • Okta
  • Outreach
  • Qlik Sense
  • Snowflake
updated_at
string · date-time

The date and time the role was last updated

Supported in
  • Adobe Marketo Engage
  • Close
  • Confluent
  • Datadog
  • DocuSign
  • Freshdesk
  • Freshservice
  • Okta
  • Outreach
  • Qlik Sense
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.