GET User Groups

GET User Groups

Return the list for all the user groups registered in Operations for Logs.

Request
URI
GET
https://{api_host}/api/v1/user-groups
COPY
Authentication
This operation uses the following authentication methods.
Responses
200

The list of user groups was retrieved successfully.

Returns user.groups.get.response of type(s) application/json
[
    {
        "provider": "ad",
        "domain": "vmware.com",
        "name": "example",
        "roleIds": [
            "00000000-0000-0000-0000-000000000002",
            "53986a8b-489d-45cc-9334-b71ade385c2b"
        ]
    },
    {
        "provider": "vidm",
        "domain": "example.com",
        "name": "name_example.com",
        "roleIds": [
            "00000000-0000-0000-0000-000000000002",
            "53986a8b-411d-455c-9334-b71ade385c2b"
        ]
    }
]

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