User & Team Management Overview
The User & Team Management services provide a comprehensive set of APIs for developers to create and manage users and teams within the OS1 platform. These APIs allow the creation, retrieving, updating, and deactivating of users and teams.
The User APIs allow onboarding and managing users throughout their lifecycle, which includes four default states: onboarding, where user data is entered and verified; active, indicating verified user data and activation; deboarding, the phase of user deactivation; and Inactive, where the user is fully deactivated. Each user is assigned specific roles, such as operator, supervisor, or manager, associated with a set of permissions and team mappings.
Similarly, the Teams API simplifies creating and managing teams by providing endpoints and operations for customizing team properties, such as operational hours and types, and managing team statuses.
Together, the User & Team Management services offer developers a way to create and manage users and teams.
Developers can use the User API endpoints to perform the following operations to create and manage users:
Developers can use the Team API endpoints to perform the following operations to create and manage teams:
- UpdateTeamState: Perform state transitions to change the state of a team, such as activating or deactivating it.