Skip to content

Make a team that holds a role made here - its people hold it beside their own; never more than the person making it holds

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.

POST
/v1/teams
curl --request POST \  --url https://api.xovris.ai/v1/teams \  --header 'Authorization: Bearer <token>' \  --header 'Content-Type: application/json' \  --data '{ "name": "string", "about": null, "provider": null, "rule": null, "expiresAt": null, "roleId": null, "parentId": "string", "owners": null }'

Needs a token that can read and change. A token without change access is refused with token_read_only and the step to take.

Media typeapplication/json
object
name
string
about
provider
rule
expiresAt
roleId
parentId
string
owners

Example

{  "name": "string",  "about": null,  "provider": null,  "rule": null,  "expiresAt": null,  "roleId": null,  "parentId": "string",  "owners": null}

Done.

Media typeapplication/json
object

Example generated

{}

Done: something new was made, and the answer is it.

Media typeapplication/json
object
id
required
string
name
required
string
about
required
One of:
string
provider
required
One of:
string
roleId
required
One of:
string
roleName
required
One of:
string
roleActions
required
number
rule
required
One of:
object
domains
Array<string>
roles
Array<string>
parentId
required
One of:
string
owners
required
Array<string>
expiresAt
required
One of:
string
people
required
Array<object>
object
userId
required
string
email
required
string
name
required
One of:
string
how
required
string
Allowed values: rule added
updatedAt
required
string

Example

{  "id": "string",  "name": "string",  "about": "string",  "provider": "string",  "roleId": "string",  "roleName": "string",  "roleActions": 1,  "rule": {    "domains": [      "string"    ],    "roles": [      "string"    ]  },  "parentId": "string",  "owners": [    "string"  ],  "expiresAt": "string",  "people": [    {      "userId": "string",      "email": "string",      "name": "string",      "how": "rule"    }  ],  "updatedAt": "string"}

Started: the answer says where to follow it.

Media typeapplication/json
object

Example generated

{}

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.