Getting Started
Core Features
How-To Guides
Configuration
Troubleshooting
Integrations
This section of the documentation explains how to manage people, referred to as "members," within your organization. This includes adding new members, viewing their details, updating their information, and removing them. By managing members, you control who has access to your organization's resources and what permissions they hold.
All actions related to people management are performed within the context of your specific organization.
admin, member, or owner. The owner role typically has the highest level of access and can perform sensitive operations.When interacting with the system programmatically (e.g., via API), you will need to provide your X-Organization-Id in the request header to specify which organization you are managing members for.
You can perform various operations to manage the members of your organization.
To retrieve a list of all members currently associated with your organization:
You can add new members to your organization one by one.
userId and role.Example Member Details:
{
"userId": "usr_abc123def456",
For adding many members at once, you can use the bulk creation feature.
You can add a maximum of 1000 members in a single bulk request.
Example Bulk Member Details:
{
"members": [
{
"userId": "usr_abc123def456",
"role": "admin",
"department": "it",
"isActive": true,
"fleetDmLabelId": 123
},
{
"userId": "usr_def456ghi789",
"role": "member",
"department": "hr",
"isActive": true
}
]
}To see the detailed information for a particular member:
You can modify existing member details, such as their role, department, or activity status.
Example Update Details (changing role and deactivating):
{
"role": "member",
"isActive": false
}Deactivating a member (setting isActive to false) is a "soft delete." The member's record remains in the system, but they will no longer have active access.
isActive field to false in the update request.This action allows you to disassociate a specific host device from a member.
This operation typically requires the owner role within the organization.
To permanently remove a member from your organization:
Deleting a member is a permanent action and cannot be undone. Consider deactivating a member first if you might need their record later.
This action allows you to remove any associated device information from a member's profile without deleting the member themselves.