Security Groups

Update Security Role

Use to update a specific security role via patch. <span hidden>For more information see <a href="group.html#patchSecurityRole">here</a></span>

patch/v2/partition/{partitionId}/security/{securityId}

Request

Path parameters

partitionIdstring required

ID of partition. Refers to <a href="#/~schema/SecurityRoleX">SecurityRoleX.partitionId</a>

securityIdstring required

Id of the Security Role. Refers to <a href="#/~schema/SecurityRoleX">SecurityRoleX.id</a>

Request body

object required

Json containing the fragment of the security role object to be updated.

Example request

{
  "name": "New Role Name",
  "permissions": [
    {
      "type": "newPermissionType",
      "accessType": "newAccessType"
    }
  ]
}

Response

Successful operation

idstring
partitionIdstring

Reference to <a href="#/~schema/PartitionX">partition.id</a>

namestring

The name of the Role. Must be unique among SecurityRoleX with the same partitionId.

userType'AccountUser' | 'EndUser' | 'ManagementUser' | 'AlianzaUser' | 'BusinessLines'

Which user type can be assigned the role.

userCountinteger

A readonly (calculated) value which indicates how many users are assigned this Role.

Changes

No recorded changes to this operation across all 1 revision of this API.