Skip to content
Authrim

Rotate a key registry.

POST
/api/admin/field-mapping/key-registries/{keyRegistryId}/rotate
Code sample: Shell / cURL 
curl --request POST \
  --url https://auth.example.com/api/admin/field-mapping/key-registries/example/rotate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "algorithm": "HKDF-SHA256", "backendType": "key_manager", "materialRef": "tenant:default:saml:pairwise-nameid:v2", "jobMode": "both" }'

Creates a new active key version for a key registry and optionally schedules rewrap or blind-index rotation jobs. The response includes the new active version and any generated jobs.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
keyRegistryId
required
string

Header Parameters

Section titled “Header Parameters ”
Idempotency-Key
string

Idempotency key for state-changing operations that support replay protection.

Request Body required

Section titled “Request Body required ”
Media type application/json
object
algorithm
required
string
backendType
required
string
materialRef
required
string
materialMetadata
object
key
additional properties
actorId
string
jobMode
string
Allowed values: rewrap blind_index both none
artifactScope
object
key
additional properties
key
additional properties
Example 
{
  "algorithm": "HKDF-SHA256",
  "backendType": "key_manager",
  "materialRef": "tenant:default:saml:pairwise-nameid:v2",
  "jobMode": "both"
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Key registry rotation response.

Media type application/json
object
result
required
object
keyRegistryId
required
string
activeVersionId
required
string
version
required
integer
jobs
required
Array<object>
object
id
required
string
type
required
string
Allowed values: rewrap blind_index_rotation
key
additional properties
key
additional properties
key
additional properties
Example 
{
  "result": {
    "jobs": [
      {
        "type": "rewrap"
      }
    ]
  }
}

400

Section titled “400 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

401

Section titled “401 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

403

Section titled “403 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

404

Section titled “404 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

409

Section titled “409 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

500

Section titled “500 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}