Assign Role Permission To User Group Using PUT

Assign Role Permission To User Group Using PUT

Replaces existing role permission entirety if it exists already for the named role.

Request
URI
PUT
https://{api_host}/api/auth/usergroups/{groupId}/permissions
COPY
Path Parameters
string
groupId
Required

Identifier of the user group

Request Body

The role permission to assign.

role-permission of type(s) application/json
Required

Show optional properties

{
    "roleName": "string"
}
{
    "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
        }
    ]
}
boolean
allowAllObjects
Optional

If true then ignore traversal specifications and allow all objects

array of link
links
Optional

links

string
roleName
Required

The role name.

string As uuid As uuid
scopeId
Optional

The id of the scope

array of traversal-spec-instance
traversal-spec-instances
Optional

Collection of traversal specification instances

Authentication
This operation uses the following authentication methods.
Responses
200

The Updated Role Permissions object

Returns role-permissions of type(s) application/json 
{
    "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
                }
            ]
        }
    ]
}
array of role-permission
permissions
Optional

list of role permissions


On This Page
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