Function getUsers

  • Returns a list of users using cursor-based pagination.

    Parameters

    • query: {
          email?: string;
          endingBefore?: string;
          fields?: string;
          filter?: string;
          limit?: number;
          next?: string;
          prev?: string;
          role?: 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";
          sortBy?: "name";
          sortOrder?: "asc"
          | "desc";
          startingAfter?: string;
          status?: "active" | "disabled" | "deleted" | "invited" | "provisioned";
          subject?: string;
          tenantId?: string;
          totalResults?: boolean;
      }

      an object with query parameters

      • Optionalemail?: string

        The email to filter by. Deprecated. Use the new filter parameter to provide an advanced query filter.

      • OptionalendingBefore?: string

        Get users with IDs that are lower than the target user ID. Cannot be used in conjunction with startingAfter. Deprecated. Use prev instead.

      • 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")

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

        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")

        Invalid:

        name eq "Bob" or name eq "Alice" and (status eq "active" or status eq "disabled")
      • 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.

      • Optionalrole?: string

        The role to filter by. Deprecated.

      • 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

      • OptionalsortBy?: "name"

        The user parameter to sort by. Deprecated. Use sort instead.

      • OptionalsortOrder?: "asc" | "desc"

        The sort order, either ascending or descending. Deprecated. Use sort instead.

      • OptionalstartingAfter?: string

        Get users with IDs that are higher than the target user ID. Cannot be used in conjunction with endingBefore. Deprecated. Use next instead.

      • Optionalstatus?: "active" | "disabled" | "deleted" | "invited" | "provisioned"

        The status to filter by. Supports multiple values delimited by commas. Deprecated. Use the new filter parameter to provide an advanced query filter.

      • Optionalsubject?: string

        The subject to filter by. Deprecated. Use the new filter parameter to provide an advanced query filter.

      • OptionaltenantId?: string

        The tenant ID to filter by. Deprecated.

      • 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

    Returns Promise<GetUsersHttpResponse>

    GetUsersHttpError

Settings

Member Visibility