Skip to content

Read every permission by area - what each built-in and custom role holds of it, and the groups this workspace's plan offers

What you can call today

Every example here runs against api.xovris.ai with a key from your account’s settings. GET /v1/health and GET /v1/public/status answer without one.

GET
/v1/permissions
curl --request GET \  --url https://api.xovris.ai/v1/permissions \  --header 'Authorization: Bearer <token>'

A token that can read is enough.

Done.

Media typeapplication/json
object
plan
required
string
Allowed values: free personal personal_protect business business_protect scale enterprise builder
builtIn
required
Array<string>
Allowed values: admin billing owner member viewer
groups
required
Array<object>
object
id
required
string
Allowed values: billing read operate administer own self
words
string
actions
required
Array<string>
areas
required
Array<object>
object
area
required
string
words
required
string
permissions
required
Array
roles
required
Array<object>
object
id
required
string
name
required
string
about
required
One of:
string
actions
required
Array<string>
members
required
number
stage
required
string
Allowed values: testing ready off retiring
createdAt
required
string
updatedAt
required
string
use
required
object
window
required
number
days
required
number
people
required
number
used
required
Array<string>
unused
required
Array<string>
idle
required
Array<object>
object
userId
required
string
who
required
string
count
required
number

Example

{  "plan": "free",  "builtIn": [    "admin"  ],  "groups": [    {      "id": "billing",      "words": "string",      "actions": [        "string"      ]    }  ],  "areas": [    {      "area": "string",      "words": "string",      "permissions": [        null      ]    }  ],  "roles": [    {      "id": "string",      "name": "string",      "about": "string",      "actions": [        "string"      ],      "members": 1,      "stage": "testing",      "createdAt": "string",      "updatedAt": "string",      "use": {        "window": 1,        "days": 1,        "people": 1,        "used": [          "string"        ],        "unused": [          "string"        ],        "idle": [          {            "userId": "string",            "who": "string"          }        ]      }    }  ],  "count": 1}

Not signed in: the token is missing, expired or revoked. The answer says how to get a new one.

Media typeapplication/json
object
error
required
object
code
required

A stable code a program can branch on.

string
message
required

What happened, in plain words.

string
nextStep
required

What to do next.

string
decisionId

The recorded authorisation decision, when a role refused it.

string

Example generated

{  "error": {    "code": "example",    "message": "example",    "nextStep": "example",    "decisionId": "example"  }}

Signed in, but this token or role may not do this. The answer names the permission it needs.

Media typeapplication/json
object
error
required
object
code
required

A stable code a program can branch on.

string
message
required

What happened, in plain words.

string
nextStep
required

What to do next.

string
decisionId

The recorded authorisation decision, when a role refused it.

string

Example generated

{  "error": {    "code": "example",    "message": "example",    "nextStep": "example",    "decisionId": "example"  }}

Nothing with that id here, or it belongs to another workspace. Nothing was changed.

Media typeapplication/json
object
error
required
object
code
required

A stable code a program can branch on.

string
message
required

What happened, in plain words.

string
nextStep
required

What to do next.

string
decisionId

The recorded authorisation decision, when a role refused it.

string

Example generated

{  "error": {    "code": "example",    "message": "example",    "nextStep": "example",    "decisionId": "example"  }}

Any other refusal or failure. The answer says what happened and what to do next.

Media typeapplication/json
object
error
required
object
code
required

A stable code a program can branch on.

string
message
required

What happened, in plain words.

string
nextStep
required

What to do next.

string
decisionId

The recorded authorisation decision, when a role refused it.

string

Example generated

{  "error": {    "code": "example",    "message": "example",    "nextStep": "example",    "decisionId": "example"  }}

Ask Xovris

Open the full page

Your data is never used to train our AI. How your data is kept

A problem is called fixed only once it works again. How each fix is checked

XOVRIS LTD, registered in England and Wales, company number 17499910. Registered office: 66 Paul Street, London EC2A 4NA.