HomeUse CasesConceptsConfig GuidesDeveloper GuidesAPI Reference
API Reference
Start typing to search…

Complete a user invitation.

put https://{tenanturl}/v1.0/usc/user/invitation/

Entitlements required: inviteUser (Invite user).

This API is a public preview and is enabled for a tenant that includes invite user beta support.

Create the user and add them to groups or add an existing user to groups depending on the payload that is passed in. If the user record is specified, the user is created and added to the groups. If the user ID is specified, the user is added to the groups. If neither is specified, the transaction is completed without any further updates to the user.

This API completes the transaction and generates the audit event. If the flow is not finished and the email link is expired, the transaction is cleaned up automatically. If successful, the end user is emailed indicating they successfully completed the invitation.

Notifications can be branded by passing in the themeId as a query parameter. The template for branding is located at "notifications/user_management/invite/invite_user_complete_email.xml"

Path Params
string
required

The transaction identifier for the user invitation.

Query Params
string

The identifier of the theme that you want to apply.

Body Params

The body of the user invitation complete operation.

string
required

The OTP string from the email link. In the email link, the factorTrnxId query parameter is the OTP.

boolean

Notify the user that the invitation is complete. If the attribute is not specified, the email notification is sent.

string
required

The user data that is used to create the account or the user's ID to update an existing account. See the POST /v2.0/Users API for the JSON payload that passes to this API for creating an account.

Responses

Updated 9 months ago

Did this page help you?
Language
URL
Choose an example:
application/json

Updated 9 months ago

Did this page help you?