Provisions a new user for the given external IdP. For multi-tenant apps, this action also includes creating the tenant that the user will be assigned to.
Note
Any user attributes specified in the request body will be overridden by their corresponding value from the external IdP if syncing is enabled for that user attribute, unless the value from the external IdP is null and the field is marked as required in the user schema, in that case, the value from the request body will take 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.
| Permission | Boundary | Description |
|---|---|---|
| external-idp-signup-workflow:execute | Application | The subject can perform this operation for requests associated to the application that the subject belongs to. |
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. |