How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Red Hat Ansible Automation Platform Users API

The users API from Red Hat Ansible Automation Platform — 25 operation(s) for users.

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

Tagged areas include User. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and authentication docs.

This API exposes 42 operations across 25 paths, and defines 33 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against 2 base URLs: http://automation-hub-backend-cwa.automation-hub-prod.svc.cluster.local:8000/, /api/eda/v1.

42 operations 25 paths 33 schemas 4 DELETE25 GET4 PATCH6 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://controller-host/api/v2/
Authentication
API Key, API Key, HTTP Basic, OAuth 2.0, API Key
Resource Areas
1

Authentication & Security 5

Red Hat Ansible Automation Platform Users API declares 5 security schemes for authenticating requests. An API key is passed in the header as X-DAB-JW-TOKEN (EDAJWTAuthentication). An API key is passed in the cookie as sessionid (cookieAuth). It accepts HTTP basic authentication (Basic_Authentication). It supports OAuth 2.0 (OAuth2_Authentication) using the authorizationCode and password flows, exposing 2 scopes. An API key is passed in the cookie as gateway_sessionid (SessionAuthentication).

Paths & Operations 42

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

Users 42
GET
/api/v2/users/
Users list
users_list 7 params → 200
POST
/api/v2/users/
Users create
users_create body → 201
GET
/api/v2/users/{id}/
Users retrieve
users_retrieve 1 param → 200
PUT
/api/v2/users/{id}/
Users update
users_update 1 param body → 200
PATCH
/api/v2/users/{id}/
Users partial update
users_partial_update 1 param body → 200
DELETE
/api/v2/users/{id}/
Users destroy
users_destroy 1 param → 204
GET
/api/v2/users/{id}/access_list/
Users access list list
users_access_list_list 8 params → 200
GET
/api/v2/users/{id}/activity_stream/
Users activity stream list
users_activity_stream_list 8 params → 200
GET
/api/v2/users/{id}/admin_of_organizations/
Users admin of organizations retrieve
users_admin_of_organizations_retrieve 1 param → 200
GET
/api/v2/users/{id}/credentials/
Users credentials list
users_credentials_list 8 params → 200
POST
/api/v2/users/{id}/credentials/
Users credentials create
users_credentials_create 1 param body → 201
GET
/api/v2/users/{id}/organizations/
Users organizations retrieve
users_organizations_retrieve 1 param → 200
GET
/api/v2/users/{id}/projects/
Users projects list
users_projects_list 8 params → 200
GET
/api/v2/users/{id}/roles/
Users roles list
users_roles_list 8 params → 200
POST
/api/v2/users/{id}/roles/
Users roles create
users_roles_create 1 param → 201
GET
/api/v2/users/{id}/teams/
Users teams list
users_teams_list 8 params → 200
GET
/api/automation-hub/pulp/api/v3/users/
List users
getApiAutomationHubPulpApiV3Users 30 params → 200
POST
/api/automation-hub/pulp/api/v3/users/
Create an user
postApiAutomationHubPulpApiV3Users body → 201
GET
/api/automation-hub/pulp/api/v3/users/{id}/
Inspect an user
users_read 3 params → 200
PUT
/api/automation-hub/pulp/api/v3/users/{id}/
Update an user
putApiAutomationHubPulpApiV3UsersById 1 param body → 200
PATCH
/api/automation-hub/pulp/api/v3/users/{id}/
Update an user
patchApiAutomationHubPulpApiV3UsersById 1 param body → 200
DELETE
/api/automation-hub/pulp/api/v3/users/{id}/
Delete an user
users_delete 1 param → 204
GET
/users/
Users list
getUsers 6 params → 200
GET
/users/{id}/
Users retrieve
getUsersById 1 param → 200
PATCH
/users/{id}/
Users partial update
patchUsersById 1 param body → 200403
GET
/users/me/
Get current user
get_current_user → 200
GET
/users/me/awx-tokens/
Users me awx tokens list
users_me_awx_tokens_list 3 params → 200
POST
/users/me/awx-tokens/
Users me awx tokens create
users_me_awx_tokens_create body → 201
GET
/users/me/awx-tokens/{id}/
Users me awx tokens retrieve
users_me_awx_tokens_retrieve 1 param → 200
DELETE
/users/me/awx-tokens/{id}/
Users me awx tokens destroy
users_me_awx_tokens_destroy 1 param → 204
GET
/api/gateway/v1/users/
Users list
getApiGatewayV1Users 50 params → 200
POST
/api/gateway/v1/users/
Users create
postApiGatewayV1Users body → 201
GET
/api/gateway/v1/users/{id}/
Users retrieve
getApiGatewayV1UsersById 1 param → 200
PUT
/api/gateway/v1/users/{id}/
Users update
putApiGatewayV1UsersById 1 param body → 200
PATCH
/api/gateway/v1/users/{id}/
Users partial update
patchApiGatewayV1UsersById 1 param body → 200
DELETE
/api/gateway/v1/users/{id}/
Users destroy
deleteApiGatewayV1UsersById 1 param → 204
GET
/api/gateway/v1/users/{id}/authenticators/
Users authenticators retrieve
users_authenticators_retrieve 1 param → 200
GET
/api/gateway/v1/users/{id}/authorized_tokens/
Users authorized tokens retrieve
users_authorized_tokens_retrieve 1 param → 200
GET
/api/gateway/v1/users/{id}/organizations/deprecated
Users organizations list
users_organizations_list 8 params → 200
GET
/api/gateway/v1/users/{id}/personal_tokens/
Users personal tokens retrieve
users_personal_tokens_retrieve 1 param → 200
GET
/api/gateway/v1/users/{id}/teams/deprecated
Users teams list
getApiGatewayV1UsersByIdTeams 8 params → 200
GET
/api/gateway/v1/users/{id}/tokens/
Users tokens retrieve
users_tokens_retrieve 1 param → 200

