Site Home
API Reference
LoginTry for Free

Create User

post
https://{application_vanity_domain}/api/v1/users
Body Params

User resource

string
string
length between 1 and 26

ID of the tenant that the user belongs to. For multi-tenant applications this value is required on create.

string
length between 1 and 70

[Required on Create] Name of the identity provider that the user belongs to.

string
length between 1 and 200

A unique identifier that can be used in conjunction with a password to authenticate a user.

string
length between 1 and 200

[Required on Create] Primary email address of the user. This is the email that all transactional emails will be sent to.

boolean
Defaults to false

Boolean indicating if the user's email has been verified or not

string
length between 1 and 200

Identifier of a user that is maintained in an external system. This value is required for users that belong to an external IdP.

string
length between 1 and 200

The user’s full name, including all middle names, titles, and suffixes as appropriate, formatted for display (e.g., "Ms. Barbara Jane Jensen, III”).

string
length between 1 and 100

Given name

string
length between 1 and 100

Family name

string
length between 1 and 100

Middle name

string
length between 1 and 40

Honorific prefix

string
length between 1 and 40

Honorific suffix

string
length between 1 and 100

The user's nickname

string
length between 1 and 100

The primary textual label by which this user is normally displayed by the service provider when presenting it to end-users.

uri
length between 1 and 2000

URL of the user’s profile picture. This URL MUST refer to an image file (for example, a PNG, JPEG, or GIF image file), rather than to a web page containing an image. Note that this URL SHOULD specifically reference a profile photo of the user suitable for displaying when describing the user, rather than an arbitrary photo taken by the user.

string
length between 1 and 100

The user’s gender as described by the user.

date
length between 1 and 10

The user's birthday represented in ISO 8601 YYYY-MM-DD format.

string
length between 1 and 50

User's preferred telephone number. The value should be normalized to E.164 format. If the phone number contains an extension, the extension should be represented using the RFC 3966 extension syntax, for example, +16045551234;ext=5678.

string
length between 1 and 50

The preferred language of the user.

string
length between 1 and 50

The locale used to determine how localized content such as currency, date time format, numerical representations, etc. should be rendered.

string
length between 1 and 50

The user's timezone

restrictedMetadata
object

Allows for storing custom metadata that should only be modifiable by authenticated subjects with the user:manage-restricted-metadata permission. Conceptually, the restricted metadata is meant to store custom attributes that end users should not be able to modify, for example, internal identifiers. The following restrictions apply to this field:

  • The max size of the JSON is 4KB
  • The max nesting depth is 3
  • The max number of top level fields within an object is 15
  • Field names must abide by the following regex: ^[a-zA-Z]([-_]?[a-zA-Z0-9]+)*$
  • Directly nesting arrays within each other is not permitted. For example the following value is not allowed: [[1, 2], [4,5]] The object fields are case-insensitive and if duplicate field names are provided then the last value written will win.

Fields can be deleted by assigning them a value of null. Likewise, all fields can be deleted by setting the restrictedMetadata field to null.

publicMetadata
object

Allows for storing custom metadata that should be modifiable by end users. Unlike the restrictedMetadata field, the public metadata does not require any extra permissions to modify. The following restrictions apply to this field:

  • The max size of the JSON is 4KB
  • The max nesting depth is 3
  • The max number of top level fields within an object is 15
  • Field names must abide by the following regex: ^[a-zA-Z]([-_]?[a-zA-Z0-9]+)*$
  • Directly nesting arrays within each other is not permitted. For example the following value is not allowed: [[1, 2], [4,5]] The object fields are case-insensitive and if duplicate field names are provided then the last value written will win.

Fields can be deleted by assigning them a value of null. Likewise, all fields can be deleted by setting the publicMetadata field to null.

string
enum
length between 1 and 45
Defaults to ACTIVE

The user's current status

Allowed:
string
Responses

Updated 6 months ago

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