Appearance

List Licenses ​

Endpoint ​

http
GET /unified/user-directory/licenses
Integrations supported
  • Adobe
  • Azure Active Directory
  • Cisco Meraki
  • ClickUp
  • DocuSign
  • Dropbox - Business
  • GitHub
  • Jira
  • Monday.com
  • PagerDuty
  • Qlik Sense
  • Salesforce
  • Webex
  • Zendesk
  • Zoom

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
organization_id
string

The unique identifier for the organization

Required in
  • Cisco Meraki
  • ClickUp
  • GitHub
Supported in
  • Webex

Response Body ​

result
object[]

List of Licenses

id
string
REQUIRED · 

Unique identifier for the license.

Supported in
  • Adobe
  • Azure Active Directory
  • Cisco Meraki
  • ClickUp
  • DocuSign
  • Dropbox - Business
  • GitHub
  • Jira
  • Monday.com
  • PagerDuty
  • Qlik Sense
  • Salesforce
  • Webex
  • Zendesk
  • Zoom
name
string

Name of the license.

Supported in
  • Adobe
  • Azure Active Directory
  • ClickUp
  • DocuSign
  • Dropbox - Business
  • GitHub
  • Jira
  • Monday.com
  • PagerDuty
  • Salesforce
  • Webex
  • Zendesk
  • Zoom
description
string

Description for the license.

Supported in
  • PagerDuty
available_quantity
number

Total number of licenses that can be assigned to users.

Supported in
  • Adobe
  • Azure Active Directory
  • Cisco Meraki
  • ClickUp
  • DocuSign
  • Dropbox - Business
  • GitHub
  • Monday.com
  • PagerDuty
  • Qlik Sense
  • Salesforce
  • Zendesk
assigned_quantity
number

Number of licenses that have been assigned to users.

Supported in
  • Azure Active Directory
  • ClickUp
  • Dropbox - Business
  • GitHub
  • Jira
  • PagerDuty
  • Qlik Sense
  • Salesforce
  • Webex
  • Zoom
unit_amount
string

Unit amount for the license.

Supported in
  • DocuSign
roles
object[]

Valid Roles for the license.

Supported in
  • PagerDuty
id
string

Unique identifier for the role.

name
string

Name of the role.

is_paid
boolean

Whether the license is paid or not.

Supported in
  • Adobe
  • ClickUp
  • DocuSign
  • Dropbox - Business
  • GitHub
  • Jira
  • Monday.com
  • PagerDuty
  • Qlik Sense
  • Salesforce
  • Zendesk
  • Zoom
currency
string

Currency for the license.

Supported in
  • DocuSign
status
string

Status for the license

All possible enum values:
  • active
  • inactive
Supported in
  • Azure Active Directory
  • Cisco Meraki
  • Dropbox - Business
  • Qlik Sense
  • Salesforce
products
object[]

The products that are part of the license.

Supported in
  • Azure Active Directory
id
string

Unique identifier for the product

name
string

The name of product

status
string

Status for the product within the license. Usually denotes the provisioning status.

All possible enum values:
  • active
  • inactive
  • errored
  • needs_input
  • needs_confirmation
  • pending
created_at
string · date-time

Date and time when the license was created.

Supported in
  • Cisco Meraki
  • Salesforce
updated_at
string · date-time

Date and time when the license was last updated.

Supported in
  • Qlik Sense
  • Salesforce
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.