Roles

Download OpenAPI specification:Download

Manage user roles and permissions

Create role

Create a new role for this application

SecurityOAuth2: AdminAccessToken
Request
path Parameters
app_id
required
string

ID of the application to retrieve it's roles

Request Body schema: application/json
required
role_name
required
string

New role name

permissions
Array of strings

Names of permissions

description
string

Role description

display_name
string

Role display name

Responses
201
409
post/v1/applications/{app_id}/roles
Request samples
application/json
{
  • "role_name": "string",
  • "permissions": [
    ],
  • "description": "string",
  • "display_name": "string"
}
Response samples
application/json
{
  • "result": {
    }
}

Get roles

Retrieve a list of all roles created for this application

SecurityOAuth2: AdminAccessToken
Request
path Parameters
app_id
required
string

ID of the application to retrieve it's roles

Responses
200
get/v1/applications/{app_id}/roles
Request samples
Response samples
application/json
{
  • "result": [
    ]
}

Update role

Update an existing role for this application

SecurityOAuth2: AdminAccessToken
Request
path Parameters
app_id
required
string

ID of the application to retrieve it's roles

role_id
required
string

ID of the role to update

Request Body schema: application/json
required
role_name
required
string

New role name

permissions
Array of strings

Names of permissions

description
string

Role description

display_name
string

Role display name

Responses
202
put/v1/applications/{app_id}/roles/{role_id}
Request samples
application/json
{
  • "role_name": "string",
  • "permissions": [
    ],
  • "description": "string",
  • "display_name": "string"
}
Response samples
application/json
{
  • "result": { }
}

Delete role

Delete role from this application

SecurityOAuth2: AdminAccessToken
Request
path Parameters
app_id
required
string

ID of the application to delete the role from

role_id
required
string

ID of the role to delete

Responses
202
delete/v1/applications/{app_id}/roles/{role_id}
Request samples