Provision Wristband IdP User on Signup

Body Params

Wristband IdP Signup Provision User Request JSON object

string
length between 1 and 200

[Conditionally Required] Display name of the tenant that will be created and the user will be assigned to.

Required Conditions:

  • The signup request is at the application level and the tenant is being created as part of the signup request.
string
length between 3 and 20
deprecated

Deprecation Notice: This field has been replaced by the tenantName field and should no longer be used. In the future, this field may be removed.

Name of the tenant that will be created and the user will be assigned to.

string
length between 3 and 20

[Conditionally Required] Name of the tenant that will be created and the user will be assigned to.

Required Conditions:

  • The signup request is at the application level and the tenant is being created as part of the signup request.
string
required
length between 1 and 200

Email used for authenticating a user. Must be unique per IdP and tenant.

string
length between 1 and 200

[Conditionally Required] The user's whole name, including their given name and surname, and sometimes any middle names, prefixes, or suffixes.

Required Conditions:

  • This value is required if the tenant's resolved user schema has full name set as required.
string
length between 1 and 200

[Conditionally Required] The given name, or first name in most Western languages.

Required Conditions:

  • This value is required if the tenant's resolved user schema has given name set as required.
string
length between 1 and 200

[Conditionally Required] The family name, or last name in most Western languages.

Required Conditions:

  • This value is required if the tenant's resolved user schema has family name set as required.
string
length between 1 and 16

[Conditionally Required] The user's phone number in E.164 international format.

Required Conditions:

  • This value is required if the tenant's resolved user schema has phone number set as required.
date
length between 1 and 10

[Conditionally Required] The user's birthdate.

Required Conditions:

  • This value is required if the tenant's resolved user schema has birthdate set as required.
string
length between 1 and 26

ID of the client making the signup request.

string
length between 1 and 26

[Conditionally Required] ID of the application that the user will get assigned to.

Required Conditions:

  • The signup request is at the application level.
string
length between 1 and 26

[Conditionally Required] ID of the tenant that the user will get assigned to.

Required Conditions:

  • The signup request is at the tenant level.
string
length between 1 and 200

[Conditionally Required] Username used for authenticating a user. Must be unique per IdP and tenant.

Required Conditions:

  • The Wristband IdP has both username and email configured as login identifiers.
password
length ≥ 1

[Conditionally Required] Password that will be assigned to the user.

Required Conditions:

  • The Wristband IdP only has password configured as a login factor.
string
length between 1 and 26

Opaque string that clients can use to propagate state through the signup flow. If a state value is provided it will be returned in the state query param as part of the redirect URL.

Responses

Language
Credentials
Bearer
JWT
URL
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json