/api/accesscontrol/addUsersToAccessControlGroup

Adds specified users to an access control group

Add Users to Access Control Group

This endpoint adds one or more specified users to an access control group. Access control groups are a powerful feature for managing permissions at scale. By adding users to a group, they will inherit all the access privileges assigned to that group, such as entry to specific doors or access to certain system features.

Overview

Access control groups allow you to:

  • Manage permissions for multiple users simultaneously
  • Streamline access management by grouping related permissions
  • Quickly grant or revoke access for entire teams or departments
  • Maintain consistent access policies across your organization

Required Parameters

To use this endpoint, you need to provide:

  1. groupUuid - The unique identifier of the access control group
  2. userUuids - A list of unique identifiers for the users you want to add to the group

Usage Example

Here's how you might structure a request to add users to an access control group:

{
  "groupUuid": "550e8400-e29b-41d4-a716-446655440000",
  "userUuids": [
    "7b44b47b-62e7-4b85-8c3f-9d3b5b1961d2",
    "a2e8d4f6-3b7c-4d91-8c4e-5a6b7c8d9e0f"
  ]
}

Important Notes

  • Users must exist in your organization before they can be added to a group
  • A user can belong to multiple access control groups
  • Adding a user to a group will immediately grant them all permissions associated with that group
  • If a user is already a member of the specified group, the request will succeed but no changes will be made for that user

Best Practices

  1. Audit Regularly: Keep track of group memberships and review them periodically
  2. Group Organization: Create groups based on logical access needs rather than organizational structure
  3. Documentation: Maintain clear records of which permissions each group grants
  4. Principle of Least Privilege: Only grant access levels that are necessary for users to perform their roles

Related Endpoints

  • /api/accesscontrol/createAccessControlGroup - Create a new access control group
  • /api/accesscontrol/removeUsersFromAccessControlGroup - Remove users from a group
  • /api/accesscontrol/findAllUsersForAccessControlGroup - List all users in a group
Language
Credentials
Header
Click Try It! to start a request and see the response here!