Role Administration API Reference

List User's Roles

Description

List currently logged in user's roles

Endpoint

  • uri - /box/srv/1.1/admin/role/list
  • method - POST

Request Body

n/a

Response Body

Success

{
  "status": "ok",
  "list": ["sub", "dev"]
}

Error

{
  "status": "error",
  "message": "<error_message>"
}

List User's Assignable Roles

Description

List currently logged in user's assignable roles i.e. roles that this user can assign to others

Endpoint

  • uri - /box/srv/1.1/admin/role/listAssignable
  • method - POST

Request Body

n/a

Success

{
  "status": "ok",
  "list": ["sub", "dev", "devadmin", "analytics", "portaladmin"]
}

Error

{
  "status": "error",
  "message": "<error_message>"
}