Skip to content

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.

GET
/v1/access/map
curl --request GET \  --url https://api.xovris.ai/v1/access/map \  --header 'Authorization: Bearer <token>'

A token that can read is enough.

Done.

Media typeapplication/json
object
found
Array<object>
object
connect
required
object
method
required
string
path
required
string
body
required
object
wants
required
Array
manual
required
object
method
required
string
path
required
string
domain
required
string
kind
required
string
Allowed values: google_workspace microsoft_entra
name
required
string
evidence
required
string
flags
required
Array<object>
object
state
required
string
foundAt
required
One of:
string
askedAt
required
One of:
string
key
required
string
kind
required
string
Allowed values: orphaned_access shared_sign_in missing_two_factor unowned_asset dormant_access idle_licence excessive_admin new_admin widened_grant unused_admin
severity
required
string
Allowed values: high medium low
asset
required
string
assetName
required
string
person
required
One of:
string
words
required
string
evidence
required
Array<string>
fix
required
object
action
required
string
Allowed values: release_seat remove_access ask_person set_owner guided
automatic
required
boolean
words
required
string
steps
required
Array<string>
link
string
connectionId
string
accountId
string
needs
string
Allowed values: owner_email confirm
alternatives
required
Array<object>
object
action
required
string
Allowed values: release_seat remove_access ask_person set_owner guided
automatic
required
boolean
words
required
string
steps
required
Array<string>
link
string
connectionId
string
accountId
string
needs
string
Allowed values: owner_email confirm
fixed
required
Array<object>
object
key
required
string
fixedAt
required
One of:
string
fixedBy
required
One of:
string
runId
required
One of:
string
readAt
required
Array<object>
object
connectionId
required
string
label
required
string
readAt
required
One of:
string
empty
required
One of:
string
people
required
Array<object>
object
email
required
string
name
required
One of:
string
works
required
string
Allowed values: outside unknown here left
member
required
One of:
string
assets
required
number
admin
required
number
assets
required
Array<object>
object
ref
required
string
type
required
string
Allowed values: domain device account app integration
name
required
string
system
required
One of:
string
owner
required
One of:
string
ownerSource
required
One of:
string
Allowed values: address directory connected named
state
required
string
access
required
Array<object>
object
person
required
string
asset
required
string
level
required
string
Allowed values: admin owner user invited
counts
required
object
domain
required
number
people
required
number
device
required
number
account
required
number
app
required
number
integration
required
number
flags
required
number
directory
required
One of:
object
connectionId
required
string
system
required
string
admins
required
Array<object>
object
connectionId
required
string
system
required
string
admins
required
number
allowed
required
number
source
required
string
Allowed values: business cis
setBy
required
One of:
string
setAt
required
One of:
string

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.

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.