Skip to content

Compare a connection's access with what a fix needs

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/connections/{id}/access-delta
curl --request GET \  --url https://api.xovris.ai/v1/connections/example/access-delta \  --header 'Authorization: Bearer <token>'

A token that can read is enough.

id
required
string

Done.

Media typeapplication/json
object
repairClass
required
string
title
required
string
target
required
Array<string>
reads
required
Array<string>
changes
required
Array<string>
never
required
Array<string>
scopes
required
object
needed
required
Array<object>
object
scope
required
string
label
required
string
known
required
boolean
granted
required
Array<object>
object
scope
required
string
label
required
string
known
required
boolean
missing
required
Array<object>
object
scope
required
string
label
required
string
known
required
boolean
options
required
Array<object>
object
kind
required
string
Allowed values: oauth zone_token
covers
required
string
enforcedBy
required
string
Allowed values: provider cedar
inForce
required
boolean
extraReach
required
Array<object>
object
id
required
string
name
required
string
revoke
required
string

Example

{  "repairClass": "string",  "title": "string",  "target": [    "string"  ],  "reads": [    "string"  ],  "changes": [    "string"  ],  "never": [    "string"  ],  "scopes": {    "needed": [      {        "scope": "string",        "label": "string",        "known": true      }    ],    "granted": [      {        "scope": "string",        "label": "string",        "known": true      }    ],    "missing": [      {        "scope": "string",        "label": "string",        "known": true      }    ]  },  "options": [    {      "kind": "oauth",      "covers": "string",      "enforcedBy": "provider",      "inForce": true    }  ],  "extraReach": [    {      "id": "string",      "name": "string"    }  ],  "revoke": "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.