List Roles

Endpoint

http

GET /unified/user-directory/roles

Integrations supported

Adobe
Adobe Marketo Engage
Anthropic
Auth0
Azure Active Directory
Baremetrics
BigPanda
Bitbucket
BrowserStack
Canva
Checkr
Cisco Meraki
ClickUp
Close
Cloudflare
Confluent
CrowdStrike
Datadog
dbt Labs
Discord
Dixa
DocuSign
Domo
Doppler
Drift
Dynatrace
Elastic Cloud
Eventbrite
Files.com
Fivetran
Freshcaller
Freshchat
Freshdesk
Freshservice
FuseDesk
GitLab
Gong
Google Ads
Google Cloud
Happyfox
Harness
Harvest
HelloID
Dropbox Sign (HelloSign)
Help Scout
Heroku
Highlevel
HubSpot
Illow
Jamf
JFrog
Jira
JumpCloud
KnowBe4
Kustomer
LastPass
LaunchDarkly
Leadsquared
Looker
Mailgun
Mode
New Relic
Okta
OneDrive
OneLogin
OpenAI
Opsgenie
Outreach
PagerDuty
Pipedrive
Pivotal Tracker
Power BI
ProdPad
Qlik Sense
Re:amaze
Rockset
Salesforce
Salesloft
Scale AI
Segment
Sendoso
Showpad
Slab
Slack
Slack Enterprise
SmartRecruiters
Smartsheet
Snowflake
Snyk
SolarWinds Service Desk
Statsig
Supabase
SurveySparrow
Tableau
TeamViewer
Teamwork Desk
Trello
Trengo
Turso
Vercel
Webex
WordPress
Wrike
Zendesk
Zoho Bigin
Zoho CRM
Zoho Desk
Zoho Meeting
Zoho Projects
Zoom

Partial response integrations

For partial response integrations, you will need to fetch the individual resource using the "get" endpoint to get the full response object.

CrowdStrike

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 returns the response with unified mappings applied.
raw returns the unprocessed, raw response from the remote API.
normalized applies the unified mappings and returns the data in a normalized format.
stream returns the response as a stream, which is ideal for transmitting large datasets, files, or binary data. Using streaming mode helps to efficiently handle large payloads or real-time data flows without requiring the entire data to be buffered in memory.

Defaults to unified.

All possible enum values:

unified
raw
normalized
stream

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
Confluent
Eventbrite

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

name

string

The name of the role

Supported in

Auth0
Harness
OneLogin

user_id

string

The unique identifier for the user.

Supported in

Auth0

group_id

Supported in

Opsgenie

workspace_id

Required in

dbt Labs
Discord
Gong
Google Cloud

Response Body

result

object[]

List of Roles

string

REQUIRED ·

The unique identifier for a role

Supported in

Adobe
Adobe Marketo Engage
Auth0
Azure Active Directory
BigPanda
ClickUp
Close
Cloudflare
Confluent
CrowdStrike
Datadog
dbt Labs
Discord
DocuSign
Domo
Doppler
Dynatrace
Eventbrite
Fivetran
Freshchat
Freshdesk
Freshservice
Gong
Google Cloud
Happyfox
Harness
Harvest
HelloID
HubSpot
JFrog
Jira
JumpCloud
Kustomer
LaunchDarkly
Leadsquared
Looker
New Relic
Okta
OneDrive
OneLogin
Opsgenie
Outreach
Pipedrive
Qlik Sense
Rockset
Salesforce
Salesloft
Segment
SmartRecruiters
Snowflake
SolarWinds Service Desk
SurveySparrow
TeamViewer
Webex
Zoho Bigin
Zoho CRM
Zoho Desk
Zoom

name

string

The name of the role

Supported in

Adobe
Adobe Marketo Engage
Auth0
Azure Active Directory
BigPanda
ClickUp
Close
Cloudflare
Confluent
CrowdStrike
Datadog
dbt Labs
Discord
DocuSign
Domo
Doppler
Dynatrace
Eventbrite
Fivetran
Freshchat
Freshdesk
Freshservice
Gong
Google Cloud
Happyfox
Harness
Harvest
HelloID
HubSpot
JFrog
Jira
JumpCloud
LaunchDarkly
Leadsquared
Looker
New Relic
Okta
OneDrive
OneLogin
Opsgenie
Outreach
Pipedrive
Qlik Sense
Rockset
Salesforce
Salesloft
Segment
SmartRecruiters
Snowflake
SolarWinds Service Desk
SurveySparrow
TeamViewer
Webex
Zoho Bigin
Zoho CRM
Zoho Desk
Zoom

label

string

The display label of the role

Supported in

Google Cloud
New Relic
Okta
SurveySparrow
Zoho Bigin

description

string

The description of the role

Supported in

Auth0
Azure Active Directory
Cloudflare
Discord
Domo
Dynatrace
Eventbrite
Fivetran
Freshchat
Freshservice
Gong
Google Cloud
Harness
HelloID
JFrog
JumpCloud
LaunchDarkly
Okta
OneDrive
Pipedrive
Qlik Sense
Rockset
Segment
SolarWinds Service Desk
SurveySparrow
Zoho Bigin
Zoho Desk

applicable_in

string

The context in which the role is applicable

All possible enum values:

group
workspace

Supported in

dbt Labs
Discord
Doppler
Gong
Google Cloud
JumpCloud
Opsgenie

created_at

string · date-time

The date and time the role was created

Supported in

Adobe Marketo Engage
BigPanda
ClickUp
Close
Confluent
Datadog
dbt Labs
Domo
Doppler
Dynatrace
Freshdesk
Freshservice
Harness
Harvest
Okta
Outreach
Qlik Sense
Rockset
Snowflake
SurveySparrow

updated_at

string · date-time

The date and time the role was last updated

Supported in

Adobe Marketo Engage
BigPanda
Close
Confluent
Datadog
dbt Labs
DocuSign
Domo
Dynatrace
Freshdesk
Freshservice
Harness
Harvest
Okta
Outreach
Qlik Sense
SurveySparrow

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.