Role - Updates an existing role

Updates an existing role using the provided Role Model schema and role ID.

put

Authorizations

Bearer

HTTPRequired

Please enter a valid token

Path parameters

roleIdstring · uuidRequired

Enter the ID of the existing role to be updated.

Query parameters

versionstringOptional

The requested API version

Default: 1.0

Body

application/jsontext/jsonapplication/*+json

Class for representing the view of role.

roleNamestring | nullableOptional

A public property of type string that has both a getter and a setter method, which allows for getting and setting the value of the RoleName property.

canCreatebooleanOptional

A public property of type bool that has both a getter and a setter method, which allows for getting and setting the value of the CanCreate property.

canEditbooleanOptional

A public property of type bool that has both a getter and a setter method, which allows for getting and setting the value of the CanEdit property.

canExportbooleanOptional

A public property of type bool that has both a getter and a setter method, which allows for getting and setting the value of the CanExport property.

canViewbooleanOptional

A public property of type bool that has both a getter and a setter method, which allows for getting and setting the value of the CanView property.

Responses

200

Success: Role updated successfully.

text/plainapplication/jsontext/json

404

Not Found: Indicates that the requested role does not exist.

text/plainapplication/jsontext/json

500

Internal Server Error: An unexpected error occurred or a server timeout.

text/plainapplication/jsontext/json

put

/roles/{roleId}

HTTPcURLJavaScriptPython

PUT /roles/{roleId} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 83

{
  "roleName": "text",
  "canCreate": true,
  "canEdit": true,
  "canExport": true,
  "canView": true
}

application/jsontext/jsonapplication/*+json

{
  "roleId": "123e4567-e89b-12d3-a456-426614174000",
  "roleName": "text",
  "canCreate": true,
  "canEdit": true,
  "canExport": true,
  "canView": true,
  "isEditable": true
}