Sign in
auth

List users

Changed on

List all users with roles and status information. Available to managers and admins.

get/bodhi/v1/users

Request

  • Base URL: http://localhost:1135
  • URL: http://localhost:1135/bodhi/v1/users
  • Auth: OAuth 2 (authorization code, authorization URL /bodhi/v1/auth/initiate, token URL /bodhi/v1/auth/callback, scopes: resource_manager)

Query parameters

pageinteger

Page number (1-based)

page_sizeinteger

Number of users per page

Response

Users retrieved successfully

client_idstring required
pageinteger required
page_sizeinteger required
total_pagesinteger required
total_usersinteger required
has_nextboolean required
has_previousboolean required

Example response

{
  "client_id": "resource-abc123def456",
  "users": [
    {
      "user_id": "550e8400-e29b-41d4-a716-446655440000",
      "username": "user@example.com",
      "first_name": "John",
      "last_name": "Doe"
    }
  ],
  "page": 1,
  "page_size": 10,
  "total_pages": 5,
  "total_users": 45,
  "has_next": true
}

Changes

  • 4d4ee0c37d75Revision changes
    • info

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

  • 11825ee4b44dRevision changes
    • breaking

      removed 'propertyNames' constraint from the / response property for the status

    • breaking

      removed 'propertyNames' constraint from the / response property for the status

    • breaking

      removed 'propertyNames' constraint from the / response property for the status

    • breaking

      removed 'propertyNames' constraint from the / response property for the status

    • breaking

      the / response's property type changed from object null to string null for status

    • breaking

      the / response's property type changed from object null to string null for status

    • breaking

      the / response's property type changed from object null to string null for status

    • breaking

      the / response's property type changed from object null to string null for status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status