Update client key
Updates an existing client key identified by key_id. Only fields present in the request body are changed.
Authorizations
Path Parameters
Body
- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
- Option 6
- Option 7
- Option 8
- Option 9
- Option 10
Body of a PUT /v2/settings/security/keys/{key_id} request.
Cryptographic or integration algorithm. Discriminator for polymorphic create, update, and response schemas.
A128KW, A192KW, A256KW, ES256_PRIVATE, ES256_PUBLIC, ES384_PRIVATE, ES384_PUBLIC, ES512_PRIVATE, ES512_PUBLIC, HS256, HS384, HS512, HTTP_BASIC, PASSWORD, PS256_PRIVATE, PS256_PUBLIC, PS384_PRIVATE, PS384_PUBLIC, PS512_PRIVATE, PS512_PUBLIC, RS256_PRIVATE, RS256_PUBLIC, RS384_PRIVATE, RS384_PUBLIC, RS512_PRIVATE, RS512_PUBLIC, RSA, RSA_OAEP_256_PRIVATE, RSA_OAEP_256_PUBLIC, RSA_OAEP_384_PRIVATE, RSA_OAEP_384_PUBLIC, RSA_OAEP_512_PRIVATE, RSA_OAEP_512_PUBLIC New build-time expression for the description. Omit to leave unchanged. Buildtime expressions use ClientKeyBuildtimeContext.
New build-time expression for the display name. Omit to leave unchanged. Buildtime expressions use ClientKeyBuildtimeContext.
New external key identifier (for example JWT kid). Omit to leave unchanged.
New key material in the same format as key on create for this algorithm. Omit to leave unchanged.
Response
Successful response
- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
- Option 6
- Option 7
- Option 8
- Option 9
- Option 10
Stored generic client key definition. Fields name and description are unevaluated and appear in buildtime-evaluatable form.
Cryptographic or integration algorithm. Discriminator for polymorphic create, update, and response schemas.
A128KW, A192KW, A256KW, ES256_PRIVATE, ES256_PUBLIC, ES384_PRIVATE, ES384_PUBLIC, ES512_PRIVATE, ES512_PUBLIC, HS256, HS384, HS512, HTTP_BASIC, PASSWORD, PS256_PRIVATE, PS256_PUBLIC, PS384_PRIVATE, PS384_PUBLIC, PS512_PRIVATE, PS512_PUBLIC, RS256_PRIVATE, RS256_PUBLIC, RS384_PRIVATE, RS384_PUBLIC, RS512_PRIVATE, RS512_PUBLIC, RSA, RSA_OAEP_256_PRIVATE, RSA_OAEP_256_PUBLIC, RSA_OAEP_384_PRIVATE, RSA_OAEP_384_PUBLIC, RSA_OAEP_512_PRIVATE, RSA_OAEP_512_PUBLIC RFC 3339 or RFC 9557 date-time with a numeric UTC offset and an optional IANA time-zone suffix in square brackets. Precision up to milliseconds.
^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{1,3})?(Z|[+-](?:[01][0-9]|2[0-3]):[0-5][0-9])(\[[^\]]+\])?$"2025-10-24T02:00:00-07:00"
Optional build-time expression that resolves to a human-readable description. Buildtime expressions use ClientKeyBuildtimeContext.
Stable Extole identifier for the client key.
Key material in the same encoding accepted on create. Symmetric secrets and private keys are partially masked in API responses; public keys are returned in full PEM form.
Display name for the key, in the same build-time evaluatable form that was supplied on create or update. Buildtime expressions use ClientKeyBuildtimeContext.
External key identifier used to match tokens or credentials to this key (for example the JWT kid header).
Free-form tags applied to the client key.
Usage category that determines how the key is consumed at runtime.
JWT, PASSWORD, PGP, PGP_EXTOLE, SSH, WEBHOOK RFC 3339 or RFC 9557 date-time with a numeric UTC offset and an optional IANA time-zone suffix in square brackets. Precision up to milliseconds.
^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{1,3})?(Z|[+-](?:[01][0-9]|2[0-3]):[0-5][0-9])(\[[^\]]+\])?$"2025-10-24T02:00:00-07:00"
