Search User Groups For Auth Source

The auth source can be SSO/VIDM/LDAP/AD.
For the LDAP/AD auth source, the request should contain the name of the group.
For the SSO/VIDM auth source, request should contain the name of the group and the SSO/VIDM domain.
User-group's name can contain wildcards. Maximum of 25 user-groups are returned for SSO auth source.

Request

URI

POST

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

COPY

Path Parameters

string

Required

The id of the auth source

Request Body

The query object for user group search
Notes Examples for LDAP/SSO user groups

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

Required

Show optional properties

{
    "name": "string"
}

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

string

name

Required

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

string

domain

Optional

The auth source domain. Mandatory for an sso auth source

Authentication

This operation uses the following authentication methods.

Token-based-authorization

Responses

200

User-groups matching the request query
Notes Examples for LDAP/SSO user groups

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

"usergroup-search-responses Object"

array of object

usergroup-search-response

Optional

List of user groups

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}/usergroups/search

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

200 Response Body

Auth Operations