Sign in

One `identity-providers:` definition

Changed on
get/api/v1/admin/identity-providers/{name}

Request

  • The document declares no server URL.
  • Auth: one of:
    • API key in header x-admin-token
    • HTTP bearer

Path parameters

namestring required

Response

OK

browser_login_configuredboolean nullable

identity-providers ONLY: whether a browser_login: block is configured, the presence that puts a button on the hosted login page.

max_admin_scopestring nullable

identity-providers ONLY: the per-provider ADMIN CEILING (none | read-only | full). None ⇒ the definition names none, so the most restrictive default applies. Omitted entirely for a section that carries no ceiling.

modulestring required

The module: backing this instance (a built-in name or a signed-plugin name/alias).

namestring required

The instance NAME: the map key, and the token every reference site uses.

settings_keysstring[] required

The KEY NAMES of the module's opaque settings bag, sorted, WITHOUT their values, the redacted projection of settings:. Operator/API-owned and never interpreted here, but also never a place a VALUE can leak from: a settings value may be a credential (see the type doc), and this surface is reachable at READ-ONLY admin scope. An empty bag ⇒ an empty list. The values are readable only where they are writable: the config file and the config overlay.

token_configuredboolean nullable

identity-providers ONLY: whether a token: secret REFERENCE is configured (the built-in admin-tokens operator credential). The reference itself is never projected.

unparseablestring nullable

Set ONLY on an entry that is STORED in the config overlay but could NOT be parsed into this section's typed config by this binary (a downgrade whose struct lost a field, a hand-edited overlay); the value is the parse error. Such an entry is dropped at every rebuild, so it is NOT live: module/settings_keys are the raw stored document's best-effort projection, not a resolved definition. Present so the drop is DISCOVERABLE here rather than only in a boot log line. Absent (and omitted from the body) for every live definition.

Changes