Read who can reach what
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.
const url = 'https://api.xovris.ai/v1/access/map';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://api.xovris.ai/v1/access/map \ --header 'Authorization: Bearer <token>'A token that can read is enough.
Authorizations
Section titled “Authorizations”Responses
Section titled “Responses”Done.
object
object
object
object
object
object
object
object
object
object
Example
{ "found": [ { "connect": { "method": "string", "path": "string", "body": { "wants": [ "see" ] } }, "manual": { "method": "string", "path": "string" }, "domain": "string", "kind": "google_workspace", "name": "string", "evidence": "string" } ], "flags": [ { "state": "string", "foundAt": "string", "askedAt": "string", "key": "string", "kind": "orphaned_access", "severity": "high", "asset": "string", "assetName": "string", "person": "string", "words": "string", "evidence": [ "string" ], "fix": { "action": "release_seat", "automatic": true, "words": "string", "steps": [ "string" ], "link": "string", "connectionId": "string", "accountId": "string", "needs": "owner_email" }, "alternatives": [ { "action": "release_seat", "automatic": true, "words": "string", "steps": [ "string" ], "link": "string", "connectionId": "string", "accountId": "string", "needs": "owner_email" } ] } ], "fixed": [ { "key": "string", "fixedAt": "string", "fixedBy": "string", "runId": "string" } ], "readAt": [ { "connectionId": "string", "label": "string", "readAt": "string" } ], "empty": "string", "people": [ { "email": "string", "name": "string", "works": "outside", "member": "string", "assets": 1, "admin": 1 } ], "assets": [ { "ref": "string", "type": "domain", "name": "string", "system": "string", "owner": "string", "ownerSource": "address", "state": "string" } ], "access": [ { "person": "string", "asset": "string", "level": "admin" } ], "counts": { "domain": 1, "people": 1, "device": 1, "account": 1, "app": 1, "integration": 1, "flags": 1 }, "directory": { "connectionId": "string", "system": "string" }, "admins": [ { "connectionId": "string", "system": "string", "admins": 1, "allowed": 1, "source": "business", "setBy": "string", "setAt": "string" } ]}Not signed in: the token is missing, expired or revoked. The answer says how to get a new one.
object
object
A stable code a program can branch on.
What happened, in plain words.
What to do next.
The recorded authorisation decision, when a role refused it.
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.
object
object
A stable code a program can branch on.
What happened, in plain words.
What to do next.
The recorded authorisation decision, when a role refused it.
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.
object
object
A stable code a program can branch on.
What happened, in plain words.
What to do next.
The recorded authorisation decision, when a role refused it.
Example generated
{ "error": { "code": "example", "message": "example", "nextStep": "example", "decisionId": "example" }}default
Section titled “default”Any other refusal or failure. The answer says what happened and what to do next.
object
object
A stable code a program can branch on.
What happened, in plain words.
What to do next.
The recorded authorisation decision, when a role refused it.
Example generated
{ "error": { "code": "example", "message": "example", "nextStep": "example", "decisionId": "example" }}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.