Skip to content
GET /unified/user-directory/roles

Partial response — use the "get" endpoint for the full object.

Query Parameters

Refer Specifying query parameters in Truto APIs

namestring

The name of the role

91 supported
Adobe
supported
Adobe Marketo Engage
supported
Apache Airflow
supported
Auth0
supported
Avalara AvaTax
supported
Avigilon Alta
supported
Azure Active Directory
supported
BigPanda
supported
BlackLine
supported
Boomi
supported
Cato Networks
supported
ClickUp
supported
Close
supported
Cloudflare
supported
CrowdStrike
supported
Datadog
supported
dbt Labs
supported
Discord
supported
DocuSign
supported
Domo
supported
Doppler
supported
Druva inSync
supported
Dynatrace
supported
Eventbrite
supported
Fivetran
supported
Freshchat
supported
Freshdesk
supported
Freshservice
supported
Gong
supported
Google
supported
Google Cloud
supported
Google Workspace
supported
HappyFox
supported
Harness
supported
Harvest
supported
HelloID
supported
HubSpot
supported
Jenkins
supported
JFrog
supported
Jira
supported
Jira Service Management
supported
JumpCloud
supported
Kommo
supported
LaunchDarkly
supported
Leadsquared
supported
LearnWorlds
supported
Looker
supported
Microsoft 365
supported
Oracle Netsuite
supported
New Relic
supported
Ninjaone
supported
Okta
supported
OneDrive
supported
OneLogin
supported
Opsgenie
supported
Oracle Fusion Cloud
supported
Oracle Fusion Cloud EPM
supported
Oracle Fusion Cloud Financials
supported
Outreach
supported
Pipedrive
supported
Pylon
supported
Qdrant Cloud
supported
Qlik Sense
supported
Rockset
supported
Sage Intacct
supported
SailPoint IdentityIQ SCIM
supported
SailPoint Identity Security Cloud
supported
SailPoint NERM
supported
Salesforce
supported
Salesloft
supported
Segment
supported
ServiceNow
supported
Sisense
supported
SmartRecruiters
supported
Snowflake
supported
SolarWinds Service Desk
supported
Sophos
supported
SpotDraft
supported
Sumo Logic
supported
SurveySparrow
supported
TeamViewer
supported
ThoughtSpot
supported
Torii
supported
UiPath
supported
Webex
supported
Workato
supported
Workiva
supported
Zoho Bigin
supported
Zoho CRM
supported
Zoho Desk
supported
Zoom
supported
user_idstring

The unique identifier for the user.

1 supported
Auth0
supported
organization_idstring

The unique identifier for an organization

2 supported2 required
ClickUp
required
Eventbrite
required
workspace_id
4 supported4 required
dbt Labs
required
Discord
required
Gong
required
Google Cloud
required
productstring

Select the product for which you want to retrieve the roles.

Possible values:
azure_active_directoryonedriveworkspace
2 supported2 required
Google
required
workspace
Microsoft 365
required
onedriveazure_active_directory
group_id
1 supported
Opsgenie
supported
sort_bystring

The field to sort the resource by. The possible field is name.

1 supported
Qlik Sense
supported
Show Truto-specific parameters
integrated_account_idstring · uuid
required·

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

Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d
truto_response_formatstring

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.

Example: unified
Possible values:
unifiedrawnormalizedstream
truto_key_bystring

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_limitboolean

Ignores the limit query parameter.

truto_ignore_remote_databoolean

Excludes the remote_data attribute from the response.

truto_exclude_fieldsstring[]

Array of fields to exclude from the response.

Example: truto_exclude_fields[]=id&truto_exclude_fields[]=name
remote_queryRecord<string, any>

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

Response Body

next_cursorstring

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.

resultobject[]

List of Roles

idstring
required·

The unique identifier for a role

