Function getUsers

Parameters

• query: {
      fields?: string;
      filter?: string;
      limit?: number;
      next?: string;
      prev?: string;
      sort?:
          | "subject"
          | "clientId"
          | "status"
          | "id"
          | "name"
          | "+status"
          | "-status"
          | "email"
          | "-name"
          | "+name"
          | "+createdAt"
          | "-createdAt"
          | "createdAt"
          | "+id"
          | "-id"
          | "_id"
          | "+_id"
          | "-_id"
          | "tenantId"
          | "+tenantId"
          | "-tenantId"
          | "+clientId"
          | "-clientId"
          | "+subject"
          | "-subject"
          | "+email"
          | "-email"
          | "inviteExpiry"
          | "+inviteExpiry"
          | "-inviteExpiry";
      totalResults?: boolean;
  }

  an object with query parameters

  • Optionalfields?: string

    A comma-delimited string of the requested fields per entity. If the 'links' value is omitted, then the entity HATEOAS link will also be omitted.

  • Optionalfilter?: string

    The advanced filtering to use for the query. Refer to RFC 7644 for the syntax. Cannot be combined with any of the fields marked as deprecated. All conditional statements within this query parameter are case insensitive.

    The following fields support the eq operator: id, subject, name, email, status, clientId, assignedRoles.id assignedRoles.name, assignedGroups.id, assignedGroupsAssignedRoles.name

    Additionally, the following fields support the co operator: name, email, subject

    Queries may be rate limited if they differ greatly from these examples:

    (id eq "62716ab404a7bd8626af9bd6" or id eq "62716ac4c7e500e13ff5fa22") and (status eq "active" or status eq "disabled")
    Copy

    name co "query" or email co "query" or subject co "query" or id eq "query" or assignedRoles.name eq "query"
    Copy

    Any filters for status must be grouped together and applied to the whole query.

    Valid:

    (name eq "Bob" or name eq "Alice") and (status eq "active" or status eq "disabled")
    Copy

    Invalid:

    name eq "Bob" or name eq "Alice" and (status eq "active" or status eq "disabled")
    Copy

  • Optionallimit?: number

    The number of user entries to retrieve.

  • Optionalnext?: string

    Get users that come after this cursor value when sorted. Cannot be used in conjunction with prev.

  • Optionalprev?: string

    Get users that come before this cursor value when sorted. Cannot be used in conjunction with next.

  • Optionalsort?:
        | "subject"
        | "clientId"
        | "status"
        | "id"
        | "name"
        | "+status"
        | "-status"
        | "email"
        | "-name"
        | "+name"
        | "+createdAt"
        | "-createdAt"
        | "createdAt"
        | "+id"
        | "-id"
        | "_id"
        | "+_id"
        | "-_id"
        | "tenantId"
        | "+tenantId"
        | "-tenantId"
        | "+clientId"
        | "-clientId"
        | "+subject"
        | "-subject"
        | "+email"
        | "-email"
        | "inviteExpiry"
        | "+inviteExpiry"
        | "-inviteExpiry"

    The field to sort by, with +/- prefix indicating sort order

  • OptionaltotalResults?: boolean

    Whether to return a total match count in the result. Defaults to false. It will trigger an extra DB query to count, reducing the efficiency of the endpoint.

• Optionaloptions: ApiCallOptions