Modify User Group Using PUT

Modify User Group Using PUT

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

Request
URI
PUT
https://{api_host}/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"
}
{
    "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.

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

Auth Operations
POST
Add Role Privileges Using POST
PUT
Assign Role Permission To User Group Using PUT
PUT
Assign Role Permission To User Using PUT
POST
Create Scope Using POST
POST
Create User Group Using POST
POST
Create User Role Using POST
DELETE
Delete Scopes Using DELETE
DELETE
Delete User Groups Using DELETE
DELETE
Delete User Group Using DELETE
DELETE
Delete User Role 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
PUT
Modify Scope Using PUT
PUT
Modify User Group Using PUT
PUT
Modify User Using PUT
DELETE
Remove Role Privileges Using DELETE
PUT
Set Role Privileges Using PUT
PUT
Synchronize User Groups Using PUT
DELETE
Unassigned Role Permission From User Group Using DELETE
DELETE
Unassigned Role Permission From User Using DELETE
PUT
Update User Role Using PUT