[{"label":"Latest (8.6.3)","version":"latest"}]
vrealize-operations

Create User Group

Description

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

Request

URL

URL


post
https://localhost/suite-api/api/auth/usergroups
Copy

Request Body

Request Body

user-group of type(s) application/json, application/xml Required

The group object to be created.

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

201 Created

Returns UserGroup of type(s) application/json, application/xml

The user group is created successfully

No error details were provided in the OpenAPI specification.

Code Samples

Code Samples

cURL Command

curl -X POST -H "Content-Type: application/json" -d '{"authSourceId":"string","description":"string","displayName":"string","id":"string","links":[{"description":"string","href":"string","name":"string","rel":"NEXT"}],"name":"string","role-permissions":[{"allowAllObjects":false,"links":[{"description":"string","href":"string","name":"string","rel":"NEXT"}],"roleName":"string","traversal-spec-instances":[{"adapterKind":"string","includedAdapterKinds":["string"],"name":"string","resourceKind":"string","resourceSelection":[{"resourceId":["string"],"type":"PROPAGATE"}],"selectAllResources":false}]}],"roleNames":["string"],"userIds":["string"]}' https://localhost/suite-api/api/auth/usergroups


[{"label":"Latest (8.6.3)","version":"latest"}]
vrealize-operations
Auth Operations
Feedback

Was this page helpful?