92 supported
Adobe
supported
Adobe Marketo Engage
supported
Apache Airflow
supported
Auth0
supported
Avalara AvaTax
supported
Avigilon Alta
supported
Azure Active Directory
supported
BigPanda
supported
BlackLine
supported
Boomi
supported
Cato Networks
supported
ClickUp
supported
Close
supported
Cloudflare
supported
CrowdStrike
supported
Datadog
supported
dbt Labs
supported
Discord
supported
DocuSign
supported
Domo
supported
Doppler
supported
Druva inSync
supported
Dynatrace
supported
Eventbrite
supported
Fivetran
supported
Freshchat
supported
Freshdesk
supported
Freshservice
supported
Gong
supported
Google
supported
Google Cloud
supported
Google Workspace
supported
HappyFox
supported
Harness
supported
Harvest
supported
HelloID
supported
HubSpot
supported
Jenkins
supported
JFrog
supported
Jira
supported
Jira Service Management
supported
JumpCloud
supported
Kommo
supported
Kustomer
supported
LaunchDarkly
supported
Leadsquared
supported
LearnWorlds
supported
Looker
supported
Microsoft 365
supported
Oracle Netsuite
supported
New Relic
supported
Ninjaone
supported
Okta
supported
OneDrive
supported
OneLogin
supported
Opsgenie
supported
Oracle Fusion Cloud
supported
Oracle Fusion Cloud EPM
supported
Oracle Fusion Cloud Financials
supported
Outreach
supported
Pipedrive
supported
Pylon
supported
Qdrant Cloud
supported
Qlik Sense
supported
Rockset
supported
Sage Intacct
supported
SailPoint IdentityIQ SCIM
supported
SailPoint Identity Security Cloud
supported
SailPoint NERM
supported
Salesforce
supported
Salesloft
supported
Segment
supported
ServiceNow
supported
Sisense
supported
SmartRecruiters
supported
Snowflake
supported
SolarWinds Service Desk
supported
Sophos
supported
SpotDraft
supported
Sumo Logic
supported
SurveySparrow
supported
TeamViewer
supported
ThoughtSpot
supported
Torii
supported
UiPath
supported
Webex
supported
Workato
supported
Workiva
supported
Zoho Bigin
supported
Zoho CRM
supported
Zoho Desk
supported
Zoom
supported
applicable_instring

The context in which the role is applicable

Possible values:
groupworkspace
7 supported
dbt Labs
supported
Discord
supported
Doppler
supported
Gong
supported
Google Cloud
supported
JumpCloud
supported
Opsgenie
supported
created_atstring · date-time

The date and time the role was created

31 supported
Adobe Marketo Engage
supported
Avigilon Alta
supported
BigPanda
supported
ClickUp
supported
Close
supported
Datadog
supported
dbt Labs
supported
Domo
supported
Doppler
supported
Dynatrace
supported
Freshdesk
supported
Freshservice
supported
Harness
supported
Harvest
supported
Oracle Netsuite
supported
Okta
supported
Oracle Fusion Cloud
supported
Oracle Fusion Cloud Financials
supported
Outreach
supported
Qdrant Cloud
supported
Qlik Sense
supported
Rockset
supported
Sage Intacct
supported
SailPoint IdentityIQ SCIM
supported
SailPoint Identity Security Cloud
supported
Salesforce
supported
ServiceNow
supported
Snowflake
supported
Sumo Logic
supported
SurveySparrow
supported
Workato
supported
descriptionstring

The description of the role

48 supported
Auth0
supported
Azure Active Directory
supported
Boomi
supported
Cato Networks
supported
Cloudflare
supported
Discord
supported
Domo
supported
Dynatrace
supported
Eventbrite
supported
Fivetran
supported
Freshchat
supported
Freshservice
supported
Gong
supported
Google
supported
Google Cloud
supported
Google Workspace
supported
Harness
supported
HelloID
supported
JFrog
supported
Jira
supported
JumpCloud
supported
LaunchDarkly
supported
LearnWorlds
supported
Microsoft 365
supported
Ninjaone
supported
Okta
supported
OneDrive
supported
Oracle Fusion Cloud
supported
Oracle Fusion Cloud Financials
supported
Pipedrive
supported
Qdrant Cloud
supported
Qlik Sense
supported
Rockset
supported
Sage Intacct
supported
SailPoint Identity Security Cloud
supported
Salesforce
supported
Segment
supported
ServiceNow
supported
Sisense
supported
SolarWinds Service Desk
supported
Sophos
supported
SpotDraft
supported
Sumo Logic
supported
SurveySparrow
supported
ThoughtSpot
supported
Torii
supported
Zoho Bigin
supported
Zoho Desk
supported
labelstring

The display label of the role

10 supported
Google Cloud
supported
New Relic
supported
Okta
supported
Oracle Fusion Cloud
supported
Oracle Fusion Cloud Financials
supported
Sisense
supported
SurveySparrow
supported
Torii
supported
UiPath
supported
Zoho Bigin
supported
namestring

The name of the role

