Role - Updates an existing role

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

put

/roles/{roleId}

Authorizations

Path parameters

roleIdstring uuidrequired

Enter the ID of the existing role to be updated.

Query parameters

versionstring

The requested API version

Body

application/jsontext/jsonapplication/*+json

roleNamenullable string

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.

canCreateboolean

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.

canEditboolean

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.

canExportboolean

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.

canViewboolean

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

text/plainapplication/jsontext/json

text/plainapplication/jsontext/json

text/plainapplication/jsontext/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/roles/{roleId}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json'

200

404

500

200

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

Success: Role updated successfully.