Instant User Activation Without Manual Email Confirmation

Introduction

This article explains how to quickly add users to the AppXite platform using the instant, IDP-based activation process via API. With this feature, users don't need to manually click confirmation links in activation emails, streamlining the onboarding process. You can choose between instant activation of invited users or manual activation that requires email confirmation.

In this article:

What Do You Need To Use This Feature?

To use instant, API-based user activation, you need the following:

  • Active AppXite partner account.
  • Your own identity provider solution (IDP) with added users and their IDs in your IDP.
  • Access to API and our API endpoint details that allow you to integrate your AppXite account with your IDP solution.

How Does Instant IDP-Based User Activation Work?

When you're creating users through the API, you can decide if you want them to manually activate their AppXite accounts by clicking on a confirmation link they received in an invitation email or if you want to add and activate them on AppXite instantly.

You can choose instant, IDP-based user activation by setting the ShouldActivateByEmail flag in your API request to false.

This flag prevents the platform from sending activation emails to invited users. Setting the flag to true triggers sending out confirmation emails.

Other relevant parameters that you need to include in the API request include:

  • ExternalId – the user's ID in your own IDP solution. Initially ExternalId could be random unique value. When user logs in for the 1st time with selected IDP, ExternalId updates automatically with correct one from External system after becoming permanent. It works with multiple IDPs.
  • IdentityProviderId – the ID of the IDP solution.

NOTE! Partners can invite users also with 'account' method but in this case they should set 'ShouldActivateByEmail = true'. To get the Id used for Account or any other Id of IdentityProvider reach out to Appxite Support.

For all the other parameters and detailed API information about the POST request related to user creation, check our API documentation: Create a User

Limitations

While this feature streamlines user activation, be aware that changes to certain settings may require additional steps:

  • API integration must be properly configured and maintained for seamless activation.
  • User data must match between your IDP and AppXite for successful authentication.

Summary

If you integrate your AppXite account with your own IDP solution that you use internally to verify and manage your users, you can quickly add new users to AppXite and instantly activate their accounts. You no longer need to wait for them to click manually on the confirmation links in activation emails.

Removing the need for email-based verification is particularly useful for larger companies that have many users that they want to invite to AppXite.

 

 

Was this article helpful?

0 out of 0 found this helpful

Add comment

Please sign in to leave a comment.