User Management Endpoints

An overview of the User Management category of endpoints.

The User Management category encompasses a suite of APIs designed to manage users between R1 Discover and your application. This includes capabilities for creating and updating the status of users. These endpoints are critical for ensuring that user data is managed securely and efficiently in compliance with operational requirements.

Overview of User Management APIs

User management is integral to maintaining a secure and personalized user experience. Our API provides comprehensive tools to handle user creation and management. Each endpoint listed here is further detailed in the "Endpoints Detailed Description" section, where you can find specific request formats, response structures, and examples:

Endpoints

• Create Admin: Add new admins to R1 Discover. Admins have the ability to manage users and review user data within R1 Discover.

• Update Admin: Modify existing Admin details to keep their information current and accurate, this could include type, program, and/or location assignments.

• Create User: Add new users to R1 Discover. Users solely have the ability to take activities and review their own data within R1 Discover.

• Update User: Modify existing user details to keep user information current and accurate, this could include location, program and/or practitioner alignments as well as managing their status.

• Check Global Username Availability: Usernames are set when Users/Admins are created, here you can check the availability of usernames across all of R1 Discover.

• Check Company Username Availability: We also offer the ability to create company specific usernames for Users if it is required for them to have a username in sync with another system ID, here you can check the availability of usernames within a specific Company account within R1 Discover.

These endpoints facilitate a range of functionalities tailored to comprehensive user management.

Integration Points

• User/Admin Onboarding/Offboarding: Seamlessly integrate user creation into signup (intake) workflows, as well as user deactivation (discharge) workflows.

• User/Admin Management: As users move to different programs/locations or get aligned to new practitioners, this can.

• Activity Tracking: Utilize endpoints to get user IDs to align with the activity endpoints.

Additional Resources

For developers looking to implement user management functionalities, additional resources such as code snippets, SDKs, and integration guides are available in the "Support and Resources" section of this documentation. These tools are designed to accelerate development and ensure best practices are followed in integrating our APIs.

Next Steps

After reviewing this section, developers should understand the scope and capabilities of our User Management APIs. Proceed to the detailed descriptions for code samples, technical specifics, and interactive examples to begin integration.