Search User Groups For Auth Source Using POST

Search User Groups For Auth Source Using POST

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}/api/auth/sources/{id}/usergroups/search
COPY
Path Parameters
string
id
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"
}
{
    "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 group to be searched. Can contain wildcards

Authentication
This operation uses the following authentication methods.
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-response": [
        {
            "description": "string",
            "distinguishedName": "string",
            "name": "string"
        }
    ]
}
array of usergroup-search-response
usergroup-search-response
Optional

List of user groups


On This Page
Auth Operations
POST
Acquire Token Using POST
POST
Add Auth Source Using POST
POST
Add Role Privileges Using POST
PUT
Assign Role Permission To User Group Using PUT
PUT
Assign Role Permission To User Using PUT
PUT
Assign Traversal Spec To User Group Using PUT
Deprecated
PUT
Assign Traversal Spec To User Using PUT
Deprecated
PUT
Change Password Using PUT
POST
Create User Group Using POST
POST
Create User Role Using POST
POST
Create User Using POST
DELETE
Delete Auth Source Using DELETE
DELETE
Delete User Groups Using DELETE
DELETE
Delete User Group Using DELETE
DELETE
Delete User Role Using DELETE
DELETE
Delete Users Using DELETE
DELETE
Delete User Using DELETE
GET
Get Assigned Role Permissions For Current User Using GET
GET
Get Assigned Role Permissions For User Group Using GET
GET
Get Assigned Role Permissions For User Using GET
GET
Get Auth Sources Using GET
GET
Get Auth Source Types Using GET
GET
Get Auth Source Type Using GET
GET
Get Auth Source Using GET
GET
Get Available Privilege Groups Using GET
GET
Get Available Privileges Using GET
GET
Get Current User Role Privileges Using GET
GET
Get Current User Using GET
GET
Get Role By Name Using GET
GET
Get Role Privileges Using GET
GET
Get Roles Using GET
GET
Get Traversal Specs Using GET
GET
Get User Groups Using GET
GET
Get User Group Using GET
GET
Get Users Using GET
GET
Get User Using GET
POST
Import Users Using POST
PUT
Modify User Group Using PUT
PUT
Modify User Using PUT
PATCH
Patch Auth Source With Certificate Details Using PATCH
PATCH
Patch Test Auth Source Using PATCH
POST
Release Token Using POST
DELETE
Remove Role Privileges Using DELETE
POST
Search User Groups For Auth Source Using POST
POST
Search Users For Auth Source Using POST
PUT
Set Role Privileges Using PUT
PUT
Synchronize User Groups Using PUT
POST
Test Auth Source Using POST
DELETE
Unassigned Role Permission From User Group Using DELETE
DELETE
Unassigned Role Permission From User Using DELETE
PUT
Update Auth Source Using PUT
PUT
Update User Role Using PUT