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

    Type Alias AcsUsersListParameters

    type AcsUsersListParameters = {
        acs_system_id?: string;
        created_before?: string;
        limit?: number;
        page_cursor?: string;
        search?: string;
        user_identity_email_address?: string;
        user_identity_id?: string;
        user_identity_phone_number?: string;
    }
    Index
    acs_system_id? created_before? limit? page_cursor? search? user_identity_email_address? user_identity_id? user_identity_phone_number?
    acs_system_id?: string

    ID of the acs_system for which you want to retrieve all access system users.

    created_before?: string

    Timestamp by which to limit returned access system users. Returns users created before this timestamp.

    limit?: number

    Maximum number of records to return per page.

    Optionalpage_cursor

    page_cursor?: string

    Identifies the specific page of results to return, obtained from the previous page's next_page_cursor.

    search?: string

    String for which to search. Filters returned access system users to include all records that satisfy a partial match using full_name, phone_number, email_address, acs_user_id, user_identity_id, user_identity_full_name or user_identity_phone_number.

    user_identity_email_address?: string

    Email address of the user identity for which you want to retrieve all access system users.

    user_identity_id?: string

    ID of the user identity for which you want to retrieve all access system users.

    user_identity_phone_number?: string

    Phone number of the user identity for which you want to retrieve all access system users, in E.164 format (for example, +15555550100).

    Settings
    Member Visibility

    On This Page
    Properties