Get Keys

GET {{apiPath}}/environments/{{envID}}/keys

The GET /environments/{{envID}}/keys endpoint returns a list of all key resources for the specified environment. This operation allows SCIM filtering on the algorithm and status properties with the eq operator.

The sample returns the complete list of key resources associated with the environment ID specified in the request URL.

This operation allows SCIM filtering on the algorithm and status properties with the eq operator. The following sample returns the list of valid key resources associated with the environment ID specified in the request URL:

https://api.pingone.com/v1/environments/{{envID}}/keys?filter=status eq "VALID"

RESPONSES

status: OK

{"_links":{"self":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/keys"}},"_embedded":{"keys":[{"_links":{"self":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/keys/11b40ce3-fb02-4ee7-b5df-3abe64c6dda3"}},"id":"11b40ce3-fb02-4ee7-b5df-3abe64c6dda3","name":"Default","serialNumber":1558460844151,"issuerDN":"CN=Default-trial_ping_identity_981041295","subjectDN":"CN=Default-Default, OU=Ping Identity, O=Ping Identity, C=US","algorithm":"RSA","keyLength":2048,"createdAt":"2019-05-21T17:47:24.151Z","startsAt":"2019-05-21T17:47:24.151Z","expiresAt":"2020-05-20T17:47:24.151Z","validityPeriod":365,"signatureAlgorithm":"SHA256withRSA","usageType":"ENCRYPTION","status":"VALID","organization":{"id":"bed432e6-676a-4ebe-b5a5-6b3b54e46bda"},"environment":{"id":"abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"},"default":true},{"_links":{"self":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/keys/5183c34a-6e64-4e19-9e83-69c0de54e744"}},"id":"5183c34a-6e64-4e19-9e83-69c0de54e744","name":"Default","serialNumber":1558460843791,"issuerDN":"CN=Default-trial_ping_identity_981041295","subjectDN":"CN=Default-Default, OU=Ping Identity, O=Ping Identity, C=US","algorithm":"RSA","keyLength":2048,"createdAt":"2019-05-21T17:47:23.791Z","startsAt":"2019-05-21T17:47:23.791Z","expiresAt":"2020-05-20T17:47:23.791Z","validityPeriod":365,"signatureAlgorithm":"SHA256withRSA","usageType":"SIGNING","status":"VALID","organization":{"id":"bed432e6-676a-4ebe-b5a5-6b3b54e46bda"},"environment":{"id":"abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"},"default":true}]},"size":2}