Skip to content
Last updated

idps

Products:RedocRedocRevelRevelReefReefRealmRealm
Plans:EnterpriseEnterprise+

Restrict project login to specific identity providers (IdPs) selected by unique ID.

Configure which individual identity providers (IdPs) — by their unique ID — are available at project login. idps selects identity providers by the unique ID and is mutually exclusive with sso. When idps is configured, only the listed identity providers can be used to log in to the project — the standard Redocly login (email/password and Social Login providers) is not offered.

Use idps when:

  • You have multiple identity providers in the same category (for example, two GUEST IdPs) and you want a project to surface only one of them.
  • You want to expose a specific IdP without enabling the entire category.

Each identity provider's unique ID is displayed next to its name on the Reunite organization Settings > SSO and login page and can be edited there.

Options

OptionTypeDescription
idpsstring | [string]List of identity provider unique IDs from Reunite. Each entry must be in kebab-case (lowercase letters, numbers, hyphens). Values: redocly, corporate, and guest are reserved and cause validation errors. Identity providers not listed in idps are hidden at project login and cannot be used to authenticate.

Examples

Target a single IdP by unique ID

redocly.yaml
access:
  idps:
    - acme-corp-saml

Only the IdP with unique ID acme-corp-saml is offered. Other IdPs (including ones in CORPORATE or GUEST categories) are hidden, and the standard Redocly login is not available.

Resources