@seamapi/http - v2.1.0
    Preparing search index...

    Type Alias AccessGrant

    Represents an Access Grant. Access Grants enable you to grant a user identity access to spaces, entrances, and devices through one or more access methods, such as mobile keys, plastic cards, and PIN codes. You can create an Access Grant for an existing user identity, or you can create a new user identity while creating the new Access Grant.

    type AccessGrant = {
        access_grant_id: string;
        access_grant_key?: string;
        access_method_ids: string[];
        client_session_token?: string;
        created_at: string;
        customization_profile_id?: string;
        display_name: string;
        ends_at: string | null;
        errors: {
            created_at: string;
            error_code: "cannot_create_requested_access_methods";
            message: string;
            missing_device_ids?: string[];
        }[];
        instant_key_url?: string;
        location_ids: string[];
        name: string
        | null;
        pending_mutations: (
            | {
                created_at: string;
                from: { device_ids: string[] };
                message: string;
                mutation_code: "updating_spaces";
                to: { common_code_key?: string | null; device_ids: string[] };
            }
            | {
                access_method_ids: string[];
                created_at: string;
                from: { ends_at: string
                | null; starts_at: string | null };
                message: string;
                mutation_code: "updating_access_times";
                to: { ends_at: string | null; starts_at: string | null };
            }
        )[];
        requested_access_methods: {
            code?: string;
            created_access_method_ids: string[];
            created_at: string;
            display_name: string;
            instant_key_max_use_count?: number;
            mode: "code"
            | "card"
            | "mobile_key"
            | "cloud_key";
        }[];
        reservation_key?: string;
        space_ids: string[];
        starts_at: string;
        user_identity_id: string;
        warnings: (
            | {
                created_at: string;
                message: string;
                warning_code: "being_deleted";
            }
            | {
                created_at: string;
                message: string;
                warning_code: "underprovisioned_access";
            }
            | {
                created_at: string;
                failed_devices?: {
                    device_id: string;
                    error_code: string;
                    message: string;
                }[];
                message: string;
                warning_code: "overprovisioned_access";
            }
            | {
                access_method_ids: string[];
                created_at: string;
                message: string;
                warning_code: "updating_access_times";
            }
            | {
                created_at: string;
                device_id: string;
                message: string;
                new_code: string;
                original_code: string;
                warning_code: "requested_code_unavailable";
            }
            | {
                created_at: string;
                device_id: string;
                message: string;
                warning_code: "device_does_not_support_access_codes";
            }
            | {
                created_at: string;
                device_id: string;
                message: string;
                reason: | "duration_exceeds_max"
                | "times_do_not_match_slots"
                | "ongoing_not_supported";
                warning_code: "device_time_constraints_violated";
            }
        )[];
        workspace_id: string;
    }
    Index
    access_grant_id access_grant_key? access_method_ids client_session_token? created_at customization_profile_id? display_name ends_at errors instant_key_url? location_ids name pending_mutations requested_access_methods reservation_key? space_ids starts_at user_identity_id warnings workspace_id
    access_grant_id: string

    ID of the Access Grant.

    access_grant_key?: string

    Unique key for the access grant within the workspace.

    access_method_ids: string[]

    IDs of the access methods created for the Access Grant.

    client_session_token?: string

    Client Session Token. Only returned if the Access Grant has a mobile_key access method.

    created_at: string

    Date and time at which the Access Grant was created.

    customization_profile_id?: string

    ID of the customization profile associated with the Access Grant.

    display_name: string

    Display name of the Access Grant.

    ends_at: string | null

    Date and time at which the Access Grant ends.

    errors: {
        created_at: string;
        error_code: "cannot_create_requested_access_methods";
        message: string;
        missing_device_ids?: string[];
    }[]

    Errors associated with the access grant.

    Type Declaration

    • created_at: string

      Date and time at which Seam created the error.

    • error_code: "cannot_create_requested_access_methods"

      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.

    • Optionalmissing_device_ids?: string[]

      IDs of the devices that did not receive an access code at grant creation. Use these to identify which specific devices failed when the message reports a partial failure.

    instant_key_url?: string

    Instant Key URL. Only returned if the Access Grant has a single mobile_key access_method.

    location_ids: string[]

    Use space_ids.

    name: string | null

    Name of the Access Grant. If not provided, the display name will be computed.

    pending_mutations: (
        | {
            created_at: string;
            from: { device_ids: string[] };
            message: string;
            mutation_code: "updating_spaces";
            to: { common_code_key?: string | null; device_ids: string[] };
        }
        | {
            access_method_ids: string[];
            created_at: string;
            from: { ends_at: string
            | null; starts_at: string | null };
            message: string;
            mutation_code: "updating_access_times";
            to: { ends_at: string | null; starts_at: string | null };
        }
    )[]

    List of pending mutations for the access grant. This shows updates that are in progress.

    Type Declaration

    • {
          created_at: string;
          from: { device_ids: string[] };
          message: string;
          mutation_code: "updating_spaces";
          to: { common_code_key?: string | null; device_ids: string[] };
      }
      • created_at: string

        Date and time at which the mutation was created.

      • from: { device_ids: string[] }

        Previous location configuration.

        • device_ids: string[]

          Previous device IDs where access codes existed.

      • message: string

        Detailed description of the mutation.

      • mutation_code: "updating_spaces"

        Mutation code to indicate that Seam is in the process of updating the spaces (devices) associated with this access grant.

      • to: { common_code_key?: string | null; device_ids: string[] }

        New location configuration.

        • Optionalcommon_code_key?: string | null

          Common code key to ensure PIN code reuse across devices.

        • device_ids: string[]

          New device IDs where access codes should be created.

    • {
          access_method_ids: string[];
          created_at: string;
          from: { ends_at: string | null; starts_at: string | null };
          message: string;
          mutation_code: "updating_access_times";
          to: { ends_at: string | null; starts_at: string | null };
      }
      • access_method_ids: string[]

        IDs of the access methods being updated.

      • created_at: string

        Date and time at which the mutation was created.

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

        Previous access time configuration.

        • ends_at: string | null

          Previous end time for access.

        • starts_at: string | null

          Previous start time for access.

      • message: string

        Detailed description of the mutation.

      • mutation_code: "updating_access_times"

        Mutation code to indicate that Seam is in the process of updating the access times for this access grant.

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

        New access time configuration.

        • ends_at: string | null

          New end time for access.

        • starts_at: string | null

          New start time for access.

    requested_access_methods: {
        code?: string;
        created_access_method_ids: string[];
        created_at: string;
        display_name: string;
        instant_key_max_use_count?: number;
        mode: "code" | "card" | "mobile_key" | "cloud_key";
    }[]

    Access methods that the user requested for the Access Grant.

    Type Declaration

    • Optionalcode?: string

      Specific PIN code to use for this access method. Only applicable when mode is 'code'.

    • created_access_method_ids: string[]

      IDs of the access methods created for the requested access method.

    • created_at: string

      Date and time at which the requested access method was added to the Access Grant.

    • display_name: string

      Display name of the access method.

    • Optionalinstant_key_max_use_count?: number

      Maximum number of times the instant key can be used. Only applicable when mode is 'mobile_key'. Defaults to 1 if not specified.

    • mode: "code" | "card" | "mobile_key" | "cloud_key"

      Access method mode. Supported values: code, card, mobile_key, cloud_key.

    reservation_key?: string

    Reservation key for the access grant.

    space_ids: string[]

    IDs of the spaces to which the Access Grant gives access.

    starts_at: string

    Date and time at which the Access Grant starts.

    user_identity_id: string

    ID of user identity to which the Access Grant gives access.

    warnings: (
        | { created_at: string; message: string; warning_code: "being_deleted" }
        | {
            created_at: string;
            message: string;
            warning_code: "underprovisioned_access";
        }
        | {
            created_at: string;
            failed_devices?: {
                device_id: string;
                error_code: string;
                message: string;
            }[];
            message: string;
            warning_code: "overprovisioned_access";
        }
        | {
            access_method_ids: string[];
            created_at: string;
            message: string;
            warning_code: "updating_access_times";
        }
        | {
            created_at: string;
            device_id: string;
            message: string;
            new_code: string;
            original_code: string;
            warning_code: "requested_code_unavailable";
        }
        | {
            created_at: string;
            device_id: string;
            message: string;
            warning_code: "device_does_not_support_access_codes";
        }
        | {
            created_at: string;
            device_id: string;
            message: string;
            reason: | "duration_exceeds_max"
            | "times_do_not_match_slots"
            | "ongoing_not_supported";
            warning_code: "device_time_constraints_violated";
        }
    )[]

    Warnings associated with the access grant.

    Type Declaration

    • { created_at: string; message: string; warning_code: "being_deleted" }
      • 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: "being_deleted"

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

    • { created_at: string; message: string; warning_code: "underprovisioned_access" }
      • 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: "underprovisioned_access"

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

    • {
          created_at: string;
          failed_devices?: { device_id: string; error_code: string; message: string }[];
          message: string;
          warning_code: "overprovisioned_access";
      }
      • created_at: string

        Date and time at which Seam created the warning.

      • Optionalfailed_devices?: { device_id: string; error_code: string; message: string }[]

        Devices whose access codes could not be revoked during reconciliation. Present when the provider does not support revoking an offline access code (e.g. Dormakaba oracode with exhausted override budget).

      • message: string

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

      • warning_code: "overprovisioned_access"

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

    • {
          access_method_ids: string[];
          created_at: string;
          message: string;
          warning_code: "updating_access_times";
      }
      • access_method_ids: string[]

        IDs of the access methods being updated.

      • 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: "updating_access_times"

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

    • {
          created_at: string;
          device_id: string;
          message: string;
          new_code: string;
          original_code: string;
          warning_code: "requested_code_unavailable";
      }
      • created_at: string

        Date and time at which Seam created the warning.

      • device_id: string

        ID of the device where the requested code was unavailable.

      • message: string

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

      • new_code: string

        The new PIN code that was assigned instead.

      • original_code: string

        The originally requested PIN code that was unavailable.

      • warning_code: "requested_code_unavailable"

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

    • {
          created_at: string;
          device_id: string;
          message: string;
          warning_code: "device_does_not_support_access_codes";
      }
      • created_at: string

        Date and time at which Seam created the warning.

      • device_id: string

        ID of the device that does not support access codes.

      • message: string

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

      • warning_code: "device_does_not_support_access_codes"

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

    • {
          created_at: string;
          device_id: string;
          message: string;
          reason:
              | "duration_exceeds_max"
              | "times_do_not_match_slots"
              | "ongoing_not_supported";
          warning_code: "device_time_constraints_violated";
      }
      • created_at: string

        Date and time at which Seam created the warning.

      • device_id: string

        ID of the device whose time constraints the access grant violates.

      • message: string

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

      • reason: "duration_exceeds_max" | "times_do_not_match_slots" | "ongoing_not_supported"

        Specific reason why the grant's times are not programmable on the device.

      • warning_code: "device_time_constraints_violated"

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

    workspace_id: string

    ID of the Seam workspace associated with the Access Grant.

    Settings
    Member Visibility

    On This Page
    Properties