Create User Group Using POST

• Auth

If the authSourceId is specified(in the request), then the user group will be imported from the corresponding auth source (LDAP/AD/SSO/VIDM).Note that the id of the user group has to be null. For LDAP/AD groups the distinguishedName should be provided in the name field. The value of displayName is used only while importing LDAP/AD groups, and if it is not provided then the value of name will be assigned to it. For SSO/VIDM groups the value of name is assigned to displayName. NOTE: Before importing please make sure that the group exists in the specified authSource by using the following API - /api/auth/sources/{id}/usergroups/search . Otherwise, if you try to import a non-existing group, a new one will be created with the specified authSourceId.

Request

URI

POST

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

COPY

Request Body

The group object to be created.

user-group of type(s) application/json

Required

Show optional properties

{
    "name": "string"
}

{
    "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.

Authentication

This operation uses the following authentication methods.

vRealizeOpsToken

Responses

201

Hide Details

The user group is created successfully

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

Description

Request

Request Body

Authentication

Response

201 Response Body

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 Scope Using POST

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 Scopes 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 All Object Scopes Using GET

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 Scope 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 Scope Using PUT

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