Authentication

Package v1alpha1 contains the API Schema definitions for WSO2 APK.

Authentication¶

Authentication is the Schema for the authentications API

Field Description

apiVersion
string dp.wso2.com/v1alpha1

kind
string Authentication

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

spec
AuthenticationSpec

`default` AuthSpec
`override` AuthSpec
`targetRef` sigs.k8s.io/gateway-api/apis/v1alpha2.PolicyTargetReference

status
AuthenticationStatus

APIAuth ¶

(Appears on: AuthSpec)

APIAuth Authentication scheme type and details

Field	Description
`oauth2` Oauth2Auth	(Optional) Oauth2 is to specify the Oauth2 authentication scheme details
`apiKey` []APIKeyAuth	(Optional) APIKey is to specify the APIKey authentication scheme details
`testConsoleKey` TestConsoleKeyAuth	(Optional) TestConsoleKey is to specify the Test Console Key authentication scheme details

APIKeyAuth ¶

(Appears on: APIAuth)

APIKeyAuth APIKey Authentication scheme details

Field	Description
`in` string	In is to specify how the APIKey is passed to the request
`name` string	Name is the name of the header or query parameter to be used
`sendTokenToUpstream` bool	(Optional) SendTokenToUpstream is to specify whether the APIKey should be sent to the upstream

AuthSpec ¶

(Appears on: AuthenticationSpec)

AuthSpec specification of the authentication service

Field	Description
`disabled` bool	Disabled is to disable all authentications
`authTypes` APIAuth	AuthTypes is to specify the authentication scheme types and details

AuthenticationSpec ¶

(Appears on: Authentication)

AuthenticationSpec defines the desired state of Authentication

Field	Description
`default` AuthSpec
`override` AuthSpec
`targetRef` sigs.k8s.io/gateway-api/apis/v1alpha2.PolicyTargetReference

AuthenticationStatus ¶

(Appears on: Authentication)

AuthenticationStatus defines the observed state of Authentication

Oauth2Auth ¶

(Appears on: APIAuth)

Oauth2Auth OAuth2 Authentication scheme details

Field	Description
`disabled` bool	(Optional) Disabled is to disable OAuth2 authentication
`header` string	(Optional) Header is the header name used to pass the OAuth2 token
`sendTokenToUpstream` bool	(Optional) SendTokenToUpstream is to specify whether the OAuth2 token should be sent to the upstream

TestConsoleKeyAuth ¶

(Appears on: APIAuth)

TestConsoleKeyAuth Test Console Key Authentication scheme details

Field	Description
`header` string	(Optional) Header is the header name used to pass the Test Console Key
`sendTokenToUpstream` bool	(Optional) SendTokenToUpstream is to specify whether the Test Console Key should be sent to the upstream

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

Authentication Sample¶

The following is a sample CR for adding authentication to an API.

apiVersion: "dp.wso2.com/v1alpha1"
kind: "Authentication"
metadata:
  name: http-bin-authentication
spec:
  default:
    authTypes:
      oauth2:
        header: "Authorization"
        sendTokenToUpstream: true
        disabled: false
      apiKey: []
    disabled: false
  targetRef:
    group: "gateway.networking.k8s.io"
    kind: "API"
    name: default