Site Home
API Reference
LoginTry for Free

Accept New User Invitation For External IdP User

post
https://{application_vanity_domain}/api/v1/new-user-invitation/external-idp/accept-invite
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

External IdP Accept New User Invite Request JSON object

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 6 months ago

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 6 months ago