{"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"access","__idx":0},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["access"]}]},{"$$mdtype":"Tag","name":"ConfigOptionRequirements","attributes":{"products":["Redoc","Revel","Reef","Realm"],"plans":["Pro","Enterprise","Enterprise+"]},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Configure authentication and access-related settings in a single object."," ","The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["access"]}," object groups authentication and access-related configuration options together for better organization and maintainability."]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"New configuration format"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["access"]}," object is the recommended way to configure authentication and access settings."," ","Root-level properties (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["requiresLogin"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["residency"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sso"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["rbac"]},") are supported for backward compatibility but display deprecation warnings when used alongside the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["access"]}," object."]}]},{"$$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":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["access"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["object"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Container object for access-related configuration properties."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Properties:"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["requiresLogin"]}," (boolean) - Makes all content private for non-authenticated users."," ","Available on ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Pro, Enterprise, Enterprise+"]},"."," ","See ",{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/realm/config/access/requires-login"},"children":["RequiresLogin configuration"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["logoutReturnUrl"]}," (string) - URL where users are redirected after logout (new feature)."," ","Available on ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Pro, Enterprise, Enterprise+"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["residency"]}," (string) - Geographical location URL for hosting your project."," ","Available on ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Enterprise+"]},"."," ","See ",{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/realm/config/access/residency"},"children":["Residency configuration"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sso"]}," (string | [string]) - List of identity provider categories from Reunite (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["REDOCLY"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CORPORATE"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GUEST"]},")."," ","Available for ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Enterprise and Enterprise+"]}," plans."," ","Mutually exclusive with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["idps"]},"."," ","See ",{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/realm/config/access/sso"},"children":["SSO configuration"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["idps"]}," (string | [string]) - List of identity provider unique IDs from Reunite."," ","Mutually exclusive with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sso"]},"."," ","Available for ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Enterprise and Enterprise+"]}," plans."," ","See ",{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/realm/config/access/idps"},"children":["IdPs configuration"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["rbac"]}," (object) - Role-based access control configuration."," ","Available on ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Enterprise, Enterprise+"]},"."," ","See ",{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/realm/config/access/rbac"},"children":["RBAC configuration"]},"."]}]}]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"examples","__idx":2},"children":["Examples"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"basic-access-configuration","__idx":3},"children":["Basic access configuration"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The following example configures authentication requirements and logout redirect:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"yaml","data-title":"redocly.yaml","header":{"title":"redocly.yaml","controls":{"copy":{}}},"source":"access:\n  requiresLogin: true\n  logoutReturnUrl: https://example.com\n  sso:\n    - CORPORATE\n    - REDOCLY\n","lang":"yaml"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"configure-logout-redirect","__idx":4},"children":["Configure logout redirect"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The following example shows how to redirect users to your main website after logout:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"yaml","data-title":"redocly.yaml","header":{"title":"redocly.yaml","controls":{"copy":{}}},"source":"access:\n  requiresLogin: true\n  logoutReturnUrl: https://yourcompany.com\n","lang":"yaml"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"configure-residency","__idx":5},"children":["Configure residency"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The following example sets EU residency:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"yaml","data-title":"redocly.yaml","header":{"title":"redocly.yaml","controls":{"copy":{}}},"source":"access:\n  residency: https://app.cloud.eu.redocly.com\n  requiresLogin: true\n","lang":"yaml"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"configure-rbac","__idx":6},"children":["Configure RBAC"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The following example shows how to configure role-based access control within the access object:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"yaml","data-title":"redocly.yaml","header":{"title":"redocly.yaml","controls":{"copy":{}}},"source":"access:\n  rbac:\n    content:\n      '**':\n        authenticated: read\n","lang":"yaml"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"complete-access-configuration","__idx":7},"children":["Complete access configuration"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The following example shows all access-related options:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"yaml","data-title":"redocly.yaml","header":{"title":"redocly.yaml","controls":{"copy":{}}},"source":"access:\n  requiresLogin: true\n  logoutReturnUrl: https://yourcompany.com\n  residency: https://app.cloud.eu.redocly.com\n  sso:\n    - CORPORATE\n    - GUEST\n  rbac:\n    content:\n      '**':\n        authenticated: read\n","lang":"yaml"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"migrate-from-root-level-properties","__idx":8},"children":["Migrate from root-level properties"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If you're currently using ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["requiresLogin"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["residency"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sso"]},", or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["rbac"]}," property at the root-level, migrate to the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["access"]}," object format:"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Old format (deprecated):"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"yaml","header":{"controls":{"copy":{}}},"source":"requiresLogin: true\nresidency: https://app.cloud.eu.redocly.com\nsso:\n  - CORPORATE\nrbac:\n  content:\n    '**':\n      authenticated: read\n","lang":"yaml"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["New format (recommended):"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"yaml","header":{"controls":{"copy":{}}},"source":"access:\n  requiresLogin: true\n  residency: https://app.cloud.eu.redocly.com\n  sso:\n    - CORPORATE\n  rbac:\n    content:\n      '**':\n        authenticated: read\n","lang":"yaml"},"children":[]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"warning","name":"Warning"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Do not define the same property both at root level and in the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["access"]}," object."," ","Duplicate properties result in an error."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use only the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["access"]}," object format for new configurations."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"resources","__idx":9},"children":["Resources"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/realm/config/access/requires-login"},"children":["RequiresLogin configuration"]}]}," - Detailed information about requiring login for your project"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/realm/config/access/sso"},"children":["SSO configuration"]}]}," - Complete guide for configuring single sign-on"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/realm/config/access/idps"},"children":["IdPs configuration"]}]}," - Target specific identity providers by unique ID"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/realm/config/access/residency"},"children":["Residency configuration"]}]}," - Information about geographical hosting locations"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/realm/config/access/rbac"},"children":["RBAC configuration"]}]}," - Alternative access control using role-based permissions"]}]}]},"frontmatter":{"products":["Redoc","Revel","Reef","Realm"],"plans":["Pro","Enterprise","Enterprise+"],"description":"Configure authentication and access-related settings in a single object."},"tagList":["admonition","configOptionRequirements","table"],"title":"access","lastModified":"2026-07-09T13:06:17.000Z"}