Skip to content

Get Role assignments ​

Endpoint ​

http
GET /unified/user-directory/role_assignments/{id}
Integrations supported
  • Confluent

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

Response Body ​

id
string
REQUIRED · 

The unique identifier for a role assignment

Supported in
  • Confluent
user_id
string

The unique identifier for a user who the role is assigned to

Supported in
  • Confluent
group_id
string

The unique identifier for a group the role is assigned to

group_type
string

The type of the group the role is assigned to

All possible enum values:
  • product
  • group
  • team
role_id
string

The unique identifier for a role

Supported in
  • Confluent
workspace
string[]

The unique identifier for a workspace the assignment is applicable in

created_at
string · date-time

The date and time of the role assignment was created

Supported in
  • Confluent
updated_at
string · date-time

The date and time of the role assignment was updated

Supported in
  • Confluent
remote_data
object

Raw data returned from the remote API call.