Skip to content

Read a starter or leaver run

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

A token that can read is enough.

id
required
string

Done.

Media typeapplication/json
object
seal
required
One of:
object
sha256
required
string
systems
required
number
confirmed
required
number
contradicted
required
number
id
required
string
kind
required
string
Allowed values: leaver starter access_removal breach_response access_restore
email
required
string
name
required
One of:
string
state
required
string
Allowed values: done running waiting incomplete access_returned
summary
required
One of:
string
requestedBy
required
string
decisionId
required
One of:
string
createdAt
required
string
finishedAt
required
One of:
string
reverifyAt
required
One of:
string
reverifiedAt
required
One of:
string
steps
required
Array<object>
object
id
required
string
seq
required
number
system
required
One of:
string
connectionId
required
One of:
string
action
required
string
Allowed values: join create secure first_password disable enable sign_out revoke_tokens require_password_change hand_over restore_seat recover_devices release_seat verify laptop_code laptop_verify
state
required
string
Allowed values: done refused failed unsupported already running waiting pending
words
required
One of:
string
error
required
One of:
string
detail
required
object
key
additional properties
decisionId
required
One of:
string
attempts
required
number
finishedAt
required
One of:
string

Example

{  "seal": {    "sha256": "string",    "systems": 1,    "confirmed": 1,    "contradicted": 1  },  "id": "string",  "kind": "leaver",  "email": "string",  "name": "string",  "state": "done",  "summary": "string",  "requestedBy": "string",  "decisionId": "string",  "createdAt": "string",  "finishedAt": "string",  "reverifyAt": "string",  "reverifiedAt": "string",  "steps": [    {      "id": "string",      "seq": 1,      "system": "string",      "connectionId": "string",      "action": "join",      "state": "done",      "words": "string",      "error": "string",      "detail": {},      "decisionId": "string",      "attempts": 1,      "finishedAt": "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.