Resolve a tenant discovery input.

POST

/api/auth/discovery

Code sample: Shell / cURL

curl --request POST \
  --url https://auth.example.com/api/auth/discovery \
  --header 'Content-Type: application/json' \
  --data '{ "mode": "email", "value": "[email protected]" }'

Resolves an email domain, tenant code, tenant slug, invitation token, WAYF choice, or app hint into one or more tenant login candidates.

Request Body ^required

Media type application/json

object

mode

required

string

Allowed values: email tenant_code tenant_slug wayf invite_token app_hint

value

required

string

<= 2048 characters

Example

{
  "mode": "email",
  "value": "[email protected]"
}

Responses

200

Successful JSON response.

Media type application/json

One of:

object

object

result

required

string

Allowed values: resolved

candidate

required

object

tenant_id

required

string

tenant_code

required

string

display_name

required

string

logo_url

string | null format: uri

login_url

required

string format: uri

source

required

string

Allowed values: email_domain tenant_code tenant_slug wayf invitation app_hint

invited_email

string | null

object

object

result

required

string

Allowed values: multiple

candidates

required

Array<object>

object

tenant_id

required

string

tenant_code

required

string

display_name

required

string

logo_url

string | null format: uri

login_url

required

string format: uri

source

required

string

Allowed values: email_domain tenant_code tenant_slug wayf invitation app_hint

object

object

result

required

string

Allowed values: manual_required

methods

required

Array<string>

allow_manual_tenant_entry

required

boolean

object

object

result

required

string

Allowed values: not_found

code

required

string

Example

{
  "result": "resolved",
  "candidate": {
    "tenant_id": "tenant_123",
    "tenant_code": "acme",
    "display_name": "Acme",
    "logo_url": null,
    "login_url": "https://acme.auth.example.com/login",
    "source": "email_domain"
  }
}

400

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

401

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

403

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}