Sign in
users

List Users

Changed on

List the users the caller's organization can name, with pagination.

users is deployment-global and has no organization column, so which of them this organization can name is derived: a key, usage, or a roster row puts one in reach, and one reached from nowhere at all (the shared default owner, or a user just created) is shared rather than hidden. See repositories.users_repository.in_organization.

parent_user_id with external_id finds the end user a service key created for a user value, which is how a caller maps its own ids to Otari's. include_total adds an Otari-Total-Count header counting every match, so limit=1 with it counts a service key's end users.

get/api/v1/users

Request

  • The document declares no server URL.
  • Auth: one of:
    • API key in header Otari-Key
    • API key in header x-api-key

Query parameters

skipinteger
limitinteger
parent_user_idstring nullable

Only the end users of this owner: the user a service key belongs to.

external_idstring nullable

Only the end user a service key names with this user value.

blockedboolean nullable

Only blocked users (true) or only unblocked ones (false).

include_totalboolean

Also count every matching user, in the Otari-Total-Count response header.

Response

Successful Response

aliasstring nullable required
allowed_modelsstring[] nullable required
blockedboolean required
budget_idstring nullable required
budget_started_atstring nullable required
created_atstring required
current_requestsinteger required
current_tokensinteger required
external_idstring nullable
metadataobject required
next_budget_reset_atstring nullable required
parent_user_idstring nullable
reservednumber required
reserved_requestsinteger required
reserved_tokensinteger required
spendnumber required
updated_atstring required
user_idstring required

Changes

  • fbee488d4d9fRevision changes
    • info

      added the optional property to the response with the status

  • e99152573057Revision changes
    • info

      added the new optional query request parameter blocked

    • info

      added the new optional query request parameter external_id

    • info

      added the new optional query request parameter include_total

    • info

      added the new optional query request parameter parent_user_id