Get Users Or Groups Global Summary
Note: CPA needs to be initialized for the pod for invoking this API. All the listed privileges are required -
| Privileges | Description |
|---|---|
| FEDERATED_LDAP_VIEW | Caller should have permission to this privilege, to perform this operation. |
id
OK
{
"application_local_session_ids": [
"bc6fc134-d197-3bbc-a6bf-24dc63123ae6"
],
"container": "example.com/Users",
"description": "Test User account",
"desktop_local_session_ids": [
"bc6fc134-d197-3bbc-a6bf-24dc63123ae6"
],
"display_name": "example.com\\\\testuser",
"distinguished_name": "CN=Test User,CN=Users,DC=example,DC=com",
"domain": "example.com",
"domain_net_bios_name": "example",
"email": "testuser@example.com",
"first_name": "Test",
"global_application_entitlements": [
"0223796c-102b-4ed3-953f-3dfe3d23e1de"
],
"global_desktop_entitlements": [
"0103796c-102b-4ed3-953f-3dfe3d23e0fe"
],
"global_user_application_entitlements": [
"S-1-1-1-3965912346-1012345398-3123456564-123"
],
"global_user_desktop_entitlements": [
"S-1-1-1-3965912346-1012345398-3123456564-123"
],
"group": false,
"id": "S-1-5-21-1111111111-2222222222-3333333333-500",
"kiosk_user": false,
"last_name": "User",
"login_name": "testuser",
"long_display_name": "testuser@example.com (Test User)",
"name": "Test User",
"phone": "1-877-486-9273",
"pod_assignments": [
"58deeb70-97d5-409e-abb4-497196f1ee18"
],
"unauthenticated_access_user": false,
"user_display_name": "Test User",
"user_home_sites": [
"32a5ea06-cd09-4609-b3e5-df8379e99c13"
],
"user_principal_name": "testuser@example.com"
}Ids for local application sessions for this user. This will be unset if this is a group.
AD container for this user or group. This property can be used for sorting.
Description of this user or group. Supported Filters : 'Equals', 'StartsWith', 'Contains'. This property can be used for sorting.
Ids for local desktop sessions for this user. This will be unset if this is a group.
Login name with domain of this user or group. This property can be used for sorting.
Active Directory distinguished name for this user or group. This property can be used for sorting.
DNS name of the domain in which this user or group belongs. Supported Filters : 'Equals'. Also, if 'Or' filter is used anywhere in filter string for this model class, then that 'Or' filter should nest only 'Equals' filter on 'domain' or 'id' field. This property can be used for sorting.
The domain netbios the user or group is in. This will be the netbios name of the domain. This property can be used for sorting.
Email address of this user or group. Supported Filters : 'Equals', 'StartsWith', 'Contains'. This property can be used for sorting.
First name of this user or group. This property can be used for sorting.
Global application entitlements for this user. Supported Filters : 'Contains'.
Global desktop entitlements for this user. Supported Filters : 'Contains'.
Global application entitlement user entitlements for this user or group.
Global desktop entitlement user entitlements for this user or group.
Indicates if this object represents a group.
Supported Filters: 'Equals'. This property can be used for sorting.
Unique SID representing this AD User or Group. Supported Filters : 'Equals'. 'Or' filter chain of 'Equals' filter can be used to query for more than one id. For this model, if 'Or' filter is used, then it should nest only 'Equals' filter on 'domain' or 'id' field.
Indicates if this user or group is a "kiosk user" that supports client authentication. Client authentication is the process of supporting client devices directly logging into resources. This property can be used for sorting.
Last name of this user or group. This property can be used for sorting.
Login name of this user or group. Supported Filters : 'Equals', 'StartsWith', 'Contains'. This property can be used for sorting.
Login name, domain and name for this user or group, else display name. This property can be used for sorting.
Name of this user or group. Supported Filters : 'Equals', 'StartsWith', 'Contains'. This property can be used for sorting.
Phone number of this user. Supported Filters : 'Equals', 'StartsWith', 'Contains'. This property can be used for sorting.
Pod assignments per global entitlement, if any, for this user or group. If this is a group, this will be unset.
Whether or not this is unauthenticated access user. Supported Filters : 'Equals'. This property can be used for sorting.
User or group's display name. This corresponds with displayName attribute in AD. This property can be used for sorting.
Home sites for this user or group. There may be home site overrides for each global entitlement specified for this user or group and one default site for the user or group in general.
User Principal name(UPN) of this user. Supported Filters : 'Equals', 'StartsWith', 'Contains'. This property can be used for sorting.
User is not authenticated
Access to the resource is forbidden
Not Found
Conflict | CPA not initialized for the pod