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 Organizations API

The organizations API from Red Hat Ansible Automation Platform — 33 operation(s) for organizations.

Red Hat Ansible Automation Platform Organizations 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 Organization. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and authentication docs.

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

Requests are made against a single base URL, /api/eda/v1.

56 operations 33 paths 52 schemas 2 DELETE29 GET2 PATCH21 POST2 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 Organizations 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 56

Across 33 paths, the API surfaces 56 operations — 2 DELETE, 29 GET, 2 PATCH, 21 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Organizations 56
GET
/api/v2/organizations/
Organizations retrieve
organizations_retrieve → 200
POST
/api/v2/organizations/
Organizations create
organizations_create → 201
GET
/api/v2/organizations/{id}/
Organizations retrieve 2
organizations_retrieve_2 1 param → 200
PUT
/api/v2/organizations/{id}/
Organizations update
organizations_update 1 param body → 200
PATCH
/api/v2/organizations/{id}/
Organizations partial update
organizations_partial_update 1 param body → 200
DELETE
/api/v2/organizations/{id}/
Organizations destroy
organizations_destroy 1 param → 204
GET
/api/v2/organizations/{id}/access_list/
Organizations access list list
organizations_access_list_list 8 params → 200
GET
/api/v2/organizations/{id}/activity_stream/
Organizations activity stream list
organizations_activity_stream_list 8 params → 200
GET
/api/v2/organizations/{id}/admins/
Organizations admins list
organizations_admins_list 8 params → 200
POST
/api/v2/organizations/{id}/admins/
Organizations admins create
organizations_admins_create 1 param body → 201
GET
/api/v2/organizations/{id}/credentials/
Organizations credentials list
organizations_credentials_list 8 params → 200
POST
/api/v2/organizations/{id}/credentials/
Organizations credentials create
organizations_credentials_create 1 param body → 201
GET
/api/v2/organizations/{id}/execution_environments/
Organizations execution environments list
organizations_execution_environments_list 8 params → 200
POST
/api/v2/organizations/{id}/execution_environments/
Organizations execution environments create
organizations_execution_environments_create 1 param body → 201
GET
/api/v2/organizations/{id}/galaxy_credentials/
Organizations galaxy credentials list
organizations_galaxy_credentials_list 8 params → 200
POST
/api/v2/organizations/{id}/galaxy_credentials/
Organizations galaxy credentials create
organizations_galaxy_credentials_create 1 param body → 201
GET
/api/v2/organizations/{id}/instance_groups/
Organizations instance groups list
organizations_instance_groups_list 8 params → 200
POST
/api/v2/organizations/{id}/instance_groups/
Organizations instance groups create
organizations_instance_groups_create 1 param body → 201
GET
/api/v2/organizations/{id}/inventories/
Organizations inventories list
organizations_inventories_list 8 params → 200
GET
/api/v2/organizations/{id}/job_templates/
Organizations job templates list
organizations_job_templates_list 8 params → 200
POST
/api/v2/organizations/{id}/job_templates/
Organizations job templates create
organizations_job_templates_create 1 param body → 201
GET
/api/v2/organizations/{id}/notification_templates/
Organizations notification templates list
organizations_notification_templates_list 8 params → 200
POST
/api/v2/organizations/{id}/notification_templates/
Organizations notification templates create
organizations_notification_templates_create 1 param body → 201
GET
/api/v2/organizations/{id}/notification_templates_approvals/
Organizations notification templates approvals list
organizations_notification_templates_approvals_list 8 params → 200
POST
/api/v2/organizations/{id}/notification_templates_approvals/
Organizations notification templates approvals create
organizations_notification_templates_approvals_create 1 param body → 201
GET
/api/v2/organizations/{id}/notification_templates_error/
Organizations notification templates error list
organizations_notification_templates_error_list 8 params → 200
POST
/api/v2/organizations/{id}/notification_templates_error/
Organizations notification templates error create
organizations_notification_templates_error_create 1 param body → 201
GET
/api/v2/organizations/{id}/notification_templates_started/
Organizations notification templates started list
organizations_notification_templates_started_list 8 params → 200
POST
/api/v2/organizations/{id}/notification_templates_started/
Organizations notification templates started create
organizations_notification_templates_started_create 1 param body → 201
GET
/api/v2/organizations/{id}/notification_templates_success/
Organizations notification templates success list
organizations_notification_templates_success_list 8 params → 200
POST
/api/v2/organizations/{id}/notification_templates_success/
Organizations notification templates success create
organizations_notification_templates_success_create 1 param body → 201
GET
/api/v2/organizations/{id}/object_roles/
Organizations object roles list
organizations_object_roles_list 8 params → 200
GET
/api/v2/organizations/{id}/projects/
Organizations projects list
organizations_projects_list 8 params → 200
POST
/api/v2/organizations/{id}/projects/
Organizations projects create
organizations_projects_create 1 param body → 201
GET
/api/v2/organizations/{id}/teams/
Organizations teams list
organizations_teams_list 8 params → 200
POST
/api/v2/organizations/{id}/teams/
Organizations teams create
organizations_teams_create 1 param body → 201
GET
/api/v2/organizations/{id}/users/
Organizations users list
organizations_users_list 8 params → 200
POST
/api/v2/organizations/{id}/users/
Organizations users create
organizations_users_create 1 param body → 201
GET
/api/v2/organizations/{id}/workflow_job_templates/
Organizations workflow job templates list
organizations_workflow_job_templates_list 8 params → 200
POST
/api/v2/organizations/{id}/workflow_job_templates/
Organizations workflow job templates create
organizations_workflow_job_templates_create 1 param body → 201
GET
/organizations/
Organizations list
organizations_list 5 params → 200
GET
/organizations/{id}/teams/
Organizations teams list
getOrganizationsByIdTeams 6 params → 200
GET
/organizations/{id}/
Organizations retrieve
getOrganizationsById 1 param → 200
GET
/api/gateway/v1/organizations/
Organizations list
getApiGatewayV1Organizations 30 params → 200
POST
/api/gateway/v1/organizations/
Organizations create
postApiGatewayV1Organizations body → 201
GET
/api/gateway/v1/organizations/{id}/
Organizations retrieve
getApiGatewayV1OrganizationsById 1 param → 200
PUT
/api/gateway/v1/organizations/{id}/
Organizations update
putApiGatewayV1OrganizationsById 1 param body → 200
PATCH
/api/gateway/v1/organizations/{id}/
Organizations partial update
patchApiGatewayV1OrganizationsById 1 param body → 200
DELETE
/api/gateway/v1/organizations/{id}/
Organizations destroy
deleteApiGatewayV1OrganizationsById 1 param → 204
GET
/api/gateway/v1/organizations/{id}/admins/deprecated
Organizations admins list
getApiGatewayV1OrganizationsByIdAdmins 51 params → 200
POST
/api/gateway/v1/organizations/{id}/admins/associate/deprecated
Organizations admins associate create
organizations_admins_associate_create 1 param body → 200
POST
/api/gateway/v1/organizations/{id}/admins/disassociate/deprecated
Organizations admins disassociate create
organizations_admins_disassociate_create 1 param body → 200
GET
/api/gateway/v1/organizations/{id}/teams/
Organizations teams list
getApiGatewayV1OrganizationsByIdTeams 31 params → 200
GET
/api/gateway/v1/organizations/{id}/users/deprecated
Organizations users list
getApiGatewayV1OrganizationsByIdUsers 51 params → 200
POST
/api/gateway/v1/organizations/{id}/users/associate/deprecated
Organizations users associate create
organizations_users_associate_create 1 param body → 200
POST
/api/gateway/v1/organizations/{id}/users/disassociate/deprecated
Organizations users disassociate create
organizations_users_disassociate_create 1 param body → 200

