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

    Type Alias AccessGrantsCreateParameters

    type AccessGrantsCreateParameters = {
        access_grant_key?: string;
        acs_entrance_ids?: string[];
        customization_profile_id?: string;
        device_ids?: string[];
        ends_at?: string;
        location?: {
            acs_entrance_ids?: string[];
            device_ids?: string[];
            name?: string;
        };
        location_ids?: string[];
        name?: string;
        requested_access_methods: {
            code?: string;
            instant_key_max_use_count?: number;
            mode?: "code"
            | "card"
            | "mobile_key"
            | "cloud_key";
        }[];
        reservation_key?: string;
        space_ids?: string[];
        space_keys?: string[];
        starts_at?: string;
        user_identity?: {
            email_address?: string;
            full_name?: string;
            phone_number?: string;
            user_identity_key?: string;
        };
        user_identity_id?: string;
    }
    Index
    access_grant_key? acs_entrance_ids? customization_profile_id? device_ids? ends_at? location? location_ids? name? requested_access_methods reservation_key? space_ids? space_keys? starts_at? user_identity? user_identity_id?
    access_grant_key?: string

    Unique key for the access grant within the workspace.

    acs_entrance_ids?: string[]

    Set of IDs of the entrances to which access is being granted.

    customization_profile_id?: string

    ID of the customization profile to apply to the Access Grant and its access methods.

    device_ids?: string[]

    Set of IDs of the devices to which access is being granted.

    ends_at?: string

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

    location?: { acs_entrance_ids?: string[]; device_ids?: string[]; name?: string }

    Type Declaration

    • Optionalacs_entrance_ids?: string[]

      Use acs_entrance_ids at the top level.

    • Optionaldevice_ids?: string[]

      Use device_ids at the top level.

    • Optionalname?: string

      Name of the location.

    Create a space first, then reference it using space_ids.

    location_ids?: string[]

    Use space_ids.

    name?: string

    Name for the access grant.

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

    Type Declaration

    • Optionalcode?: string

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

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

    • Optionalmode?: "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[]

    Set of IDs of existing spaces to which access is being granted.

    space_keys?: string[]

    Set of keys of existing spaces to which access is being granted.

    starts_at?: string

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

    user_identity?: {
        email_address?: string;
        full_name?: string;
        phone_number?: string;
        user_identity_key?: string;
    }

    When used, creates a new user identity with the given details, and grants them access.

    Type Declaration

    • Optionalemail_address?: string

      Unique email address for the user identity.

    • Optionalfull_name?: string

      Full name of the user associated with the user identity.

    • Optionalphone_number?: string

      Unique phone number for the user identity in E.164 format (for example, +15555550100).

    • Optionaluser_identity_key?: string

      Unique key for the user identity.

    user_identity_id?: string

    ID of user identity for whom access is being granted.

    Settings
    Member Visibility

    On This Page
    Properties