Type Alias AcsAccessGroup

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.

type AcsAccessGroup = {
    access_group_type:
        | "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";
    access_group_type_display_name: string;
    access_schedule?: { ends_at: string
    | null; starts_at: string };
    acs_access_group_id: string;
    acs_system_id: string;
    connected_account_id: string;
    created_at: string;
    display_name: string;
    errors: {
        created_at: string;
        error_code: "failed_to_create_on_acs_system";
        message: string;
    }[];
    external_type: | "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";
    external_type_display_name: string;
    is_managed: boolean;
    name: string;
    pending_mutations: (
        | { created_at: string; message: string; mutation_code: "creating" }
        | { created_at: string; message: string; mutation_code: "deleting" }
        | {
            created_at: string;
            message: string;
            mutation_code: "deferring_deletion";
        }
        | {
            created_at: string;
            from: { name?: string
            | null };
            message: string;
            mutation_code: "updating_group_information";
            to: { name?: string | null };
        }
        | {
            created_at: string;
            from: { ends_at: string
            | null; starts_at: string | null };
            message: string;
            mutation_code: "updating_access_schedule";
            to: { ends_at: string | null; starts_at: string | null };
        }
        | {
            created_at: string;
            from: { acs_user_id: string
            | null };
            message: string;
            mutation_code: "updating_user_membership";
            to: { acs_user_id: string | null };
        }
        | {
            created_at: string;
            from: { acs_entrance_id: string
            | null };
            message: string;
            mutation_code: "updating_entrance_membership";
            to: { acs_entrance_id: string | null };
        }
        | {
            acs_user_id: string;
            created_at: string;
            message: string;
            mutation_code: "deferring_user_membership_update";
            variant: "adding"
            | "removing";
        }
    )[];
    warnings: {
        created_at: string;
        message: string;
        warning_code: "unknown_issue_with_acs_access_group"
        | "being_deleted";
    }[];
    workspace_id: string;
}

Index

Properties

access_group_type access_group_type_display_name access_schedule? acs_access_group_id acs_system_id connected_account_id created_at display_name errors external_type external_type_display_name is_managed name pending_mutations warnings workspace_id

Properties

access_group_type

Deprecated

Use external_type.

access_group_type_display_name

access_group_type_display_name: string

Deprecated

Use external_type_display_name.

`Optional`access_schedule

access_schedule?: { ends_at: string | null; starts_at: string }

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

Type Declaration

ends_at: string | null

Date and time at which the user's access ends, in ISO 8601 format.
starts_at: string

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

acs_access_group_id

acs_access_group_id: string

ID of the access group.

acs_system_id

acs_system_id: string

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

connected_account_id

connected_account_id: string

ID of the connected account that contains the access group.

created_at

created_at: string

Date and time at which the access group was created.

display_name

display_name: string

Display name for the access group.

errors

errors: {
    created_at: string;
    error_code: "failed_to_create_on_acs_system";
    message: string;
}[]

Errors associated with the acs_access_group.

Type Declaration

created_at: string

Date and time at which Seam created the error.
error_code: "failed_to_create_on_acs_system"

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

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

external_type

Brand-specific terminology for the access group type.

external_type_display_name

external_type_display_name: string

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

is_managed

is_managed: boolean

Indicates whether Seam manages the access group.

name

name: string

Name of the access group.

pending_mutations

pending_mutations: (
    | { created_at: string; message: string; mutation_code: "creating" }
    | { created_at: string; message: string; mutation_code: "deleting" }
    | {
        created_at: string;
        message: string;
        mutation_code: "deferring_deletion";
    }
    | {
        created_at: string;
        from: { name?: string
        | null };
        message: string;
        mutation_code: "updating_group_information";
        to: { name?: string | null };
    }
    | {
        created_at: string;
        from: { ends_at: string
        | null; starts_at: string | null };
        message: string;
        mutation_code: "updating_access_schedule";
        to: { ends_at: string | null; starts_at: string | null };
    }
    | {
        created_at: string;
        from: { acs_user_id: string
        | null };
        message: string;
        mutation_code: "updating_user_membership";
        to: { acs_user_id: string | null };
    }
    | {
        created_at: string;
        from: { acs_entrance_id: string
        | null };
        message: string;
        mutation_code: "updating_entrance_membership";
        to: { acs_entrance_id: string | null };
    }
    | {
        acs_user_id: string;
        created_at: string;
        message: string;
        mutation_code: "deferring_user_membership_update";
        variant: "adding"
        | "removing";
    }
)[]

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

Type Declaration

{ created_at: string; message: string; mutation_code: "creating" }
- created_at: string
  
  Date and time at which the mutation was created.
- message: string
  
  Detailed description of the mutation.
- mutation_code: "creating"
  
  Mutation code to indicate that Seam is in the process of pushing an access group creation to the integrated access system.
{ created_at: string; message: string; mutation_code: "deleting" }
- created_at: string
  
  Date and time at which the mutation was created.
- message: string
  
  Detailed description of the mutation.
- mutation_code: "deleting"
  
  Mutation code to indicate that Seam is in the process of pushing an access group deletion to the integrated access system.
{ created_at: string; message: string; mutation_code: "deferring_deletion" }
- created_at: string
  
  Date and time at which the mutation was created.
- message: string
  
  Detailed description of the mutation.
- mutation_code: "deferring_deletion"
  
  Mutation code to indicate that this access group is scheduled for automatic deletion when its access window expires.
{
    created_at: string;
    from: { name?: string | null };
    message: string;
    mutation_code: "updating_group_information";
    to: { name?: string | null };
}
- created_at: string
  
  Date and time at which the mutation was created.
