Skip to content

See each identity system Xovris connects with one approval, and exactly what it asks for

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/identity/doors
curl --request GET \  --url https://api.xovris.ai/v1/identity/doors \  --header 'Authorization: Bearer <token>'

A token that can read is enough.

Done.

Media typeapplication/json
object
items
required
Array<object>
object
live
required
boolean
waitingFor
required
One of:
string
start
required
One of:
object
body
required
object
app
required
string
method
required
string
path
required
string
manual
required
object
words
required
string
method
required
string
path
required
string
grant
required
object
cannotNarrow
string
narrowsByWants
required
boolean
kind
required
string
Allowed values: google_workspace microsoft_entra okta github scim
app
string
system
required
string
how
required
string
Allowed values: oauth browser_capture admin_consent app_install client_credentials
yeses
required
Array<string>
lets
required
Array<object>
object
scope
required
string
words
required
string
doing
required
string

Example

{  "items": [    {      "live": true,      "waitingFor": "string",      "start": {        "body": {          "app": "string"        },        "method": "string",        "path": "string"      },      "manual": {        "words": "string",        "method": "string",        "path": "string"      },      "grant": {        "cannotNarrow": "string",        "narrowsByWants": true      },      "kind": "google_workspace",      "app": "string",      "system": "string",      "how": "oauth",      "yeses": [        "string"      ],      "lets": [        {          "scope": "string",          "words": "string"        }      ],      "doing": "string"    }  ]}

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.