Skip to content

Roles

CreateRole

Method: POST

Endpoint: /roles/create-role

Authentication: bearer

Request Body

{
  "name": "basic",
  "description": "The most basic role",
  "permissions": [
    "auth.accounts.list"
  ]
}

UpdateRole

Method: POST

Endpoint: /roles/update-role

Authentication: bearer

Request Body

{
  "role": "2290379f-667e-4c09-9f1e-be0b643ff327",
  "name": "PLEASE",
  "description": "The UPDATED THE BEST basic role"
}

ListRoles

Method: GET

Endpoint: /roles/list-roles

Authentication: bearer

DescribeRole

Method: POST

Endpoint: /roles/describe-role

Authentication: bearer

Request Body

{
  "role": "2290379f-667e-4c09-9f1e-be0b643ff327"
}

DeleteRole

Method: POST

Endpoint: /roles/delete-role

Authentication: bearer

Request Body

{
  "role": "basic"
}

AssignRoles

Method: POST

Endpoint: /roles/assign-roles

Authentication: bearer

Request Body

{
  "account": "best@email.com",
  "roles": [
    "viewer",
    "admin"
  ]
}

RemoveRoles

Method: POST

Endpoint: /roles/remove-roles

Authentication: bearer

Request Body

{
  "account": "newd@email.com",
  "roles": [
    "viewer"
  ]
}

CreatePermissions

Method: POST

Endpoint: /roles/create-permissions

Authentication: bearer

Request Body

{
  "permissions": [
    "flask.protected.route"
  ]
}

ListPermssions

Method: GET

Endpoint: /roles/list-permissions

Authentication: bearer

DeletePermissions

Method: POST

Endpoint: /roles/delete-permissions

Authentication: bearer

Request Body

{
  "permissions": [
    "auth.users.list"
  ]
}

AssignPermissions

Method: POST

Endpoint: /roles/assign-permissions

Authentication: bearer

Request Body

{
  "role": "0a19a8e1-4b7f-4f45-a31a-1d40953af5c5",
  "permissions": [
    "auth.accounts.create"
  ]
}

RemovePermisions

Method: POST

Endpoint: /roles/remove-permissions

Authentication: bearer

Request Body

{
  "role": "viewer",
  "permissions": [
    "auth.accounts.describeSelf",
    "auth.accounts.updateSelf",
    "auth.services.describe"
  ]
}