Skip to content

Connect a sign-in directory

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/identity/connections
curl --request POST \  --url https://api.xovris.ai/v1/identity/connections \  --header 'Authorization: Bearer <token>' \  --header 'Content-Type: application/json' \  --data '{ "kind": "google_workspace", "settings": {}, "issuer": null, "metadataUrl": null, "secret": {}, "domain": null, "description": null, "credential": null, "baseUrl": null, "label": null, "directory": 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
kind
string
Allowed values: google_workspace microsoft_entra okta github scim
settings
object
issuer
metadataUrl
secret
object
domain
description
credential
baseUrl
label
directory

Example

{  "kind": "google_workspace",  "settings": {},  "issuer": null,  "metadataUrl": null,  "secret": {},  "domain": null,  "description": null,  "credential": null,  "baseUrl": null,  "label": null,  "directory": null}

Done.

Media typeapplication/json
object

Example generated

{}

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

Media typeapplication/json
One of:
object
met
required
boolean
system
required
One of:
string
title
required
One of:
string
connectionId
required
string
proved
required
number
key
required
string
issuer
required
One of:
object
protocol
required
string
Allowed values: oidc saml
issuer
required
string
signIn
required
One of:
string
keys
required
One of:
string
people
required
One of:
string
scim
required
One of:
string
parts
required
Array<object>
object
part
required
string
operation
required
string
tried
required
Array<string>

Example

{  "met": true,  "system": "string",  "title": "string",  "connectionId": "string",  "proved": 1,  "key": "string",  "issuer": {    "protocol": "oidc",    "issuer": "string",    "signIn": "string",    "keys": "string",    "people": "string",    "scim": "string"  },  "parts": [    {      "part": "string",      "operation": "string"    }  ],  "tried": [    "string"  ]}

Started: the answer says where to follow it.

Media typeapplication/json
object
met
required
boolean
system
required
One of:
string
issuer
required
One of:
object
protocol
required
string
Allowed values: oidc saml
issuer
required
string
signIn
required
One of:
string
keys
required
One of:
string
people
required
One of:
string
scim
required
One of:
string
parts
required
Array<object>
object
part
required
string
operation
required
string
tried
required
Array<string>
missing
required
Array<string>
next
required
string

Example

{  "met": true,  "system": "string",  "issuer": {    "protocol": "oidc",    "issuer": "string",    "signIn": "string",    "keys": "string",    "people": "string",    "scim": "string"  },  "parts": [    {      "part": "string",      "operation": "string"    }  ],  "tried": [    "string"  ],  "missing": [    "string"  ],  "next": "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.