Developers

Sign Up

Cookie
session

Request Body

blocked
boolean

Whether this End-User is blocked or not. If true End-User will not be able to login.

email
string

End-User's e-mail address.

email_verified
boolean

true if the End-User's e-mail address has been verified; otherwise false. If force_email_verification is enabled in your tenant's settings, it will check this value of user while performing email verification checks.

hash_fn
string

Used password hash function identifier.

Available Values: bcryptargon2pbkdf2

identities
array<object>
identities.
connection
string
Required

Connection name

identities.
provider
string
Required

Available Values: twiliovonagenetgsm3gbilisimdataportmessagebirdcustomhotptotpnativeexpoone-signalaws_sespostmarksendgridsparkpostsmtpcustom-oauth2amazonapplee-devletdribbbledropboxfacebookgithubgooglelinkedinmicrosoftslackspotifytwittersamlldap

identities.
type
string
Required

Available Values: smsotppushemailsocialenterprise

identities.
id
string

External user's id coming from the connection.

identities.
details
object
Required

Raw user object from the connection

login_attempts
integer
min0
max
20000

Failed login attempts of user. It will reset to 0 after successful login.

name
string

End-User's full name in displayable form including all name parts, possibly including titles and suffixes, ordered according to the End-User's locale and preferences.

password
string

End-User's password in plaintext. Defined password policy rules will be enforced.

phone_number
string

End-User's preferred phone number. It will be stored in E.164 format.

phone_number_verified
boolean

true if the End-User's phone number has been verified; otherwise false. If SMS MFA is enabled this value will be used to determine whether End-User has verified it's phone or not.

picture
string

URI reference of the End-User's profile picture.

salt
string

Salt value used in computing hash of password.

username
string

End-User's username

verify_email
boolean
metadata
object

Additional metadata for your End-User. It must be an object containing 10 fields at max with keys and values no more than 1024 characters. Values can be only one of the types string, number and boolean. You can also use "null" as value to make metadata consistent across other users.

profile
object
profile.
addresses
array
profile.addresses.
city
string

City or locality component.

profile.addresses.
country
string

Country name component.

profile.addresses.
first_name
string
profile.addresses.
id
string

Identifier for user address. Example: Delivery Address, Billing Address etc.

profile.addresses.
is_primary
boolean
profile.addresses.
last_name
string
profile.addresses.
state
string

State, province, prefecture or region component.

profile.addresses.
street_address
string

Full street address component, which MAY include house number, street name, Post Office Box, and multi-line extended street address information. This field may contain multiple lines, separated by newline characters.

profile.addresses.
street_address_2
string

Full street address component, which MAY include house number, street name, Post Office Box, and multi-line extended street address information. This field may contain multiple lines, separated by newline characters.

profile.addresses.
zip_code
string

Zip code or postal code component.

profile.
birthdate
string

End-User's birthday. ISO 8601:2004 YYYY-MM-DD format. The year may be 0000, indicating that it is omitted. To represent only the year, YYYY format is preferred.

profile.
family_name
string

Surname(s) or last name(s) of the End-User. Note that in some cultures, people can have multiple family names or no family name; all can be present, with the names being separated by space characters.

profile.
gender
string, integer
min-10
max
10

Short code of End-User's gender.

profile.
given_name
string

Given name(s) or first name(s) of the End-User. Note that in some cultures, people can have multiple given names; all can be present, with the names being separated by space characters.

profile.
locale
string

End-User's locale. For example, en-US or fr-CA.

profile.
middle_name
string

Middle name(s) of the End-User. Note that in some cultures, people can have multiple middle names; all can be present, with the names being separated by space characters. Also note that in some cultures, middle names are not used.

profile.
nickname
string

Casual name of the End-User that may or may not be the same as the given_name. For instance, a nickname value of Mike might be returned alongside a given_name value of Michael.

profile.
profile_page
string

URI reference for the End-User's profile page.

profile.
website
string

URI reference for the End-User's Web page or blog.

profile.
zoneinfo
string

String from zoneinfo time zone database representing the End-User's time zone. For example, Europe/Paris or America/Los_Angeles.

POST
/signup
1
2
3
4
5
6
7
8
9
10
11
12
13
14
Loading...