Understanding User and Role Management API endpoints in ZenQMS: A Guide for Quality Managers

As a Quality Manager in a life sciences company, you're constantly working to ensure your team has the right access and permissions to maintain compliance and efficiency. While the term "API endpoints" (Application Programming Interface endpoints) might sound technical, think of them as specific access points that allow different software systems to communicate and exchange information. ZenQMS provides these access points to help you manage your users and their roles more effectively.

The power of these access points:

• Automates and integrates processes.
• Connects ZenQMS with internal systems.
• Achieves seamless data flow.
• Reduces manual work.
• Minimizes errors.
• Streamlines onboarding.
• Adjusts permissions efficiently.
• Ensures correct access for all users.
• Maintains secure and compliant processes.
• Saves time and leads to a robust quality management system.

These endpoints allow you to integrate ZenQMS with your existing user management tool and allow a single source of truth for users and roles management.

User Management Access Points

These access points help you control individual user accounts within ZenQMS:

• Creating a New User (POST /v2/users): This access point allows you to set up new user accounts in ZenQMS.
• Updating User Information (PATCH /v2/users/{userId}): modify existing user details: email, first name, last name, title, site, supervisor, status (active, locked out, disabled, etc).
• Searching for Users (POST /v2/users/search): find specific users within ZenQMS. You can search based on various criteria to quickly locate an account, such as user ID, name, email address, or even their current status (active/inactive).
• Adding Roles to a User (POST /v2/users/{userId}/roles/add): assigns user to Roles defined in ZenQMS. Roles are used in ZenQMS to control permissions and access.

• Removing Roles from a User (DELETE /v2/users/{userId}/roles/remove): remove users from specified Roles.

   

Role Management Access Points

These access points help you manage the different types of access or "Roles" themselves within ZenQMS:

• Searching for Roles (POST /v2/roles/search): find a defined role in ZenQMS and return the id, name, description, created at date, and updated at date.
• Adding Users to a Role (POST /v2/roles/{roleId}/users/add): assign multiple users to a specific role.
• Removing Users from a Role (DELETE /v2/roles/{roleId}/users/remove): remove multiple users from a specific role.