# WebID Service ESS introduces a separate service to host and manage [WebIDs](https://docs.inrupt.com/reference/glossary#webid) and the corresponding Profile Documents. ## WebID and Profile Document According to the [WebID draft specification](https://www.w3.org/2005/Incubator/webid/spec/identity/#terminology), a WebID is a URL that identifies an agent. * ESS’ WebID service creates WebIDs of the form: ```none https://id.{ESS DOMAIN}/{username} ``` * The WebID profile document is no longer hosted in the user’s Pod. * ESS creates an [extended profile](https://docs.inrupt.com/ess/2.5/service-pod-management/service-pod-provision#default-resource-extended-profile) resource, separate from the public WebID profile. The extended profile resource, unlike the WebID profile, is hosted in the agent’s Pod, and by default, is private. The agents can grant or deny access to their extended profile like any other resource in their Pod. For more information, see [extended profile](https://docs.inrupt.com/ess/2.5/service-pod-management/service-pod-provision#default-resource-extended-profile) in the [Pod Provisioning Service](https://docs.inrupt.com/ess/2.5/services/service-pod-management/service-pod-provision). Prior to version 2.0, ESS issued WebIDs of the form **`https://{ESS Domain}/{username}/profile/card#me`** , which were hosted in the user’s Pod. ### WebID Profile Document The WebID URL dereferences to the agent’s WebID profile, where the profile is a document that describes the agent. The ESS WebID Service ensures that the WebID Profile document is a valid [RDF document](https://docs.inrupt.com/reference/glossary#rdf-resource). #### **WebID Profile Document Constraints** ESS enforces the following constraints on the RDF data model in the WebID Profile: * The document must contain the following **`solid:oidcIssuer`** triple : ```turtle solid:oidcIssuer . ``` where * **``** is the agent’s WebID * **``** is the configured [**`INRUPT_WEBID_ISSUER`**](#inrupt_webid_issuer) value. * For all **`solid:oidcIssuer`** triples, * The subject must be the agent’s WebID URL. * The object must be a valid HTTP(S) URL. * If an **`rdf:type`** triple is present in the WebID Profile Document, its value must be one of: * **`foaf:Agent`** * **`foaf:Group`** * **`foaf:Person`** * **`foaf:Organization`** where **`foaf:`** is the namespace prefix for **`http://xmlns.com/foaf/0.1/`** .\ For example, ```turtle a foaf:Agent. ``` * For any **`foaf:isPrimaryTopicOf`** triples, the object must be an HTTP(S) URL. * For any **`pim:storage`** triples, the object must be an HTTP(S) URL. ESS allows any other RDF triples, without constraints, in the WebID profile. ## WebID Profile Document Endpoints The WebID service provides various endpoints for managing ([get](#fetch-a-profile-document), [create](#create-a-profile-document), [replace](#replace-a-profile-document), [add storage info](#add-pod-location-to-profile-document), [delete](#delete-a-profile-document)) the WebID profile document. ### Authentication and Authorization Requirements The operations to create and modify the WebID profile ( [create](#create-a-profile-document), [replace](#replace-a-profile-document), [update with storage info](#add-pod-location-to-profile-document), [delete](#delete-a-profile-document)) have authentication and authorization requirements: * Agents must be authenticated. * The agent’s ID token must be issued by an approved issuer. See [**`INRUPT_JWT_ISSUER_ALLOW_LIST`**](#inrupt_jwt_issuer_allow_list) for details. * Agents can only use approved applications to create and modify their WebID profile. See [**`INRUPT_WEBID_ALLOWED_CLIENT_IDS`**](#inrupt_webid_allowed_client_ids) for details. * Agents can only create and modify their own WebID. Specifically, the WebID service checks that the **`webid`** claim in the agent’s [ID token](https://docs.inrupt.com/ess/2.5/service-oidc#tokens-and-claims) matches the specified **`https://id.{ESS DOMAIN}/{username}`** endpoint. ### Fetch a Profile Document A client can retrieve the profile associated with a WebID by issuing a **`GET`** request to the WebID:
Method:GET
Endpoint:https://id.{ESS DOMAIN}/{username}
Accept:text/turtle
Body:N/A
Content-Type:N/A
{% hint style="info" %} **Tip**\ Per the [WebID draft specification](https://www.w3.org/2005/Incubator/webid/spec/identity/#terminology) , an HTTP request on the WebID can return a redirect status ( **`303`** ) along with the profile document URL in the **`Location`** header. As such, a client may need to handle the HTTP redirection according to its needs (e.g., **`follow`** the redirect automatically or **`error`** ). {% endhint %} Alternatively, if the profile document URL is the WebID with a file extension (e.g., **`.Turtle`** , **`.jsonld`** ), you can issue a **`GET`** request directly to the profile document URL. Upon successful fetch, the response includes a status of **`200 OK`** (including when the client automatically follows the redirect) and the profile document in its body. ### Create a Profile Document {% hint style="warning" %} **Important**\ The operation has authentication and authorization requirements. See [Authentication and Authorization Requirements](#authentication-and-authorization-requirements). {% endhint %} To create a WebID profile document if one does not already exist for the WebID, issue a **`POST`** request to the WebID:
Method:POST
Endpoint:https://id.{ESS DOMAIN}/{username}
Body:N/A
Content-Type:N/A
{% hint style="info" %} **Note**\ If the WebID profile document already exists, the **`POST`** request returns a **`400 Bad Request`** error. {% endhint %} Upon successful creation of a WebID profile document, the response includes a status of **`201 Created`** . The newly created WebID profile document has the following content: ```turtle @prefix foaf: . @prefix solid: . @prefix rdfs: . a foaf:Agent; solid:oidcIssuer <{WEBID_ISSUER}/>. ``` Where the **`{WEBID_ISSUER}`** is the configured [**`INRUPT_WEBID_ISSUER`**](#inrupt_webid_issuer) value. ### Replace a Profile Document {% hint style="warning" %} **Important**\ The operation has authentication and authorization requirements. See [Authentication and Authorization Requirements](#authentication-and-authorization-requirements). {% endhint %} To replace an existing WebID profile document, issue a **`PUT`** request with a valid replacement profile document to the WebID:
Method:PUT
Endpoint:https://id.{ESS DOMAIN}/{username}
Body:

A profile document that conform to the WebID service’s constraints.

If the document does not conform to the service constraints, a 400 Bad Request error is returned.

Content-Type:text/turtle
Upon successful update, the response includes a status of **`204 No Content`** . ### Add Pod Location to Profile Document {% hint style="warning" %} **Important**\ The operation has authentication and authorization requirements. See [Authentication and Authorization Requirements](#authentication-and-authorization-requirements). {% endhint %} To add a Pod Location to a WebID profile document, issue a **`POST`** request to the **`{WebID}/provision`** endpoint:
Method:POST
Endpoint:https://id.{ESS DOMAIN}/{username}/provision
Body:

A JSON document:

{
   "@context": {
      "id":"@id",
      "storage":{
         "@type":"@id",
         "@id":"http://www.w3.org/ns/pim/space#storage"
      },
      "profile":{
         "@type":"@id",
         "@id":"http://xmlns.com/foaf/0.1/isPrimaryTopicOf"
      }
   },
   "id":"{WebID}",
   "profile":"{extended Profile Resource stored on the Pod}",
   "storage":"{HTTP(S) Pod URL}"
}

See also Pod Provisioning Service.

Content-Type:application/json
### Delete a Profile Document {% hint style="warning" %} **Important**\ The operation has authentication and authorization requirements. {% endhint %} To delete a WebID profile document, issue a **`DELETE`** request to the WebID:
Method:DELETE
Endpoint:https://id.{ESS DOMAIN}/{username}
Body:N/A
Content-Type:N/A
Upon successful delete, the response includes a status of **`204 No Content`** . ## WebID Service Configuration As part of the [installation process](https://docs.inrupt.com/ess/2.5/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. {% hint style="info" %} **Note**\ 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 "`** . {% endhint %} ### Required These WebID service configuration options are set as part of [updating the inputs for your deployment](https://docs.inrupt.com/ess/installation#step-1-initialize-the-installation-directory). #### INRUPT\_JWT\_ISSUER\_ALLOW\_LIST A comma-separated list of trusted Solid-OIDC issuers (i.e., identity providers). {% hint style="info" %} **Tip** * Ensure that [**`INRUPT_JWT_ISSUER_ALLOW_LIST`**](#inrupt_jwt_issuer_allow_list) includes the configured [**`INRUPT_WEBID_ISSUER`**](#inrupt_webid_issuer) value. * If your application, such as a start app, provisions the Pod and updates the WebID with the provisioned Pod information, ensure that the WebID service’s [**`INRUPT_JWT_ISSUER_ALLOW_LIST`**](#inrupt_jwt_issuer_allow_list) overlaps with the [**`INRUPT_JWT_ISSUER_ALLOW_LIST`**](https://docs.inrupt.com/ess/2.5/service-pod-management/service-pod-provision#inrupt_jwt_issuer_allow_list) value set for the [Pod Provision Service](https://docs.inrupt.com/ess/2.5/services/service-pod-management/service-pod-provision). {% endhint %} {% hint style="warning" %} **Important** For the WebID service, you must set [**`INRUPT_JWT_ISSUER_ALLOW_LIST`**](#inrupt_jwt_issuer_allow_list) to a non-empty list. If the list is empty, the WebID service throws an error. {% endhint %} The WebID service uses the [**`INRUPT_JWT_ISSUER_ALLOW_LIST`**](#inrupt_jwt_issuer_allow_list) to check the issuer **`iss`** claim (from the agent’s [ID token](https://docs.inrupt.com/ess/2.5/service-oidc#tokens-and-claims)), accepting only 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. All other issuers are rejected with a **`401 Unauthorized`** error. See also [**`INRUPT_JWT_ISSUER_DENY_LIST`**](#inrupt_jwt_issuer_deny_list). #### INRUPT\_PROVISION\_HTTP\_BASE\_URL The base URL of the [Pod Provision Service](https://docs.inrupt.com/ess/2.5/services/service-pod-management/service-pod-provision). This is used by the WebID Service to link to the Pod Provisioning Service. {% hint style="warning" %} **Important** The value requires a trailing slash **`/`** ; e.g., **`https://provision.{ESS_DOMAIN}/`** . {% endhint %} #### INRUPT\_START\_CLIENT\_ID Default : **`https://start.{ESS_DOMAIN}/app/id`** The [Solid-OIDC Client ID](https://github.com/inrupt/docs-gitbook/blob/main/ess/security/authentication.md#client-identifier-client-id) of the [start application](https://docs.inrupt.com/ess/2.5/services/service-start). The default start app can handle: * User sign up/log in, and * Provisioning of the user’s [WebID](https://docs.inrupt.com/ess/2.5/services/service-webid) and [Pod](https://docs.inrupt.com/ess/2.5/services/service-pod-management/service-pod-provision). #### INRUPT\_WEBID\_ALLOWED\_CLIENT\_IDS Default : [**`INRUPT_START_CLIENT_ID`**](#inrupt_start_client_id), [**`INRUPT_WEBID_CLIENT_ID`**](#inrupt_webid_client_id) Comma-delimited list of Solid-OIDC Client IDs. The list determines which clients are authorized to modify the WebID profile documents. Specifically, the WebID service uses [**`INRUPT_WEBID_ALLOWED_CLIENT_IDS`**](#inrupt_webid_allowed_client_ids) to check the authorized party **`azp`** claim from the agent’s [ID token](https://docs.inrupt.com/ess/2.5/service-oidc#broker-token-claims). #### INRUPT\_WEBID\_CLIENT\_ID Default : **`https://id.{ESS_DOMAIN}/app/id`** The URL of the WebID editor application. #### INRUPT\_WEBID\_ISSUER Default : **`https://openid.{ESS DOMAIN}`** The required issuer that must appear in the WebID profile documents. See [WebID Profile Document Constraints](#webid-profile-document-constraints) . {% hint style="info" %} **Tip** Ensure this issuer is in the [**`INRUPT_JWT_ISSUER_ALLOW_LIST`**](#inrupt_jwt_issuer_allow_list). {% endhint %} See also [**`INRUPT_OPENID_ISSUER`**](#inrupt_webid_issuer). #### QUARKUS\_DATASOURCE\_JDBC\_URL The JDBC connection string for the persistence datasource. For example, **`jdbc:postgresql://HOSTNAME/DATABASE-NAME`** . #### QUARKUS\_DATASOURCE\_PASSWORD The password for connecting to the persistence datasource. #### QUARKUS\_DATASOURCE\_USERNAME The username for connecting to the persistence datasource. ### Kafka Configuration {% hint style="info" %} **Tip**\ See also [ESS’ Kafka Configuration](https://docs.inrupt.com/ess/2.5/services/appendix/appendix-kafka-configuration). {% endhint %} #### INRUPT\_KAFKA\_AUDITV1EVENTSENCRYPTED\_CIPHER\_PASSWORD The strong cipher key to use when running auditing with encrypted messages over the **`auditv1eventsencrypted`** topic. #### 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, iincluding 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). This 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://docs.inrupt.com/ess/2.5/services/appendix/appendix-kafka-configuration). ### Optional ### **Configuration Logging** ESS services log their startup configuration. #### INRUPT\_LOGGING\_CONFIGURATION\_PREFIX\_ALLOW Default : inrupt,smallrye.jwt.expiration.grace,mp.jwt.verify.clock.skew,smallrye.jwt.always-check-authorization,smallrye.jwt.token.decryption.kid,smallrye.jwt.token.schemes,smallrye.jwt.require.named-principal,smallrye.jwt.time-to-live,smallrye.jwt.jwks.refresh-interval,smallrye.jwt.jwks.forced-refresh-interval,smallrye.jwt.required.claims,mp.jwt.verify.audiences 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="danger" %} **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.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="danger" %} **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 %} #### 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 **`PRIORITIZE`**, see also **INRUPT\_LOGGING\_REDACTION\_{NAME}\_LEVEL**. For more information on log redaction, see [Logging Redaction](https://docs.inrupt.com/ess/2.5/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.5/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.5/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.5/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.5/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.5/administration/logging/logging-redaction). #### INRUPT\_AUDIT\_PRODUCER\_REQUEST\_METADATA\_ALLOW A comma-separated list of application-defined properties that can be included in the associated [audit events](https://github.com/inrupt/docs-gitbook/blob/main/enterprise-solid-server/2.5/service-auditing/README.md#event-message-instrument-app-defined-metadata) (unless specified in the corresponding [**`INRUPT_AUDIT_PRODUCER_REQUEST_METADATA_DENY`**](#inrupt_audit_producer_request_metadata_deny)). See: * [Manage Application-Defined Metadata Propagation](https://docs.inrupt.com/ess/2.5/installation/customize-configurations/customization-logging/manage-app-defined-metadata) to configure. * [Application-Defined Metadata](https://docs.inrupt.com/ess/2.5/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). See: * [Manage Application-Defined Metadata Propagation](https://docs.inrupt.com/ess/2.5/installation/customize-configurations/customization-logging/manage-app-defined-metadata) to configure. * [Application-Defined Metadata](https://docs.inrupt.com/ess/2.5/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://github.com/inrupt/docs-gitbook/blob/main/enterprise-solid-server/2.5/administration/tutorial/logging/README.md#log-app-defined-metadata) (unless specified in the corresponding [**`INRUPT_LOGGING_REQUEST_METADATA_DENY`**](#inrupt_logging_request_metadata_deny)). See: * [Manage Application-Defined Metadata Propagation](https://docs.inrupt.com/ess/2.5/installation/customize-configurations/customization-logging/manage-app-defined-metadata) to configure. * [Application-Defined Metadata](https://docs.inrupt.com/ess/2.5/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). See: * [Manage Application-Defined Metadata Propagation](https://docs.inrupt.com/ess/2.5/installation/customize-configurations/customization-logging/manage-app-defined-metadata) to configure. * [Application-Defined Metadata](https://docs.inrupt.com/ess/2.5/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.5/installation/customize-configurations/customization-logging/manage-app-defined-metadata) to configure. * [Application-Defined Metadata](https://docs.inrupt.com/ess/2.5/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.5/installation/customize-configurations/customization-logging/manage-app-defined-metadata) to configure. * [Application-Defined Metadata](https://docs.inrupt.com/ess/2.5/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/latest/administration/application-defined-metadata) . #### 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.5/installation/customize-configurations/customization-logging/manage-app-defined-metadata) to configure. * [Application-Defined Metadata](https://docs.inrupt.com/ess/2.5/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.5/installation/customize-configurations/customization-logging/manage-app-defined-metadata) to configure. * [Application-Defined Metadata](https://docs.inrupt.com/ess/2.5/administration/application-defined-metadata) for more information. ### **Purge Configuration** The WebID service contains user data, and as such it can be purged upon user request. See the [Purger documentation](https://docs.inrupt.com/ess/2.5/services/service-purger) 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. {% hint style="info" %} Added in version 2.3.0. {% endhint %} #### 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. {% hint style="info" %} Added in version 2.3.0. {% endhint %} #### 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. {% hint style="info" %} Added in version 2.3.0. {% endhint %} #### 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. {% hint style="info" %} Added in version 2.3.0. {% endhint %} #### 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. {% hint style="info" %} Added in version 2.3.0. {% endhint %} ### General #### 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\_DENY\_LIST A comma-separated list of disallowed Solid-OIDC issuers. * If unset, the service accepts all Solid-OIDC issuers unless [**`INRUPT_JWT_ISSUER_ALLOW_LIST`**](#inrupt_jwt_issuer_allow_list) is set, in which case, the service only accepts those in the [**`INRUPT_JWT_ISSUER_ALLOW_LIST`**](#inrupt_jwt_issuer_allow_list) . * If set, the service disallows the Solid-OIDC 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. #### INRUPT\_WEBID\_CLIENT\_CONTACTS A comma-delimited list of contacts (either email addresses or WebID URLs) for the client associated with the default Solid-OIDC Client ID. See [**`INRUPT_WEBID_ALLOWED_CLIENT_IDS`**](#inrupt_webid_allowed_client_ids) . #### INRUPT\_WEBID\_CLIENT\_LOGO\_URI Default : **`https://{ESS DOMAIN}/logo.png`** The application logo for the client associated with the default Solid-OIDC Client ID. See [**`INRUPT_WEBID_ALLOWED_CLIENT_IDS`**](#inrupt_webid_allowed_client_ids) . #### INRUPT\_WEBID\_CLIENT\_NAME Default : **`Inrupt WebID Manager`** The name of the client associated with the default Solid-OIDC Client ID. See [**`INRUPT_WEBID_ALLOWED_CLIENT_IDS`**](#inrupt_webid_allowed_client_ids) . #### INRUPT\_WEBID\_CLIENT\_TOS\_URI The URL for a terms of service document for the client associated with the default Solid-OIDC Client ID. See [**`INRUPT_WEBID_ALLOWED_CLIENT_IDS`**](#inrupt_webid_allowed_client_ids) . #### QUARKUS\_LOG\_LEVEL Default : **`INFO`** Logging level. ## Additional Information See also [Quarkus Configuration Options](https://quarkus.io/guides/all-config) .