Package ai.vectros.resources.identity.requests

Class ListUsersRequest

java.lang.Object
ai.vectros.resources.identity.requests.ListUsersRequest
public final class ListUsersRequest extends Object

  • Method Details

    • getExternalId

      public Optional<String> getExternalId()
      Returns:
      Look up a single user by your own externalId. Returns a one-element list, or an empty list if no match. Cannot be combined with the type/field/value lookup parameters.

    • getStartFrom

      public Optional<String> getStartFrom()
      Returns:
      Pagination cursor. Pass the nextCursor returned by the previous page to fetch the next page; omit it for the first page. The cursor is opaque — echo it back unchanged, and do not parse it or construct one. Keep every other query parameter identical while paging: a cursor is valid only for the exact query that returned it, and reusing one against a different query is rejected with a 400.

    • getLimit

      public Optional<Long> getLimit()
      Returns:
      Maximum number of users to return per page (1–100; defaults to 20).

    • getType

      public Optional<String> getType()
      Returns:
      The schema record type whose lookup fields you are querying (the schema's declared record type, not the user's HUMAN/SERVICE kind). Must be supplied together with field and exactly one lookup mode (value, from+to, or prefix).

    • getField

      public Optional<String> getField()
      Returns:
      The lookup field to filter on. Must be declared as a lookup field on the schema named by type. Supplied together with type and one lookup mode.

    • getValue

      public Optional<String> getValue()
      Returns:
      Exact value to match for field. Cannot be combined with from/to or prefix. Not allowed for a sensitive (blind-indexed) field on this endpoint; use POST /v1/users/lookup instead, which keeps the value out of the URL.

    • getFrom

      public Optional<String> getFrom()
      Returns:
      Inclusive lower bound for a range lookup. Requires to, and is only valid on non-sensitive fields declared with range support. Cannot be combined with value or prefix.

    • getTo

      public Optional<String> getTo()
      Returns:
      Inclusive upper bound for a range lookup. Requires from.

    • getPrefix

      public Optional<String> getPrefix()
      Returns:
      Prefix to match. Only valid on string fields declared with range support. Cannot be combined with value or from/to.

    • getOrder

      public Optional<ListUsersRequestOrder> getOrder()
      Returns:
      Sort direction for the matched users: asc (ascending, the default) or desc (descending).

    • equals

      public boolean equals(Object other)
      Overrides:
      equals in class Object

    • getAdditionalProperties

      public Map<String,Object> getAdditionalProperties()

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • builder

      public static ListUsersRequest.Builder builder()