Sign in
Auth API

List Users

Changed on

List all users with optional filtering.

Args: start_index: Pagination start (1-based, default: 1) count: Results per page (default: 100, max: 1000) id_prefix: Filter users whose ID starts with this prefix roles: List of role names. Returns users who have ANY of these roles. Use multiple query params: ?roles=admin&roles=user

Returns: UserListResponse with paginated user list

get/api/auth/user

Request

  • The document declares no server URL.
  • Auth: none declared

Query parameters

start_indexinteger
countinteger
id_prefixstring nullable
rolesstring[] nullable

Response

Successful Response

total_resultsinteger required
start_indexinteger required
items_per_pageinteger required

Changes

  • b9d312a13f5dRevision changes
    • ○

      added the optional property // to the response with the status

    • ○

      added the optional property // to the response with the status

  • a8157dc3279dRevision changes
    • ▲

      response property users/items/created_at list-of-types was widened by adding types null to media type application/json of response 200

    • ▲

      response property users/items/created_by list-of-types was widened by adding types null to media type application/json of response 200

    • ○

      query request parameter id_prefix list-of-types was widened by adding types null

    • ○

      query request parameter roles list-of-types was widened by adding types null

    • ○

      for the query request parameter id_prefix, the type was generalized from string to no type

    • ○

      for the query request parameter roles, the type was generalized from array to no type