Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace CustomAuthenticationPolicy

Use a function to validate a custom header or query parameter sent with the request authentication. A valid policy must specify either tokenHeader or tokenQueryParam.

Properties

Optional cacheKey

cacheKey: Array<string>

A list of keys from "parameters" attribute value whose values will be added to the cache key.

functionId

functionId: string

The OCID of the Oracle Functions function resource.

Optional isAnonymousAccessAllowed

isAnonymousAccessAllowed: undefined | false | true

Whether an unauthenticated user may access the API. Must be "true" to enable ANONYMOUS route authorization.

Optional parameters

parameters: undefined | object

A map where key is a user defined string and value is a context expressions whose values will be sent to the custom auth function. Values should contain an expression. Example: {@code {"foo": "request.header[abc]"}}

Optional tokenHeader

tokenHeader: undefined | string

The name of the header containing the authentication token.

Optional tokenQueryParam

tokenQueryParam: undefined | string

The name of the query parameter containing the authentication token.

Const type

type: string = "CUSTOM_AUTHENTICATION"

Optional validationFailurePolicy

Methods

getDeserializedJsonObj

getJsonObj