Modify User Group

Modify User Group
Modify a local user group

You can add or remove users from the group. Name and id of the group cannot be changed.

Request
URI
PUT
https://{api_host}/suite-api/api/auth/usergroups
COPY
Request Body

The group object to be updated

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

Show optional properties

{
    "name": "string"
}
"{\n  \"id\" : \"85172da1-792e-44fe-b9ce-cc2b04cfe9ec\",\n  \"name\" : \"user_group_name\",\n  \"description\" : \"user_group_desc\",\n  \"userIds\" : [ \"9f9d3764-b76e-49f5-9676-c3cc969c160d\" ],\n  \"role-permissions\" : [ {\n    \"roleName\" : \"Administrator\",\n    \"traversal-spec-instances\" : [ {\n      \"adapterKind\" : \"adap_kind\",\n      \"resourceKind\" : \"resource_kind\",\n      \"name\" : \"traversal_spec_name\",\n      \"selectAllResources\" : true\n    } ],\n    \"allowAllObjects\" : true\n  } ]\n}"
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
externalId
Optional

External ID of vIDB user group. This field is only used in vIDB user group import flow. It will not be populated for any other scenarios. Please note, this field may be removed in future.

string As uuid As uuid
id
Optional

The identifier of this group.(unique)

Note: Required when updating or deleting the user group.

array of object
links
Optional

Represents a HTTP 'link' element.
It is implicit that all the link tags support http 'GET' method.

string
name
Required

The name of this group.

array of object
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.
Responses
200

The user group is updated successfully

Operation doesn't return any data structure

Code Samples
COPY
                    curl -X PUT -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"name":"string"}' https://{api_host}/suite-api/api/auth/usergroups
On This Page
Auth Operations
GET
Get Current User
GET
Get Assigned Role Permissions For Current User
GET
Get Current User Role Privileges
GET
Get Available Privilege Groups
GET
Get Available Privileges
GET
Get Roles
POST
Create User Role
PUT
Update User Role
DELETE
Delete User Role
GET
Get Role By Name
DELETE
Remove Role Privileges
GET
Get Role Privileges
POST
Add Role Privileges
PUT
Set Role Privileges
DELETE
Delete Scopes
GET
Get All Object Scopes
POST
Create Scope
PUT
Modify Scope
GET
Get Scope
GET
Get Auth Sources
PATCH
Patch Auth Source With Certificate Details
POST
Add Auth Source
PUT
Update Auth Source
PATCH
Patch Test Auth Source
POST
Test Auth Source
GET
Get VIDB Well Known URL
POST
Search User Groups For Auth Source
PUT
Synchronize User Groups
POST
Import Users
POST
Search Users For Auth Source
DELETE
Delete Auth Source
GET
Get Auth Source
GET
Get Auth Source Types
GET
Get Auth Source Type
POST
Acquire Token
POST
Exchange Ops Token With Jwt Token
POST
Release Token
GET
Get Traversal Specs
DELETE
Delete User Groups
GET
Get User Groups
POST
Create User Group
PUT
Modify User Group
GET
Get Assigned Role Permissions For User Group
PUT
Assign Role Permission To User Group
DELETE
Unassigned Role Permission From User Group
PUT
Assign Traversal Spec To User Group
Deprecated
DELETE
Delete User Group
GET
Get User Group
DELETE
Delete Users
GET
Get Users
POST
Create User
PUT
Modify User
PUT
Change Password
DELETE
Delete User
GET
Get User
GET
Get Assigned Role Permissions For User
PUT
Assign Role Permission To User
DELETE
Unassigned Role Permission From User
PUT
Assign Traversal Spec To User
Deprecated