Skip to content

Review who can do what - each person's role beside what they used, with stale and unused access proposed for change

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

A token that can read is enough.

Done.

Media typeapplication/json
object
days
required
number
actions
required
Array<object>
object
action
required
string
group
required
string
Allowed values: billing read operate administer own self
members
required
Array<object>
object
userId
required
string
email
required
string
name
required
One of:
string
role
required
string
Allowed values: admin billing owner member viewer
environments
required
Array<string>
joinedAt
required
string
can
required
number
used
required
number
lastActive
required
One of:
string
unusedPowers
required
Array<string>
allowed
required
Array<string>
usedActions
required
Array<string>
proposal
required
object
kind
required
string
Allowed values: owner keep new remove narrow
to
required
One of:
string
Allowed values: admin billing owner member viewer
last
required
One of:
object
at
required
string
by
required
string
acted
required
number
members
required
number
note
required
One of:
string
every
required
One of:
number
secondReviewer
boolean
signers
One of:
number
pastDue
One of:
number
due
required
One of:
string
rule
required
object
every
required
One of:
number
secondReviewer
required
boolean
pastDue
required
One of:
number
signers
required
number
pending
required
One of:
object
id
required
string
at
required
string
by
required
string
byId
required
string
note
required
One of:
string
changes
required
Array<object>
object
userId
required
string
who
required
string
kind
required
string
Allowed values: remove narrow
from
required
string
Allowed values: admin billing owner member viewer
to
required
One of:
string
Allowed values: admin billing owner member viewer
signers
required
number
signedBy
required
Array<string>
rule
object
every
required
One of:
number
secondReviewer
required
boolean
pastDue
required
One of:
number
signers
required
number
tokens
Array<object>
object
id
required
string
name
required
string
scopes
required
Array<string>
lastUsed
required
One of:
string
createdAt
required
string
proposal
required
string
Allowed values: keep revoke
teams
Array<object>
object
id
required
string
name
required
string
members
required
Array<object>
object
userId
required
string
who
required
string
lastActive
required
One of:
string
proposal
required
string
Allowed values: keep remove
applyAt
required
One of:
string

Example

{  "days": 1,  "actions": [    {      "action": "string",      "group": "billing"    }  ],  "members": [    {      "userId": "string",      "email": "string",      "name": "string",      "role": "admin",      "environments": [        "string"      ],      "joinedAt": "string",      "can": 1,      "used": 1,      "lastActive": "string",      "unusedPowers": [        "string"      ],      "allowed": [        "string"      ],      "usedActions": [        "string"      ],      "proposal": {        "kind": "owner",        "to": "admin"      }    }  ],  "last": {    "at": "string",    "by": "string",    "acted": 1,    "members": 1,    "note": "string",    "every": 1,    "secondReviewer": true,    "signers": 1,    "pastDue": 1  },  "due": "string",  "rule": {    "every": 1,    "secondReviewer": true,    "pastDue": 1,    "signers": 1  },  "pending": {    "id": "string",    "at": "string",    "by": "string",    "byId": "string",    "note": "string",    "changes": [      {        "userId": "string",        "who": "string",        "kind": "remove",        "from": "admin",        "to": "admin"      }    ],    "signers": 1,    "signedBy": [      "string"    ],    "rule": {      "every": 1,      "secondReviewer": true,      "pastDue": 1,      "signers": 1    }  },  "tokens": [    {      "id": "string",      "name": "string",      "scopes": [        "string"      ],      "lastUsed": "string",      "createdAt": "string",      "proposal": "keep"    }  ],  "teams": [    {      "id": "string",      "name": "string",      "members": [        {          "userId": "string",          "who": "string",          "lastActive": "string",          "proposal": "keep"        }      ]    }  ],  "applyAt": "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.