LdapIdentitySearchItem

LdapIdentitySearchItem
Ldap Identity Search Item

A single user or group matched by GET /iam/ldap-identity-sources/search.

JSON Example
{
    "common_name": "string",
    "distinguished_name": "string",
    "principal_name": "string",
    "user_type": "string"
}
string
common_name
Required

The entry's Common Name (CN) attribute, if the directory populates one.

string
distinguished_name
Required

The entry's full Distinguished Name (DN). Can be used as entity_name when granting a role via POST /iam/role-bindings.

string
principal_name
Optional

The entry's user principal name (for example [email protected]), if the directory populates one. Prefer this over distinguished_name as entity_name when available, since it is typically more stable.

user_type
Required

Identifies whether an identity is a local Installer account, a remote user authenticated through a configured LDAP identity source, or a remote LDAP group.

Enumeration: LOCAL_USER, REMOTE_USER, REMOTE_GROUP