Type alias GetUsersArg

GetUsersArg: {
    bustCache?: boolean;
    createdBy?: string;
    createdDate?: string;
    created_date.gte?: string;
    created_date.lte?: string;
    desc?: boolean;
    email?: string;
    email.regex?: string;
    firstName?: string;
    first_name.regex?: string;
    groupId?: string;
    isActive?: boolean;
    isDeleteProtected?: boolean;
    isGroupAdmin?: boolean;
    isOrgAdmin?: boolean;
    isProjectAdmin?: boolean;
    lastName?: string;
    lastSeen?: string;
    lastUpdatedBy?: string;
    lastUpdatedDate?: string;
    last_name.regex?: string;
    last_seen.gte?: string;
    last_seen.lte?: string;
    last_updated_date.gte?: string;
    last_updated_date.lte?: string;
    limit?: number;
    locale?: string;
    locale.regex?: string;
    mfaEnabled?: boolean;
    middleName?: string;
    middle_name.regex?: string;
    nickname?: string;
    nickname.regex?: string;
    objectCount?: boolean;
    orderBy?: string;
    page?: number;
    pageCount?: boolean;
    phoneNumber?: string;
    phone_number.regex?: string;
    projectId?: string;
    roleId?: string;
    search?: string;
    searchFields?: string;
    smsMfaEnabled?: boolean;
    softwareMfaEnabled?: boolean;
    tags?: string;
    tags.contains?: string;
    tags.contains_any?: string;
    username?: string;
    username.regex?: string;
    zoneinfo?: string;
    zoneinfo.regex?: string;
}

Type declaration

  • Optional bustCache?: boolean

    Whether to bypass the cache and get the latest data

  • Optional createdBy?: string

    ID of the user who created the account

  • Optional createdDate?: string

    Created date of items to return

  • Optional created_date.gte?: string
  • Optional created_date.lte?: string
  • Optional desc?: boolean

    Whether to order results in descending order

  • Optional email?: string

    Email of the user

  • Optional email.regex?: string
  • Optional firstName?: string

    First (or given) name of the user

  • Optional first_name.regex?: string
  • Optional groupId?: string

    ID of the group to filter accounts by

  • Optional isActive?: boolean

    (Admin only) Whether to only return active accounts

  • Optional isDeleteProtected?: boolean

    Whether to only return delete-protected accounts

  • Optional isGroupAdmin?: boolean

    Whether to only return group admins

  • Optional isOrgAdmin?: boolean

    Whether to only return org admins

  • Optional isProjectAdmin?: boolean

    Whether to only return project admins

  • Optional lastName?: string

    Last (or family) name of the user

  • Optional lastSeen?: string

    Last time the account was seen

  • Optional lastUpdatedBy?: string

    ID of the user who last updated the account

  • Optional lastUpdatedDate?: string

    Last edited date of items to return

  • Optional last_name.regex?: string
  • Optional last_seen.gte?: string
  • Optional last_seen.lte?: string
  • Optional last_updated_date.gte?: string
  • Optional last_updated_date.lte?: string
  • Optional limit?: number

    Maximum number of objects to return

  • Optional locale?: string

    Locale of the account

  • Optional locale.regex?: string
  • Optional mfaEnabled?: boolean

    Whether to only return users with MFA enabled

  • Optional middleName?: string

    Middle name of the user

  • Optional middle_name.regex?: string
  • Optional nickname?: string

    Nickname of the user

  • Optional nickname.regex?: string
  • Optional objectCount?: boolean

    Whether to only return the number of matching entries

  • Optional orderBy?: string

    Field to order results by

  • Optional page?: number

    Page number to return

  • Optional pageCount?: boolean

    Whether to only return the number of pages

  • Optional phoneNumber?: string

    Phone number of the user

  • Optional phone_number.regex?: string
  • Optional projectId?: string

    ID of the project to filter accounts by

  • Optional roleId?: string

    ID of the role to filter accounts by

  • Optional search?: string

    Search term to filter accounts by

  • Optional searchFields?: string

    Comma-delimited list of fields to search in

  • Optional smsMfaEnabled?: boolean

    Whether to only return users with SMS MFA enabled

  • Optional softwareMfaEnabled?: boolean

    Whether to only return users with software MFA enabled

  • Optional tags?: string

    Comma delimited list of tags on this account

  • Optional tags.contains?: string
  • Optional tags.contains_any?: string
  • Optional username?: string

    Username of the user

  • Optional username.regex?: string
  • Optional zoneinfo?: string

    Timezone of the account

  • Optional zoneinfo.regex?: string

Settings

Member Visibility

Theme