# `access`


The `access` object groups authentication and access-related configuration options together for better organization and maintainability.

**New format:** The `access` object is the recommended way to configure authentication and access settings. Root-level properties (`requiresLogin`, `residency`, `sso`, `rbac`) are still supported for backward compatibility but will show 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, Enterprise, Enterprise+**.
See [RequiresLogin configuration](/docs/realm/config/requires-login).
- `logoutReturnUrl` (string) - URL where users are redirected after logout (new feature).
Available on **Pro, Enterprise, Enterprise+**.
- `residency` (string) - Geographical location URL for hosting your project.
Available on **Enterprise+**.
See [Residency configuration](/docs/realm/config/residency).
- `sso` (string | [string]) - List of identity provider types from Reunite. Available on **Enterprise, Enterprise+**. See [SSO configuration](/docs/realm/config/sso).
- `rbac` (object) - Role-based access control configuration.
Available on **Enterprise, Enterprise+**.
See [RBAC configuration](/docs/realm/config/rbac).

 |


## Examples

### Basic access configuration

The following example configures authentication requirements and logout redirect:


```yaml redocly.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 redocly.yaml
access:
  requiresLogin: true
  logoutReturnUrl: https://yourcompany.com
```

### Configure residency

The following example sets EU residency:


```yaml redocly.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 redocly.yaml
access:
  rbac:
    content:
      '**':
        authenticated: read
```

### Complete access configuration

The following example shows all access-related options:


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

## Migration from root-level properties

If you're currently using root-level properties, you can 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
```

**Note:** `logoutReturnUrl` is a new feature and is only available in the `access` object format. It was not previously available as a root-level property.

**Important:** Do not define the same property both at root level and in the `access` object. If both are defined, the configuration will throw an error. Use only the `access` object format for new configurations.

## Resources

- **[RequiresLogin configuration](/docs/realm/config/requires-login)** - Detailed information about requiring login for your project
- **[SSO configuration](/docs/realm/config/sso)** - Complete guide for configuring single sign-on
- **[Residency configuration](/docs/realm/config/residency)** - Information about geographical hosting locations
- **[RBAC configuration](/docs/realm/config/rbac)** - Alternative access control using role-based permissions