# AdminConfig Schema

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



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

## admin Type

`object` ([AdminConfig](project-config-properties-adminconfig.md))

# admin Properties

| Property                    | Type     | Required | Nullable       | Defined by                                                                                                                                                            |
| :-------------------------- | :------- | :------- | :------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [role](#role)               | `object` | Optional | cannot be null | [ProjectConfig](project-config-properties-adminconfig-properties-role.md "https://ns.adobe.com/helix/config/project#/properties/admin/properties/role")               |
| [requireAuth](#requireauth) | Merged   | Optional | cannot be null | [ProjectConfig](project-config-properties-adminconfig-properties-requireauth.md "https://ns.adobe.com/helix/config/project#/properties/admin/properties/requireAuth") |
| [defaultRole](#defaultrole) | Merged   | Optional | cannot be null | [ProjectConfig](project-config-defs-stringorarray.md "https://ns.adobe.com/helix/config/project#/properties/admin/properties/defaultRole")                            |
| [apiKeyId](#apikeyid)       | Merged   | Optional | cannot be null | [ProjectConfig](project-config-defs-stringorarray.md "https://ns.adobe.com/helix/config/project#/properties/admin/properties/apiKeyId")                               |
| [events](#events)           | `object` | Optional | cannot be null | [ProjectConfig](project-config-properties-adminconfig-properties-events.md "https://ns.adobe.com/helix/config/project#/properties/admin/properties/events")           |

## role



`role`

*   is optional

*   Type: `object` ([Role](project-config-properties-adminconfig-properties-role.md))

*   cannot be null

*   defined in: [ProjectConfig](project-config-properties-adminconfig-properties-role.md "https://ns.adobe.com/helix/config/project#/properties/admin/properties/role")

### role Type

`object` ([Role](project-config-properties-adminconfig-properties-role.md))

## requireAuth

Enforce authentication if set to true. If set to 'auto' it will enforce authentication if a role mapping is defined. defaults to 'auto'.

`requireAuth`

*   is optional

*   Type: merged type ([Details](project-config-properties-adminconfig-properties-requireauth.md))

*   cannot be null

*   defined in: [ProjectConfig](project-config-properties-adminconfig-properties-requireauth.md "https://ns.adobe.com/helix/config/project#/properties/admin/properties/requireAuth")

### requireAuth Type

merged type ([Details](project-config-properties-adminconfig-properties-requireauth.md))

one (and only one) of

*   [Untitled boolean in ProjectConfig](project-config-properties-adminconfig-properties-requireauth-oneof-0.md "check type definition")

*   [Untitled string in ProjectConfig](project-config-properties-adminconfig-properties-requireauth-oneof-1.md "check type definition")

### requireAuth Default Value

The default value is:

```json
"auto"
```

## defaultRole

the default roles assigned to the users. defaults to `basic_publish` for unauthenticated setups.

`defaultRole`

*   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/admin/properties/defaultRole")

### defaultRole 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/admin/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")

## events

Events that are triggered by the admin.

`events`

*   is optional

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

*   cannot be null

*   defined in: [ProjectConfig](project-config-properties-adminconfig-properties-events.md "https://ns.adobe.com/helix/config/project#/properties/admin/properties/events")

### events Type

`object` ([Details](project-config-properties-adminconfig-properties-events.md))