Skip to content
Cloudflare API
Start here
API Reference
Token Validation

Configuration

List token validation configurations
token_validation.configuration.list(ConfigurationListParams**kwargs) -> SyncV4PagePaginationArray[TokenConfig]
GET/zones/{zone_id}/token_validation/config
Get a single Token Configuration
token_validation.configuration.get(strconfig_id, ConfigurationGetParams**kwargs) -> TokenConfig
GET/zones/{zone_id}/token_validation/config/{config_id}
Create a new Token Validation configuration
token_validation.configuration.create(ConfigurationCreateParams**kwargs) -> TokenConfig
POST/zones/{zone_id}/token_validation/config
Edit an existing Token Configuration
token_validation.configuration.edit(strconfig_id, ConfigurationEditParams**kwargs) -> ConfigurationEditResponse
PATCH/zones/{zone_id}/token_validation/config/{config_id}
Delete Token Configuration
token_validation.configuration.delete(strconfig_id, ConfigurationDeleteParams**kwargs) -> ConfigurationDeleteResponse
DELETE/zones/{zone_id}/token_validation/config/{config_id}
ModelsExpand Collapse
class TokenConfig: …
id: str

UUID.

maxLength36
minLength36
created_at: datetime
formatdate-time
credentials: Credentials
keys: List[CredentialsKey]
One of the following:
class CredentialsKeyAPIShieldCredentialsJWTKeyRSA: …

JSON representation of an RSA key.

alg: Literal["RS256", "RS384", "RS512", 3 more]

Algorithm

One of the following:
"RS256"
"RS384"
"RS512"
"PS256"
"PS384"
"PS512"
e: str

RSA exponent

kid: str

Key ID

kty: Literal["RSA"]

Key Type

n: str

RSA modulus

class CredentialsKeyAPIShieldCredentialsJWTKeyEcEs256: …

JSON representation of an ES256 key

alg: Literal["ES256"]

Algorithm

crv: Literal["P-256"]

Curve

kid: str

Key ID

kty: Literal["EC"]

Key Type

x: str

X EC coordinate

y: str

Y EC coordinate

class CredentialsKeyAPIShieldCredentialsJWTKeyEcEs384: …

JSON representation of an ES384 key

alg: Literal["ES384"]

Algorithm

crv: Literal["P-384"]

Curve

kid: str

Key ID

kty: Literal["EC"]

Key Type

x: str

X EC coordinate

y: str

Y EC coordinate

description: str
maxLength500
last_updated: datetime
formatdate-time
title: str
maxLength50
token_sources: List[str]
token_type: Literal["JWT"]
class ConfigurationEditResponse: …
id: Optional[str]

UUID.

maxLength36
minLength36
description: Optional[str]
maxLength500
title: Optional[str]
maxLength50
token_sources: Optional[List[str]]
class ConfigurationDeleteResponse: …
id: Optional[str]

UUID.

maxLength36
minLength36

ConfigurationCredentials

Update Token Configuration credentials
token_validation.configuration.credentials.update(strconfig_id, CredentialUpdateParams**kwargs) -> CredentialUpdateResponse
PUT/zones/{zone_id}/token_validation/config/{config_id}/credentials
ModelsExpand Collapse
class CredentialUpdateResponse: …
errors: Message
keys: List[Key]
One of the following:
class KeyAPIShieldCredentialsJWTKeyRSA: …

JSON representation of an RSA key.

alg: Literal["RS256", "RS384", "RS512", 3 more]

Algorithm

One of the following:
"RS256"
"RS384"
"RS512"
"PS256"
"PS384"
"PS512"
e: str

RSA exponent

kid: str

Key ID

kty: Literal["RSA"]

Key Type

n: str

RSA modulus

class KeyAPIShieldCredentialsJWTKeyEcEs256: …

JSON representation of an ES256 key

alg: Literal["ES256"]

Algorithm

crv: Literal["P-256"]

Curve

kid: str

Key ID

kty: Literal["EC"]

Key Type

x: str

X EC coordinate

y: str

Y EC coordinate

class KeyAPIShieldCredentialsJWTKeyEcEs384: …

JSON representation of an ES384 key

alg: Literal["ES384"]

Algorithm

crv: Literal["P-384"]

Curve

kid: str

Key ID

kty: Literal["EC"]

Key Type

x: str

X EC coordinate

y: str

Y EC coordinate

messages: Message
success: Literal[true]

Whether the API call was successful.