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

    Type Alias AcsCredentialsCreateParameters

    type AcsCredentialsCreateParameters = {
        access_method: "code" | "card" | "mobile_key" | "cloud_key";
        acs_system_id?: string;
        acs_user_id?: string;
        allowed_acs_entrance_ids?: string[];
        assa_abloy_vostio_metadata?: {
            auto_join?: boolean;
            join_all_guest_acs_entrances?: boolean;
            override_all_guest_acs_entrances?: boolean;
            override_guest_acs_entrance_ids?: string[];
        };
        code?: string;
        credential_manager_acs_system_id?: string;
        ends_at?: string;
        is_multi_phone_sync_credential?: boolean;
        salto_space_metadata?: { assign_new_key?: boolean };
        starts_at?: string;
        user_identity_id?: string;
        visionline_metadata?: {
            auto_join?: boolean;
            card_format?: "TLCode" | "rfid48";
            card_function_type?: "guest" | "staff";
            joiner_acs_credential_ids?: string[];
            override?: boolean;
        };
    }
    Index
    access_method acs_system_id? acs_user_id? allowed_acs_entrance_ids? assa_abloy_vostio_metadata? code? credential_manager_acs_system_id? ends_at? is_multi_phone_sync_credential? salto_space_metadata? starts_at? user_identity_id? visionline_metadata?
    access_method: "code" | "card" | "mobile_key" | "cloud_key"

    Access method for the new credential. Supported values: code, card, mobile_key, cloud_key.

    acs_system_id?: string

    ID of the access system to which the new credential belongs. You must provide either acs_user_id or the combination of user_identity_id and acs_system_id.

    acs_user_id?: string

    ID of the access system user to whom the new credential belongs. You must provide either acs_user_id or the combination of user_identity_id and acs_system_id.

    allowed_acs_entrance_ids?: string[]

    Set of IDs of the entrances for which the new credential grants access.

    assa_abloy_vostio_metadata?: {
        auto_join?: boolean;
        join_all_guest_acs_entrances?: boolean;
        override_all_guest_acs_entrances?: boolean;
        override_guest_acs_entrance_ids?: string[];
    }

    Vostio-specific metadata for the new credential.

    code?: string

    Access (PIN) code for the new credential. There may be manufacturer-specific code restrictions. For details, see the applicable device or system integration guide.

    credential_manager_acs_system_id?: string

    ACS system ID of the credential manager for the new credential.

    ends_at?: string

    Date and time at which the validity of the new credential ends, in ISO 8601 format. Must be a time in the future and after starts_at.

    is_multi_phone_sync_credential?: boolean

    Indicates whether the new credential is a multi-phone sync credential.

    salto_space_metadata?: { assign_new_key?: boolean }

    Salto Space-specific metadata for the new credential.

    Type Declaration

    starts_at?: string

    Date and time at which the validity of the new credential starts, in ISO 8601 format.

    user_identity_id?: string

    ID of the user identity to whom the new credential belongs. You must provide either acs_user_id or the combination of user_identity_id and acs_system_id. If the access system contains a user with the same email_address or phone_number as the user identity that you specify, they are linked, and the credential belongs to the access system user. If the access system does not have a corresponding user, one is created.

    visionline_metadata?: {
        auto_join?: boolean;
        card_format?: "TLCode" | "rfid48";
        card_function_type?: "guest" | "staff";
        joiner_acs_credential_ids?: string[];
        override?: boolean;
    }

    Visionline-specific metadata for the new credential.

    Settings
    Member Visibility

    On This Page
    Properties