Credentials

Update Token Configuration credentials

client.tokenValidation.configuration.credentials.update(, , ?): 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 } | APIShieldCredentialsJWTKeyOctResponse { alg, kid, kty } >

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

APIShieldCredentialsJWTKeyOctResponse { alg, kid, kty }

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

alg: "HS256" | "HS384" | "HS512"

Algorithm

One of the following:

"HS256"

"HS384"

"HS512"

kid: string

Key ID

kty: "oct"

Key Type

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

success: true

Whether the API call was successful.