Overview
- The Optimum Parcel User API lets you manage team members and individual account profiles within a workspace. You can develop applications that integrate with Optimum Parcel to automate User onboarding, enforce security policies, and synchronize staff directories with internal HR systems.
- View Doc →
- The following figure shows the relationship between your Optimum Parcel app, the Optimum Parcel API, and User services.
Optimum Parcel App
Optimum Parcel’s User management services give administrators control over who accesses the platform to allow for the invitation of colleagues, assignment of roles, and maintenance of accurate contact details for security alerts.
Optimum Parcel API
The REST API that allows Users to create, update, and deactivate User accounts from within your app.
Access Control
A system that defines the permissions associated with each login, restricting visibility to sensitive financial data or configuration settings based on the assigned role.
Team Administration
A mechanism that organizes multiple unique logins under a single corporate account to ensure that every action on the platform links back to a specific individual.
What can Users do with the Optimum Parcel User API?
Users can use the Optimum Parcel Users API to perform common workflows, such as:
- Invite a new team member to the workspace
- Update the email address or name for an existing User
- Reset a password for a locked account
- Change the permission role of a staff member
- Deactivate a User account upon employee termination
- Retrieve a list of all active Users in the organization
User properties available to create, modify, update and delete through the Optimum Parcel User API:
- Email Addresses
- Full Names
- Passwords
- Roles
- User IDs
