Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Red Hat Users API

Operations for managing user accounts, credentials, and profile attributes within a realm.

Red Hat Users API is one of 75 APIs that Red Hat publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Users. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, a getting-started guide, a changelog, and a GitHub repository.

This API exposes 6 operations across 3 paths, and defines 2 schemas. It is described by OpenAPI 3.1.0, at version 2.6.

Requests are made against a single base URL, https://ansible-platform.example.com.

6 operations 3 paths 2 schemas 1 DELETE3 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2.6
Server
https://ansible-platform.example.com
Authentication
HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 1

Red Hat Users API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — OAuth 2.0 Bearer token for authenticating API requests to the automation controller.

Paths & Operations 6

Across 3 paths, the API surfaces 6 operations — 1 DELETE, 3 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Users 6

Operations for managing user accounts, credentials, and profile attributes within a realm.

GET
/admin/realms/{realm}/users
Red Hat List Users
listUsers 8 params → 200401
POST
/admin/realms/{realm}/users
Red Hat Create a User
createUser 1 param body → 201400401409
GET
/admin/realms/{realm}/users/{user_id}
Red Hat Get a User
getUser 2 params → 200401404
PUT
/admin/realms/{realm}/users/{user_id}
Red Hat Update a User
updateUser 2 params body → 204400401404
DELETE
/admin/realms/{realm}/users/{user_id}
Red Hat Delete a User
deleteUser 2 params → 204401404
GET
/user/
Red Hat Get Logged-in User
getLoggedInUser → 200401

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are User (11 properties), User_2 (4 properties). Each schema is shown below with its type and property counts.

User
object
A user account within a Keycloak realm.
11 properties
User_2
object
A Quay user account.
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

red-hat-users-api-openapi.yml Raw ↑

Other APIs Red Hat publishes across the network.

Red Hat Subscription Management API
Red Hat Advanced Cluster Management API
Red Hat Advanced Cluster Security API
Red Hat 3scale API Management
Red Hat Cost Management API
Red Hat Image Builder API
Red Hat Vulnerability Management API
Red Hat Patch API
Red Hat Compliance API
Red Hat Build of Apicurio Registry API
Red Hat Streams for Apache Kafka Bridge API
Red Hat Ansible Lightspeed API