91 supported
Adobe
supported
Adobe Marketo Engage
supported
Apache Airflow
supported
Auth0
supported
Avalara AvaTax
supported
Avigilon Alta
supported
Azure Active Directory
supported
BigPanda
supported
BlackLine
supported
Boomi
supported
Cato Networks
supported
ClickUp
supported
Close
supported
Cloudflare
supported
CrowdStrike
supported
Datadog
supported
dbt Labs
supported
Discord
supported
DocuSign
supported
Domo
supported
Doppler
supported
Druva inSync
supported
Dynatrace
supported
Eventbrite
supported
Fivetran
supported
Freshchat
supported
Freshdesk
supported
Freshservice
supported
Gong
supported
Google
supported
Google Cloud
supported
Google Workspace
supported
HappyFox
supported
Harness
supported
Harvest
supported
HelloID
supported
HubSpot
supported
Jenkins
supported
JFrog
supported
Jira
supported
Jira Service Management
supported
JumpCloud
supported
Kommo
supported
LaunchDarkly
supported
Leadsquared
supported
LearnWorlds
supported
Looker
supported
Microsoft 365
supported
Oracle Netsuite
supported
New Relic
supported
Ninjaone
supported
Okta
supported
OneDrive
supported
OneLogin
supported
Opsgenie
supported
Oracle Fusion Cloud
supported
Oracle Fusion Cloud EPM
supported
Oracle Fusion Cloud Financials
supported
Outreach
supported
Pipedrive
supported
Pylon
supported
Qdrant Cloud
supported
Qlik Sense
supported
Rockset
supported
Sage Intacct
supported
SailPoint IdentityIQ SCIM
supported
SailPoint Identity Security Cloud
supported
SailPoint NERM
supported
Salesforce
supported
Salesloft
supported
Segment
supported
ServiceNow
supported
Sisense
supported
SmartRecruiters
supported
Snowflake
supported
SolarWinds Service Desk
supported
Sophos
supported
SpotDraft
supported
Sumo Logic
supported
SurveySparrow
supported
TeamViewer
supported
ThoughtSpot
supported
Torii
supported
UiPath
supported
Webex
supported
Workato
supported
Workiva
supported
Zoho Bigin
supported
Zoho CRM
supported
Zoho Desk
supported
Zoom
supported
remote_dataRecord<string, any>

Raw data returned from the remote API call.

typestring

The type of the role

4 supported
Jenkins
supported
Ninjaone
supported
UiPath
supported
Workato
supported
updated_atstring · date-time

The date and time the role was last updated

28 supported
Adobe Marketo Engage
supported
Avigilon Alta
supported
BigPanda
supported
Close
supported
Datadog
supported
dbt Labs
supported
DocuSign
supported
Domo
supported
Dynatrace
supported
Freshdesk
supported
Freshservice
supported
Harness
supported
Harvest
supported
Oracle Netsuite
supported
Okta
supported
Oracle Fusion Cloud
supported
Oracle Fusion Cloud Financials
supported
Outreach
supported
Qdrant Cloud
supported
Qlik Sense
supported
Sage Intacct
supported
SailPoint IdentityIQ SCIM
supported
SailPoint Identity Security Cloud
supported
Salesforce
supported
ServiceNow
supported
Sumo Logic
supported
SurveySparrow
supported
Workato
supported
curl -X GET 'https://api.truto.one/unified/user-directory/roles?integrated_account_id=<integrated_account_id>' \
  -H 'Authorization: Bearer <your_api_token>' \
  -H 'Content-Type: application/json'
const integratedAccountId = '<integrated_account_id>';

const response = await fetch(`https://api.truto.one/unified/user-directory/roles?integrated_account_id=${integratedAccountId}`, {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer <your_api_token>',
    'Content-Type': 'application/json',
  },
});

const data = await response.json();
console.log(data);
import requests

url = "https://api.truto.one/unified/user-directory/roles"
headers = {
    "Authorization": "Bearer <your_api_token>",
    "Content-Type": "application/json",
}
params = {
    "integrated_account_id": "<integrated_account_id>"
}

response = requests.get(url, headers=headers, params=params)
print(response.json())
import Truto from '@truto/truto-ts-sdk';

const truto = new Truto({
  token: '<your_api_token>',
});

const result = await truto.unifiedApi.list(
  'user-directory',
  'roles',
  { integrated_account_id: '<integrated_account_id>' }
);

console.log(result);
import asyncio
from truto_python_sdk import TrutoApi

truto_api = TrutoApi(token="<your_api_token>")

async def main():
    async for item in truto_api.unified_api.list(
        "user-directory",
        "roles",
        {"integrated_account_id": "<integrated_account_id>"}
    ):
        print(item)

asyncio.run(main())