Role - Update an existing role

Updates an existing role

put

Authorizations

Bearer

HTTPRequired

Please enter a valid token

Path parameters

roleIdstring · uuidRequired

Expects Id of an existing role

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

Acknowledgment for successful new role update

text/plainapplication/jsontext/json

Class for storing details of a role.

roleIdstring · uuidOptional

A public property of type Guid (a unique identifier) that has both a getter and a setter method, which allows for getting and setting the value of the RoleId property.

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.

isEditablebooleanOptional

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 IsEditable property.

404

Idicates that the requested role does not exist

text/plainapplication/jsontext/json

500

Server related error

text/plainapplication/jsontext/json

put

/roles/{roleId}

HTTPcURLJavaScriptPython

PUT /roles/{roleId} HTTP/1.1
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
}