Provision External IdP User on Signup

post

https://{application_vanity_domain}/api/v1/external-idp-signup/provision-user

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Provisions a new user for the given external IdP.

For profile attributes not configured to sync from the external IdP, you can manually provide values in the request body. If syncing is enabled for an attribute, its value from the external IdP will override any value you provide—unless the IdP value is null and the field is marked as required in the user schema. In that case, the request body value takes precedence.

Several responses can be returned from this API. Please refer to the result response field description to see the different types of responses that can be returned.

Required Permissions

Below is the list of required permissions needed to interact with this API. For each permission, the allowed permission boundaries are also specified.

Permission	Boundary	Description
external-idp-signup-workflow:execute	Application	The subject can perform this operation for requests associated with the application to which the subject belongs.

Body Params

External IdP Signup Provision User Request JSON object

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

tenantDisplayName

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.

tenantDomainName

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.

tenantName

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.

fullName

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.

givenName

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.

familyName

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.

phoneNumber

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.

birthdate

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.

externalIdpAuthCode

string

required

length ≥ 1

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

Responses

Required Permissions

200OK

400Bad Request

401Unauthorized

403Forbidden

405Method Not Allowed

406Not Acceptable

409Conflict

415Unsupported Media Type

500Internal Server Error

503Service Unavailable