Skip to content

Prove a company sign-in's domain - Xovris reads its DNS TXT record and switches the sign-in on when 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/sso/providers/{providerId}/verify
curl --request POST \  --url https://api.xovris.ai/v1/sso/providers/example/verify \  --header 'Authorization: Bearer <token>' \  --header 'Content-Type: application/json' \  --data '{}'

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

providerId
required
string
Media typeapplication/json
object

Example generated

{}

Done.

Media typeapplication/json
object
metadataUrl
required
One of:
string
certTaken
required
One of:
string
idpInitiated
required
boolean
providerId
required
string
kind
required
string
Allowed values: oidc saml
issuer
required
string
domain
required
string
verified
required
boolean
proof
required
One of:
object
name
required
string
value
required
string
join
required
One of:
object
role
required
string
Allowed values: admin billing member viewer custom
roleId
required
One of:
string
groups
required
Array
One of:
object
group
required
string
role
required
string
Allowed values: admin billing member viewer custom
roleId
required
One of:
string
required
required
boolean
certEnds
required
One of:
string
signIns
required
object
people
required
number
latest
required
One of:
string
setup
required
One of:
object
kind
required
string
Allowed values: oidc
redirectUri
required
string

Example

{  "metadataUrl": "string",  "certTaken": "string",  "idpInitiated": true,  "providerId": "string",  "kind": "oidc",  "issuer": "string",  "domain": "string",  "verified": true,  "proof": {    "name": "string",    "value": "string"  },  "join": {    "role": "admin",    "roleId": "string"  },  "groups": [    {      "group": "string",      "role": "admin",      "roleId": "string"    }  ],  "required": true,  "certEnds": "string",  "signIns": {    "people": 1,    "latest": "string"  },  "setup": {    "kind": "oidc",    "redirectUri": "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.