method

ListUsers

acme.user.v1.UserService.ListUsers

local acme.user.v1 acme/user/v1/user_service.proto View source

List users with optional server-side filtering.

Pagination

  • page_size accepts values from 0 through 100.
  • Pass a returned next_page_token as page_token to request another page.
  • Treat page tokens as opaque strings rather than parsing their contents.

Filter syntax and the default page size are implementation choices; this example schema does not define them.

RPC on UserService

rpc ListUsers(acme.user.v1.ListUsersRequest) returns (acme.user.v1.ListUsersResponse);

NO_SIDE_EFFECTS

Options

idempotency_level 
idempotency_level = NO_SIDE_EFFECTS
HTTP — GET /v1/users
GET
(google.api.http) = { get: "/v1/users" }

Request

acme.user.v1.ListUsersRequest

FieldNumberTypeCardinalityValidationDescription
page_size1int32implicit
int32.lte=100int32.gte=0
—
Details
  • JSON name: pageSize
  • Presence: IMPLICIT
(buf.validate.field) = {
  int32: {
    lte: 100
    gte: 0
  }
}
page_token2stringimplicit——
Details
  • JSON name: pageToken
  • Presence: IMPLICIT
filter3stringimplicit——
Details
  • JSON name: filter
  • Presence: IMPLICIT

Response

acme.user.v1.ListUsersResponse

FieldNumberTypeCardinalityValidationDescription
users1acme.user.v1.Userrepeated——
Details
  • JSON name: users
  • Presence: IMPLICIT
  • Packed: false
next_page_token2stringimplicit——
Details
  • JSON name: nextPageToken
  • Presence: IMPLICIT