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.
Key Concepts
- Member: An individual user associated with your organization in the system. Each member has a unique user ID, and can have a role, department, and other attributes.
- Organization: Your dedicated workspace or company account within the system. All members belong to an organization.
- Role: A set of permissions assigned to a member, determining what actions they can perform. Common roles might include
admin,member, orowner. Theownerrole typically has the highest level of access and can perform sensitive operations. - User ID: A unique identifier for a user, often provided by an external identity management system. This ID links a system user to a member in your organization.
- Fleet DM Label ID: An optional identifier used for integrating with Fleet Device Management, allowing you to associate members with specific device groups or labels.
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.
Managing Members
You can perform various operations to manage the members of your organization.
View All Members
To retrieve a list of all members currently associated with your organization:
- Access the people management interface or send a request to the appropriate API endpoint.
- The system will return a list of all members, including their details such as user ID, role, department, and activity status.
Add a Single Member
You can add new members to your organization one by one.
- Prepare the details for the new member. At a minimum, you will need their
userIdandrole. - Provide the member's information to the system.
Example Member Details:
{ "userId": "usr_abc123def456", "role": "admin", "department": "it", "isActive": true, "fleetDmLabelId": 123 }- Prepare the details for the new member. At a minimum, you will need their
Add Multiple Members (Bulk Upload)
For adding many members at once, you can use the bulk creation feature.
- Compile a list of member details, where each item in the list is a new member to be added.
- Submit this list to the system.
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 } ] }View Specific Member Details
To see the detailed information for a particular member:
- Identify the unique ID of the member you wish to view.
- Request the member's details using their ID.
- The system will return all available information for that member.
Update Member Information
You can modify existing member details, such as their role, department, or activity status.
- Identify the unique ID of the member you wish to update.
- Provide the updated information. Only include the fields you want to change.
Example Update Details (changing role and deactivating):
{ "role": "member", "isActive": false }Deactivate a Member
Deactivating a member (setting
isActivetofalse) is a "soft delete." The member's record remains in the system, but they will no longer have active access.- Follow the "Update Member Information" steps.
- Set the
isActivefield tofalsein the update request.
Remove a Host from a Member
This action allows you to disassociate a specific host device from a member.
- Identify the unique ID of the member and the numerical ID of the host you want to remove.
- Submit the request to remove the host.
This operation typically requires the
ownerrole within the organization.Delete a Member
To permanently remove a member from your organization:
- Identify the unique ID of the member you wish to delete.
- Confirm the deletion request.
Deleting a member is a permanent action and cannot be undone. Consider deactivating a member first if you might need their record later.
Unlink a Device from a Member
This action allows you to remove any associated device information from a member's profile without deleting the member themselves.
- Identify the unique ID of the member from whom you want to unlink a device.
- Submit the request to unlink the device.