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

    Type Alias AcsUsersUpdateParameters

    type AcsUsersUpdateParameters = {
        access_schedule?: { ends_at?: string; starts_at?: string };
        acs_system_id?: string;
        acs_user_id?: string;
        email?: string;
        email_address?: string;
        full_name?: string;
        hid_acs_system_id?: string;
        phone_number?: string;
        user_identity_id?: string;
    }
    Index
    access_schedule? acs_system_id? acs_user_id? email? email_address? full_name? hid_acs_system_id? phone_number? user_identity_id?
    access_schedule?: { ends_at?: string; starts_at?: string }

    starts_at and ends_at timestamps for the access system user's access. If you specify an access_schedule, you may include both starts_at and ends_at. If you omit starts_at, it defaults to the current time. ends_at is optional and must be a time in the future and after starts_at.

    Type Declaration

    • Optionalends_at?: string

      Ending timestamp for the access system user's access.

    • Optionalstarts_at?: string

      Starting timestamp for the access system user's access.

    acs_system_id?: string

    ID of the access system that you want to update. You can only provide acs_system_id with user_identity_id.

    acs_user_id?: string

    ID of the access system user that you want to update. You can only provide acs_user_id or user_identity_id.

    email?: string

    use email_address.

    email_address?: string

    Email address of the access system user.

    full_name?: string

    Full name of the access system user.

    hid_acs_system_id?: string

    ID of the HID access control system associated with the user.

    phone_number?: string

    Phone number of the access system user in E.164 format (for example, +15555550100).

    user_identity_id?: string

    ID of the user identity that you want to update. You can only provide acs_user_id or user_identity_id. If you provide user_identity_id, you must also provide acs_system_id.

    Settings
    Member Visibility

    On This Page
    Properties