Appearance

Get Licenses ​

Endpoint ​

http
GET /unified/user-directory/licenses/{id}
Integrations supported
  • Salesforce
  • Webex

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 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_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
include_assigned_to
string

The type of object to whom the license is assigned to

All possible enum values:
  • user
Supported in
  • Webex

Response Body ​

id
string
REQUIRED · 

Unique identifier for the license.

Supported in
  • Salesforce
  • Webex
name
string

Name of the license.

Supported in
  • Salesforce
  • Webex
description
string

Description for the license.

available_quantity
number

Total number of licenses that can be assigned to users.

Supported in
  • Salesforce
assigned_quantity
number

Number of licenses that have been assigned to users.

Supported in
  • Salesforce
  • Webex
unit_amount
string

Unit amount for the license.

roles
object[]

Valid Roles for the license.

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
  • Salesforce
currency
string

Currency for the license.

status
string

Status for the license

All possible enum values:
  • active
  • inactive
Supported in
  • Salesforce
created_at
string · date-time

Date and time when the license was created.

Supported in
  • Salesforce
updated_at
string · date-time

Date and time when the license was last updated.

Supported in
  • Salesforce
remote_data
object

Raw data returned from the remote API call.