Skip to content

BackendJWT

Package v1alpha1 contains the API Schema definitions for WSO2 APK.

Backend JWT

BackendJWT is the Schema for the backendjwts API

Field Description
metadata
Kubernetes meta/v1.ObjectMeta
Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
BackendJWTSpec


encoding
string
(Optional)

Encoding of the JWT token

header
string
(Optional)

Header of the JWT token

signingAlgorithm
string
(Optional)

Signing algorithm of the JWT token

tokenTTL
uint32
(Optional)

TokenTTL time to live for the backend JWT token in seconds

customClaims
[]CustomClaim
(Optional)

CustomClaims holds custom claims that needs to be added to the jwt

status
BackendJWTStatus

BackendJWTSpec

(Appears on: BackendJWT)

BackendJWTSpec defines the desired state of BackendJWT

Field Description
encoding
string
(Optional)

Encoding of the JWT token

header
string
(Optional)

Header of the JWT token

signingAlgorithm
string
(Optional)

Signing algorithm of the JWT token

tokenTTL
uint32
(Optional)

TokenTTL time to live for the backend JWT token in seconds

customClaims
[]CustomClaim
(Optional)

CustomClaims holds custom claims that needs to be added to the jwt

BackendJWTStatus

(Appears on: BackendJWT)

BackendJWTStatus defines the observed state of BackendJWT

CustomClaim

(Appears on: BackendJWTSpec)

CustomClaim holds custom claim information

Field Description
claim
string

Claim name

value
string

Claim value

type
string

Claim type


Generated with gen-crd-api-reference-docs.

BackendJWT Sample

The following is a sample BackendJWT CR.

apiVersion: dp.wso2.com/v1alpha1
kind: BackendJWT
metadata:
  name: backendjwt
spec:
  encoding: "base64"
  signingAlgorithm: "SHA256withRSA"
  header: "X-JWT-Assertion"
  tokenTTL: 3600
  customClaims:
    - claim: "admin"
      value: "http://wso2.org/claims/enduser"
    - claim: "test"
      value: "1"
      type: float

Refer Learn to attach API Policies for Backend JWT Token Manipulation for more information on how to configure backend JWT in APK.