Skip to main content

​
The acs_access_group Object

Group that defines the entrances to which a set of users has access and, in some cases, the access schedule for these entrances and users. Some access control systems use access group, which are sets of users, combined with sets of permissions. These permissions include both the set of areas or assets that the users can access and the schedule during which the users can access these areas or assets. Instead of assigning access rights individually to each access control system 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 access control system users, especially in bigger organizations or complexes. To learn whether your access control system supports access groups, see the corresponding system integration guide.
An access group resource.
{
  "access_group_type": "salto_ks_access_group",
  "access_group_type_display_name": "Salto KS Access Group",
  "acs_access_group_id": "3f448826-9875-4947-9519-e468090a4f7d",
  "acs_system_id": "045baa77-6d06-40fe-a2cd-b82eef688f4a",
  "connected_account_id": "daba7bd0-edb6-4bb9-a70b-f9ae08a0e301",
  "created_at": "2025-06-15T16:54:17.946453Z",
  "display_name": "Main Group",
  "errors": [],
  "external_type": "salto_ks_access_group",
  "external_type_display_name": "Salto KS Access Group",
  "is_managed": true,
  "name": "My Access Group",
  "pending_mutations": [],
  "warnings": [],
  "workspace_id": "ac19352c-869a-4209-9ce7-44c740a8b5d0"
}

​
Properties

access_group_type Enum
Deprecated. Use external_type.
access_group_type_display_name String
Deprecated. Use external_type_display_name.
access_schedule Object starts_at and ends_at timestamps for the access group’s access.
acs_access_group_id UUID ID of the access group.
acs_system_id UUID ID of the access control system that contains the access group.
connected_account_id UUID ID of the connected account that contains the access group.
created_at Datetime Date and time at which the access group was created.
display_name String
errors List of Objects Errors associated with the acs_access_group. The specific structure of each object in this list depends on the value of its error_code field. Variants:
external_type Enum Brand-specific terminology for the access group type.
external_type_display_name String Display name that corresponds to the brand-specific terminology for the access group type.
is_managed Boolean
name String Name of the access group.
pending_mutations List of Objects Collection of pending mutations for the access group. Represents operations that have been requested but not yet completed on the integrated access system. The specific structure of each object in this list depends on the value of its mutation_code field. Variants:
warnings List of Objects Warnings associated with the acs_access_group.
workspace_id UUID ID of the workspace that contains the access group.

​
Errors

failed_to_create_on_acs_system Indicates that the access group was not created on the access system. This is likely due to an internal unexpected error. Contact Seam support.

​
Events

acs_access_group.deleted An ACS access group was deleted.

​
Endpoints

/acs/access_groups/add_user Adds a specified access system user to a specified access group. /acs/access_groups/delete Deletes a specified access group. /acs/access_groups/get Returns a specified access group. /acs/access_groups/list Returns a list of all access groups. /acs/access_groups/list_accessible_entrances Returns a list of all accessible entrances for a specified access group. /acs/access_groups/list_users Returns a list of all access system users in an access group. /acs/access_groups/remove_user Removes a specified access system user from a specified access group.