Skip to content

Turn the app inventory or the insider risk watch on, with its assessment accepted and staff told

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.

PUT
/v1/watch/{feature}/setup
curl --request PUT \  --url https://api.xovris.ai/v1/watch/example/setup \  --header 'Authorization: Bearer <token>' \  --header 'Content-Type: application/json' \  --data '{ "v": {} }'

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

feature
required
string
Media typeapplication/json
object
v
object
key
additional properties

Example

{  "v": {}}

Done.

Media typeapplication/json
object
feature
required
string
Allowed values: app_inventory insider_risk
setup
required
object
enabledBy
required
One of:
object
member
required
string
role
required
string
at
required
string
assessmentAcceptedAt
required
One of:
string
noticeSentAt
required
One of:
string
noticeChannels
required
Array<string>
countries
required
Array<string>
countryRecords
required
object
key
additional properties
object
ref
required
string
at
required
string
personalDeviceConsent
required
Array<string>
runs
required
One of:
object
ok
required
boolean

Example

{  "feature": "app_inventory",  "setup": {    "enabledBy": {      "member": "string",      "role": "string",      "at": "string"    },    "assessmentAcceptedAt": "string",    "noticeSentAt": "string",    "noticeChannels": [      "string"    ],    "countries": [      "string"    ],    "countryRecords": {},    "personalDeviceConsent": [      "string"    ]  },  "runs": {    "ok": true  }}

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.