Skip to content
Authrim

Register an opaque handle to an already-enrolled provider secret.

POST
/api/admin/agent-secret-refs
Code sample: Shell / cURL 
curl --request POST \
  --url https://auth.example.com/api/admin/agent-secret-refs \
  --header 'Content-Type: application/json' \
  --cookie authrim_admin_session=<authrim_admin_session> \
  --data '{ "resource_type": "example", "resource_id": "example", "purpose": "example", "provider_key": "example", "expires_at": 1 }'

This endpoint never accepts or returns the secret value, creates or confirms the tenant-bound KeyManager entry, and is unavailable to Agent bearer contexts.

Authorizations

Section titled “Authorizations ”

Request Body required

Section titled “Request Body required ”
Media type application/json
object
resource_type
required
string
>= 1 characters <= 128 characters
resource_id
string
>= 1 characters <= 128 characters
purpose
required
string
>= 1 characters <= 120 characters
provider_key
required

Tenant-owned KeyManager locator using the tenant:{tenant_id}:agent: prefix; never a secret value.

string
>= 1 characters <= 256 characters
expires_at

Optional Unix epoch milliseconds, no more than one year in the future.

integer format: int64
key
additional properties
Example generated
{
  "resource_type": "example",
  "resource_id": "example",
  "purpose": "example",
  "provider_key": "example",
  "expires_at": 1
}

Responses

Section titled “ Responses ”

201

Section titled “201 ”

Opaque secret reference created.

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

503

Section titled “503 ”

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