Configurations

Retrieve information about specific configuration properties

client.apiGateway.configurations.get(, ?): Configuration { auth_id_characteristics }

GET/zones/{zone_id}/api_gateway/configuration

Update configuration properties

client.apiGateway.configurations.update(, ?): Configuration { auth_id_characteristics }

PUT/zones/{zone_id}/api_gateway/configuration

ModelsExpand Collapse

Configuration { auth_id_characteristics }

auth_id_characteristics: Array<APIShieldAuthIDCharacteristic { name, type } | APIShieldAuthIDCharacteristicJWTClaim { name, type } >

One of the following:

APIShieldAuthIDCharacteristic { name, type }

Auth ID Characteristic

name: string

The name of the characteristic field, i.e., the header or cookie name.

maxLength128

type: "header" | "cookie"

The type of characteristic.

One of the following:

"header"

"cookie"

APIShieldAuthIDCharacteristicJWTClaim { name, type }

Auth ID Characteristic extracted from JWT Token Claims

name: string

Claim location expressed as $(token_config_id):$(json_path), where token_config_id is the ID of the token configuration used in validating the JWT, and json_path is a RFC 9535 JSONPath (https://goessner.net/articles/JsonPath/, https://www.rfc-editor.org/rfc/rfc9535.html). The JSONPath expression may be in dot or bracket notation, may only specify literal keys or array indexes, and must return a singleton value, which will be interpreted as a string.

maxLength128

type: "jwt"

The type of characteristic.