GET User Groups Provider

GET User Groups Provider

Return the list of all the user groups for specified provider

Request
URI
GET
https://{api_host}/api/v1/user-groups/{provider}
COPY
Path Parameters
string
provider
Required

Authentication provider. Should be ad or vidm

Authentication
This operation uses the following authentication methods.
Responses
200
Returns Array of object of type(s) application/json 
[
    {
        "provider": "ad",
        "domain": "vmware.com",
        "name": "test-example",
        "roleIds": [
            "00000000-0000-0000-0000-000000000002",
            "53986a8b-410d-45ss-9334-b71ade385c2b"
        ]
    },
    {
        "provider": "ad",
        "domain": "vmware.com",
        "name": "test-example2",
        "roleIds": []
    }
]

400

Authentication group provider should have one of following values - 'ad','vidm'

Operation doesn't return any data structure

401

The request was refused because it lacks valid authentication credentials. This can happen if the Authorization header was missing, or if it contained an invalid session ID.

Obtain a new session ID and retry the request, or make an unauthenticated request without the Authorization header.

"Invalid session ID"

440

The request was refused because the session ID has expired. Obtain a new session ID from /api/v1/sessions.

"Login Timeout"

Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/api/v1/user-groups/{provider}
On This Page
User Groups Operations
GET
GET User Groups
POST
POST User Groups
GET
GET User Groups Provider
GET
GET User Groups Provider Domain Name
DELETE
DELETE User Groups Provider Domain Name
PATCH
PATCH User Groups Provider Domain Name