Access Groups
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",
"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.
Enum values
pti_unitpti_access_levelsalto_ks_access_groupbrivo_groupsalto_space_groupdormakaba_community_access_groupdormakaba_ambiance_access_group
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
external_type Enum
Brand-specific terminology for the access group type.
Enum values
pti_unitpti_access_levelsalto_ks_access_groupbrivo_groupsalto_space_groupdormakaba_community_access_groupdormakaba_ambiance_access_group
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:
creating
Seam is in the process of pushing an access group creation to the integrated access system.
created_at Datetime
Date and time at which the mutation was created.
message String
Detailed description of the mutation.
mutation_code Enum
Mutation code to indicate that Seam is in the process of pushing an access group creation to the integrated access system.
Enum values:
creating
deleting
Seam is in the process of pushing an access group deletion to the integrated access system.
created_at Datetime
Date and time at which the mutation was created.
message String
Detailed description of the mutation.
mutation_code Enum
Mutation code to indicate that Seam is in the process of pushing an access group deletion to the integrated access system.
Enum values:
deleting
deferring_deletion
This access group is scheduled for automatic deletion when its access window expires.
created_at Datetime
Date and time at which the mutation was created.
message String
Detailed description of the mutation.
mutation_code Enum
Mutation code to indicate that this access group is scheduled for automatic deletion when its access window expires.
Enum values:
deferring_deletion
updating_group_information
Seam is in the process of pushing an access group information update to the integrated access system.
created_at Datetime
Date and time at which the mutation was created.
from Object
Old access group information.
Child Properties
nameStringName of the access group.
message String
Detailed description of the mutation.
mutation_code Enum
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
to Object
New access group information.
Child Properties
nameStringName of the access group.
updating_access_schedule
Seam is in the process of pushing an access schedule update to the integrated access system.
created_at Datetime
Date and time at which the mutation was created.
from Object
Old access schedule information.
Child Properties
ends_atDatetimeEnding time for the access schedule.
starts_atDatetimeStarting time for the access schedule.
message String
Detailed description of the mutation.
mutation_code Enum
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
to Object
New access schedule information.
Child Properties
ends_atDatetimeEnding time for the access schedule.
starts_atDatetimeStarting time for the access schedule.
updating_user_membership
Seam is in the process of pushing a user membership update to the integrated access system.
created_at Datetime
Date and time at which the mutation was created.
from Object
Old user membership.
Child Properties
acs_user_idUUIDOld user ID.
message String
Detailed description of the mutation.
mutation_code Enum
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
to Object
New user membership.
Child Properties
acs_user_idUUIDNew user ID.
updating_entrance_membership
Seam is in the process of pushing an entrance membership update to the integrated access system.
created_at Datetime
Date and time at which the mutation was created.
from Object
Old entrance membership.
Child Properties
acs_entrance_idUUIDOld entrance ID.
message String
Detailed description of the mutation.
mutation_code Enum
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
to Object
New entrance membership.
Child Properties
acs_entrance_idUUIDNew entrance ID.
deferring_user_membership_update
A scheduled user membership change is pending for this access group.
acs_user_id UUID
ID of the user involved in the scheduled change.
created_at Datetime
Date and time at which the mutation was created.
message String
Detailed description of the mutation.
mutation_code Enum
Mutation code to indicate that a scheduled user membership change is pending for this access group.
Enum values:
deferring_user_membership_update
variant Enum
Whether the user is scheduled to be added to or removed from this access group.
Enum values:
addingremoving
warnings List of Objects
Warnings associated with the acs_access_group.
Child Object Properties
created_at Datetime
Date and time at which Seam created the warning.
message String
Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
warning_code Enum
Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
workspace_id UUID
ID of the workspace that contains the access group.
Events
acs_access_group.deleted
An ACS access group was deleted.
Properties
acs_access_group_id UUID
ID of the affected access group.
acs_system_id UUID
ID of the access system.
connected_account_id UUID
ID of the connected account.
created_at Datetime
Date and time at which the event was created.
event_id UUID
ID of the event.
event_type Enum
Value: acs_access_group.deleted
occurred_at Datetime
Date and time at which the event occurred.
workspace_id UUID
ID of the workspace associated with the event.
Endpoints
Adds a specified access system user to a specified access group.
Deletes a specified access group.
Returns a specified access group.
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.
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.
Last updated
Was this helpful?