Skip to content
Authrim

Create a key registry.

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

Creates a key registry and initial active key version reference for field-mapping secrets, blind indexes, or persistent identifier material. The response is wrapped as { result }.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

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
keyPurpose
required
string
scope
required
object
key
additional properties
algorithm
required
string
backendType
required
string
materialRef
required
string
materialMetadata
object
key
additional properties
actorId
string
key
additional properties
Example 
{
  "keyPurpose": "persistent_identifier",
  "scope": {
    "profileId": "persistent_identifier_profile_123"
  },
  "algorithm": "HKDF-SHA256",
  "backendType": "key_manager",
  "materialRef": "tenant:default:saml:pairwise-nameid"
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Key registry create response.

Media type application/json
object
result
required
object
id
required
string
tenantId
required
string
activeVersionId
required
string
keyPurpose
required
string
status
required
string
key
additional properties
key
additional properties
Example generated
{
  "result": {
    "id": "example",
    "tenantId": "example",
    "activeVersionId": "example",
    "keyPurpose": "example",
    "status": "example"
  }
}

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"
}