{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-docs-realm.sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["configOptionRequirements"]},"redocly_category":"Realm","type":"markdown"},"seo":{"title":"idps","description":"OpenAPI-generated documentation tool with 24k+ stars on Github - make APIs your company's superpower.","siteUrl":"https://redocly.com","image":"/assets/redocly-card.f670aae34a39545a5ea633a540cb3a4a333a1f23bb2ed3c4a1b17a5fbcf0ac85.db81178d.png","lang":"en-US","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"idps","__idx":0},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["idps"]}]},{"$$mdtype":"Tag","name":"ConfigOptionRequirements","attributes":{"products":["Redoc","Revel","Reef","Realm"],"plans":["Enterprise","Enterprise+"]},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Restrict project login to specific identity providers (IdPs) selected by unique ID."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Configure which individual identity providers (IdPs) — by their unique ID — are available at project login."," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["idps"]}," selects identity providers by the unique ID and is mutually exclusive with ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/realm/config/access/sso"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sso"]}]},"."," ","When ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["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."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["idps"]}," when:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["You have multiple identity providers in the same category (for example, two ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GUEST"]}," IdPs) and you want a project to surface only one of them."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["You want to expose a specific IdP without enabling the entire category."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Each identity provider's unique ID is displayed next to its name on the Reunite organization ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Settings"]}," > ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["SSO and login"]}," page and can be edited there."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"options","__idx":1},"children":["Options"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Option"},"children":["Option"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["idps"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string | [string]"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["List of identity provider unique IDs from Reunite."," ","Each entry must be in kebab-case (lowercase letters, numbers, hyphens)."," ","Values: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["redocly"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["corporate"]},", and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["guest"]}," are reserved and cause validation errors."," ","Identity providers not listed in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["idps"]}," are hidden at project login and cannot be used to authenticate."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"examples","__idx":2},"children":["Examples"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"target-a-single-idp-by-unique-id","__idx":3},"children":["Target a single IdP by unique ID"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"yaml","data-title":"redocly.yaml","header":{"title":"redocly.yaml","controls":{"copy":{}}},"source":"access:\n  idps:\n    - acme-corp-saml\n","lang":"yaml"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Only the IdP with unique ID ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["acme-corp-saml"]}," is offered."," ","Other IdPs (including ones in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CORPORATE"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GUEST"]}," categories) are hidden, and the standard Redocly login is not available."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"resources","__idx":4},"children":["Resources"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/realm/config/access/sso"},"children":["SSO configuration"]}]}," - Filter identity providers by category (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["REDOCLY"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CORPORATE"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GUEST"]},")"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/realm/config/access"},"children":["Access configuration"]}]}," - Group authentication and access settings together"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/realm/reunite/organization/sso/add-idp"},"children":["Add an identity provider"]}]}," - Add, configure, and assign unique IDs to identity providers"]}]}]},"headings":[{"value":"idps","id":"idps","depth":1},{"value":"Options","id":"options","depth":2},{"value":"Examples","id":"examples","depth":2},{"value":"Target a single IdP by unique ID","id":"target-a-single-idp-by-unique-id","depth":3},{"value":"Resources","id":"resources","depth":2}],"frontmatter":{"products":["Redoc","Revel","Reef","Realm"],"plans":["Enterprise","Enterprise+"],"description":"Restrict project login to specific identity providers (IdPs) selected by unique ID.","seo":{"title":"idps"}},"lastModified":"2026-06-30T18:04:32.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/docs/realm/config/access/idps","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}