Skip to content

Read every permission a connection asks for, in plain words, why it is needed and what it enables

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/public/catalogue/scopes
curl --request GET \  --url https://api.xovris.ai/v1/public/catalogue/scopes

No token needed: anyone may call this.

Done.

Media typeapplication/json
object
door
required
string
scopes
required
Array<object>
object
scope
required
string
words
required
string
access
required
string
Allowed values: read write
why
required
string
enables
required
string
asks
required
Array<string>
userScopes
required
Array
audit
required
object
undisclosed
required
number
unused
required
number
stalePreview
required
number

Example

{  "door": "string",  "scopes": [    {      "scope": "string",      "words": "string",      "access": "read",      "why": "string",      "enables": "string"    }  ],  "asks": [    "string"  ],  "userScopes": [    null  ],  "audit": {    "undisclosed": 1,    "unused": 1,    "stalePreview": 1  }}

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.