Search Users For Auth Source

Search users for an auth source

The auth source can be SSO/LDAP/AD/VIDM.
For the LDAP/AD auth source, the request should contain the name of the user.
For the SSO/VIDM auth source, request should contain the name of the user and the SSO/VIDM domain.
Username can contain wildcards. Maximum of 25 users are returned for SSO auth source.

Request

URI

POST

https://{api_host}/suite-api/api/auth/sources/{id}/users/search

COPY

Path Parameters

string

Required

The id of the auth source

Request Body

The query object for user search
Notes Examples for LDAP/SSO users

user-search-request of type(s) application/json

Required

Show optional properties

{
    "name": "string"
}

{
    "domain": "string",
    "name": "string"
}

string

domain

Optional

The auth source domain. Mandatory for an sso auth source

string

name

Required

The name of the user to be searched. Can contain wildcards

Authentication

This operation uses the following authentication methods.

Token-based-authorization

Responses

200

Users matching the request query
Notes Examples for LDAP/SSO users

Returns user-search-responses of type(s) application/json

{
    "user-search-response": [
        {
            "distinguishedName": "string",
            "emailAddress": "string",
            "externalId": "string",
            "firstName": "string",
            "lastName": "string",
            "name": "string"
        }
    ]
}

array of object

user-search-response

Optional

Collection of users

Code Samples

COPY

                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"name":"string"}' https://{api_host}/suite-api/api/auth/sources/{id}/users/search

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

200 Response Body

Auth Operations