Get User Group Using GET

Get User Group Using GET

Look up a local user group using its identifier

Request

URI

GET

https://{api_host}/api/auth/usergroups/{id}

COPY

Path Parameters

string

id

Required

The identifier of the user group

Authentication

This operation uses the following authentication methods.

vRealizeOpsToken

Responses

200

The user group data

Returns user-group of type(s) application/json

{
    "authSourceId": "string",
    "description": "string",
    "displayName": "string",
    "id": "string",
    "links": [
        {
            "description": "string",
            "href": "string",
            "name": "string",
            "rel": "string"
        }
    ],
    "name": "string",
    "role-permissions": [
        {
            "allowAllObjects": false,
            "links": [
                {
                    "description": "string",
                    "href": "string",
                    "name": "string",
                    "rel": "string"
                }
            ],
            "roleName": "string",
            "scopeId": "string",
            "traversal-spec-instances": [
                {
                    "adapterKind": "string",
                    "includedAdapterKinds": [
                        "string"
                    ],
                    "name": "string",
                    "resourceKind": "string",
                    "resourceSelection": [
                        {
                            "resourceId": [
                                "string"
                            ],
                            "type": "string"
                        }
                    ],
                    "selectAllResources": false
                }
            ]
        }
    ],
    "roleNames": [
        "string"
    ],
    "userIds": [
        "string"
    ]
}

string As uuid As uuid

authSourceId

Optional

The identifier of the auth source. If it is null, a local user group will be created.

string

description

Optional

A description about this group.

string

displayName

Optional

The displayName of this group.

string As uuid As uuid

id

Optional

The identifier of this group.(unique)

Note: Required when updating or deleting the user group.

array of link

links

Optional

links

string

name

Required

The name of this group.

array of role-permission

role-permissions

Optional

The list of role permissions assigned to this group. May be null. Replaces and takes precedence over roleNames.

array of string

roleNames

Optional

(Deprecated) List of role names assigned to the user group. May be null.

array of string

userIds

Optional

The list of users who are members of this group.

On This Page

Request

Path Parameters

200 Response Body

Auth Operations

Acquire Token Using POST

Add Auth Source Using POST

Add Role Privileges Using POST

Assign Role Permission To User Group Using PUT

Assign Role Permission To User Using PUT

Assign Traversal Spec To User Group Using PUT

Assign Traversal Spec To User Using PUT

Change Password Using PUT

Create Scope Using POST

Create User Group Using POST

Create User Role Using POST

Create User Using POST

Delete Auth Source Using DELETE

Delete Scopes Using DELETE

Delete User Groups Using DELETE

Delete User Group Using DELETE

Delete User Role Using DELETE

Delete Users Using DELETE

Delete User Using DELETE

Get All Object Scopes Using GET

Get Assigned Role Permissions For Current User Using GET

Get Assigned Role Permissions For User Group Using GET

Get Assigned Role Permissions For User Using GET

Get Auth Sources Using GET

Get Auth Source Types Using GET

Get Auth Source Type Using GET

Get Auth Source Using GET

Get Available Privilege Groups Using GET

Get Available Privileges Using GET

Get Current User Role Privileges Using GET

Get Current User Using GET

Get Role By Name Using GET

Get Role Privileges Using GET

Get Roles Using GET

Get Scope Using GET

Get Traversal Specs Using GET

Get User Groups Using GET

Get User Group Using GET

Get Users Using GET

Get User Using GET

Import Users Using POST

Modify Scope Using PUT

Modify User Group Using PUT

Modify User Using PUT

Patch Auth Source With Certificate Details Using PATCH

Patch Test Auth Source Using PATCH

Release Token Using POST

Remove Role Privileges Using DELETE

Search User Groups For Auth Source Using POST

Search Users For Auth Source Using POST

Set Role Privileges Using PUT

Synchronize User Groups Using PUT

Test Auth Source Using POST

Unassigned Role Permission From User Group Using DELETE

Unassigned Role Permission From User Using DELETE

Update Auth Source Using PUT

Update User Role Using PUT