Skip to main content
POST
Agent registration (auth.md)

Body

application/json
type
enum<string>
required
Available options:
anonymous
requested_credential_type
enum<string>

Requested credential type. Currently only api_key is supported.

Available options:
api_key

Response

200 - application/json

The request has succeeded.

registration_id
string
required

Server-generated registration id (rgn_...).

registration_type
enum<string>
required

How the registration was initiated.

Available options:
anonymous,
email-verification
credential_type
enum<string>

Credential type returned, when issued immediately. Omitted on flows that require claim_token first.

Available options:
api_key
credential
string

Live credential (API key) issued by the server, when one is issued immediately.

credential_expires
integer<int64>

Unix epoch ms when the credential expires, or null/undefined for non-expiring keys.

scopes
string[]

Scopes the credential is authorized for at issue time.

post_claim_scopes
string[]

Scopes that will be added after the claim flow completes.

claim_url
string

URL the agent should direct the principal to in order to complete claim/verification.

claim_token
string

Opaque token used to complete the claim flow.

claim_token_expires
integer<int64>

Unix epoch ms when the claim_token expires.