Use the PUT /keyPairs/oauthOpenIdConnect
endpoint to update OAuth/OpenID Connect key settings.
Code | Reason |
---|---|
200 | OAuth/Open ID Connect key settings updated. |
400 | The request was improperly formatted or contained invalid fields. |
422 | Validation error(s) occurred. |
OAuthOidcKeysSettings
- Setting for OAuth/OpenID Connect signing and decryption key settings.
Property | Type | Description |
---|---|---|
p256ActiveCertRef | ResourceLink | Reference to the P-256 key currently active. |
p256DecryptionActiveCertRef | ResourceLink | Reference to the P-256 decryption key currently active. |
p256DecryptionPreviousCertRef | ResourceLink | Reference to the P-256 decryption key previously active. |
p256DecryptionPublishX5cParameter | boolean | Enable publishing of the P-256 certificate chain associated with the active key. |
p256PreviousCertRef | ResourceLink | Reference to the P-256 key previously active. |
p256PublishX5cParameter | boolean | Enable publishing of the P-256 certificate chain associated with the active key. |
p384ActiveCertRef | ResourceLink | Reference to the P-384 key currently active. |
p384DecryptionActiveCertRef | ResourceLink | Reference to the P-384 decryption key currently active. |
p384DecryptionPreviousCertRef | ResourceLink | Reference to the P-384 decryption key previously active. |
p384DecryptionPublishX5cParameter | boolean | Enable publishing of the P-384 certificate chain associated with the active key. |
p384PreviousCertRef | ResourceLink | Reference to the P-384 key previously active. |
p384PublishX5cParameter | boolean | Enable publishing of the P-384 certificate chain associated with the active key. |
p521ActiveCertRef | ResourceLink | Reference to the P-521 key currently active. |
p521DecryptionActiveCertRef | ResourceLink | Reference to the P-521 decryption key currently active. |
p521DecryptionPreviousCertRef | ResourceLink | Reference to the P-521 decryption key previously active. |
p521DecryptionPublishX5cParameter | boolean | Enable publishing of the P-521 certificate chain associated with the active key. |
p521PreviousCertRef | ResourceLink | Reference to the P-521 key previously active. |
p521PublishX5cParameter | boolean | Enable publishing of the P-521 certificate chain associated with the active key. |
rsaActiveCertRef | ResourceLink | Reference to the RSA key currently active. |
rsaDecryptionActiveCertRef | ResourceLink | Reference to the RSA decryption key currently active. |
rsaDecryptionPreviousCertRef | ResourceLink | Reference to the RSA decryption key previously active. |
rsaDecryptionPublishX5cParameter | boolean | Enable publishing of the RSA certificate chain associated with the active key. |
rsaPreviousCertRef | ResourceLink | Reference to the RSA key previously active. |
rsaPublishX5cParameter | boolean | Enable publishing of the RSA certificate chain associated with the active key. |
staticJwksEnabled * | boolean | Enable static keys. |
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. |