# AccessConfig Schema

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

Access config specific to preview content

| 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") |

## preview Type

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

# preview Properties

| Property              | Type   | Required | Nullable       | Defined by                                                                                                                                                  |
| :-------------------- | :----- | :------- | :------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [allow](#allow)       | Merged | Required | cannot be null | [ProjectConfig](project-config-defs-stringorarray.md "https://ns.adobe.com/helix/config/project#/properties/access/properties/preview/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/preview/properties/apiKeyId") |

## allow

The email glob of the users that are allowed.

`allow`

*   is required

*   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/preview/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/preview/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")