Site Home
API Reference
LoginTry for Free

Accept New User Invite

post
https://{application_vanity_domain}/api/v1/new-user-invitation/accept-invite
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Accept New User Invite Request JSON object

string
length ≥ 1

[Conditionally Required] The email auth code that will be used to authorize the request.

Required Conditions:

  • This value is only required for invitations of type EMAIL. If an inviteCode is specified then this value must be null.
string
length ≥ 1

[Conditionally Required] The invite code that will be used to authorize the request.

Required Conditions:

  • This value is only required for invitations of type LINK. If an emailAuthCode is specified then this value must be null.
string
length between 1 and 200

[Conditionally Required] The user's primary email.

Required Conditions:

  • This value is only required for invitations of type LINK. The email must be unique per IdP and tenant.
string
length between 1 and 200

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

Required Conditions:

  • This value is required if the Wristband IdP has both username and email configured as login identifiers.
password
length ≥ 1

[Conditionally Required] The new password associated to the user who is accepting the invitation.

Required Conditions:

  • This is required if the user is being provisioned to the Wristband IdP and password login factor is enabled.
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.
Responses

Updated 6 months ago

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

Updated 6 months ago