IdentityPropagation

microgateway.airlock.com/v1alpha1

Premium Featureauth module

IdentityPropagation defines an identity propagation operation.

​
---
config:
  theme: base
  themeVariables:
    secondaryColor: '#ffffff'
---
block
  columns 7

  classDef al_ref_box fill:#F2F2F2,stroke:#555;
  classDef al_mgw_box fill:#70991F,stroke:#555;
  classDef al_gwapi_box fill:#326CE5,stroke:#555;
  classDef al_std_box fill:#808B8F,stroke:#555;
  classDef al_self_box fill:#70991F,stroke:#777,stroke-width:5px; 

  
  
  block:RefBy:1
    columns 1
    AccessControlPolicy["<a href='../../../microgateway/access-control-policy/v1alpha1'>&nbsp;&nbsp;AccessControlPolicy&nbsp;&nbsp;</a>"]
    class AccessControlPolicy al_mgw_box
  end
  class RefBy al_ref_box
  space:2
  
  
  IdentityPropagation["<a href='../../../microgateway/identity-propagation/v1alpha1'>&nbsp;&nbsp;<b>IdentityPropagation</b>&nbsp;&nbsp;</a>"]
  class IdentityPropagation al_self_box
  
  space:3
  

  RefBy -- "<br><i>references</i>" --> IdentityPropagation
apiVersion: microgateway.airlock.com/v1alpha1
kind: IdentityPropagation
metadata:
  name: identity-propagation-example
spec:
  bearerToken:
    source:
      jwt: {}
apiVersion: microgateway.airlock.com/v1alpha1
kind: IdentityPropagation
metadata:
  name: identity-propagation-example
spec:
  header:
    name: X-USER-NAME
    value:
      source:
        oidc:
          idToken:
            claim: "name"

IdentityPropagation

Field Description Type Required Default Allowed Values
metadata defines the resource’s metadata ObjectMeta yes
spec defines the desired identity propagation. object yes bearerToken{}, header{}

IdentityPropagation.spec

Field Description Type Required Default Allowed Values
bearerToken configures identity propagation via an authorization header containing a bearer token. object no
header configures identity propagation via a request header. object no

IdentityPropagation.spec.bearerToken

Field Description Type Required Default Allowed Values
source from which to extract the token. object yes clientCertificate{}, jwt{}, metadata{}, oidc{}, tokenExchange{}

IdentityPropagation.spec.bearerToken.source

Field Description Type Required Default Allowed Values
clientCertificate specifies to extract a value from the presented client certificate. object no
jwt specifies to extract a value from a JWT. object no
metadata specifies to extract a value from an Envoy dynamic filter metadata key. object no
oidc specifies to extract a value from the result of an OpenID Connect flow. object no accessToken{}, idToken{}
tokenExchange specifies to use the token obtained via token exchange as value. object no

IdentityPropagation.spec.bearerToken.source.clientCertificate

Field Description Type Required Default Allowed Values
issuer specifies to extract the value from the presented client certificate’s issuer. object no
san specifies to extract the value from the presented client certificate’s subject alternative names.' object no
subject specifies to extract the value from the presented client certificate’s subject. object no

IdentityPropagation.spec.bearerToken.source.clientCertificate.issuer

Field Description Type Required Default Allowed Values
field specifies the field to extract as value.
If the certificate contains multiple occurrences of the field, all their values are joined into a comma-separated list.		 enum yes CommonName, Country, Locality, Organization, OrganizationalUnit, State

IdentityPropagation.spec.bearerToken.source.clientCertificate.san

Field Description Type Required Default Allowed Values
type specifies to extract subject alternative names with this type.
If there are multiple such SANs, they are joined into a comma-separated list.		 enum yes DNS, Email, IPAddress, URI

IdentityPropagation.spec.bearerToken.source.clientCertificate.subject

Field Description Type Required Default Allowed Values
field specifies the field to extract as value.
If the certificate contains multiple occurrences of the field, all their values are joined into a comma-separated list.		 enum yes CommonName, Country, Locality, Organization, OrganizationalUnit, State

IdentityPropagation.spec.bearerToken.source.jwt

Field Description Type Required Default Allowed Values
claim specifies the JWT claim to extract as value. If omitted, the entire JWT will be used as value.
If the claim value is a JSON object, the value of a nested property can be extracted using dot notation (e.g., "user.name" or "org.unit.name").
Note: Extracting properties or claims with a name containing dots is currently not supported.		 string no

IdentityPropagation.spec.bearerToken.source.metadata

Field Description Type Required Default Allowed Values
key specifies the metadata key from which to load the value, e.g. some_payload.aud. string yes
namespace specifies the metadata namespace within which the lookup should be performed, e.g. envoy.filters.http.jwt_authn. string yes

IdentityPropagation.spec.bearerToken.source.oidc

