Update Key
PUT {{apiPath}}/environments/{{envID}}/keys/{{keyID}}
The PUT /environments/{{envID}}/keys/{{keyID}} operation updates a property or properties for the current key. You'll get an error if you attempt to update a key having a status of EXPIRED.
Prerequisites
- See Certificate Management for important overview information.
For property descriptions, see Certificate management data model.
| Property | Type | Required? |
|---|---|---|
algorithm | String | Required |
default | Boolean | Required |
expiresAt | Date | N/A |
issuerDN | String | Required |
keyLength | Integer | Required |
name | String | Optional |
serialNumber | Integer | Required |
signatureAlgorithm | String | Required |
startsAt | Date | Required |
status | String | Required |
subjectDN | String | Required |
trustChain | String[] | Optional |
usageType | String | Required |
validityPeriod | Integer | Required |
Request Body
{"default"=>true, "usageType"=>"SIGNING"}
RESPONSES
status: OK
{"_links":{"self":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/keys/42ffcea1-dcff-4098-821a-11654759ffc9"}},"id":"42ffcea1-dcff-4098-821a-11654759ffc9","name":"PingOne SSO Certificate for New-Env_1614297110 environment","serialNumber":1614297109858,"subjectDN":"C=US,O=Ping Identity,OU=Ping Identity,CN=PingOne SSO Certificate for New-Env_1614297110 environment","issuerDN":"PingOne SSO Certificate for New-Env_1614297110 environment","algorithm":"RSA","keyLength":2048,"createdAt":"2021-02-25T23:51:49.858Z","startsAt":"2021-02-25T23:51:49.858Z","expiresAt":"2022-02-25T23:51:49.858Z","validityPeriod":365,"signatureAlgorithm":"SHA256withRSA","usageType":"SIGNING","status":"VALID","organization":{"id":"bed432e6-676a-4ebe-b5a5-6b3b54e46bda"},"environment":{"id":"abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"},"default":true}