Assigning ACS Users to Access Groups

Learn how to use access groups to manage ACS user permissions across different doors and areas.

Some ACSs use access groups, which are sets of ACS users, combined with sets of permissions. These permissions include both the set of areas or assets that the ACS users can access and the schedule during which the users can access these areas or assets. Instead of assigning access rights individually to each ACS user, which can be time-consuming and error-prone, administrators can assign users to an access group, thereby ensuring that the users inherit all the permissions associated with the access group. Using access groups streamlines the process of managing large numbers of ACS users, especially in bigger organizations or complexes.

To learn whether your ACS supports access groups, see the system integration guide for your ACS.

This guide explains how to grant access permissions to ACS users by adding them to the appropriate access groups.

---

Add an ACS User to an Access Group

To add an ACS user to an access group, provide both the acs_user_id and the acs_access_group_id.

JavaScript

Request:

await seam.acs.users.addToAccessGroup({
  acs_user_id: '33333333-3333-3333-3333-333333333333',
  acs_access_group_id: '44444444-4444-4444-4444-444444444444',
})

Response:

void

cURL

Request:

curl -X 'POST' \
  'https://connect.getseam.com/acs/users/add_to_access_group' \
  -H "Authorization: Bearer ${SEAM_API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{
  "acs_user_id": "33333333-3333-3333-3333-333333333333",
  "acs_access_group_id": "44444444-4444-4444-4444-444444444444"
}'

Response:

{
  "ok": true
}

Python

Request:

seam.acs.users.add_to_access_group(
  acs_user_id="33333333-3333-3333-3333-333333333333",
  acs_access_group_id="44444444-4444-4444-4444-444444444444"
)

Response:

None

Ruby

Request:

# Coming soon!

Response:

# Coming soon!

PHP

Request:

$seam->acs->users->add_to_access_group(
  acs_user_id: "33333333-3333-3333-3333-333333333333",
  acs_access_group_id: "44444444-4444-4444-4444-444444444444"
);

Response:

void

C#

Request:

seam.UsersAcs.AddToAccessGroup(
  acsUserId: "33333333-3333-3333-3333-333333333333",
  acsAccessGroupId: "44444444-4444-4444-4444-444444444444"
);

Response:

void

---

Remove an ACS User from an Access Group

To remove an ACS user from an access group, provide both the acs_user_id and the acs_access_group_id.

JavaScript

Request:

await seam.acs.users.removeFromAccessGroup({
  acs_user_id: '33333333-3333-3333-3333-333333333333',
  acs_access_group_id: '44444444-4444-4444-4444-444444444444',
})

Response:

void

cURL

Request:

curl -X 'POST' \
  'https://connect.getseam.com/acs/users/remove_from_access_group' \
  -H 'accept: */*' \
  -H "Authorization: Bearer ${SEAM_API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{
  "acs_user_id": "33333333-3333-3333-3333-333333333333",
  "acs_access_group_id": "44444444-4444-4444-4444-444444444444"
}'

Response:

{
  "ok": true
}

Python

Request:

seam.acs.users.remove_from_access_group(
  acs_user_id="33333333-3333-3333-3333-333333333333",
  acs_access_group_id="44444444-4444-4444-4444-444444444444"
)

Response:

None

Ruby

Request:

# Coming soon!

Response:

# Coming soon!

PHP

Request:

$seam->acs->users->remove_from_access_group(
  acs_user_id: "33333333-3333-3333-3333-333333333333",
  acs_access_group_id: "44444444-4444-4444-4444-444444444444"
);

Response:

void

C#

Request:

seam.UsersAcs.RemoveFromAccessGroup(
  acsUserId: "33333333-3333-3333-3333-333333333333",
  acsAccessGroupId: "44444444-4444-4444-4444-444444444444"
);

Response:

void