users

List all users

Retrieves a list of all database (db user type) users with their roles and status information.

get/users/db

Request

  • Base URL: https://localhost:8080/v1
  • URL: https://localhost:8080/v1/users/db
  • Auth: one of:
    • none
    • OAuth 2 (implicit, authorization URL http://to-be-configured-in-the-application-config)

Query parameters

includeLastUsedTimeboolean

Whether to include the last time the users were utilized.

Response

Info about the users.

rolesstring[] required

The roles associated with the user.

userIdstring required

The name (ID) of the user.

dbUserType'db_user' | 'db_env_user' required

Type of the returned user.

activeboolean required

Activity status of the returned user.

createdAtstring date-time nullable

Date and time in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

apiKeyFirstLettersstring nullable

First 3 letters of the associated API key.

lastUsedAtstring date-time nullable

Date and time in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

namespacestring

The namespace this user is bound to. Only populated for callers with global-operator privileges; omitted otherwise.

Changes

No recorded changes to this operation across all 1 revision of this API.