コンテンツにスキップ
Authrim

Read tenant discovery configuration.

GET
/api/auth/discovery
Code sample: Shell / cURL 
curl --request GET \
  --url https://auth.example.com/api/auth/discovery

Returns common-login discovery settings, Login UI branding, and candidate tenant hints for the current host.

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful JSON response.

Media type application/json
object
config
required
object
key
additional properties
ui
required
object
key
additional properties
single_tenant_mode
required
boolean
is_common_entry_host
required
boolean
common_discover_url
string | null format: uri
wayf_candidates
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
single_active_tenant_candidate
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
default_candidate
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
Example 
{
  "config": {
    "tenant_id": "default",
    "mode": "direct",
    "discovery_methods": [
      "email_domain",
      "tenant_code"
    ],
    "allow_manual_tenant_entry": true
  },
  "ui": {
    "theme": "light",
    "variant": "beige",
    "brand_name": "Authrim"
  },
  "single_tenant_mode": false,
  "is_common_entry_host": true,
  "common_discover_url": "https://auth.example.com/discover"
}

400

Section titled “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

Section titled “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

Section titled “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"
}