Skip to navigation
Runtype APIAgents

Register an agent public key

Register a public JWK the external agent signs private_key_jwt client assertions with. Symmetric keys, keys with private members and algorithms outside the allowlist are refused.

Authentication

AuthorizationBearer
API key or Clerk session token

Path parameters

idstringRequired
Agent ID

Request

This endpoint expects an object.
jwkmap from strings to anyRequired

A public JWK (EC P-256/P-384, RSA of at least 2048 bits, or OKP Ed25519) with no private members.

algorithmenumOptional

The algorithm client assertions are signed with; defaults to the JWK alg.

expiresAtdatetimeOptional
When the key stops being accepted.

Response

The registered key
agentIdstring
algorithmstring or null
The pinned signing algorithm of a public key.
createdAtstring
createdByUserIdstring or null

Who registered it; provenance only.

expiresAtstring or null
idstring
kidstring

Key ID; for a client secret, a generated identifier.

kindenum
Allowed values:
publicJwkmap from strings to any or null
The registered public JWK.
revokedAtstring or null
secretHintstring or null
The last four characters of a client secret.
statusenum
Allowed values:

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error