ADUserOrGroupSummary

ADUserOrGroupSummary

Summary information related to AD Users or Groups. List API returning this summary information can use search filter query to filter on specific fields supported by filters. Supported Filters : 'And', 'Or', 'Equals', 'StartsWith', 'Contains'. See the field description to know the filter types it supports.

JSON Example

{
    "container": "example.com/Users",
    "description": "Test User account",
    "display_name": "example.com\\\\testuser",
    "distinguished_name": "CN=Test User,CN=Users,DC=example,DC=com",
    "domain": "example.com",
    "email": "[email protected]",
    "first_name": "Test",
    "group": false,
    "guid": "5F5A45D9-15C0-4654-8FCF-D589C0EF3ECA",
    "id": "S-1-5-21-1111111111-2222222222-3333333333-500",
    "kiosk_user": false,
    "last_name": "User",
    "login_name": "testuser",
    "long_display_name": "[email protected] (Test User)",
    "name": "Test User",
    "phone": "1-877-486-9273",
    "user_display_name": "Test User",
    "user_principal_name": "[email protected]"
}

string

container

Optional

AD container for this user or group.

string

description

Optional

Description number of this user or group. Supported Filters : 'Equals', 'StartsWith', 'Contains'.

string

display_name

Optional

Login name with domain of this user or group.

string

distinguished_name

Optional

Active Directory distinguished name for this user or group.

string

domain

Optional

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.

string

email

Optional

Email address of this user or group. Supported Filters : 'Equals', 'StartsWith', 'Contains'.

string

first_name

Optional

First name of this user or group.

boolean

group

Optional

Indicates if this object represents a group. This field is NOT supported in filter string. To use any filter on 'group', use 'group_only' query param directly.

string

guid

Optional

GUID of the user or group in RFC 4122 format. Supported Filters : 'Equals'.

string

id

Optional

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.

boolean

kiosk_user

Optional

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.

string

last_name

Optional

Last name of this user or group.

string

login_name

Optional

Login name of this user or group. Supported Filters : 'Equals', 'StartsWith', 'Contains'.

string

long_display_name

Optional

Login name, domain and name for this user or group, else display name

string

name

Optional

Name of this user or group. Supported Filters : 'Equals', 'StartsWith', 'Contains'.

string

phone

Optional

Phone number of this user. Supported Filters : 'Equals', 'StartsWith', 'Contains'.

string

user_display_name

Optional

User or group's display name. This corresponds with displayName attribute in AD.

string

user_principal_name

Optional

User Principal name(UPN) of this user. Supported Filters : 'Equals', 'StartsWith', 'Contains'.