Use the PUT /sp/idpConnections/{{idpId}}/credentials/decryptionKeys endpoint to update the IdP connection decryption keys.

Path parameters

Parameter Value Description
idpId string(required) ID of IdP Connection to update.

Status codes

Code Reason
200 Connection updated.
400 The request was improperly formatted or contained invalid fields.
403 PingFederate does not have its SP role enabled. Operation not available.
404 Resource not found.
422 Validation error(s) occurred.

DecryptionKeys - Decryption keys used to decrypt message content received from the partner.

Property Type Description
primaryKeyRef ResourceLink The ID of the primary decryption key pair. It is also known as the alias and can be found by viewing the corresponding certificate under ‘Signing & Decryption Keys & Certificates’ in the PingFederate Administrative Console.
secondaryKeyPairRef ResourceLink The ID of the secondary key pair used to decrypt message content received from the partner.

ResourceLink - A reference to a resource.

Property Type Description
id * string The ID of the resource.
location string A read-only URL that references the resource. If the resource is not currently URL-accessible, this property will be null.