Access Groups

acs_access_group

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.

access_group_type

Deprecated. Use external_type.

Format: Enum

Possible enum values:

• pti_unit

• pti_access_level

• salto_ks_access_group

• brivo_group

• salto_space_group

• dormakaba_community_access_group

---

access_group_type_display_name

Deprecated. Use external_type_display_name.

Format: String

---

acs_access_group_id

Format: UUID

ID of the access group.

---

acs_system_id

Format: UUID

ID of the access control system that contains the access group.

---

created_at

Format: Datetime

Date and time at which the access group was created.

---

display_name

Format: String

---

external_type

Format: Enum

Brand-specific terminology for the access group type.

Possible enum values:

• pti_unit

• pti_access_level

• salto_ks_access_group

• brivo_group

• salto_space_group

• dormakaba_community_access_group

---

external_type_display_name

Format: String

Display name that corresponds to the brand-specific terminology for the access group type.

---

is_managed

Format: Boolean

---

name

Format: String

Name of the access group.

---

warnings

Format: List

Item format: Object

Warnings associated with the acs_access_group.

created_at Format: Datetime

Date and time at which Seam created the warning.

message Format: String

Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.

warning_code Format: Enum

Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.

Possible enum values:

• unknown_issue_with_acs_access_group

---

workspace_id

Format: UUID

ID of the workspace that contains the access group.

---

Endpoints

/acs/access_groups/add_user

Adds a specified ACS user to 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 ACS users in an access group.

/acs/access_groups/remove_user

Removes a specified ACS user from a specified access group.

---

Events

acs_access_group.deleted

An ACS access group was deleted.

acs_access_group_id Format: UUID

acs_system_id Format: UUID

ID of the ACS system.

connected_account_id Format: UUID

ID of the connected account.

created_at Format: Datetime

Date and time at which the event was created.

event_id Format: UUID

ID of the event.

event_type Format: Enum

Value: acs_access_group.deleted

occurred_at Format: Datetime

Date and time at which the event occurred.

workspace_id Format: UUID

ID of the workspace.

---