Test User Management API Overview

Overview

Using the test user management APIs enables administrators to manage their test users utilizing a management key. This allows administrators to generate login details to test the user authentication flow.

Management keys are generated from Company > Management Keys. These keys will be used within the bearer token. The format is <Project ID>:<Management Key>.

Use Cases

Test User Management:

1. Create test Users
2. Generate OTP (sms/email) for test users
3. Generate Magic Link (sms/email) for test users
4. Generate Enchanted Link (email) for test users
5. Delete Test Users

Examples

Example - Create Test User and Validate Authentication Functionality with OTP

1. Create a user with the test flag set to true to set it as a test user.
2. Generate an OTP code for the test user, when you generate this, you can set it to sms or email for the delivery method.
3. Verify the OTP code via verify OTP email or verify OTP sms
4. Delete the test user or delete all test users

Example - Create Test User and Validate Authentication Functionality with Enchanted Link

1. Create a user with the test flag set to true to set it as a test user.
2. Generate an Enchanted Link for the test user.
3. Verify the token
4. Delete the test user or delete all test users