The Access Group Object

{
  "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"
}

{
  "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"
}

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.

{
  "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

Object

starts_at and ends_at timestamps for the access group’s access.

Show properties

String (ISO 8601) or null

required

Date and time at which the user’s access ends, in ISO 8601 format.

String (ISO 8601)

required

Date and time at which the user’s access starts, in ISO 8601 format.

String (UUID)

required

ID of the access group.

String (UUID)

required

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

String (UUID)

required

ID of the connected account that contains the access group.

String (ISO 8601)

required

Date and time at which the access group was created.

String

required

Display name for the access group.

Array of Objects

required

Errors associated with the acs_access_group.

Show properties

Enum (String)

required

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

Enum values

failed_to_create_on_acs_system

String

required

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

String (ISO 8601)

required

Date and time at which Seam created the error.

Enum (String)

required

Brand-specific terminology for the access group type.

Enum values

pti_unit
pti_access_level
salto_ks_access_group
brivo_group
salto_space_group
dormakaba_community_access_group
dormakaba_ambiance_access_group
avigilon_alta_group
kisi_access_group
akiles_member_group

String

required

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

Boolean (Always true)

required

Indicates whether Seam manages the access group.

String

required

Name of the access group.

Array of Objects

required

Collection of pending mutations for the access group. Represents operations that have been requested but not yet completed on the integrated access system.

Show mutation_code: creating

Seam is in the process of pushing an access group creation to the integrated access system.

String (ISO 8601)

required

Date and time at which the mutation was created.

String

required

Detailed description of the mutation.

Enum (String)

required

Mutation code to indicate that Seam is in the process of pushing an access group creation to the integrated access system.

Enum values

creating

Show mutation_code: deleting

Seam is in the process of pushing an access group deletion to the integrated access system.

String (ISO 8601)

required

Date and time at which the mutation was created.

String

required

Detailed description of the mutation.

Enum (String)

required

Mutation code to indicate that Seam is in the process of pushing an access group deletion to the integrated access system.

Enum values

deleting

Show mutation_code: deferring_deletion

This access group is scheduled for automatic deletion when its access window expires.

String (ISO 8601)

required

Date and time at which the mutation was created.

String

required

Detailed description of the mutation.

Enum (String)

required

Mutation code to indicate that this access group is scheduled for automatic deletion when its access window expires.

Enum values

deferring_deletion

Show mutation_code: updating_group_information

Seam is in the process of pushing an access group information update to the integrated access system.

String (ISO 8601)

required

Date and time at which the mutation was created.

Object

required

Old access group information.

Show properties

String or null

Name of the access group.

String

required

Detailed description of the mutation.

Enum (String)

required

Mutation code to indicate that Seam is in the process of pushing updated access group information to the integrated access system.

Enum values

updating_group_information

Object

required

New access group information.

Show properties

String or null

Name of the access group.

Show mutation_code: updating_access_schedule

Seam is in the process of pushing an access schedule update to the integrated access system.

String (ISO 8601)

required

Date and time at which the mutation was created.

Object

required

Old access schedule information.

Show properties

String (ISO 8601) or null

required

Ending time for the access schedule.

String (ISO 8601) or null

required

Starting time for the access schedule.

String

required

Detailed description of the mutation.

Enum (String)

required

Mutation code to indicate that Seam is in the process of pushing updated access schedule information to the integrated access system.

Enum values

updating_access_schedule

Object

required

New access schedule information.

Show properties

String (ISO 8601) or null

required

Ending time for the access schedule.

String (ISO 8601) or null

required

Starting time for the access schedule.

Show mutation_code: updating_user_membership

Seam is in the process of pushing a user membership update to the integrated access system.

String (ISO 8601)

required

Date and time at which the mutation was created.

Object

required

Old user membership.

Show properties

String (UUID) or null

required

Old user ID.

String

required

Detailed description of the mutation.

Enum (String)

required

Mutation code to indicate that Seam is in the process of pushing updated user membership information to the integrated access system.

Enum values

updating_user_membership

Object

required

New user membership.

Show properties

String (UUID) or null

required

New user ID.

Show mutation_code: updating_entrance_membership

Seam is in the process of pushing an entrance membership update to the integrated access system.

String (ISO 8601)

required

Date and time at which the mutation was created.

Object

required

Old entrance membership.

Show properties

String (UUID) or null

required

Old entrance ID.

String

required

Detailed description of the mutation.

Enum (String)

required

Mutation code to indicate that Seam is in the process of pushing updated entrance membership information to the integrated access system.

Enum values

updating_entrance_membership

Object

required

New entrance membership.

Show properties

String (UUID) or null

required

New entrance ID.

Show mutation_code: deferring_user_membership_update

A scheduled user membership change is pending for this access group.

String (UUID)

required

ID of the user involved in the scheduled change.

String (ISO 8601)

required

Date and time at which the mutation was created.

String

required

Detailed description of the mutation.

Enum (String)

required

Mutation code to indicate that a scheduled user membership change is pending for this access group.

Enum values

deferring_user_membership_update

Enum (String)

required

Whether the user is scheduled to be added to or removed from this access group.

Enum values

adding
removing

Array of Objects

required

Warnings associated with the acs_access_group.

Show properties

String (ISO 8601)

required

Date and time at which Seam created the warning.

String

required

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

Enum (String)

required

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

Enum values

unknown_issue_with_acs_access_group
being_deleted

String (UUID)

required

ID of the workspace that contains the access group.

Getting Started

Granting Access

Devices and Systems

Setup

Monitoring

Low-Level APIs

The Access Group Object

The acs_access_group Object

Properties