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

    Type Alias AcsUsersCreateParameters

    Parameters for SeamHttpAcsUsers.create.

    type AcsUsersCreateParameters = {
        access_schedule?: { ends_at?: string; starts_at?: string };
        acs_access_group_ids?: string[];
        acs_system_id: string;
        email?: string;
        email_address?: string;
        full_name: string;
        phone_number?: string;
        user_identity_id?: string;
    }
    Index
    access_schedule? acs_access_group_ids? acs_system_id email? email_address? full_name phone_number? user_identity_id?
    access_schedule?: { ends_at?: string; starts_at?: string }

    starts_at and ends_at timestamps for the new 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 new access system user's access.

    • Optionalstarts_at?: string

      Starting timestamp for the new access system user's access.

    acs_access_group_ids?: string[]

    Array of access group IDs to indicate the access groups to which you want to add the new access system user.

    acs_system_id: string

    ID of the access system to which you want to add the new access system user.

    email?: string

    use email_address.

    email_address?: string

    Email address of the access system user.

    full_name: string

    Full name of the new access system 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 with which you want to associate the new access system user.

    Settings
    Member Visibility

    On This Page
    Properties