Site Home
API Reference
LoginTry for Free

Provision External IdP User on Login

post
https://{application_vanity_domain}/api/v1/external-idp-login/provision-user
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Provisions a new user within Wristband based on the profile attributes synced from an external IdP. The user will be created with an ACTIVE status and their email will be marked as verified if the IdP asserts that the email is verified.

If the user's email is not verified, and the Enterprise IdP Login Workflow Policy email verification strategy is set to EMAIL_LINK, then this API will asynchronously send a verification email to the user that they can use to verify their email.

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.

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.

PermissionBoundaryDescription
external-idp-login-workflow:executeApplicationThe subject can perform this operation for requests associated with the application to which the subject belongs.
Body Params

External IdP Login Provision User Request JSON object

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

string
required
length ≥ 1

The external IdP auth code that will be used to authorize the 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.
Responses

Updated about 2 months ago

Did this page help you?
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 about 2 months ago

Did this page help you?