# Access Grant Service ESS supports an [authorization mechanism based on Access Requests and Grants](https://docs.inrupt.com/security/authorization/access-requests-grants) . With Access Requests and Grants: 1. An [agent](https://docs.inrupt.com/reference/glossary#agent) sends an [Access Request](https://docs.inrupt.com/reference/glossary#access-request) to the [resource owner](https://docs.inrupt.com/reference/glossary#resource-owner) . This request includes the specific [access modes](https://docs.inrupt.com/reference/glossary#access-modes) (e.g. **`Read`** , **`Write`** , **`Append`** ), the [resources](https://docs.inrupt.com/reference/glossary#resource) to access, etc. See [Access Request Shape](https://docs.inrupt.com/ess/2.3/services/issue-endpoint#input-access-request-shape). 2. The resource owner approves or denies the Access Request. * For an approved request, ESS creates an [Access Grant](https://docs.inrupt.com/reference/glossary#access-grant) with an **`approved`** status. * For a denied request, ESS creates an Access Grant with a **`denied`** status. 3. If the requesting agent receives an approved Access Grant, the requesting agent can exchange the Access Grant for an access token in order to access the resource. See [UMA tokens](https://docs.inrupt.com/ess/2.3/services/service-uma). {% hint style="warning" %} **Important** * An Access Request for a [Container](https://docs.inrupt.com/reference/glossary#container), by default, also applies to the Container’s descendants, unless explicitly specified otherwise in the request (See [inherit: false](https://docs.inrupt.com/ess/2.3/services/issue-endpoint#input-access-request-shape)). * An Access Grant for a Container, by default, also applies to the Container’s descendants, unless explicitly specified otherwise in the grant (See [inherit: false](https://docs.inrupt.com/ess/2.3/services/issue-endpoint#input-access-request-shape)). {% endhint %} See also [Enable Access Grant Usage (ACP)](https://docs.inrupt.com/security/authorization/access-requests-grants#enable-access-grant-usage-acp). ## Access Grant Service ESS provides an Access Grant Service that serializes Access Requests and Grants as [Verifiable Credentials (VCs)](https://docs.inrupt.com/reference/glossary#verifiable-credential) and provides various Access Grants endpoints that follow the [draft VC API](https://w3c-ccg.github.io/vc-api/). ### ESS Access Grant Service Endpoints By default, the ESS Access Grant Service runs from the following root URL: ```none https://vc. ``` To change the root URL, see [**`INRUPT_VC_ISSUER`**](#inrupt_vc_issuer) . The ESS Access Grant Service consists of the following endpoints:
EndpointDescription
/issueIssues Access Requests and Grants that are serialized as VCs.
/verifyVerifies Access Requests and Grants that are serialized as VCs.
/statusUpdates the status of an Access Grant.
/queryQuery for Access Requests and Grants using filters.
/deriveQuery for Access Requests and Grants VCs and derive a Verifiable Presentation that contains the matching Access Requests and Grants VCs.
### Endpoint Access Control #### **Access Tokens** ESS Access Grant Service endpoints ( **`/issue`** , **`/status`** , **`/query`** , and **`/derive`** ) require the user to be authenticated. To identify the user, the endpoints support the use of the following tokens: * [UMA token](https://docs.inrupt.com/ess/2.3/services/service-uma) * [Solid-OpenID Connect (OIDC) access token](https://docs.inrupt.com/ess/2.3/services/service-oidc) See also: * [UMA Configuration](#uma-configuration) * [OIDC Configuration](#oidc-configuration) #### **Client Allow Lists** {% hint style="info" %} **Note**\ The Access Grant Service replaces the **`INRUPT_VC_CLIENT_ID_ALLOW_LIST`** configuration with **required** configurations that specify allow lists by the specific Access Credential Type. These configuration **must** be set for the Access Grant Service to start. {% endhint %} To restrict client access to the **`/issue`** and **`/status`** endpoints, see: * [**`INRUPT_VC_CLIENT_ID_ALLOW_LIST_SOLIDACCESSREQUEST`**](#inrupt_vc_client_id_allow_list_solidaccessrequest) (Defaults to **`Any`** .) * [**`INRUPT_VC_CLIENT_ID_ALLOW_LIST_SOLIDACCESSGRANT`**](#inrupt_vc_client_id_allow_list_solidaccessgrant) (Default is **unset** .) To set these configurations, use the ESS-provided overlay **`inputs/`** file **`ess-verifiable-credentials-client-type-allow-list.env`** . If keeping default values for these configurations, you only need to set [**`INRUPT_VC_CLIENT_ID_ALLOW_LIST_SOLIDACCESSGRANT`**](#inrupt_vc_client_id_allow_list_solidaccessgrant) in the **`ess-verifiable-credentials-client-type-allow-list.env`** file. #### Access Grant Service Discovery ESS provides a Access Grant service metadata resource at the following **`/.well-known/vc-configuration`** URI: ```none https://vc./.well-known/vc-configuration ``` The endpoint returns a [JSON-LD](https://w3c.github.io/json-ld-syntax/#basic-concepts) document that includes the locations for the Access Grant Service endpoints: 
{
  "@context": [
    "https://www.w3.org/2018/credentials/v1",
    "https://vc.<ESS Domain>/credentials/v1"
  ],
  "derivationService": "https://vc.<ESS Domain>/derive",
  "issuerService": "https://vc.<ESS Domain>/issue",
  "queryService": "https://vc.<ESS Domain>/query",
  "statusService": "https://vc.<ESS Domain>/status",
  "supportedSignatureTypes": [
    "Ed25519Signature2020"
  ],
  "verifierService": "https://vc.<ESS Domain>/verify"
}
## Access Grant Service Configuration As part of the [installation process](https://docs.inrupt.com/ess/2.3/installation), Inrupt provides base Kustomize overlays and associated files that require deployment-specific configuration inputs. The following configuration options are available for the service and may be set as part of [updating the inputs for your deployment](https://docs.inrupt.com/ess/installation#step-1-initialize-the-installation-directory). The Inrupt-provided base Kustomize overlays may be using updated configuration values that differ from the default values. ### Required #### INRUPT\_VC\_ISSUER Default : **`https://vc.`** Specifies the root URL of the Access Grant service. #### QUARKUS\_DATASOURCE\_JDBC\_URL Required if using a PostgreSQL database for persistence The JDBC connection string for the PostgreSQL database. See also: [**`QUARKUS_DATASOURCE_USERNAME`**](#quarkus_datasource_username) and [**`QUARKUS_DATASOURCE_PASSWORD`**](#quarkus_datasource_password) #### QUARKUS\_DATASOURCE\_PASSWORD Required if using a PostgreSQL database for persistence The password for the JDBC connector See also: [**`QUARKUS_DATASOURCE_JDBC_URL`**](#quarkus_datasource_jdbc_url) and [**`QUARKUS_DATASOURCE_USERNAME`**](#quarkus_datasource_username) #### QUARKUS\_DATASOURCE\_USERNAME Required if using a PostgreSQL database for persistence The username for the JDBC connector See also: [**`QUARKUS_DATASOURCE_JDBC_URL`**](#quarkus_datasource_jdbc_url) and [**`QUARKUS_DATASOURCE_PASSWORD`**](#quarkus_datasource_password) #### QUARKUS\_MONGODB\_CONNECTION\_STRING Required if using MongoDB for persistence The connection string for the MongoDB database See also [**`INRUPT_VC_MONGODB_DATABASE`**](#inrupt_vc_mongodb_database) #### INRUPT\_KAFKA\_AUDITV1EVENTSENCRYPTED\_CIPHER\_PASSWORD The strong cipher key to use when running auditing with encrypted messages. #### INRUPT\_KAFKA\_AUDITV1EVENTSPRODUCERENCRYPTED\_CIPHER\_PASSWORD The strong cipher key to use when running auditing with encrypted messages over the **`auditv1eventsproducerencrypted`** topic. #### KAFKA\_BOOTSTRAP\_SERVERS Default : **`localhost:9092`**. Comma-delimited list of Kafka broker servers for use by ESS services, including this service. Setting [**`KAFKA_BOOTSTRAP_SERVERS`**](#kafka_bootstrap_servers) configures ESS to use the same Kafka instance(s) for all its Kafka [message channels](https://quarkus.io/guides/kafka#kafka-configuration) (e.g., **`solidresource`** and **`auditv1out`** message channels). The Access Grant service uses the **`auditv1out`** message channel. {% hint style="info" %} **Note**\ Inrupt-provided overlays default to using [**`KAFKA_BOOTSTRAP_SERVERS`**](#kafka_bootstrap_servers). To use a different Kafka instance for the **`auditv1out`** channel, use specific [message channel](https://quarkus.io/guides/kafka#kafka-configuration) configuration. {% endhint %} See also [ESS’ Kafka Configuration](https://github.com/inrupt/docs-gitbook/blob/main/ess/2.3/services/service-access-grant/broken-reference/README.md) ### UMA Configuration #### INRUPT\_AUTHZ\_AS\_URI The URI of the UMA Authorization Server. The value must match: * [**`INRUPT_JWT_AUTHORIZATION_SERVER_ISSUER`**](#inrupt_jwt_authorization_server_issuer) configuration for the service, and * [**`INRUPT_UMA_ISSUER`**](#inrupt_vc_issuer) configuration for [UMA Service](https://docs.inrupt.com/ess/2.3/services/service-uma) #### INRUPT\_JWT\_AUTHORIZATION\_SERVER\_ISSUER The URI of the UMA token issuer. The value must match [**`INRUPT_AUTHZ_AS_URI`**](#inrupt_authz_as_uri) #### INRUPT\_JWT\_AUTHORIZATION\_SERVER\_JWKS The JWKS endpoint of the [**`INRUPT_JWT_AUTHORIZATION_SERVER_ISSUER`**](#inrupt_jwt_authorization_server_issuer) ### OIDC Configuration #### INRUPT\_JWT\_ALLOWED\_SIGNATURE\_ALGORITHMS Default : **`ES256`**, **`RS256`**. A comma-separated list that specifies the allowed encryption [algorithms](https://www.rfc-editor.org/rfc/rfc7515#section-4.1.1) used to sign ID tokens. #### INRUPT\_JWT\_ISSUER\_ALLOW\_LIST A comma-separated list of trusted issuers of Solid-OIDC tokens. * If unset, the service accepts Solid-OIDC tokens from all issuers with the exception of those in the [**`INRUPT_JWT_ISSUER_DENY_LIST`**](#inrupt_jwt_issuer_deny_list). * If set, the service accepts only the Solid-OIDC tokens from the issuers in the list with the following exception: * If an issuer is in both [**`INRUPT_JWT_ISSUER_ALLOW_LIST`**](#inrupt_jwt_issuer_allow_list) and [**`INRUPT_JWT_ISSUER_DENY_LIST`**](#inrupt_jwt_issuer_deny_list) , the [**`INRUPT_JWT_ISSUER_DENY_LIST`**](#inrupt_jwt_issuer_deny_list) supersedes the [**`INRUPT_JWT_ISSUER_ALLOW_LIST`**](#inrupt_jwt_issuer_allow_list) and the issuer is not accepted by ESS. See also [**`INRUPT_JWT_ISSUER_DENY_LIST`**](#inrupt_jwt_issuer_deny_list) . {% hint style="info" %} **Tip**\ Ensure that ESS UMA service’ [**`INRUPT_JWT_ISSUER_ALLOW_LIST`**](#inrupt_jwt_issuer_allow_list) is consistent with the [**`INRUPT_JWT_ISSUER_ALLOW_LIST`**](#inrupt_jwt_issuer_allow_list) value set for this service. {% endhint %} #### INRUPT\_JWT\_ISSUER\_DENY\_LIST A comma-separated list of disallowed issuers of Solid-OIDC tokens. * If unset, the service accepts Solid-OIDC tokens from all issuers unless [**`INRUPT_JWT_ISSUER_ALLOW_LIST`**](#inrupt_jwt_issuer_allow_list) is set, in which case, the service only accepts tokens from those in the [**`INRUPT_JWT_ISSUER_ALLOW_LIST`**](#inrupt_jwt_issuer_allow_list) . * If set, the service disallows the Solid-OIDC tokens from the issuers in the list. If [**`INRUPT_JWT_ISSUER_ALLOW_LIST`**](#inrupt_jwt_issuer_allow_list) is also set, issuers not in the [**`INRUPT_JWT_ISSUER_ALLOW_LIST`**](#inrupt_jwt_issuer_allow_list) are also disallowed. {% hint style="info" %} **Tip**\ Ensure that ESS UMA service’ [**`INRUPT_JWT_ISSUER_ALLOW_LIST`**](#inrupt_jwt_issuer_allow_list) is consistent with the [**`INRUPT_JWT_ISSUER_ALLOW_LIST`**](#inrupt_jwt_issuer_allow_list) value set for this service. {% endhint %} **Allow List Configuration** #### INRUPT\_VC\_CLIENT\_ID\_ALLOW\_LIST\_SOLIDACCESSGRANT Determines which applications can access the [/issue Endpoint](https://docs.inrupt.com/ess/2.3/services/service-access-grant/issue-endpoint) and the [/status Endpoint](https://docs.inrupt.com/ess/2.3/services/service-access-grant/service-access-grant-status) for Access Grants; i.e., can be used to issue and revoke Access Requests. The value can be either: * A comma-delimited list of the applications (specifically, their [Client IDs](https://docs.inrupt.com/reference/glossary#client-identifier)) that are allowed access. * One of the following reserved keywords (case-insensitive): * **`Any`** to allow all applications. * **`None`** to **disallow** all applications. See [Client Allow Lists](#ag-service-client-allow-list) #### INRUPT\_VC\_CLIENT\_ID\_ALLOW\_LIST\_SOLIDACCESSREQUEST Default : **`Any`** Determines which applications can access the [/issue Endpoint](https://docs.inrupt.com/ess/2.3/services/service-access-grant/issue-endpoint) and the [/status Endpoint](https://docs.inrupt.com/ess/2.3/services/service-access-grant/service-access-grant-status) for Access Grants; i.e., can be used to issue and revoke Access Requests. The value can be either: * A comma-delimited list of the applications (specifically, their [Client IDs](https://docs.inrupt.com/reference/glossary#client-identifier) ) that are allowed access. * One of the following reserved keywords (case-insensitive): * **`Any`** to allow all applications. * **`None`** to **disallow** all applications. See [Client Allow Lists](#client-allow-lists) ### Optional Configuration #### INRUPT\_JSONLD\_CACHE\_HOURS Default : **`6`**. The number of hours to cache remote JSON-LD context documents. See also: * [**`INRUPT_JSONLD_CACHE_SIZE`**](#inrupt_jsonld_cache_size) * [**`INRUPT_JSONLD_CONTEXT_ALLOW_LIST`**](#inrupt_jsonld_context_allow_list) * [**`INRUPT_JSONLD_CONTEXT_DENY_LIST`**](#inrupt_jsonld_context_deny_list) * [**`INRUPT_JSONLD_HTTP_MAX_REDIRECTS`**](#inrupt_jsonld_http_max_redirects) * [**`INRUPT_JSONLD_HTTP_TIMEOUT`**](#inrupt_jsonld_http_timeout) #### INRUPT\_JSONLD\_CACHE\_SIZE Default : **`100`**. The maximum number of entries in the internal cache of remote JSON-LD context documents. See also: * [**`INRUPT_JSONLD_CACHE_HOURS`**](#inrupt_jsonld_cache_size) * [**`INRUPT_JSONLD_CONTEXT_ALLOW_LIST`**](#inrupt_jsonld_context_allow_list) * [**`INRUPT_JSONLD_CONTEXT_DENY_LIST`**](#inrupt_jsonld_context_deny_list) * [**`INRUPT_JSONLD_HTTP_MAX_REDIRECTS`**](#cmdoption-agconfig-arg-INRUPT_JSONLD_HTTP_MAX_REDIRECTS) * [**`INRUPT_JSONLD_HTTP_TIMEOUT`**](#cmdoption-agconfig-arg-INRUPT_JSONLD_HTTP_TIMEOUT) #### INRUPT\_JSONLD\_CONTEXT\_ALLOW\_LIST Default : **`https://vc.{ESS DOMAIN}/credentials/v1`**. A comma-delimited list of trusted JSON-LD context URIs allowed to be dereferenced. The list is *in addition to* the following contexts (i.e., you do not need to include the following contexts): * **`https://www.w3.org/2018/credentials/v1`.** * **`https://schema.inrupt.com/credentials/v2.jsonld`**. * **`https://schema.inrupt.com/credentials/v2.jsonld`.** * **`https://w3id.org/security/data-integrity/v1`.** * **`https://w3id.org/vc-revocation-list-2020/v1`.** * **`https://w3id.org/vc/status-list/2021/v1`.** * **`https://w3id.org/security/suites/ed25519-2020/v1`.** * **`http://www.w3.org/ns/odrl.jsonld`.** {% hint style="warning" %} **Recommended**\ If possible, set this configuration value to that of the [**UMA Service**](https://docs.inrupt.com/ess/2.3/services/service-uma) . Mismatched values may result in the failure to parse access request/grant VCs. {% endhint %} {% hint style="warning" %} **Warning**\ Do **not** set to an empty list (i.e., do not unset this configuration). If empty, any context URI (with the exception of those URIs in [**`INRUPT_JSONLD_CONTEXT_DENY_LIST`**](#inrupt_jsonld_context_deny_list) ) is allowed, including untrusted and malicious contexts. {% endhint %} See also: * [**`INRUPT_JSONLD_CACHE_HOURS`**](#inrupt_jsonld_cache_size) * [**`INRUPT_JSONLD_CACHE_SIZE`**](#inrupt_jsonld_cache_size) * [**`INRUPT_JSONLD_CONTEXT_DENY_LIST`**](#inrupt_jsonld_context_deny_list) * [**`INRUPT_JSONLD_HTTP_MAX_REDIRECTS`**](#cmdoption-agconfig-arg-INRUPT_JSONLD_HTTP_MAX_REDIRECTS) * [**`INRUPT_JSONLD_HTTP_TIMEOUT`**](#cmdoption-agconfig-arg-INRUPT_JSONLD_HTTP_TIMEOUT) #### INRUPT\_JSONLD\_CONTEXT\_DENY\_LIST A deny-list of JSON-LD context URIs. URIs listed in this configuration are prevented from being dereferenced. See also: * [**`INRUPT_JSONLD_CACHE_HOURS`**](#inrupt_jsonld_cache_size) * [**`INRUPT_JSONLD_CACHE_SIZE`**](#inrupt_jsonld_cache_size) * [**`INRUPT_JSONLD_CONTEXT_ALLOW_LIST`**](#inrupt_jsonld_context_allow_list) * [**`INRUPT_JSONLD_HTTP_MAX_REDIRECTS`**](#cmdoption-agconfig-arg-INRUPT_JSONLD_HTTP_MAX_REDIRECTS) * [**`INRUPT_JSONLD_HTTP_TIMEOUT`**](#cmdoption-agconfig-arg-INRUPT_JSONLD_HTTP_TIMEOUT) #### INRUPT\_JSONLD\_HTTP\_MAX\_REDIRECTS *Default* : **`10`**. The maximum number of redirects allowed when fetching JSON-LD context documents. See also: * [**`INRUPT_JSONLD_CACHE_HOURS`**](#inrupt_jsonld_cache_size) * [**`INRUPT_JSONLD_CACHE_SIZE`**](#inrupt_jsonld_cache_size) * [**`INRUPT_JSONLD_CONTEXT_ALLOW_LIST`**](#inrupt_jsonld_context_allow_list) * [**`INRUPT_JSONLD_CONTEXT_DENY_LIST`**](#inrupt_jsonld_context_deny_list) * [**`INRUPT_JSONLD_HTTP_TIMEOUT`**](#cmdoption-agconfig-arg-INRUPT_JSONLD_HTTP_TIMEOUT) #### INRUPT\_JSONLD\_HTTP\_TIMEOUT Default\_ : **`10`**. The timeout in seconds for fetching a remote JSON-LD context document. See also: * [**`INRUPT_JSONLD_CACHE_HOURS`**](#inrupt_jsonld_cache_size) * [**`INRUPT_JSONLD_CACHE_SIZE`**](#inrupt_jsonld_cache_size) * [**`INRUPT_JSONLD_CONTEXT_ALLOW_LIST`**](#inrupt_jsonld_context_allow_list) * [**`INRUPT_JSONLD_CONTEXT_DENY_LIST`**](#inrupt_jsonld_context_deny_list) * [**`INRUPT_JSONLD_HTTP_MAX_REDIRECTS`**](#cmdoption-agconfig-arg-INRUPT_JSONLD_HTTP_MAX_REDIRECTS) #### INRUPT\_VC\_ISSUER\_DESCRIPTION A description of the access request/grant issuer. #### INRUPT\_VC\_ISSUER\_NAME A display name for the access request/grant issuer. #### INRUPT\_VC\_ISSUER\_TOS A URL for a Terms of Service (TOS) document. #### INRUPT\_VC\_MONGODB\_DATABASE Default : **vc** The name of the MongoDB database. See also [**`QUARKUS_MONGODB_CONNECTION_STRING`**](#quarkus_mongodb_connection_string) #### QUARKUS\_LOG\_LEVEL Default : **INFO**. Logging level. #### INRUPT\_VC\_MAX\_DURATION Default : **P365D** A maximum duration (i.e., expiration time) for the issued Access Requests/Grants. Specify the value in a format supported by Java [**`Duration.parse()`**](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html#parse\(java.lang.CharSequence\)) method, such as **`PT2H`** (2 hours) or **`P180D`** (180 days). If the value is set, the Access Grant Service calculates an expiration date using this value. Then, * If the credential payload sent to the **`/issue`** endpoint also specifies an expiration date, the issuer uses the earlier of the two dates. * If the credential payload sent to the **`/issue`** endpoint does not specify an expiration date, the Access Grant Service uses the calculated date as the expiration date. If the value is unset, the Access Grant Service uses **`P365D`** (365 days) to calculate the expiration date. * If the credential payload sent to the **`/issue`** endpoint specifies an expiration date, the Access Grant Service uses the earlier of the two dates. * If the credential payload sent to the **`issuer`** endpoint does not specify an expiration date, the Access Grant Service uses the calculated date as the expiration date. {% hint style="info" %} **Tip** This value should be set in accordance with your specific business, industry, or regulatory policies that govern data access durations. For example, the default value of **`P365D`** is typical of a business process that requires data access to be revalidated on an annual basis. {% endhint %} ### **/status Endpoint Configuration** #### INRUPT\_VC\_STATUS\_LIST\_ID\_LENGTH Default : **4**. This sets the size of the status list identifiers. A higher value adds a greater level of entropy to the status list allocations. For example, a value of 4 supports about 1.7 trillion entries. This value can be changed at any time without adverse effects. ### /query Endpoint Configuration #### INRUPT\_VC\_QUERY\_AGENT\_PATHS Default : **`/credentialSubject/providedConsent/isProvidedTo,/credentialSubject/providedConsent/isProvidedToPerson,/credentialSubject/providedConsent/isProvidedToController`** A comma-separated list of paths that can be considered during query execution. The query runs against access requests and grants that have the agent’s WebID in any of the listed paths. Available paths are: * **`/credentialSubject/providedConsent/isProvidedTo`** * **`/credentialSubject/providedConsent/isProvidedToPerson`** * **`/credentialSubject/providedConsent/isProvidedToController`** #### INRUPT\_VC\_QUERY\_PROPERTY\_LIMIT Default : **`16`**. The maximum number of properties in a `/derive` query. ### **/derive Endpoint Configuration** #### INRUPT\_VC\_QUERY\_AGENT\_PATHS Default : **`/credentialSubject/providedConsent/isProvidedTo,/credentialSubject/providedConsent/isProvidedToPerson,/credentialSubject/providedConsent/isProvidedToController`** A comma-separated list of paths that can be considered during query execution. The query runs against access requests and grants that have the agent’s WebID in any of the listed paths. Available paths are: * **`/credentialSubject/providedConsent/isProvidedTo`** * **`/credentialSubject/providedConsent/isProvidedToPerson`** * **`/credentialSubject/providedConsent/isProvidedToController`** #### INRUPT\_VC\_QUERY\_PROPERTY\_LIMIT Default : **`16`**. The maximum number of properties in a /derive query. ### **Service Configuration Logging** ESS services log their startup configuration. #### INRUPT\_LOGGING\_CONFIGURATION\_PREFIX\_ALLOW Default : inrupt,smallrye.jwt.encrypt.key.id,smallrye.jwt.encrypt.key.location A comma-separated list of configuration property prefixes ( **case-sensitive** ) that determine which configurations are logged: * If the list is empty, **NO** configuration property is logged. * If a configuration property starts with a listed prefix ( **case-sensitive** ), the configuration property and its value are logged **unless** the configuration also matches a prefix in [**`INRUPT_LOGGING_CONFIGURATION_PREFIX_DENY`**](#inrupt_logging_configuration_prefix_deny) (which acts as a filter on [**`INRUPT_LOGGING_CONFIGURATION_PREFIX_ALLOW`**](#inrupt_logging_configuration_prefix_allow) list).\ As such, if the configuration matches prefix in both [**`INRUPT_LOGGING_CONFIGURATION_PREFIX_ALLOW`**](#inrupt_logging_configuration_prefix_allow) and [**`INRUPT_LOGGING_CONFIGURATION_PREFIX_DENY`**](#inrupt_logging_configuration_prefix_deny) , the [**`INRUPT_LOGGING_CONFIGURATION_PREFIX_DENY`**](#inrupt_logging_configuration_prefix_deny) takes precedence and the configuration is not logged. For example, if **`inrupt.`** is an allow prefix, but **`inrupt.kafka.`** is a deny prefix, all configurations that start with **`inrupt.kafka.`** are excluded from the logs. When specifying the prefixes, you can specify the prefixes using one of two formats: * using dot notation (e.g., **`inrupt.foobar.`** ), or * using the [MicroProfile Config environmental variables conversion value](https://quarkus.io/guides/config-reference#environment-variables) (e.g., **`INRUPT_FOOBAR_`** ). {% hint style="warning" %} **Warning**\ Use the same format for **both** [**`INRUPT_LOGGING_CONFIGURATION_PREFIX_ALLOW`**](#inrupt_logging_configuration_prefix_allow) and [**`INRUPT_LOGGING_CONFIGURATION_PREFIX_DENY`**](#inrupt_logging_configuration_prefix_deny). For example, if you change the format of [**`INRUPT_LOGGING_CONFIGURATION_PREFIX_ALLOW`**](#inrupt_logging_configuration_prefix_allow) , change the format of [**`INRUPT_LOGGING_CONFIGURATION_PREFIX_DENY`**](#inrupt_logging_configuration_prefix_deny) as well. {% endhint %} {% hint style="info" %} **Tip** To avoid allowing more than desired configurations, specify as much of the prefix as possible. If the prefix specifies the complete prefix term, include the term delineator. For example: * If using dot-notation, if you want to match configuration properties of the form **`foobar....`** , specify **`foobar.`** (including the dot **`.`** ) instead of, for example, **`foo`** or **`foobar`** . * If using converted form, if you want to match configuration properties of the form **`FOOBAR_...`** , specify **`FOOBAR_`** (including the underscore **`_`** ) instead of, for example, **`FOO`** or **`FOOBAR`** . {% endhint %} #### INRUPT\_LOGGING\_CONFIGURATION\_PREFIX\_DENY Default : inrupt.vc.sign.key-seed,inrupt.kafka A comma-separated list of configuration name prefixes ( **case-sensitive** ) that determines which configurations (that would otherwise match the [**`INRUPT_LOGGING_CONFIGURATION_PREFIX_ALLOW`**](#inrupt_logging_configuration_prefix_allow) ) are not logged. That is, [**`INRUPT_LOGGING_CONFIGURATION_PREFIX_DENY`**](#inrupt_logging_configuration_prefix_deny) acts as a filter on [**`INRUPT_LOGGING_CONFIGURATION_PREFIX_ALLOW`**](#inrupt_logging_configuration_prefix_allow) . For example: * If **`foobar.`** is an allowed prefix, to suppress **`foobar.private.`** , you can specify **`foobar.private.`** to the deny list. * If **`foobar.`** is **not** an allowed prefix, no property starting with **`foobar.`** is logged. As such, you do not need to specify **`foobar.private`** to the deny list. When specifying the prefixes, you can specify the prefixes using one of two formats: * using dot notation (e.g., **`inrupt.foobar.`** ), or * using the [MicroProfile Config environmental variables conversion value](https://quarkus.io/guides/config-reference#environment-variables) (e.g., **`INRUPT_FOOBAR_`** ). {% hint style="warning" %} Warning\ Use the same format for **both** [**`INRUPT_LOGGING_CONFIGURATION_PREFIX_ALLOW`**](#inrupt_logging_configuration_prefix_allow) and [**`INRUPT_LOGGING_CONFIGURATION_PREFIX_DENY`**](#inrupt_logging_configuration_prefix_deny). For example, if you change the format of [**`INRUPT_LOGGING_CONFIGURATION_PREFIX_ALLOW`**](#inrupt_logging_configuration_prefix_allow) , change the format of [**`INRUPT_LOGGING_CONFIGURATION_PREFIX_DENY`**](#inrupt_logging_configuration_prefix_deny) as well. {% endhint %} ### **Log Redaction** #### INRUPT\_LOGGING\_REDACTION\_NAME\_ACTION Default : **`REPLACE`** Type of the redaction to perform. Supported values are:
ActionDescription
REPLACEDefault. Replaces the matching text with a specified replacement.
PLAINLeaves the matching field unprocessed. Only available if the redaction target is a field (i.e.,INRUPT_LOGGING_REDACTION_{NAME}_FIELD).
DROPSuppresses the matching field. Only available if the redaction target is a field (i.e.,INRUPT_LOGGING_REDACTION_{NAME}_FIELD).
PRIORITIZEChanges the log level of the matching message.
SHA256Replaces the matching text with its hash.
* If the action is **`REPLACE`** ( *default* ), see also **`INRUPT_LOGGING_REDACTION_{NAME}_REPLACEMENT`** . * If the action is to **`PRIORITIZE`** , see also **`INRUPT_LOGGING_REDACTION_{NAME}_LEVEL`** . For more information on log redaction, see [Logging Redaction](https://docs.inrupt.com/ess/2.3/administration/logging/logging-redaction) #### INRUPT\_LOGGING\_REDACTION\_NAME\_ENABLED Default : **`true`** A boolean that determines whether the redaction configurations with the specified **`INRUPT_LOGGING_REDACTION_{NAME}_`** prefix is enabled. For more information on log redaction, see [Logging Redaction](https://docs.inrupt.com/ess/2.3/administration/logging/logging-redaction) #### INRUPT\_LOGGING\_REDACTION\_NAME\_EXCEPTION Fully qualified name of the exception class to match in the log messages (includes inner exception). Configure to target an exception message class. For more information on log redaction, see [Logging Redaction](https://docs.inrupt.com/ess/2.3/administration/logging/logging-redaction) #### INRUPT\_LOGGING\_REDACTION\_NAME\_FIELD Exact name of the field to match in the log messages. Configure to target a specific log message field for redaction. For more information on log redaction, see [Logging Redaction](https://docs.inrupt.com/ess/2.3/administration/logging/logging-redaction) #### INRUPT\_LOGGING\_REDACTION\_NAME\_LEVEL A new log level to use for the log message if the **`INRUPT_LOGGING_REDACTION_{NAME}_ACTION`** is **`PRIORITIZE`** . #### INRUPT\_LOGGING\_REDACTION\_NAME\_PATTERN A regex (see [Java regex pattern](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/regex/Pattern.html#sum) ) to match in the log messages. Configure to target log message text that matches a specified pattern. For more information on log redaction, see [Logging Redaction](https://docs.inrupt.com/ess/2.3/administration/logging/logging-redaction) #### INRUPT\_LOGGING\_REDACTION\_NAME\_REPLACEMENT Replacement text to use if the **`INRUPT_LOGGING_REDACTION_{NAME}_ACTION`** is **`REPLACE`** . If unspecified, defaults to **`[REDACTED]`** . For more information on log redaction, see [Logging Redaction](https://docs.inrupt.com/ess/2.3/administration/logging/logging-redaction) ### **Application-Defined Metadata Propagation** #### INRUPT\_AUDIT\_PRODUCER\_REQUEST\_METADATA\_ALLOW A comma-separated list of application-defined properties that can be included in the associated audit events (unless specified in the corresponding [**`INRUPT_AUDIT_PRODUCER_REQUEST_METADATA_DENY`**](#inrupt_audit_producer_request_metadata_deny) ). This configuration is **case-sensitive** to the propagated properties in the baggage. {% hint style="info" %} **Tip** To include a propagated property that was added via the [**`INRUPT_REQUEST_METADATA_PROPAGATOR_HEADER_ALLOW`**](#inrupt_request_metadata_propagator_header_allow) configuration, ensure that the cases of these properties match. {% endhint %} See: * [Manage Application-Defined Metadata Propagation](https://docs.inrupt.com/ess/2.3/installation/customize-configurations/customization-logging/manage-app-defined-metadata) to configure. * [Application-Defined Metadata](https://docs.inrupt.com/ess/2.3/administration/application-defined-metadata) for more information. #### INRUPT\_AUDIT\_PRODUCER\_REQUEST\_METADATA\_DENY A comma-separated list of application-defined properties to exclude from the associated audit messages. This setting takes precedence over [**`INRUPT_AUDIT_PRODUCER_REQUEST_METADATA_ALLOW`**](#inrupt_audit_producer_request_metadata_allow) . This configuration is **case-sensitive** to the propagated properties in the baggage. {% hint style="info" %} **Tip** To exclude a propagated property that was added via the [**`INRUPT_REQUEST_METADATA_PROPAGATOR_HEADER_ALLOW`**](#inrupt_request_metadata_propagator_header_allow) configuration, ensure that the cases of these properties match. {% endhint %} See: * [Manage Application-Defined Metadata Propagation](https://docs.inrupt.com/ess/2.3/installation/customize-configurations/customization-logging/manage-app-defined-metadata) to configure. * [Application-Defined Metadata](https://docs.inrupt.com/ess/2.3/administration/application-defined-metadata) for more information. #### **INRUPT\_LOGGING\_REQUEST\_METADATA\_ALLOW** A comma-separated list of application-defined properties that can be included in the associated [log messages](https://docs.inrupt.com/ess/administration/logging#application-defined-metadata) (unless specified in the corresponding [**`INRUPT_LOGGING_REQUEST_METADATA_DENY`**](#inrupt_logging_request_metadata_deny) ). This configuration is **case-sensitive** to the propagated properties in the baggage. {% hint style="info" %} **Tip** To include a propagated property that was added via the [**`INRUPT_REQUEST_METADATA_PROPAGATOR_HEADER_ALLOW`**](#inrupt_request_metadata_propagator_header_allow) configuration, ensure that the cases of these properties match. {% endhint %} See: * [Manage Application-Defined Metadata Propagation](https://docs.inrupt.com/ess/2.3/installation/customize-configurations/customization-logging/manage-app-defined-metadata) to configure. * [Application-Defined Metadata](https://docs.inrupt.com/ess/2.3/administration/application-defined-metadata) for more information. #### **INRUPT\_LOGGING\_REQUEST\_METADATA\_DENY** A comma-separated list of application-defined properties to exclude from the associated log messages. This setting takes precedence over [**`INRUPT_LOGGING_REQUEST_METADATA_ALLOW`**](#inrupt_logging_request_metadata_allow) . This configuration is **case-sensitive** to the propagated properties in the baggage. {% hint style="info" %} **Tip** To exclude a propagated property that was added via the [**`INRUPT_REQUEST_METADATA_PROPAGATOR_HEADER_ALLOW`**](#inrupt_request_metadata_propagator_header_allow) configuration, ensure that the cases of these properties match. {% endhint %} See: * [Manage Application-Defined Metadata Propagation](https://docs.inrupt.com/ess/2.3/installation/customize-configurations/customization-logging/manage-app-defined-metadata) to configure. * [Application-Defined Metadata](https://docs.inrupt.com/ess/2.3/administration/application-defined-metadata) for more information. #### **INRUPT\_REQUEST\_METADATA\_PROPAGATOR\_HEADER\_ALLOW** A comma-separated list of non-baggage request headers to add to the [baggage](https://www.w3.org/TR/baggage/) (unless specified in the corresponding [**`INRUPT_REQUEST_METADATA_PROPAGATOR_HEADER_DENY`**](#inrupt_request_metadata_propagator_header_deny) i.e., include these non-baggage request headers as application-defined properties. The configuration is case-insensitive; i.e., the listed headers do **not** need to match the case of the client request headers. For example, a list that includes **`x-correlation-id`** can match **`x-correlation-id`** header, **`X-CoRrElAtIoN-Id`** header, etc. See: * [Manage Application-Defined Metadata Propagation](https://docs.inrupt.com/ess/2.3/installation/customize-configurations/customization-logging/manage-app-defined-metadata) to configure. * [Application-Defined Metadata](https://docs.inrupt.com/ess/2.3/administration/application-defined-metadata) for more information. #### **INRUPT\_REQUEST\_METADATA\_PROPAGATOR\_HEADER\_DENY** A comma-separated list of non-baggage request headers to exclude from being added to the [baggage](https://www.w3.org/TR/baggage/); i.e., excludes these headers as application-defined properties. This setting takes precedence over [**`INRUPT_REQUEST_METADATA_PROPAGATOR_HEADER_ALLOW`**](#inrupt_request_metadata_propagator_header_allow) . The configuration is case-insensitive; i.e., the listed headers do **not** need to match the case of the client request headers. For example, a list that includes **`x-correlation-id`** can match (and exclude) **`x-correlation-id`** header, **`X-CoRrElAtIoN-Id`** header, etc. See: * [Manage Application-Defined Metadata Propagation](https://docs.inrupt.com/ess/2.3/installation/customize-configurations/customization-logging/manage-app-defined-metadata) to configure. * [Application-Defined Metadata](https://docs.inrupt.com/ess/2.3/administration/application-defined-metadata) for more information. #### **INRUPT\_REQUEST\_METADATA\_PROPAGATOR\_HEADER\_OVERRIDES** A flag that determines ESS behavior when metadata property is defined both as a header and as a baggage entry: * If **`true`** ESS updates/overrides the baggage entry with the header value. * If **`false`** (the default), ESS keeps the baggage entry. For details, [Duplicate Property Definition](https://docs.inrupt.com/ess/administration/application-defined-metadata#duplicate-property-definition) #### **INRUPT\_REQUEST\_METADATA\_REFLECTOR\_HEADER\_ALLOW** A comma-separated list of application-defined properties that can return as response headers (unless specified in the corresponding [**`INRUPT_REQUEST_METADATA_REFLECTOR_HEADER_DENY`**](#inrupt_request_metadata_reflector_header_deny) ). This configuration is **case-sensitive** to the propagated properties in the baggage. {% hint style="info" %} **Tip** * To return a propagated property that was added via the [**`INRUPT_REQUEST_METADATA_PROPAGATOR_HEADER_ALLOW`**](#inrupt_request_metadata_propagator_header_allow) configuration, ensure that the cases of these properties match. * You may need to update **`QUARKUS_HTTP_CORS_EXPOSED_HEADERS`** to extend the list of [CORS-safelisted response headers](https://developer.mozilla.org/en-US/docs/Glossary/CORS-safelisted_response_header) . {% endhint %} See: * [Manage Application-Defined Metadata Propagation](https://docs.inrupt.com/ess/2.3/installation/customize-configurations/customization-logging/manage-app-defined-metadata) to configure. * [Application-Defined Metadata](https://docs.inrupt.com/ess/2.3/administration/application-defined-metadata) for more information. #### **INRUPT\_REQUEST\_METADATA\_REFLECTOR\_HEADER\_DENY** A comma-separated list of application-defined properties to exclude from returning as response headers. This setting takes precedence over [**`INRUPT_REQUEST_METADATA_REFLECTOR_HEADER_ALLOW`**](#inrupt_request_metadata_reflector_header_allow) . This configuration is **case-sensitive** to the propagated properties in the baggage. {% hint style="info" %} **Tip** To exclude a propagated property that was added via the [**`INRUPT_REQUEST_METADATA_PROPAGATOR_HEADER_ALLOW`**](#inrupt_request_metadata_propagator_header_allow) configuration, ensure that the cases of these properties match. {% endhint %} See: * [Manage Application-Defined Metadata Propagation](https://docs.inrupt.com/ess/2.3/installation/customize-configurations/customization-logging/manage-app-defined-metadata) to configure. * [Application-Defined Metadata](https://docs.inrupt.com/ess/2.3/administration/application-defined-metadata) for more information. ### **Purge Configuration** The Access Grant Service contains user data, and as such it can be purged upon user request. See the [Purger documentation](https://docs.inrupt.com/ess/2.3/services/purger-application) for more information about the data being purged. #### INRUPT\_PURGE\_BATCH\_SIZE Default: **`100`** The maximum number of credentials that the purge task will purge in each batch. This must be a non-zero, positive integer. #### INRUPT\_PURGE\_CLEANUP\_TASK\_EVERY Default : **`PT5H`** Frequency at which a task goes through stored purge statuses to clear any which are beyond their retention window. #### INRUPT\_PURGE\_IN\_PROGRESS\_TIMEOUT\_SECONDS Default: **`120`** Timeout after which an ongoing purge task is considered stale. Stale tasks are picked up by an ESS background process to be taken to completion. By keeping track of a purge task’s state (active or stale) the service can ensure that a purge which was started will eventually reach completion, even if the system is disrupted whilst the asynchronous purge process is ongoing. #### INRUPT\_PURGE\_PROCESS\_TASK\_EVERY Default: **`PT5M`** Frequency at which an ESS background process goes through ongoing purges to pick up the incomplete stale ones. See **`INRUPT_PURGE_IN_PROGRESS_TIMEOUT_SECONDS`** for additional details. #### INRUPT\_PURGE\_STATUS\_RETENTION\_WINDOW Default: **P2D** Duration after which a purge task status will be cleared from storage. The purge task contains some Personally Identifying Data (such as the WebID), so ensuring it is cleared after a purge is required for compliance. ### Additional Information See also [Quarkus Configuration Options](https://quarkus.io/guides/all-config). Whitespaces are **preserved** when parsing comma-delimited lists (i.e., the parsed string values are not trimmed). For example, when parsed, **`"value1, value2,value3 "`** results in **`"value1"`** , **`" value2"`** , **`"value3 "`** . Features based on draft specifications are subject to change.