List Licenses
/unified/user-directory/licenses
Query Parameters
Refer Specifying query parameters in Truto APIs
The unique identifier for the organization
4 supported3 required
Select the product for which you want to retrieve the licenses.
azure_active_directoryonedrive
1 supported1 required
Show Truto-specific parameters
The ID of the integrated account to use for the request.
62f44730-dd91-461e-bd6a-aedd9e0ad79dThe format of the response.
unifiedreturns the response with unified mappings applied.rawreturns the unprocessed, raw response from the remote API.normalizedapplies the unified mappings and returns the data in a normalized format.streamreturns 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.
unifiedunifiedrawnormalizedstream
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.
idIgnores the limit query parameter.
Excludes the remote_data attribute from the response.
Array of fields to exclude from the response.
truto_exclude_fields[]=id&truto_exclude_fields[]=nameQuery parameters to pass to the underlying API without any transformations. Refer this guide to see how to structure the query parameters.
remote_query[foo]=barResponse Body
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.
List of Licenses
Unique identifier for the license.
25 supported
Number of licenses that have been assigned to users.
18 supported
Total number of licenses that can be assigned to users.
16 supported
Date and time when the license was created.
5 supported
Currency for the license.
1 supported
Description for the license.
1 supported
Whether the license is paid or not.
20 supported
Name of the license.
23 supported
The products that are part of the license.
4 supported
3 properties
Unique identifier for the product
The name of product
Status for the product within the license. Usually denotes the provisioning status.
activeinactiveerroredneeds_inputneeds_confirmationpending
Raw data returned from the remote API call.
Valid Roles for the license.
1 supported
2 properties
Unique identifier for the role.
Name of the role.
Status for the license
activeinactive
9 supported
Unit amount for the license.
1 supported
Date and time when the license was last updated.
3 supported
curl -X GET 'https://api.truto.one/unified/user-directory/licenses?integrated_account_id=<integrated_account_id>' \
-H 'Authorization: Bearer <your_api_token>' \
-H 'Content-Type: application/json'const integratedAccountId = '<integrated_account_id>';
const response = await fetch(`https://api.truto.one/unified/user-directory/licenses?integrated_account_id=${integratedAccountId}`, {
method: 'GET',
headers: {
'Authorization': 'Bearer <your_api_token>',
'Content-Type': 'application/json',
},
});
const data = await response.json();
console.log(data);import requests
url = "https://api.truto.one/unified/user-directory/licenses"
headers = {
"Authorization": "Bearer <your_api_token>",
"Content-Type": "application/json",
}
params = {
"integrated_account_id": "<integrated_account_id>"
}
response = requests.get(url, headers=headers, params=params)
print(response.json())import Truto from '@truto/truto-ts-sdk';
const truto = new Truto({
token: '<your_api_token>',
});
const result = await truto.unifiedApi.list(
'user-directory',
'licenses',
{ integrated_account_id: '<integrated_account_id>' }
);
console.log(result);import asyncio
from truto_python_sdk import TrutoApi
truto_api = TrutoApi(token="<your_api_token>")
async def main():
async for item in truto_api.unified_api.list(
"user-directory",
"licenses",
{"integrated_account_id": "<integrated_account_id>"}
):
print(item)
asyncio.run(main())