Send Invitations

Send user onboarding invitations.

Required entitlements:

• inviteUser (always required)
• manageUserGroups or manageUserStandardGroups (required only when using the Groups parameter)

External Documentation

To learn more, visit the IBM Security Verify documentation.

​

Basic Parameters

Parameter	Description
Expiration In Days	The number of days before the invitation expires. Valid range is 1-30.
Groups	A comma-separated list of group IDs to which the user will be assigned. Users inherit roles and permissions through group membership. At least one of the following entitlements is required to use this parameter: * manageUserGroups * manageUserStandardGroups
Invitations	An array of invitations to send. Invitation structure: * email (required): The email address of the user to invite. * name: The name of the user to include in the invitation email. * stateId: A custom identifier to associate with the invitation transaction, defaults to default. For example: [ { “email”: “[e-mail]”, “name”: “John Doe”, “stateId”: “custom-state” } ]
Realm	The realm or identity source where the user account will be created.
Theme ID	The identifier of the theme to apply to the invitation email.

​

Advanced Parameters

Parameter	Description
Adopter ID	An identifier for creating a unique invitation based on Adopter ID and Email. When sending the invitation, any existing invitation with the same Adopter ID and Email combination is replaced.
Base Verification URL	A custom URL to override the default invitation acceptance link. For more information about the Base Verification URL parameter, refer to IBM API documentation.
Enrollment ID	The Enrollment ID for the password resetter and username recovery operations. Defaults to the first available enrollment if not specified. Use the value transient to verify using the user’s profile data. When using this option, parameter Transient Value is required. For more information about the Enrollment ID parameter, refer to IBM API documentation.
OTP Correlation	A custom prefix to prepend to the OTP (One-Time Password) that is sent to the user. For example, if the correlation is 3235, the user will receive the value 3235-126543 where 126543 is the generated OTP.
Redirect URL	The destination URL to redirect the user after a successful verification when Base Verification URL is not specified.
Transient Value	The user’s email address or phone number for verification when Enrollment ID parameter is set to transient. If not provided, the user’s primary contact information from their profile will be used. For more information about the Enrollment ID parameter, refer to IBM API documentation.

​

Example Output

{
	"messageId": "string",
	"messageDescription": "string",
	"results": [
		{
			"trxId": "string",
			"expiration": "string",
			"error": "string",
			"email": "string",
			"result": "failure"
		}
	]
}