Access Grant Service#
Starting in version 2.0, ESS supports an authorization mechanism based on Access Requests and Grants. With Access Requests and Grants:
An agent sends an Access Request to the resource owner. This request includes the specific access mode(s) (e.g.
Read
,Write
,Append
), the resource(s) to access, etc. See Access Request Shape.The resource owner approves or denies the Access Request.
For an approved request, ESS creates an Access Grant with an
approved
status.For a denied request, ESS creates an Access Grant with a
denied
status.
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.
Important
Starting in version 2.1:
An access request for a Container, by default, also applies to the Container’s descendants, unless explicitly specified otherwise in the request (See inherit: false).
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).
In the previous version, access request/grant applied only to the explicitly stated resource or resources in the access request/grant, regardless of whether the resource is a Container, an Resource Description Framework (RDF) Resource, or a Non-RDF Resource.
See also Enable Access Grant Usage (ACP).
Access Grant Service#
ESS provides an Access Grant Service that serializes Access Requests and Grants as Verifiable Credentials (VCs) and provides various Access Grants endpoints that follow the draft VC API. [2]
ESS Access Grant Service Endpoints#
By default, the ESS Access Grant Service runs from the following root URL:
https://vc.<ESS Domain>
To change the root URL, see INRUPT_VC_ISSUER
.
The ESS Access Grant Service consists of the following endpoints:
Endpoint |
Description |
---|---|
|
Issues Access Requests and Grants that are serialized as VCs. |
|
Verifies Access Requests and Grants that are serialized as VCs. |
|
Updates the status of an Access Grant. |
|
Query for Access Requests and Grants using filters. |
|
Query 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 (Starting in 2.1)
See also:
Client Allow Lists#
Note
Starting in 2.2.1, 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.
To restrict client access to the /issue
and /status
endpoints, see:
INRUPT_VC_CLIENT_ID_ALLOW_LIST_SOLIDACCESSREQUEST
(Defaults toAny
.)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
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:
https://vc.<ESS Domain>/.well-known/vc-configuration
The endpoint returns a JSON-LD 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, 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. 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.<ESS DOMAIN>
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
andQUARKUS_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
andQUARKUS_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
andQUARKUS_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
.
Kafka Configuration#
Tip
See also ESS’ Kafka Configuration.
- INRUPT_KAFKA_AUDITV1EVENTSENCRYPTED_CIPHER_PASSWORD#
The strong cipher key to use when running auditing with encrypted messages.
Added in version 2.1.5.
- INRUPT_KAFKA_AUDITV1EVENTSPRODUCERENCRYPTED_CIPHER_PASSWORD#
The strong cipher key to use when running auditing with encrypted messages over the
auditv1eventsproducerencrypted
topic.Added in version 2.2.0.
- 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
configures ESS to use the same Kafka instance(s) for all its Kafka message channels (e.g.,solidresource
andauditv1out
message channels). The Access Grant service uses theauditv1out
message channel.Note
Inrupt-provided overlays default to using
KAFKA_BOOTSTRAP_SERVERS
.To use a different Kafka instance for the
auditv1out
channel, use specific message channel configuration.See also ESS’ Kafka Configuration.
UMA Configuration#
- INRUPT_AUTHZ_AS_URI#
The URI of the UMA Authorization Server.
The value must match:
INRUPT_JWT_AUTHORIZATION_SERVER_ISSUER
configuration for the service, andINRUPT_UMA_ISSUER
configuration for UMA Service.
Added in version 2.1.
- INRUPT_JWT_AUTHORIZATION_SERVER_ISSUER#
The URI of the UMA token issuer.
The value must match
INRUPT_AUTHZ_AS_URI
.Added in version 2.1.
- INRUPT_JWT_AUTHORIZATION_SERVER_JWKS#
The JWKS endpoint of the
INRUPT_JWT_AUTHORIZATION_SERVER_ISSUER
.Added in version 2.1.
OIDC Configuration#
- INRUPT_JWT_ALLOWED_SIGNATURE_ALGORITHMS#
Default:
ES256
,RS256
A comma-separated list that specifies the allowed encryption algorithms used to sign ID tokens.
- INRUPT_JWT_ISSUER_ALLOW_LIST#
A comma-separated list [1] 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
.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
andINRUPT_JWT_ISSUER_DENY_LIST
, theINRUPT_JWT_ISSUER_DENY_LIST
supersedes theINRUPT_JWT_ISSUER_ALLOW_LIST
and the issuer is not accepted by ESS.
See also
INRUPT_JWT_ISSUER_DENY_LIST
.Tip
Ensure that ESS UMA service’
INRUPT_JWT_ISSUER_ALLOW_LIST
is consistent with theINRUPT_JWT_ISSUER_ALLOW_LIST
value set for this service.
- INRUPT_JWT_ISSUER_DENY_LIST#
A comma-separated list [1] of disallowed issuers of Solid-OIDC tokens.
If unset, the service accepts Solid-OIDC tokens from all issuers unless
INRUPT_JWT_ISSUER_ALLOW_LIST
is set, in which case, the service only accepts tokens from those in theINRUPT_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
is also set, issuers not in theINRUPT_JWT_ISSUER_ALLOW_LIST
are also disallowed.
Tip
Ensure that ESS’ UMA service’s
INRUPT_JWT_ISSUER_DENY_LIST
is consistent with theINRUPT_JWT_ISSUER_DENY_LIST
value set for this service.
Allow List Configuration#
- INRUPT_VC_CLIENT_ID_ALLOW_LIST_SOLIDACCESSGRANT#
Determines which applications can access the /issue Endpoint and the /status Endpoint for access grants; i.e., can be used to issue and revoke access requests.
The value can be either:
A comma-delimited list [1] of the applications (specifically, their Client IDs) 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.
Added in version 2.2.1.
- INRUPT_VC_CLIENT_ID_ALLOW_LIST_SOLIDACCESSREQUEST#
Default:
Any
Determines which applications can access the /issue Endpoint and the /status Endpoint for access requests; i.e., can be used to issue and revoke access requests.
The value can be either:
A comma-delimited list [1] of the applications (specifically, their Client IDs) 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.
Added in version 2.2.1.
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#
Default:
100
The maximum number of entries in the internal cache of remote JSON-LD context documents.
See also:
- INRUPT_JSONLD_CONTEXT_ALLOW_LIST#
Default:
https://vc.{ESS DOMAIN}/credentials/v1
A comma-delimited list [1] 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/v1.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
Recommended
If possible, set this configuration value to that of the
UMA Service
. Mismatched values may result in the failure to parse access request/grant VCs.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
) is allowed, including untrusted and malicious contexts.See also:
- 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_HTTP_MAX_REDIRECTS#
Default:
10
The maximum number of redirects allowed when fetching JSON-LD context documents.
See also:
- INRUPT_JSONLD_HTTP_TIMEOUT#
Default:
10
The timeout in seconds for fetching a remote JSON-LD context document.
See also:
- 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_LOG_LEVEL#
Default:
INFO
Logging level.
/issue
Endpoint Configuration#
- INRUPT_VC_MAX_DURATION#
Default:
P365D
(Starting in 2.2)A maximum duration (i.e., expiration time) for the issued access requests/grants. Specify the value in a format supported by Java Duration.parse() method, such as
PT2H
(2 hours) orP180D
(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, starting in 2.2, 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, starting in 2.2, uses the calculated date as the expiration date.
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.
/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#
Starting in 2.2, 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
(which acts as a filter onINRUPT_LOGGING_CONFIGURATION_PREFIX_ALLOW
list).As such, if the configuration matches prefix in both
INRUPT_LOGGING_CONFIGURATION_PREFIX_ALLOW
andINRUPT_LOGGING_CONFIGURATION_PREFIX_DENY
, theINRUPT_LOGGING_CONFIGURATION_PREFIX_DENY
takes precedence and the configuration is not logged. For example, ifinrupt.
is an allow prefix, butinrupt.kafka.
is a deny prefix, all configurations that start withinrupt.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.
), orusing the MicroProfile Config environmental variables conversion value (e.g.,
INRUPT_FOOBAR_
).
Warning
Use the same format for both
INRUPT_LOGGING_CONFIGURATION_PREFIX_ALLOW
andINRUPT_LOGGING_CONFIGURATION_PREFIX_DENY
.For example, if you change the format of
INRUPT_LOGGING_CONFIGURATION_PREFIX_ALLOW
, change the format ofINRUPT_LOGGING_CONFIGURATION_PREFIX_DENY
as well.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.<xxxx>...
, specifyfoobar.
(including the dot.
) instead of, for example,foo
orfoobar
.If using converted form, if you want to match configuration properties of the form
FOOBAR_<XXXX>...
, specifyFOOBAR_
(including the underscore_
) instead of, for example,FOO
orFOOBAR
.
Added in version 2.2.0.
- 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
) are not logged. That is,INRUPT_LOGGING_CONFIGURATION_PREFIX_DENY
acts as a filter onINRUPT_LOGGING_CONFIGURATION_PREFIX_ALLOW
. For example:If
foobar.
is an allowed prefix, to suppressfoobar.private.<anything>
, you can specifyfoobar.private.
to the deny list.If
foobar.
is not an allowed prefix, no property starting withfoobar.
is logged. As such, you do not need to specifyfoobar.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.
), orusing the MicroProfile Config environmental variables conversion value (e.g.,
INRUPT_FOOBAR_
).
Warning
Use the same format for both
INRUPT_LOGGING_CONFIGURATION_PREFIX_ALLOW
andINRUPT_LOGGING_CONFIGURATION_PREFIX_DENY
.For example, if you change the format of
INRUPT_LOGGING_CONFIGURATION_PREFIX_ALLOW
, change the format ofINRUPT_LOGGING_CONFIGURATION_PREFIX_DENY
as well.Added in version 2.2.0.
Log Redaction#
- INRUPT_LOGGING_REDACTION_NAME_ACTION#
Default: REPLACE
Type of the redaction to perform. Supported values are:
Action
Description
REPLACE
Default. Replaces the matching text with a specified replacement.
PLAIN
Leaves the matching field unprocessed. Only available if the redaction target is a field (i.e.,
INRUPT_LOGGING_REDACTION_{NAME}_FIELD
).DROP
Suppresses the matching field. Only available if the redaction target is a field (i.e.,
INRUPT_LOGGING_REDACTION_{NAME}_FIELD
).PRIORITIZE
Changes the log level of the matching message.
SHA256
Replaces the matching text with its hash.
If the action is
REPLACE
(default), see alsoINRUPT_LOGGING_REDACTION_{NAME}_REPLACEMENT
.If the action is to
PRIORITIZE
, see alsoINRUPT_LOGGING_REDACTION_{NAME}_LEVEL
.
For more information on log redaction, see Logging Redaction.
Added in version 2.2.0.
- 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.
Added in version 2.2.0.
- 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.
Added in version 2.2.0.
- 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.
Added in version 2.2.0.
- INRUPT_LOGGING_REDACTION_NAME_LEVEL#
A new log level to use for the log message if the
INRUPT_LOGGING_REDACTION_{NAME}_ACTION
isPRIORITIZE
.Added in version 2.2.0.
- INRUPT_LOGGING_REDACTION_NAME_PATTERN#
A regex (see Java regex pattern) 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.
Added in version 2.2.0.
- INRUPT_LOGGING_REDACTION_NAME_REPLACEMENT#
Replacement text to use if the
INRUPT_LOGGING_REDACTION_{NAME}_ACTION
isREPLACE
.If unspecified, defaults to
[REDACTED]
.For more information on log redaction, see Logging Redaction.
Added in version 2.2.0.
Application-Defined Metadata Propagation#
- INRUPT_AUDIT_PRODUCER_REQUEST_METADATA_ALLOW#
A comma-separated list [1] of application-defined properties that can be included in the associated audit events (unless specified in the corresponding
INRUPT_AUDIT_PRODUCER_REQUEST_METADATA_DENY
).This configuration is case-sensitive to the propagated properties in the baggage.
Tip
To include a propagated property that was added via the
INRUPT_REQUEST_METADATA_PROPAGATOR_HEADER_ALLOW
configuration, ensure that the cases of these properties match.See:
Manage Application-Defined Metadata Propagation to configure.
Application-Defined Metadata for more information.
Added in version 2.2.0.
- INRUPT_AUDIT_PRODUCER_REQUEST_METADATA_DENY#
A comma-separated list [1] of application-defined properties to exclude from the associated audit messages. This setting takes precedence over
INRUPT_AUDIT_PRODUCER_REQUEST_METADATA_ALLOW
.This configuration is case-sensitive to the propagated properties in the baggage.
Tip
To exclude a propagated property that was added via the
INRUPT_REQUEST_METADATA_PROPAGATOR_HEADER_ALLOW
configuration, ensure that the cases of these properties match.See:
Manage Application-Defined Metadata Propagation to configure.
Application-Defined Metadata for more information.
Added in version 2.2.0.
- INRUPT_LOGGING_REQUEST_METADATA_ALLOW#
A comma-separated list [1] of application-defined properties that can be included in the associated log messages (unless specified in the corresponding
INRUPT_LOGGING_REQUEST_METADATA_DENY
).This configuration is case-sensitive to the propagated properties in the baggage.
Tip
To include a propagated property that was added via the
INRUPT_REQUEST_METADATA_PROPAGATOR_HEADER_ALLOW
configuration, ensure that the cases of these properties match.See:
Manage Application-Defined Metadata Propagation to configure.
Application-Defined Metadata for more information.
Added in version 2.2.0.
- INRUPT_LOGGING_REQUEST_METADATA_DENY#
A comma-separated list [1] of application-defined properties to exclude from the associated log messages. This setting takes precedence over
INRUPT_LOGGING_REQUEST_METADATA_ALLOW
.This configuration is case-sensitive to the propagated properties in the baggage.
Tip
To exclude a propagated property that was added via the
INRUPT_REQUEST_METADATA_PROPAGATOR_HEADER_ALLOW
configuration, ensure that the cases of these properties match.See:
Manage Application-Defined Metadata Propagation to configure.
Application-Defined Metadata for more information.
Added in version 2.2.0.
- INRUPT_REQUEST_METADATA_PROPAGATOR_HEADER_ALLOW#
A comma-separated list [1] of non-baggage request headers to add to the baggage (unless specified in the corresponding
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 matchx-correlation-id
header,X-CoRrElAtIoN-Id
header, etc.See:
Manage Application-Defined Metadata Propagation to configure.
Application-Defined Metadata for more information.
Added in version 2.2.0.
- INRUPT_REQUEST_METADATA_PROPAGATOR_HEADER_DENY#
A comma-separated list [1] of non-baggage request headers to exclude from being added to the baggage; i.e., excludes these headers as application-defined properties. This setting takes precedence over
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 to configure.
Application-Defined Metadata for more information.
Added in version 2.2.0.
- 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.
Added in version 2.2.0.
- INRUPT_REQUEST_METADATA_REFLECTOR_HEADER_ALLOW#
A comma-separated list [1] of application-defined properties that can return as response headers (unless specified in the corresponding
INRUPT_REQUEST_METADATA_REFLECTOR_HEADER_DENY
).This configuration is case-sensitive to the propagated properties in the baggage.
Tip
To return a propagated property that was added via the
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.
See:
Manage Application-Defined Metadata Propagation to configure.
Application-Defined Metadata for more information.
Added in version 2.2.0.
- INRUPT_REQUEST_METADATA_REFLECTOR_HEADER_DENY#
A comma-separated list [1] of application-defined properties to exclude from returning as response headers. This setting takes precedence over
INRUPT_REQUEST_METADATA_REFLECTOR_HEADER_ALLOW
.This configuration is case-sensitive to the propagated properties in the baggage.
Tip
To exclude a propagated property that was added via the
INRUPT_REQUEST_METADATA_PROPAGATOR_HEADER_ALLOW
configuration, ensure that the cases of these properties match.See:
Manage Application-Defined Metadata Propagation to configure.
Application-Defined Metadata for more information.
Added in version 2.2.0.
Purge Configuration#
The Access Grant Service contains user data, and as such it can be purged upon user request. See the Purger Application documentation 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.
Added in version 2.3.0.
- 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.
Added in version 2.3.0.
- 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.
Added in version 2.3.0.
- 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.Added in version 2.3.0.
- 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.
Added in version 2.3.0.
Additional Information#
See also Quarkus Configuration Options.