# `access`

Configure authentication and access-related settings in a single object.
The `access` object groups authentication and access-related configuration options together for better organization and maintainability.

**New configuration format**

The `access` object is the recommended way to configure authentication and access settings.
Root-level properties (`requiresLogin`, `residency`, `sso`, `rbac`) are supported for backward compatibility but display deprecation warnings when used alongside the `access` object.

## Options

| Option | Type | Description |
| --- | --- | --- |
| access | object | Container object for access-related configuration properties.  **Properties:**  - `requiresLogin` (boolean) - Makes all content private for non-authenticated users.   Available on **Pro, Scale, Enterprise**.   See [RequiresLogin configuration](/docs/platform/config/access/requires-login). - `logoutReturnUrl` (string) - URL where users are redirected after logout (new feature).   Available on **Pro, Scale, Enterprise**. - `residency` (string) - Geographical location URL for hosting your project.   Available on **Enterprise**.   See [Residency configuration](/docs/platform/config/access/residency). - `sso` (string \| [string]) - List of identity provider categories from the Redocly platform (`REDOCLY`, `CORPORATE`, `GUEST`).   Available for **Scale and Enterprise** plans.   Mutually exclusive with `idps`.   See [SSO configuration](/docs/platform/config/access/sso). - `idps` (string \| [string]) - List of identity provider unique IDs from Redocly.   Mutually exclusive with `sso`.   Available for **Scale and Enterprise** plans.   See [IdPs configuration](/docs/platform/config/access/idps). - `rbac` (object) - Role-based access control configuration.   Available on **Enterprise**.   See [RBAC configuration](/docs/platform/config/access/rbac). |

## Examples

### Basic access configuration

The following example configures authentication requirements and logout redirect:

```yaml
access:
  requiresLogin: true
  logoutReturnUrl: https://example.com
  sso:
    - CORPORATE
    - REDOCLY
```

### Configure logout redirect

The following example shows how to redirect users to your main website after logout:

```yaml
access:
  requiresLogin: true
  logoutReturnUrl: https://yourcompany.com
```

### Configure residency

The following example sets EU residency:

```yaml
access:
  residency: https://app.cloud.eu.redocly.com
  requiresLogin: true
```

### Configure RBAC

The following example shows how to configure role-based access control within the access object:

```yaml
access:
  rbac:
    content:
      '**':
        authenticated: read
```

### Complete access configuration

The following example shows all access-related options:

```yaml
access:
  requiresLogin: true
  logoutReturnUrl: https://yourcompany.com
  residency: https://app.cloud.eu.redocly.com
  sso:
    - CORPORATE
    - GUEST
  rbac:
    content:
      '**':
        authenticated: read
```

## Migrate from root-level properties

If you're currently using `requiresLogin`, `residency`, `sso`, or `rbac` property at the root-level, migrate to the `access` object format:

**Old format (deprecated):**

```yaml
requiresLogin: true
residency: https://app.cloud.eu.redocly.com
sso:
  - CORPORATE
rbac:
  content:
    '**':
      authenticated: read
```

**New format (recommended):**

```yaml
access:
  requiresLogin: true
  residency: https://app.cloud.eu.redocly.com
  sso:
    - CORPORATE
  rbac:
    content:
      '**':
        authenticated: read
```

**Warning**

Do not define the same property both at root level and in the `access` object.
Duplicate properties result in an error.

Use only the `access` object format for new configurations.

## Resources

- **[RequiresLogin configuration](/docs/platform/config/access/requires-login)** - Detailed information about requiring login for your project
- **[SSO configuration](/docs/platform/config/access/sso)** - Complete guide for configuring single sign-on
- **[IdPs configuration](/docs/platform/config/access/idps)** - Target specific identity providers by unique ID
- **[Residency configuration](/docs/platform/config/access/residency)** - Information about geographical hosting locations
- **[RBAC configuration](/docs/platform/config/access/rbac)** - Alternative access control using role-based permissions