Schemas 33

The contract defines 33 schemas that model the data the API accepts and returns. The most detailed are Project (33 properties), PatchedUser_2 (21 properties), User_3 (21 properties), User (15 properties). Each schema is shown below with its type and property counts.

Project
object
33 properties 1 required
UserCredentialSerializerCreateRequest
object
5 properties 2 required
UserRequest
object
7 properties 1 required
PaginatedRoleSerializerWithParentAccessList
object
4 properties 2 required
PaginatedActivityStreamList
object
4 properties 2 required
PatchedUserRequest
object
7 properties
RoleSerializerWithParentAccess
object
7 properties
PaginatedResourceAccessListElementList
object
4 properties 2 required
Team
object
10 properties 2 required
PaginatedUserList
object
4 properties 2 required
UserCredentialSerializerCreate
object
15 properties 2 required
ActivityStream
object
13 properties 3 required
ResourceAccessListElement
object
15 properties 1 required
User
object
15 properties 1 required
PaginatedTeamList
object
4 properties 2 required
PaginatedProjectList
object
4 properties 2 required
PaginatedUserCredentialSerializerCreateList
object
4 properties 2 required
UserResponse
object
9 properties 1 required
User_2
object
7 properties 1 required
PatchedUser
object
7 properties
PaginatedUserResponseList
object
3 properties
PatchedUserUpdateIsSuperuser
object
1 property
AwxTokenCreate
object
3 properties 2 required
UserDetail
object
9 properties 5 required
PaginatedAwxTokenList
object
6 properties
AwxToken
object
6 properties 5 required
PaginatedUserListList
object
6 properties
UserList
object
6 properties 6 required
PatchedUser_2
object
Disallows editing of system user and enforces superuser requirement.
21 properties
Team_2
object
Class to be used by apps to check permissions to related objects This is a core part of integrating permission checks with REST APIs. Full enablement of checks…
11 properties 2 required
Organization
object
11 properties 1 required
PaginatedOrganizationList
object
4 properties 2 required
User_3
object
Disallows editing of system user and enforces superuser requirement.
21 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

red-hat-ansible-automation-platform-users-api-openapi.yml Raw ↑

Other APIs Red Hat Ansible Automation Platform publishes across the network.

Red Hat Automation Services Catalog API
Red Hat Ansible Automation Platform Access Policies API
Red Hat Ansible Automation Platform Acs: File API
Red Hat Ansible Automation Platform Activation Instances API
Red Hat Ansible Automation Platform Activations API
Red Hat Ansible Automation Platform Activity Stream API
Red Hat Ansible Automation Platform Ad Hoc Command Events API
Red Hat Ansible Automation Platform Ad Hoc Commands API
Red Hat Ansible Automation Platform AI API
Red Hat Ansible Automation Platform Analytics API
Red Hat Ansible Automation Platform Ansible: Collections API
Red Hat Ansible Automation Platform Api: API
Where this information came from

This is an independent, third-party profile of Red Hat Ansible Automation Platform Users API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.