API Reference

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Token Validation

Token ValidationConfiguration

List token validation configurations

client.TokenValidation.Configuration.List(ctx, params) (*V4PagePaginationArray[TokenConfig], error)

GET/zones/{zone_id}/token_validation/config

Get a token validation configuration

client.TokenValidation.Configuration.Get(ctx, configID, query) (*TokenConfig, error)

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

Create a token validation configuration

client.TokenValidation.Configuration.New(ctx, params) (*TokenConfig, error)

POST/zones/{zone_id}/token_validation/config

Edit a token validation configuration

client.TokenValidation.Configuration.Edit(ctx, configID, params) (*ConfigurationEditResponse, error)

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

Delete a token validation configuration

client.TokenValidation.Configuration.Delete(ctx, configID, body) (*ConfigurationDeleteResponse, error)

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

ModelsExpand Collapse

type TokenConfig struct{…}

ID string

UUID.

maxLength36

minLength36

CreatedAt Time

formatdate-time

Credentials TokenConfigCredentials

Keys []TokenConfigCredentialsKey

One of the following:

type TokenConfigCredentialsKeysAPIShieldCredentialsJWTKeyRSA struct{…}

JSON representation of an RSA key.

Alg TokenConfigCredentialsKeysAPIShieldCredentialsJWTKeyRSAAlg

Algorithm

One of the following:

const TokenConfigCredentialsKeysAPIShieldCredentialsJWTKeyRSAAlgRs256 TokenConfigCredentialsKeysAPIShieldCredentialsJWTKeyRSAAlg = "RS256"

const TokenConfigCredentialsKeysAPIShieldCredentialsJWTKeyRSAAlgRs384 TokenConfigCredentialsKeysAPIShieldCredentialsJWTKeyRSAAlg = "RS384"

const TokenConfigCredentialsKeysAPIShieldCredentialsJWTKeyRSAAlgRs512 TokenConfigCredentialsKeysAPIShieldCredentialsJWTKeyRSAAlg = "RS512"

const TokenConfigCredentialsKeysAPIShieldCredentialsJWTKeyRSAAlgPs256 TokenConfigCredentialsKeysAPIShieldCredentialsJWTKeyRSAAlg = "PS256"

const TokenConfigCredentialsKeysAPIShieldCredentialsJWTKeyRSAAlgPs384 TokenConfigCredentialsKeysAPIShieldCredentialsJWTKeyRSAAlg = "PS384"

const TokenConfigCredentialsKeysAPIShieldCredentialsJWTKeyRSAAlgPs512 TokenConfigCredentialsKeysAPIShieldCredentialsJWTKeyRSAAlg = "PS512"

E string

RSA exponent

Kid string

Key ID

Kty TokenConfigCredentialsKeysAPIShieldCredentialsJWTKeyRSAKty

Key Type

N string

RSA modulus

type TokenConfigCredentialsKeysAPIShieldCredentialsJWTKeyEcEs256 struct{…}

JSON representation of an ES256 key

Alg TokenConfigCredentialsKeysAPIShieldCredentialsJWTKeyEcEs256Alg

Algorithm

Crv TokenConfigCredentialsKeysAPIShieldCredentialsJWTKeyEcEs256Crv

Curve

Kid string

Key ID

Kty TokenConfigCredentialsKeysAPIShieldCredentialsJWTKeyEcEs256Kty

Key Type

X string

X EC coordinate

Y string

Y EC coordinate

type TokenConfigCredentialsKeysAPIShieldCredentialsJWTKeyEcEs384 struct{…}

JSON representation of an ES384 key

Alg TokenConfigCredentialsKeysAPIShieldCredentialsJWTKeyEcEs384Alg

Algorithm

Crv TokenConfigCredentialsKeysAPIShieldCredentialsJWTKeyEcEs384Crv

Curve

Kid string

Key ID

Kty TokenConfigCredentialsKeysAPIShieldCredentialsJWTKeyEcEs384Kty

Key Type

X string

X EC coordinate

Y string

Y EC coordinate

type TokenConfigCredentialsKeysAPIShieldCredentialsJWTKeyOctResponse struct{…}

JSON representation of a symmetric verification key in API responses (secret material is redacted).

