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

    Type Alias UnmanagedAccessMethod

    Represents an unmanaged access method. Unmanaged access methods do not have client sessions, instant keys, customization profiles, or keys.

    type UnmanagedAccessMethod = {
        access_method_id: string;
        code?: string | null;
        created_at: string;
        display_name: string;
        errors: {
            created_at: string;
            error_code: "failed_to_issue";
            message: string;
        }[];
        is_assignment_required?: boolean;
        is_encoding_required?: boolean;
        is_issued: boolean;
        is_ready_for_assignment?: boolean;
        is_ready_for_encoding?: boolean;
        issued_at: string
        | null;
        mode: "code" | "card" | "mobile_key" | "cloud_key";
        pending_mutations: (
            | {
                created_at: string;
                from: { device_ids: string[] };
                message: string;
                mutation_code: "provisioning_access";
                to: { device_ids: string[] };
            }
            | {
                created_at: string;
                from: { device_ids: string[] };
                message: string;
                mutation_code: "revoking_access";
                to: { device_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 };
            }
        )[];
        warnings: (
            | {
                created_at: string;
                message: string;
                warning_code: "being_deleted";
            }
            | {
                created_at: string;
                message: string;
                warning_code: "updating_access_times";
            }
            | {
                created_at: string;
                message: string;
                original_access_method_id?: string;
                warning_code: "pulled_backup_access_code";
            }
            | {
                created_at: string;
                message: string;
                warning_code: "delay_in_issuing";
            }
        )[];
        workspace_id: string;
    }
    Index
    access_method_id code? created_at display_name errors is_assignment_required? is_encoding_required? is_issued is_ready_for_assignment? is_ready_for_encoding? issued_at mode pending_mutations warnings workspace_id
    access_method_id: string

    ID of the access method.

    code?: string | null

    The actual PIN code for code access methods.

    created_at: string

    Date and time at which the access method was created.

    display_name: string

    Display name of the access method.

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

    Errors associated with the access method.

    Type Declaration

    • created_at: string

      Date and time at which Seam created the error.

    • error_code: "failed_to_issue"

      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.

    is_assignment_required?: boolean

    Indicates whether an existing card credential must be assigned to this access method before it can be issued. Only applies to card-mode access methods on systems that support credential assignment.

    is_encoding_required?: boolean

    Indicates whether encoding with an card encoder is required to issue or reissue the plastic card associated with the access method.

    is_issued: boolean

    Indicates whether the access method has been issued.

    is_ready_for_assignment?: boolean

    Indicates whether the access method is ready for card assignment. This is true when the access method is in card mode, has not yet been issued, and the system supports credential assignment.

    is_ready_for_encoding?: boolean

    Indicates whether the access method is ready to be encoded. This is true when the credential has been created and the card has not yet been issued.

    issued_at: string | null

    Date and time at which the access method was issued.

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

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

    pending_mutations: (
        | {
            created_at: string;
            from: { device_ids: string[] };
            message: string;
            mutation_code: "provisioning_access";
            to: { device_ids: string[] };
        }
        | {
            created_at: string;
            from: { device_ids: string[] };
            message: string;
            mutation_code: "revoking_access";
            to: { device_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 };
        }
    )[]

    Pending mutations for the access method. Indicates operations that are in progress.

    Type Declaration

    • {
          created_at: string;
          from: { device_ids: string[] };
          message: string;
          mutation_code: "provisioning_access";
          to: { device_ids: string[] };
      }
      • created_at: string

        Date and time at which the mutation was created.

      • from: { device_ids: string[] }

        Previous device configuration.

        • device_ids: string[]

          Previous device IDs where access was provisioned.

      • message: string

        Detailed description of the mutation.

      • mutation_code: "provisioning_access"

        Mutation code to indicate that Seam is in the process of provisioning access for this access method on new devices.

      • to: { device_ids: string[] }

        New device configuration.

        • device_ids: string[]

          New device IDs where access is being provisioned.

    • {
          created_at: string;
          from: { device_ids: string[] };
          message: string;
          mutation_code: "revoking_access";
          to: { device_ids: string[] };
      }
      • created_at: string

        Date and time at which the mutation was created.

      • from: { device_ids: string[] }

        Previous device configuration.

        • device_ids: string[]

          Previous device IDs where access existed.

      • message: string

        Detailed description of the mutation.

      • mutation_code: "revoking_access"

        Mutation code to indicate that Seam is in the process of revoking access for this access method from devices.

      • to: { device_ids: string[] }

        New device configuration.

        • device_ids: string[]

          New device IDs where access should remain.

    • {
          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 };
      }
      • 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 method.

      • 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.

    warnings: (
        | { created_at: string; message: string; warning_code: "being_deleted" }
        | {
            created_at: string;
            message: string;
            warning_code: "updating_access_times";
        }
        | {
            created_at: string;
            message: string;
            original_access_method_id?: string;
            warning_code: "pulled_backup_access_code";
        }
        | { created_at: string; message: string; warning_code: "delay_in_issuing" }
    )[]

    Warnings associated with the access method.

    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: "updating_access_times" }
      • 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;
          message: string;
          original_access_method_id?: string;
          warning_code: "pulled_backup_access_code";
      }
      • 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.

      • Optionaloriginal_access_method_id?: string

        ID of the original access method from which this backup access method was split, if applicable.

      • warning_code: "pulled_backup_access_code"

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

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

        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 method.

    Settings
    Member Visibility

    On This Page
    Properties