Sign Up

Creates a new user via email/password and issues tokens. When iframe_sso is true, the response returns data.oauth_token only; otherwise access_token, refresh_token, and expires_in.

Headers

X-Correlation-Id
Type: string

Optional caller-provided correlation ID; echoed in responses when present.

Body·

required

application/json

client
Type: string
required

OAuth client ID provided by the business. Required to identify the client application for signup. The OAuth application must have the Advance Auth scope enabled.
iframe_sso
Type: boolean

When true, enables iframe SSO flow; response returns data.oauth_token only. redirect_uri is required when true.
redirect_uri
Type: string Format: uri

Required when iframe_sso is true. Must match one of the OAuth application's configured redirect URIs.
user
Type: object

Responses

application/json
application/json
application/json
application/json
application/json
application/json
application/json

post/api2/basic_auth/signup

curl https://SERVER_NAME_GOES_HERE/api2/basic_auth/signup \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "client": "CLIENT_GOES_HERE",
  "iframe_sso": false,
  "user": {
    "email": "test@example.com",
    "password": "PASSWORD_GOES_HERE",
    "password_confirmation": "PASSWORD_GOES_HERE",
    "signup_channel": "WebEmailBasicAuth",
    "terms_and_conditions": true,
    "privacy_policy": true
  }
}'

Show Schema

{
  "data": {
    "access_token": "ACCESS_TOKEN_GOES_HERE",
    "refresh_token": "REFRESH_TOKEN_GOES_HERE",
    "expires_in": 86400
  }
}

User created and tokens issued successfully.