Schemas 52

The contract defines 52 schemas that model the data the API accepts and returns. The most detailed are JobTemplate (57 properties), JobTemplateRequest (44 properties), Project (33 properties), WorkflowJobTemplate (31 properties). Each schema is shown below with its type and property counts.

PaginatedJobTemplateList
object
4 properties 2 required
JobTemplate
object
Provide recent jobs and survey details in summaryfields
57 properties 1 required
NotificationTemplateRequest
object
6 properties 3 required
InstanceGroupRequest
object
9 properties 1 required
OrganizationRequest
object
5 properties 1 required
ActivityStream
object
13 properties 3 required
PaginatedUserList
object
4 properties 2 required
Role
object
7 properties
PaginatedInventoryList
object
4 properties 2 required
PaginatedProjectList
object
4 properties 2 required
PaginatedInstanceGroupList
object
4 properties 2 required
Project
object
33 properties 1 required
PatchedOrganizationRequest
object
5 properties
CredentialRequest
object
5 properties 2 required
OrganizationCredentialSerializerCreateRequest
object
5 properties 2 required
ExecutionEnvironment
object
14 properties 2 required
Credential
object
16 properties 2 required
PaginatedNotificationTemplateList
object
4 properties 2 required
User
object
15 properties 1 required
UserRequest
object
7 properties 1 required
ExecutionEnvironmentRequest
object
6 properties 2 required
PaginatedActivityStreamList
object
4 properties 2 required
PaginatedCredentialList
object
4 properties 2 required
JobTemplateRequest
object
Provide recent jobs and survey details in summaryfields
44 properties 1 required
PaginatedOrganizationCredentialSerializerCreateList
object
4 properties 2 required
ResourceAccessListElement
object
15 properties 1 required
PaginatedExecutionEnvironmentList
object
4 properties 2 required
PaginatedTeamList
object
4 properties 2 required
PaginatedWorkflowJobTemplateList
object
4 properties 2 required
WorkflowJobTemplate
object
Provide recent jobs and survey details in summaryfields
31 properties 1 required
PaginatedRoleList
object
4 properties 2 required
WorkflowJobTemplateRequest
object
Provide recent jobs and survey details in summaryfields
20 properties 1 required
NotificationTemplate
object
13 properties 3 required
TeamRequest
object
3 properties 2 required
Team
object
10 properties 2 required
Organization
object
13 properties 1 required
Inventory
object
23 properties 2 required
OrganizationCredentialSerializerCreate
object
16 properties 2 required
ProjectRequest
object
18 properties 1 required
PaginatedResourceAccessListElementList
object
4 properties 2 required
InstanceGroup
object
22 properties 1 required
Team_2
object
9 properties 8 required
PaginatedTeamList_2
object
6 properties
PaginatedOrganizationList
object
6 properties
Organization_2
object
8 properties 7 required
UserDisassociate
object
Serializer used for removing objects that are currently associated via a many-to-many relationship
1 property 1 required
UserAssociate
object
Serializer used for adding objects to a many-to-many relationship
1 property 1 required
PatchedOrganization
object
11 properties
Organization_3
object
11 properties 1 required
Team_3
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
User_2
object
Disallows editing of system user and enforces superuser requirement.
21 properties 1 required
PaginatedOrganizationList_2
object
4 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

red-hat-ansible-automation-platform-organizations-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 Organizations 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.