# SiteAccessConfig Schema

```txt
https://ns.adobe.com/helix/config/project#/properties/access
```



| Abstract            | Extensible | Status         | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In                                                                        |
| :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :-------------------------------------------------------------------------------- |
| Can be instantiated | No         | Unknown status | No           | Forbidden         | Forbidden             | none                | [project-config.schema.json\*](project-config.schema.json "open original schema") |

## access Type

`object` ([SiteAccessConfig](project-config-properties-siteaccessconfig.md))

# access Properties

| Property              | Type          | Required | Nullable       | Defined by                                                                                                                                                               |
| :-------------------- | :------------ | :------- | :------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [allow](#allow)       | Merged        | Optional | cannot be null | [ProjectConfig](project-config-defs-stringorarray.md "https://ns.adobe.com/helix/config/project#/properties/access/properties/allow")                                    |
| [apiKeyId](#apikeyid) | Merged        | Optional | cannot be null | [ProjectConfig](project-config-defs-stringorarray.md "https://ns.adobe.com/helix/config/project#/properties/access/properties/apiKeyId")                                 |
| [require](#require)   | `object`      | Optional | cannot be null | [ProjectConfig](project-config-properties-siteaccessconfig-properties-require.md "https://ns.adobe.com/helix/config/project#/properties/access/properties/require")      |
| [preview](#preview)   | `object`      | Optional | cannot be null | [ProjectConfig](project-config-properties-siteaccessconfig-properties-accessconfig.md "https://ns.adobe.com/helix/config/project#/properties/access/properties/preview") |
| [live](#live)         | Not specified | Optional | cannot be null | [ProjectConfig](project-config-properties-siteaccessconfig-properties-live.md "https://ns.adobe.com/helix/config/project#/properties/access/properties/live")            |

## allow

The email glob of the users that are allowed.

`allow`

*   is optional

*   Type: merged type ([Details](project-config-defs-stringorarray.md))

*   cannot be null

*   defined in: [ProjectConfig](project-config-defs-stringorarray.md "https://ns.adobe.com/helix/config/project#/properties/access/properties/allow")

### allow Type

merged type ([Details](project-config-defs-stringorarray.md))

one (and only one) of

*   [Untitled string in ProjectConfig](project-config-defs-stringorarray-oneof-0.md "check type definition")

*   [Untitled array in ProjectConfig](project-config-defs-stringorarray-oneof-1.md "check type definition")

## apiKeyId

the id of the API key(s). this is used to validate the API KEYS and allows to invalidate them.

`apiKeyId`

*   is optional

*   Type: merged type ([Details](project-config-defs-stringorarray.md))

*   cannot be null

*   defined in: [ProjectConfig](project-config-defs-stringorarray.md "https://ns.adobe.com/helix/config/project#/properties/access/properties/apiKeyId")

### apiKeyId Type

merged type ([Details](project-config-defs-stringorarray.md))

one (and only one) of

*   [Untitled string in ProjectConfig](project-config-defs-stringorarray-oneof-0.md "check type definition")

*   [Untitled array in ProjectConfig](project-config-defs-stringorarray-oneof-1.md "check type definition")

## require



`require`

*   is optional

*   Type: `object` ([Details](project-config-properties-siteaccessconfig-properties-require.md))

*   cannot be null

*   defined in: [ProjectConfig](project-config-properties-siteaccessconfig-properties-require.md "https://ns.adobe.com/helix/config/project#/properties/access/properties/require")

### require Type

`object` ([Details](project-config-properties-siteaccessconfig-properties-require.md))

## preview

Access config specific to preview content

`preview`

*   is optional

*   Type: `object` ([AccessConfig](project-config-properties-siteaccessconfig-properties-accessconfig.md))

*   cannot be null

*   defined in: [ProjectConfig](project-config-properties-siteaccessconfig-properties-accessconfig.md "https://ns.adobe.com/helix/config/project#/properties/access/properties/preview")

### preview Type

`object` ([AccessConfig](project-config-properties-siteaccessconfig-properties-accessconfig.md))

## live

Access config specific to live content

`live`

*   is optional

*   Type: unknown

*   cannot be null

*   defined in: [ProjectConfig](project-config-properties-siteaccessconfig-properties-live.md "https://ns.adobe.com/helix/config/project#/properties/access/properties/live")

### live Type

unknown