API/ Onboarding
Onboarding
Admin-minted onboarding secrets and the redeem flow that bootstraps a new identity into the realm.
post/onboarding-secrets
Mint a single-use onboarding secret for a new integrator username
- Body
MintOnboardingSecretRequest- Responses
200 · MintOnboardingSecretResponse — Secret minted400 · ApiError — Bad request401 · ApiError — Unauthorized403 · ApiError — Forbidden409 · ApiError — Conflict (e.g. username already provisioned)500 · ApiError — Internal server error502 · ApiError — Upstream failure (Keycloak admin or Canton topology submission)
post/onboarding/prepare
Build the Canton topology transactions for the bootstrapped integrator party
- Body
PrepareOnboardingRequest- Responses
200 · PreparedOnboardingTopology — Prepared topology ready to verify and sign400 · ApiError — Bad request401 · ApiError — Unauthorized403 · ApiError — Forbidden409 · ApiError — Conflict (e.g. username already provisioned)500 · ApiError — Internal server error502 · ApiError — Upstream failure (Keycloak admin or Canton topology submission)
post/onboarding/redeem
Redeem an onboarding secret and bootstrap a Keycloak user + API key
- Body
RedeemOnboardingSecretRequest- Responses
200 · RedeemOnboardingSecretResponse — Keycloak user + API key bootstrapped400 · ApiError — Bad request401 · ApiError — Unauthorized403 · ApiError — Forbidden409 · ApiError — Conflict (e.g. username already provisioned)500 · ApiError — Internal server error502 · ApiError — Upstream failure (Keycloak admin or Canton topology submission)
get/onboarding/status
Read the onboarding lifecycle state for the authenticated bootstrapped user
- Responses
200 · OnboardingStatusResponse — Onboarding lifecycle state400 · ApiError — Bad request401 · ApiError — Unauthorized403 · ApiError — Forbidden409 · ApiError — Conflict (e.g. username already provisioned)500 · ApiError — Internal server error502 · ApiError — Upstream failure (Keycloak admin or Canton topology submission)
post/onboarding/submit
Submit the signed topology, co-authorize as the hosting participant, and activate the party
- Body
SubmitOnboardingRequest- Responses
200 · SubmitOnboardingResponse — Party activated202 · SubmitOnboardingResponse — Topology submitted, awaiting Canton activation400 · ApiError — Bad request401 · ApiError — Unauthorized403 · ApiError — Forbidden409 · ApiError — Conflict (e.g. username already provisioned)500 · ApiError — Internal server error502 · ApiError — Upstream failure (Keycloak admin or Canton topology submission)