Appearance

Get Roles ​

Endpoint ​

http
GET /unified/user-directory/roles/{id}
Integrations supported
  • Adobe Marketo Engage
  • Auth0
  • BigPanda
  • Close
  • Confluent
  • CrowdStrike
  • Datadog
  • dbt Labs
  • Domo
  • Freshdesk
  • Freshservice
  • Harness
  • HelloID
  • JFrog
  • Jira
  • LaunchDarkly
  • New Relic
  • OneLogin
  • Opsgenie
  • Outreach
  • Pipedrive
  • Qlik Sense
  • Rockset
  • Salesforce
  • Salesloft
  • SolarWinds Service Desk
  • Webex
  • 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.

Defaults to unified.

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

Response Body ​

id
string
REQUIRED · 

The unique identifier for a role

Supported in
  • Adobe Marketo Engage
  • Auth0
  • BigPanda
  • Close
  • Confluent
  • CrowdStrike
  • Datadog
  • dbt Labs
  • Domo
  • Freshdesk
  • Freshservice
  • Harness
  • HelloID
  • JFrog
  • Jira
  • LaunchDarkly
  • New Relic
  • OneLogin
  • Opsgenie
  • Outreach
  • Pipedrive
  • Qlik Sense
  • Rockset
  • Salesforce
  • Salesloft
  • SolarWinds Service Desk
  • Webex
  • Zoho CRM
  • Zoom
name
string

The name of the role

Supported in
  • Adobe Marketo Engage
  • Auth0
  • BigPanda
  • Close
  • Confluent
  • CrowdStrike
  • Datadog
  • dbt Labs
  • Domo
  • Freshdesk
  • Freshservice
  • Harness
  • HelloID
  • JFrog
  • Jira
  • LaunchDarkly
  • New Relic
  • OneLogin
  • Opsgenie
  • Outreach
  • Pipedrive
  • Qlik Sense
  • Rockset
  • Salesforce
  • Salesloft
  • SolarWinds Service Desk
  • Webex
  • Zoho CRM
  • Zoom
label
string

The display label of the role

Supported in
  • New Relic
description
string

The description of the role

Supported in
  • Auth0
  • CrowdStrike
  • Domo
  • Freshservice
  • Harness
  • HelloID
  • JFrog
  • LaunchDarkly
  • Pipedrive
  • Qlik Sense
  • Rockset
  • SolarWinds Service Desk
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
  • BigPanda
  • Close
  • Confluent
  • Datadog
  • dbt Labs
  • Domo
  • Freshdesk
  • Freshservice
  • Harness
  • Outreach
  • Qlik Sense
  • Rockset
updated_at
string · date-time

The date and time the role was last updated

Supported in
  • BigPanda
  • Close
  • Confluent
  • Datadog
  • dbt Labs
  • Domo
  • Freshdesk
  • Freshservice
  • Harness
  • Outreach
  • Qlik Sense
remote_data
object

Raw data returned from the remote API call.