Token Issuer

Package v1alpha2 contains the API Schema definitions for WSO2 APK.

Token Issuer¶

TokenIssuer is the Schema for the tokenIssuer API

TokenIssuer ¶

TokenIssuer is the Schema for the tokenissuers API

Field Description

apiVersion
string dp.wso2.com/v1alpha2

kind
string TokenIssuer

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

spec
TokenIssuerSpec

`name` string	Name is the unique name of the Token Issuer in the Organization defined . “Organization/Name” can be used to uniquely identify an Issuer.
`organization` string	Organization denotes the organization of the Token Issuer.
`issuer` string	Issuer denotes the issuer of the Token Issuer.
`consumerKeyClaim` string	ConsumerKeyClaim denotes the claim key of the consumer key.
`scopesClaim` string	ScopesClaim denotes the claim key of the scopes.
`signatureValidation` SignatureValidation	SignatureValidation denotes the signature validation method of jwt
`claimMappings` []github.com/wso2/apk/common-go-libs/apis/dp/v1alpha2.ClaimMapping	ClaimMappings denotes the claim mappings of the jwt
`targetRef` sigs.k8s.io/gateway-api/apis/v1alpha2.PolicyTargetReference	TargetRef denotes the reference to the which gateway it applies to
`environments` []string	(Optional) Environments denotes the environments that are applicable for the token issuer.

status
TokenIssuerStatus

CERTConfig ¶

(Appears on: JWKS, SignatureValidation)

CERTConfig defines the certificate configuration

Field	Description
`certificateInline` string	CertificateInline is the Inline Certificate entry
`secretRef` RefConfig	SecretRef denotes the reference to the Secret that contains the Certificate
`configMapRef` RefConfig	ConfigMapRef denotes the reference to the ConfigMap that contains the Certificate

ClaimMapping ¶

ClaimMapping defines the reference configuration

Field	Description
`remoteClaim` string	RemoteClaim denotes the remote claim
`localClaim` string	LocalClaim denotes the local claim

JWKS ¶

(Appears on: SignatureValidation)

JWKS defines the JWKS endpoint

Field	Description
`url` string	URL is the URL of the JWKS endpoint
`tls` CERTConfig	TLS denotes the TLS configuration of the JWKS endpoint

SignatureValidation ¶

(Appears on: TokenIssuerSpec)

SignatureValidation defines the signature validation method

Field	Description
`jwks` JWKS	JWKS denotes the JWKS endpoint information
`certificate` CERTConfig	Certificate denotes the certificate information

TokenIssuerSpec ¶

(Appears on: TokenIssuer)

TokenIssuerSpec defines the desired state of TokenIssuer

Field	Description
`name` string	Name is the unique name of the Token Issuer in the Organization defined . “Organization/Name” can be used to uniquely identify an Issuer.
`organization` string	Organization denotes the organization of the Token Issuer.
`issuer` string	Issuer denotes the issuer of the Token Issuer.
`consumerKeyClaim` string	ConsumerKeyClaim denotes the claim key of the consumer key.
`scopesClaim` string	ScopesClaim denotes the claim key of the scopes.
`signatureValidation` SignatureValidation	SignatureValidation denotes the signature validation method of jwt
`claimMappings` []github.com/wso2/apk/common-go-libs/apis/dp/v1alpha2.ClaimMapping	ClaimMappings denotes the claim mappings of the jwt
`targetRef` sigs.k8s.io/gateway-api/apis/v1alpha2.PolicyTargetReference	TargetRef denotes the reference to the which gateway it applies to
`environments` []string	(Optional) Environments denotes the environments that are applicable for the token issuer.

TokenIssuerStatus ¶

(Appears on: TokenIssuer)

TokenIssuerStatus defines the observed state of TokenIssuer

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

Token Issuer Sample¶

The following is a sample TokenIssuer CR used to add a new token issuer to the APK.

apiVersion: dp.wso2.com/v1alpha2
kind: TokenIssuer
metadata:
  name: token-issuer
  namespace: ns
spec:
  consumerKeyClaim: test
  issuer: https://sample-issuer.com/token
  name: test-key
  organization: org
  scopesClaim: scope
  signatureValidation:
    certificate:
      secretRef:
        key: cert.pem
        name: truststore
  targetRef:
    group: gateway.networking.k8s.io
    kind: Gateway
    name: default