Provision External IdP User on Signup

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

External IdP Signup Provision User Request JSON object

Request to provision a user as part of a signup workflow.

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
required
length ≥ 1

The external IdP auth code that will be used to authorize the request.

Responses

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