Rotate a security object to an existing security object.

Prev Next
Post
/crypto/v1/keys/replace

For two keys R and S, where R is the key to be replaced, and S is the intended replacement, this operation will

  • Rename R to the name provided in the request
  • Establish an replaced-replacement between R and S
  • Assign R's old name to S The metadata of S should be mostly same as that of R, and it is not possible to update any fields of S while performing this operation. If S does not have any custom metadata or a rotation policy, any corresponding values from R will be copied over to S. For now, this operation is not supported if R, S, or both are externally-backed keys.
Security
HTTP
Type bearer
API Key
Header parameter nameAuthorization
Body parameters
object
replaced
OneOf
SobjectDescriptorPersistedVariantKid
object (SobjectDescriptorPersistedVariantKid)
kid
string (uuid) Required
SobjectDescriptorPersistedVariantName
object (SobjectDescriptorPersistedVariantName)
name
string Required
Max length4096
Pattern^[^\n]*[^\s\n][^\n]*$
replaced_new_name
string Required
Max length4096
Pattern^[^\n]*[^\s\n][^\n]*$
replacement
OneOf
SobjectDescriptorPersistedVariantKid
object (SobjectDescriptorPersistedVariantKid)
kid
string (uuid) Required
SobjectDescriptorPersistedVariantName
object (SobjectDescriptorPersistedVariantName)
name
string Required
Max length4096
Pattern^[^\n]*[^\s\n][^\n]*$
Responses
204

Nothing is returned on success