Skip to main content
Onboard a user in the authenticated tenant.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

At least one of email or username must be provided.

email
string<email>
username
string
Minimum string length: 1
Pattern: ^[a-zA-Z0-9._-]+$
firstName
string
lastName
string
externalIdentifier
string
Minimum string length: 1
sendOnboardingEmail
boolean

Send a Keycloak onboarding email (set password, verify email, strong auth). Defaults to true when an email is provided and the environment has onboarding contexts configured. Requires email.

onboardingContext
string

Onboarding context key from the server-side registry. Defaults to 'me-wallet'.

Minimum string length: 1
strongAuth
enum<string>

Strong-auth setup in the email stream. Defaults to the context's defaultStrongAuth.

Available options:
passkey,
otp,
skip

Response

User onboarded successfully.

data
object
required
Example:
meta
object
errors
object[]