Alg TokenConfigCredentialsKeysAPIShieldCredentialsJWTKeyOctResponseAlg

Algorithm

One of the following:

const TokenConfigCredentialsKeysAPIShieldCredentialsJWTKeyOctResponseAlgHs256 TokenConfigCredentialsKeysAPIShieldCredentialsJWTKeyOctResponseAlg = "HS256"

const TokenConfigCredentialsKeysAPIShieldCredentialsJWTKeyOctResponseAlgHs384 TokenConfigCredentialsKeysAPIShieldCredentialsJWTKeyOctResponseAlg = "HS384"

const TokenConfigCredentialsKeysAPIShieldCredentialsJWTKeyOctResponseAlgHs512 TokenConfigCredentialsKeysAPIShieldCredentialsJWTKeyOctResponseAlg = "HS512"

Kid string

Key ID

Kty TokenConfigCredentialsKeysAPIShieldCredentialsJWTKeyOctResponseKty

Key Type

Description string

maxLength500

LastUpdated Time

formatdate-time

Title string

maxLength50

TokenSources []string

TokenType TokenConfigTokenType

Token ValidationConfigurationCredentials

Replace token validation credentials

client.TokenValidation.Configuration.Credentials.Update(ctx, configID, params) (*ConfigurationCredentialUpdateResponse, error)

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

Edit token validation credentials

client.TokenValidation.Configuration.Credentials.Edit(ctx, configID, params) (*ConfigurationCredentialEditResponse, error)

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

Token ValidationRules

List token validation rules

client.TokenValidation.Rules.List(ctx, params) (*V4PagePaginationArray[TokenValidationRule], error)

GET/zones/{zone_id}/token_validation/rules

Create a token validation rule

client.TokenValidation.Rules.New(ctx, params) (*TokenValidationRule, error)

POST/zones/{zone_id}/token_validation/rules

Create token validation rules

client.TokenValidation.Rules.BulkNew(ctx, params) (*SinglePage[TokenValidationRule], error)

POST/zones/{zone_id}/token_validation/rules/bulk

Edit token validation rules

client.TokenValidation.Rules.BulkEdit(ctx, params) (*SinglePage[TokenValidationRule], error)

PATCH/zones/{zone_id}/token_validation/rules/bulk

Get a token validation rule

client.TokenValidation.Rules.Get(ctx, ruleID, query) (*TokenValidationRule, error)

GET/zones/{zone_id}/token_validation/rules/{rule_id}

Delete a token validation rule

client.TokenValidation.Rules.Delete(ctx, ruleID, body) (*RuleDeleteResponse, error)

DELETE/zones/{zone_id}/token_validation/rules/{rule_id}

Edit a token validation rule

client.TokenValidation.Rules.Edit(ctx, ruleID, params) (*TokenValidationRule, error)

PATCH/zones/{zone_id}/token_validation/rules/{rule_id}

ModelsExpand Collapse

type TokenValidationRule struct{…}

A Token Validation rule that can enforce security policies using JWT Tokens.

Action TokenValidationRuleAction

Action to take on requests that match operations included in selector and fail expression.

One of the following:

const TokenValidationRuleActionLog TokenValidationRuleAction = "log"

const TokenValidationRuleActionBlock TokenValidationRuleAction = "block"

Description string

A human-readable description that gives more details than title.

maxLength500

Enabled bool

Toggle rule on or off.

Expression string

Rule expression. Requests that fail to match this expression will be subject to action.

For details on expressions, see the Cloudflare Docs.

Selector TokenValidationRuleSelector

Select operations covered by this rule.

For details on selectors, see the Cloudflare Docs.

Exclude []TokenValidationRuleSelectorExcludeOptional

Ignore operations that were otherwise included by include.

OperationIDs []stringOptional

Excluded operation IDs.

Include []TokenValidationRuleSelectorIncludeOptional

Select all matching operations.

Host []stringOptional

Included hostnames.

Title string

A human-readable name for the rule.

maxLength50

ID stringOptional

UUID.

maxLength36

minLength36

CreatedAt TimeOptional

formatdate-time

LastUpdated TimeOptional

formatdate-time