Field Description Type Required Default Allowed Values
accessToken specifies to use the OpenID Connect Access Token as value. object no {}
idToken specifies to extract the value from the OpenID Connect ID Token. object no

IdentityPropagation.spec.bearerToken.source.oidc.idToken

Field Description Type Required Default Allowed Values
claim specifies the JWT claim to extract as value. If omitted, the entire token will be used as value.
If the claim value is a JSON object, the value of a nested property can be extracted using dot notation (e.g., "user.name" or "org.unit.name").
Note: Extracting properties or claims with a name containing dots is currently not supported.		 string no

IdentityPropagation.spec.bearerToken.source.tokenExchange

Field Description Type Required Default Allowed Values
claim specifies the JWT claim to extract as value. If omitted, the entire token will be used as value.
If the claim value is a JSON object, the value of a nested property can be extracted using dot notation (e.g., "user.name" or "org.unit.name").
Note: Extracting properties or claims with a name containing dots is currently not supported.
Note: If claim is specified, identity propagation will fail if the token obtained from the exchange is not a JWT.		 string no

IdentityPropagation.spec.header

Field Description Type Required Default Allowed Values
name of the header to set. string yes
value to propagate to the application. object yes

IdentityPropagation.spec.header.value

Field Description Type Required Default Allowed Values
source from which to extract the value. object yes clientCertificate{}, jwt{}, metadata{}, oidc{}, tokenExchange{}

IdentityPropagation.spec.header.value.source

Field Description Type Required Default Allowed Values
clientCertificate specifies to extract a value from the presented client certificate. object no
jwt specifies to extract a value from a JWT. object no
metadata specifies to extract a value from an Envoy dynamic filter metadata key. object no
oidc specifies to extract a value from the result of an OpenID Connect flow. object no accessToken{}, idToken{}
tokenExchange specifies to use the token obtained via token exchange as value. object no

IdentityPropagation.spec.header.value.source.clientCertificate

Field Description Type Required Default Allowed Values
issuer specifies to extract the value from the presented client certificate’s issuer. object no
san specifies to extract the value from the presented client certificate’s subject alternative names.' object no
subject specifies to extract the value from the presented client certificate’s subject. object no

IdentityPropagation.spec.header.value.source.clientCertificate.issuer

Field Description Type Required Default Allowed Values
field specifies the field to extract as value.
If the certificate contains multiple occurrences of the field, all their values are joined into a comma-separated list.		 enum yes CommonName, Country, Locality, Organization, OrganizationalUnit, State

IdentityPropagation.spec.header.value.source.clientCertificate.san

Field Description Type Required Default Allowed Values
type specifies to extract subject alternative names with this type.
If there are multiple such SANs, they are joined into a comma-separated list.		 enum yes DNS, Email, IPAddress, URI

IdentityPropagation.spec.header.value.source.clientCertificate.subject

Field Description Type Required Default Allowed Values
field specifies the field to extract as value.
If the certificate contains multiple occurrences of the field, all their values are joined into a comma-separated list.		 enum yes CommonName, Country, Locality, Organization, OrganizationalUnit, State

IdentityPropagation.spec.header.value.source.jwt

Field Description Type Required Default Allowed Values
claim specifies the JWT claim to extract as value. If omitted, the entire JWT will be used as value.
If the claim value is a JSON object, the value of a nested property can be extracted using dot notation (e.g., "user.name" or "org.unit.name").
Note: Extracting properties or claims with a name containing dots is currently not supported.		 string no

IdentityPropagation.spec.header.value.source.metadata

Field Description Type Required Default Allowed Values
key specifies the metadata key from which to load the value, e.g. some_payload.aud. string yes
namespace specifies the metadata namespace within which the lookup should be performed, e.g. envoy.filters.http.jwt_authn. string yes

IdentityPropagation.spec.header.value.source.oidc

Field Description Type Required Default Allowed Values
accessToken specifies to use the OpenID Connect Access Token as value. object no {}
idToken specifies to extract the value from the OpenID Connect ID Token. object no

IdentityPropagation.spec.header.value.source.oidc.idToken

Field Description Type Required Default Allowed Values
claim specifies the JWT claim to extract as value. If omitted, the entire token will be used as value.
If the claim value is a JSON object, the value of a nested property can be extracted using dot notation (e.g., "user.name" or "org.unit.name").
Note: Extracting properties or claims with a name containing dots is currently not supported.		 string no

IdentityPropagation.spec.header.value.source.tokenExchange

Field Description Type Required Default Allowed Values
claim specifies the JWT claim to extract as value. If omitted, the entire token will be used as value.
If the claim value is a JSON object, the value of a nested property can be extracted using dot notation (e.g., "user.name" or "org.unit.name").
Note: Extracting properties or claims with a name containing dots is currently not supported.
Note: If claim is specified, identity propagation will fail if the token obtained from the exchange is not a JWT.		 string no