List Users
/unified/user-directory/users
Partial response — use the "get" endpoint for the full object.
Query Parameters
Refer Specifying query parameters in Truto APIs
The first name of the user
190 supported
The last name of the user
189 supported
The emails of the user
326 supported
The email address
Whether the email address is primary
The type of email address
The status of the user. If no clear mapping is available, then the raw value is returned.
activecreateddeletedinactiveinvited
237 supported4 notes
activeinactiveThe status of the user. If no clear mapping is available, then the raw value is returned.
activeinactiveinactiveactiveactiveBy default, response should include both active and inactive users.
activeinactivedeletedinvitedactivedeletedinvitedactiveinactiveinvitedcreatedactiveinactiveSupported only for product azure_active_directory
activeinactiveThe status of the user. It should only be used if the workspace_id is not provided.
activeinactiveactiveinactiveactiveinactiveThe date and time the user was created
203 supported
The date and time the user was last updated
134 supported
The possible fieldName are id, username, urls, emails.
created_atemailsfirst_namegroupsidlast_active_atlast_login_atnamerolesstatusupdated_atusername
12 supported
idcreated_atupdated_atemailsnameemailscreated_atupdated_atusernameemailsemailsnameusernamelast_login_atrolesnamelast_active_atcreated_atnameusernamecreated_atupdated_atnamecreated_atupdated_atnameemailsrolesgroupsfirst_namecreated_atupdated_atemailsstatuslast_login_at19 supported6 required3 notes
The unique identifier for the group
Either of organization_id or group_id is required.
One of workspace or group is required.
30 supported21 required9 notes
The unique identifier for the workspace
The unique identifier for the workspace
Unique identifier of the workspace to filter the users.
The unique identifier for the workspace
One of workspace or group is required.
This is required when product is analytics.
The unique identifier for the workspace. Required when the product is sharepoint or teams
The unique identifier for the workspace
This value is required when the version that you are using is 10 or greater.
23 supported18 required5 notes
The unique identifier for the organization
The unique identifier of an organization
The unique identifier for the organization
Either of organization_id or group_id is required.
The unique identifier of the organization.
The name of the user
319 supported
2 supported2 notes
Whether to include the last login date and time for each user. Requires Premium P1 or P2 license.
Set this value when product is azure_active_directory. Whether to include the last login date and time for each user. Requires Premium P1 or P2 license.
The unique identifier for a role.
1 supported
The email of the user
5 supported
The username of the user
126 supported
If true (and using a group/workspace context), include inherited members.
1 supported
The roles of the user
238 supported
The role of the user in the group. This is available when the user can have different roles in different groups or teams in an application.
The unique identifier for a role
The name of the role
The role of the user in the organization. This is available when the user can have different roles in different organizations in an application.
The role of the user in the workspace. This is available when the user can have different roles in different workspaces in an application.
Select the product for which you want to retrieve the users.
analyticsazure_active_directoryonedrivesharepointteamsworkspace
2 supported2 required
workspaceanalyticsteamssharepointonedriveazure_active_directoryThe unique identifier of the customer.
1 supported
The full path of an org unit.
1 supported
The type of user
adminend_userlimitedmachineuser
43 supported1 required
adminend_userusermachinelimited1 supported
The groups of the user
83 supported
The name of the group
departmentgroup
The unique identifier for a group
The unique identifier of the organization to which the group belongs
The title of the user
61 supported
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 Users
The unique identifier for a user
348 supported
The date and time the user was activated
13 supported
The avatar of the user
107 supported
The bio of the user. Usually a short description set by the user about them.
13 supported
The date and time the user was created
203 supported
The emails of the user
326 supported
3 properties
The email address
Whether the email address is primary
The type of email address
The external identifier for a user. This is set when the SCIM API is being used.
33 supported
The first name of the user
190 supported
The groups of the user
83 supported
3 properties
The unique identifier for a group
The name of the group
The unique identifier of the organization to which the group belongs
The identifiers of the user.
8 supported
Whether the user has 2FA enabled
38 supported
Whether the user's email has been verified
25 supported
The languages preferred by the user
74 supported
The date and time the user was last active
32 supported
The date and time the user was last logged in
63 supported
The last name of the user
189 supported
The licenses of the user or the products the user has access to
63 supported
4 properties
The unique identifier for a license
The date and time the user was last active for the license
The name of the license
The unique identifier of the organization to which the license belongs
The name of the user
319 supported
The organizations of the user
37 supported
2 properties
The unique identifier for an organization
The name of the organization
The phones of the user
103 supported
3 properties
The extension of the phone number
The phone number
The type of phone number
Raw data returned from the remote API call.
The roles of the user
238 supported
5 properties
The role of the user in the group. This is available when the user can have different roles in different groups or teams in an application.
The unique identifier for a role
The name of the role
The role of the user in the organization. This is available when the user can have different roles in different organizations in an application.
The role of the user in the workspace. This is available when the user can have different roles in different workspaces in an application.
The status of the user. If no clear mapping is available, then the raw value is returned.
activeinactivedeletedinvited
237 supported
The date and time the user's status was last changed
5 supported
The timezone of the user
82 supported
The title of the user
61 supported
The date and time the user was last updated
134 supported
The URLs of the user
21 supported
2 properties
The type of URL
The URL
The type of user
43 supported
The username of the user
126 supported
The workspaces of the user
20 supported
2 properties
The unique identifier for a workspace
The name of the workspaces
curl -X GET 'https://api.truto.one/unified/user-directory/users?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/users?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/users"
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',
'users',
{ 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",
"users",
{"integrated_account_id": "<integrated_account_id>"}
):
print(item)
asyncio.run(main())