Appearance

Get Roles ​

Endpoint ​

http
GET /unified/user-directory/roles/{id}
Integrations supported
  • Adobe Marketo Engage
  • Apache Airflow
  • Auth0
  • Avigilon Alta
  • BigPanda
  • Boomi
  • Close
  • CrowdStrike
  • Datadog
  • dbt Labs
  • Domo
  • Freshdesk
  • Freshservice
  • Google Cloud
  • Harness
  • HelloID
  • JFrog
  • Jira
  • Jira Service Management
  • Kommo
  • LaunchDarkly
  • Oracle Netsuite
  • New Relic
  • OneLogin
  • Opsgenie
  • Oracle Fusion Cloud
  • Oracle Fusion Cloud Financials
  • Outreach
  • Pipedrive
  • Qlik Sense
  • Rockset
  • SailPoint IdentityIQ SCIM
  • SailPoint Identity Security Cloud
  • Salesforce
  • Salesloft
  • Sisense
  • SolarWinds Service Desk
  • Sophos
  • UiPath
  • Webex
  • Workato
  • Zoho CRM
  • Zoom

Path parameters ​

id
string
REQUIRED · 

The ID of the resource.

Example: 23423523

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.
  • debug returns the final unified result alongside raw remote fetch information. The response is an envelope containing result (identical to unified mode output) and debug (with requestUrl, requestOptions, data, responseHeaders, and for list operations: nextCursor, isLooping, isEmptyResult, resultCount). debug is null for static responses or when truto_skip_api_call=true.

Defaults to unified.

All possible enum values:
  • unified
  • raw
  • normalized
  • stream
  • debug
Example: unified
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
workspace_id
Required in
  • dbt Labs
group_id
Supported in
  • Opsgenie

Response Body ​

id
string
REQUIRED · 

The unique identifier for a role

Supported in
  • Adobe Marketo Engage
  • Apache Airflow
  • Auth0
  • Avigilon Alta
  • BigPanda
  • Boomi
  • Close
  • CrowdStrike
  • Datadog
  • dbt Labs
  • Domo
  • Freshdesk
  • Freshservice
  • Harness
  • HelloID
  • JFrog
  • Jira
  • Jira Service Management
  • Kommo
  • LaunchDarkly
  • Oracle Netsuite
  • New Relic
  • OneLogin
  • Opsgenie
  • Oracle Fusion Cloud
  • Oracle Fusion Cloud Financials
  • Outreach
  • Pipedrive
  • Qlik Sense
  • Rockset
  • SailPoint IdentityIQ SCIM
  • SailPoint Identity Security Cloud
  • Salesforce
  • Salesloft
  • Sisense
  • SolarWinds Service Desk
  • Sophos
  • UiPath
  • Webex
  • Workato
  • Zoho CRM
  • Zoom
name
string

The name of the role

Supported in
  • Adobe Marketo Engage
  • Apache Airflow
  • Auth0
  • Avigilon Alta
  • BigPanda
  • Boomi
  • Close
  • CrowdStrike
  • Datadog
  • dbt Labs
  • Domo
  • Freshdesk
  • Freshservice
  • Harness
  • HelloID
  • JFrog
  • Jira
  • Jira Service Management
  • Kommo
  • LaunchDarkly
  • Oracle Netsuite
  • New Relic
  • OneLogin
  • Opsgenie
  • Oracle Fusion Cloud
  • Oracle Fusion Cloud Financials
  • Outreach
  • Pipedrive
  • Qlik Sense
  • Rockset
  • SailPoint IdentityIQ SCIM
  • SailPoint Identity Security Cloud
  • Salesforce
  • Salesloft
  • Sisense
  • SolarWinds Service Desk
  • Sophos
  • UiPath
  • Webex
  • Workato
  • Zoho CRM
  • Zoom
label
string

The display label of the role

Supported in
  • New Relic
  • Oracle Fusion Cloud
  • Oracle Fusion Cloud Financials
  • Sisense
  • UiPath
description
string

The description of the role

Supported in
  • Auth0
  • Boomi
  • CrowdStrike
  • Domo
  • Freshservice
  • Harness
  • HelloID
  • JFrog
  • Jira
  • LaunchDarkly
  • Oracle Fusion Cloud
  • Oracle Fusion Cloud Financials
  • Pipedrive
  • Qlik Sense
  • Rockset
  • SailPoint Identity Security Cloud
  • Salesforce
  • Sisense
  • SolarWinds Service Desk
  • Sophos
type
string

The type of the role

Supported in
  • UiPath
  • Workato
applicable_in
string

The context in which the role is applicable

All possible enum values:
  • group
  • workspace
Supported in
  • dbt Labs
  • Opsgenie
created_at
string · date-time

The date and time the role was created

Supported in
  • Avigilon Alta
  • BigPanda
  • Close
  • Datadog
  • dbt Labs
  • Domo
  • Freshdesk
  • Freshservice
  • Harness
  • Oracle Netsuite
  • Oracle Fusion Cloud
  • Oracle Fusion Cloud Financials
  • Outreach
  • Qlik Sense
  • Rockset
  • SailPoint IdentityIQ SCIM
  • SailPoint Identity Security Cloud
  • Salesforce
  • Workato
updated_at
string · date-time

The date and time the role was last updated

Supported in
  • Avigilon Alta
  • BigPanda
  • Close
  • Datadog
  • dbt Labs
  • Domo
  • Freshdesk
  • Freshservice
  • Harness
  • Oracle Netsuite
  • Oracle Fusion Cloud
  • Oracle Fusion Cloud Financials
  • Outreach
  • Qlik Sense
  • SailPoint IdentityIQ SCIM
  • SailPoint Identity Security Cloud
  • Salesforce
  • Workato
remote_data
object

Raw data returned from the remote API call.