Appearance

List App users ​

Endpoint ​

http
GET /unified/sso/app_users
Integrations supported
  • Okta

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 will return the response with unified mappings applied.
  • raw will return the raw response from the remote API.
  • normalized will apply the unified mappings and return the data in a normalized format.

Defaults to unified.

All possible enum values:
  • unified
  • raw
  • normalized
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
app_id
string

The unique identifier of the application the user is assigned to.

Supported in
  • Okta

Response Body ​

result
object[]

List of App users

id
string
REQUIRED · 

The unique identifier of the user.

Supported in
  • Okta
first_name
string

The first name of the user

Supported in
  • Okta
last_name
string

The last name of the user

Supported in
  • Okta
name
string

The name of the user

username
string

The username of the user

Supported in
  • Okta
emails
object[]

The emails of the user

Supported in
  • Okta
email
string

The email address

type
string

The type of email address

is_primary
boolean

Whether the email address is primary

phones
object[]

The phones of the user

Supported in
  • Okta
number
string

The phone number

extension
string

The extension of the phone number

type
string

The type of phone number

status
string

The status of the user. If no clear mapping is available, then the raw value is returned.

Supported in
  • Okta
app
string

The unique identifier of the application the user is assigned to.

Supported in
  • Okta
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.