VMware Developer Documentation
API Reference PowerCLI Reference
[{"label":"Latest (8.6.3)","version":"latest"}]
vrealize-operations
VMware vRealize Operations API Auth

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.

vRealizeOpsToken

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

Generated on: 23 Jun 22 15:08 UTC
[{"label":"Latest (8.6.3)","version":"latest"}]
vrealize-operations
On This Page
Auth Operations
post
Acquire Token
post
Add Auth Source
post
Add Role Privileges
put
Assign Role Permission To User
put
Assign Role Permission To User Group
put
Assign Traversal Spec To User
put
Assign Traversal Spec To User Group
put
Change Password
post
Create User
post
Create User Group
post
Create User Role
delete
Delete Auth Source
delete
Delete User
delete
Delete User Group
delete
Delete User Groups
delete
Delete User Role
delete
Delete Users
get
Get Assigned Role Permissions For Current User
get
Get Assigned Role Permissions For User
get
Get Assigned Role Permissions For User Group
get
Get Auth Source
get
Get Auth Source Type
get
Get Auth Source Types
get
Get Auth Sources
get
Get Available Privilege Groups
get
Get Available Privileges
get
Get Current User
get
Get Current User Role Privileges
get
Get Role By Name
get
Get Role Privileges
get
Get Roles
get
Get Traversal Specs
get
Get User
get
Get User Group
get
Get User Groups
get
Get Users
post
Import Users
put
Modify User
put
Modify User Group
patch
Patch Auth Source With Certificate Details
patch
Patch Test Auth Source
post
Release Token
delete
Remove Role Privileges
post
Search User Groups For Auth Source
post
Search Users For Auth Source
put
Set Role Privileges
put
Synchronize User Groups
post
Test Auth Source
delete
Unassigned Role Permission From User
delete
Unassigned Role Permission From User Group
put
Update Auth Source
put
Update User Role
Feedback

Was this page helpful?

© 2022 VMware Inc. Terms of Use Privacy Your California Privacy Rights Accessibility Trademarks Glossary Help Contact Us