API Reference

Token Validation

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Configuration

List token validation configurations

client.tokenValidation.configuration.list(ConfigurationListParams { zone_id, page, per_page } params, RequestOptionsoptions?): V4PagePaginationArray<TokenConfig { id, created_at, credentials, 5 more } >

GET/zones/{zone_id}/token_validation/config

Get a single Token Configuration

client.tokenValidation.configuration.get(stringconfigId, ConfigurationGetParams { zone_id } params, RequestOptionsoptions?): TokenConfig { id, created_at, credentials, 5 more }

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

Create a new Token Validation configuration

client.tokenValidation.configuration.create(ConfigurationCreateParams { zone_id, credentials, description, 3 more } params, RequestOptionsoptions?): TokenConfig { id, created_at, credentials, 5 more }

POST/zones/{zone_id}/token_validation/config

Edit an existing Token Configuration

client.tokenValidation.configuration.edit(stringconfigId, ConfigurationEditParams { zone_id, description, title, token_sources } params, RequestOptionsoptions?): ConfigurationEditResponse { id, description, title, token_sources }

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

Delete Token Configuration

client.tokenValidation.configuration.delete(stringconfigId, ConfigurationDeleteParams { zone_id } params, RequestOptionsoptions?): ConfigurationDeleteResponse { id }

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

ModelsExpand Collapse

TokenConfig { id, created_at, credentials, 5 more }

id: string

UUID.

maxLength36

minLength36

created_at: string

formatdate-time

credentials: Credentials { keys }

keys: Array<APIShieldCredentialsJWTKeyRSA { alg, e, kid, 2 more } | APIShieldCredentialsJWTKeyEcEs256 { alg, crv, kid, 3 more } | APIShieldCredentialsJWTKeyEcEs384 { alg, crv, kid, 3 more } >

One of the following:

APIShieldCredentialsJWTKeyRSA { alg, e, kid, 2 more }

JSON representation of an RSA key.

alg: "RS256" | "RS384" | "RS512" | 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 { 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 { 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<string>

token_type: "JWT"

ConfigurationEditResponse { id, description, title, token_sources }

id?: string

UUID.

maxLength36

minLength36

description?: string

maxLength500

title?: string

maxLength50

token_sources?: Array<string>

ConfigurationDeleteResponse { id }

id?: string

UUID.

maxLength36

minLength36

ConfigurationCredentials

Update Token Configuration credentials

client.tokenValidation.configuration.credentials.update(stringconfigId, CredentialUpdateParams { zone_id, keys } params, RequestOptionsoptions?): CredentialUpdateResponse { errors, keys, messages, success }

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

ModelsExpand Collapse

CredentialUpdateResponse { errors, keys, messages, success }

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

keys: Array<APIShieldCredentialsJWTKeyRSA { alg, e, kid, 2 more } | APIShieldCredentialsJWTKeyEcEs256 { alg, crv, kid, 3 more } | APIShieldCredentialsJWTKeyEcEs384 { alg, crv, kid, 3 more } >

One of the following:

APIShieldCredentialsJWTKeyRSA { alg, e, kid, 2 more }

JSON representation of an RSA key.

alg: "RS256" | "RS384" | "RS512" | 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 { 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 { 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.