Role - Fetch list of available roles

Fetch list of available roles

get

Authorizations

Bearer

HTTPRequired

Please enter a valid token

Query parameters

versionstringOptional

The requested API version

Default: 1.0

Responses

200

Indicates successful retrieval for list of available roles

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.

401

Un-authorized request

text/plainapplication/jsontext/json

500

Server related error

text/plainapplication/jsontext/json

get

/roles

HTTPcURLJavaScriptPython

GET /roles HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

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