Configuration

List token validation configurations

GET/zones/{zone_id}/token_validation/config

Get a single Token Configuration

GET/zones/{zone_id}/token_validation/config/{config_id}

Create a new Token Validation configuration

POST/zones/{zone_id}/token_validation/config

Edit an existing Token Configuration

PATCH/zones/{zone_id}/token_validation/config/{config_id}

Delete Token Configuration

DELETE/zones/{zone_id}/token_validation/config/{config_id}

ModelsExpand Collapse

TokenConfig = object { id, created_at, credentials, 5 more }

id: string

UUID.

maxLength36

minLength36

created_at: string

formatdate-time

credentials: object { keys }

keys: array of object { alg, e, kid, 2 more } or object { alg, crv, kid, 3 more } or object { alg, crv, kid, 3 more }

One of the following:

APIShieldCredentialsJWTKeyRSA = object { alg, e, kid, 2 more }

JSON representation of an RSA key.

alg: "RS256" or "RS384" or "RS512" or 3 more

Algorithm

One of the following:

"RS256"

"RS384"

"RS512"

"PS256"

"PS384"

"PS512"

e: string

RSA exponent

kid: string

Key ID

kty: "RSA"

Key Type

n: string

RSA modulus

APIShieldCredentialsJWTKeyEcEs256 = object { alg, crv, kid, 3 more }

JSON representation of an ES256 key

alg: "ES256"

Algorithm

crv: "P-256"

Curve

kid: string

Key ID

kty: "EC"

Key Type

x: string

X EC coordinate

y: string

Y EC coordinate

APIShieldCredentialsJWTKeyEcEs384 = object { alg, crv, kid, 3 more }

JSON representation of an ES384 key

alg: "ES384"

Algorithm

crv: "P-384"

Curve

kid: string

Key ID

kty: "EC"

Key Type

x: string

X EC coordinate

y: string

Y EC coordinate

description: string

maxLength500

last_updated: string

formatdate-time

title: string

maxLength50

token_sources: array of string

token_type: "JWT"

ConfigurationEditResponse = object { id, description, title, token_sources }

id: optional string

UUID.

maxLength36

minLength36

description: optional string

maxLength500

title: optional string

maxLength50

token_sources: optional array of string

ConfigurationDeleteResponse = object { id }

id: optional string

UUID.

maxLength36

minLength36

ConfigurationCredentials

Update Token Configuration credentials

PUT/zones/{zone_id}/token_validation/config/{config_id}/credentials

ModelsExpand Collapse

CredentialUpdateResponse = object { errors, keys, messages, success }

errors: Message { code, message, documentation_url, source }

keys: array of object { alg, e, kid, 2 more } or object { alg, crv, kid, 3 more } or object { alg, crv, kid, 3 more }

One of the following:

APIShieldCredentialsJWTKeyRSA = object { alg, e, kid, 2 more }

JSON representation of an RSA key.

alg: "RS256" or "RS384" or "RS512" or 3 more

Algorithm

One of the following:

"RS256"

"RS384"

"RS512"

"PS256"

"PS384"

"PS512"

e: string

RSA exponent

kid: string

Key ID

kty: "RSA"

Key Type

n: string

RSA modulus

APIShieldCredentialsJWTKeyEcEs256 = object { alg, crv, kid, 3 more }

JSON representation of an ES256 key

alg: "ES256"

Algorithm

crv: "P-256"

Curve

kid: string

Key ID

kty: "EC"

Key Type

x: string

X EC coordinate

y: string

Y EC coordinate

APIShieldCredentialsJWTKeyEcEs384 = object { alg, crv, kid, 3 more }

JSON representation of an ES384 key

alg: "ES384"

Algorithm

crv: "P-384"

Curve

kid: string

Key ID

kty: "EC"

Key Type

x: string

X EC coordinate

y: string

Y EC coordinate

messages: Message { code, message, documentation_url, source }

success: true

Whether the API call was successful.