- from: { name?: string | null }
  
  Old access group information.
  - Optionalname?: string | null
    
    Name of the access group.
- message: string
  
  Detailed description of the mutation.
- mutation_code: "updating_group_information"
  
  Mutation code to indicate that Seam is in the process of pushing updated access group information to the integrated access system.
- to: { name?: string | null }
  
  New access group information.
  - Optionalname?: string | null
    
    Name of the access group.
{
    created_at: string;
    from: { ends_at: string | null; starts_at: string | null };
    message: string;
    mutation_code: "updating_access_schedule";
    to: { ends_at: string | null; starts_at: string | null };
}
- created_at: string
  
  Date and time at which the mutation was created.
- from: { ends_at: string | null; starts_at: string | null }
  
  Old access schedule information.
  - ends_at: string | null
    
    Ending time for the access schedule.
  - starts_at: string | null
    
    Starting time for the access schedule.
- message: string
  
  Detailed description of the mutation.
- mutation_code: "updating_access_schedule"
  
  Mutation code to indicate that Seam is in the process of pushing updated access schedule information to the integrated access system.
- to: { ends_at: string | null; starts_at: string | null }
  
  New access schedule information.
  - ends_at: string | null
    
    Ending time for the access schedule.
  - starts_at: string | null
    
    Starting time for the access schedule.
{
    created_at: string;
    from: { acs_user_id: string | null };
    message: string;
    mutation_code: "updating_user_membership";
    to: { acs_user_id: string | null };
}
- created_at: string
  
  Date and time at which the mutation was created.
- from: { acs_user_id: string | null }
  
  Old user membership.
  - acs_user_id: string | null
    
    Old user ID.
- message: string
  
  Detailed description of the mutation.
- mutation_code: "updating_user_membership"
  
  Mutation code to indicate that Seam is in the process of pushing updated user membership information to the integrated access system.
- to: { acs_user_id: string | null }
  
  New user membership.
  - acs_user_id: string | null
    
    New user ID.
{
    created_at: string;
    from: { acs_entrance_id: string | null };
    message: string;
    mutation_code: "updating_entrance_membership";
    to: { acs_entrance_id: string | null };
}
- created_at: string
  
  Date and time at which the mutation was created.
- from: { acs_entrance_id: string | null }
  
  Old entrance membership.
  - acs_entrance_id: string | null
    
    Old entrance ID.
- message: string
  
  Detailed description of the mutation.
- mutation_code: "updating_entrance_membership"
  
  Mutation code to indicate that Seam is in the process of pushing updated entrance membership information to the integrated access system.
- to: { acs_entrance_id: string | null }
  
  New entrance membership.
  - acs_entrance_id: string | null
    
    New entrance ID.
{
    acs_user_id: string;
    created_at: string;
    message: string;
    mutation_code: "deferring_user_membership_update";
    variant: "adding" | "removing";
}
- acs_user_id: string
  
  ID of the user involved in the scheduled change.
- created_at: string
  
  Date and time at which the mutation was created.
- message: string
  
  Detailed description of the mutation.
- mutation_code: "deferring_user_membership_update"
  
  Mutation code to indicate that a scheduled user membership change is pending for this access group.
- variant: "adding" | "removing"
  
  Whether the user is scheduled to be added to or removed from this access group.

warnings

warnings: {
    created_at: string;
    message: string;
    warning_code: "unknown_issue_with_acs_access_group" | "being_deleted";
}[]

Warnings associated with the acs_access_group.

Type Declaration

created_at: string

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: "unknown_issue_with_acs_access_group" | "being_deleted"

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

workspace_id

workspace_id: string

ID of the workspace that contains the access group.

Type Alias AcsAccessGroup

Index

Properties

Properties

access_group_type

Deprecated

access_group_type_display_name

Deprecated

Optionalaccess_schedule

Type Declaration

ends_at: string | null

starts_at: string

acs_access_group_id

acs_system_id

connected_account_id

created_at

display_name

errors

Type Declaration

created_at: string

error_code: "failed_to_create_on_acs_system"

message: string

external_type

external_type_display_name

is_managed

name

pending_mutations

Type Declaration

created_at: string

message: string

mutation_code: "creating"

created_at: string

message: string

mutation_code: "deleting"

created_at: string

message: string

mutation_code: "deferring_deletion"

created_at: string

from: { name?: string | null }

Optionalname?: string | null

message: string

mutation_code: "updating_group_information"

to: { name?: string | null }

Optionalname?: string | null

created_at: string

from: { ends_at: string | null; starts_at: string | null }

ends_at: string | null

starts_at: string | null

message: string

mutation_code: "updating_access_schedule"

to: { ends_at: string | null; starts_at: string | null }

ends_at: string | null

starts_at: string | null

created_at: string

from: { acs_user_id: string | null }

acs_user_id: string | null

message: string

mutation_code: "updating_user_membership"

to: { acs_user_id: string | null }

acs_user_id: string | null

created_at: string

from: { acs_entrance_id: string | null }

acs_entrance_id: string | null

message: string

mutation_code: "updating_entrance_membership"

to: { acs_entrance_id: string | null }

acs_entrance_id: string | null

acs_user_id: string

created_at: string

message: string

mutation_code: "deferring_user_membership_update"

variant: "adding" | "removing"

warnings

Type Declaration

created_at: string

message: string

warning_code: "unknown_issue_with_acs_access_group" | "being_deleted"

workspace_id

Settings

On This Page

`Optional`access_schedule

`Optional`name?: string | null

`Optional`name?: string | null