Skip to content

See this workspace's company sign-ins - each identity provider, its email domain and whether the domain is proved

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

A token that can read is enough.

Done.

Media typeapplication/json
object
items
required
Array<object>
object
exchanges
required
object
items
required
Array<object>
object
at
required
string
email
required
One of:
string
outcome
required
string
Allowed values: failed member test nobody joined other-domain
claims
object
key
additional properties
One of:
string
error
string
description
string
would
object
join
required
One of:
object
role
required
string
roleId
required
One of:
string
teams
required
Array<string>
otherDomain
required
boolean
total
required
number
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
redirectUri
required
string

Example

{  "items": [    {      "exchanges": {        "items": [          {            "at": "string",            "email": "string",            "outcome": "failed",            "claims": {},            "error": "string",            "description": "string",            "would": {              "join": {                "role": null,                "roleId": null              },              "teams": [                "string"              ],              "otherDomain": true            }          }        ],        "total": 1      },      "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"      }    }  ],  "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.