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

    Type Alias AccessGrantsRequestAccessMethodsParameters

    type AccessGrantsRequestAccessMethodsParameters = {
        access_grant_id: string;
        requested_access_methods: {
            code?: string;
            instant_key_max_use_count?: number;
            mode?: "code" | "card" | "mobile_key" | "cloud_key";
        }[];
    }
    Index
    access_grant_id requested_access_methods
    access_grant_id: string

    ID of the Access Grant to add access methods to.

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

    Array of requested access methods to add to the access grant.

    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.

    Settings
    Member Visibility

    On This Page
    Properties