Red Hat Ansible Automation Platform

Red Hat Ansible Automation Platform Auth API

The auth API from Red Hat Ansible Automation Platform — 3 operation(s) for auth.

GitHub OpenAPI

Operations 4

GET /auth/session/login/ Auth session preflight #
POST /auth/session/login/ Auth session login #
POST /auth/session/logout/ Auth session logout #
POST /auth/token/refresh/ Token refresh #

Documentation

📖
Documentation
https://access.redhat.com/documentation/en-us/red_hat_ansible_automation_platform/
📖
APIReference
https://docs.ansible.com/automation-controller/latest/html/controllerapi/api_ref.html
📖
Authentication
https://docs.ansible.com/automation-controller/latest/html/controllerapi/authentication.html
📖
Documentation
https://access.redhat.com/documentation/en-us/red_hat_ansible_automation_platform/2.4/html/managing_red_hat_certified_and_ansible_galaxy_collections_in_automation_hub/
📖
Documentation
https://access.redhat.com/documentation/en-us/red_hat_ansible_automation_platform/2.4/html/event-driven_ansible_controller_user_guide/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/red-hat-ansible-automation-platform/refs/heads/main/openapi/red-hat-ansible-automation-platform-auth-api-openapi.yml

Other Resources

🔗
Console
https://console.redhat.com/ansible/ansible-dashboard

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/red-hat-ansible-automation-platform-auth-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

red-hat-ansible-automation-platform-auth-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Event Driven Ansible Auth API
  version: 0.2.0
servers:
- url: /api/eda/v1
tags:
- name: Auth
paths:
  /auth/session/login/:
    get:
      operationId: auth_session_preflight
      description: Use this method to set a CSRF cookie.
      tags:
      - Auth
      security:
      - EDAJWTAuthentication: []
      responses:
        '204':
          description: OK
      summary: Auth session preflight
      x-summary-source: derived
    post:
      operationId: auth_session_login
      description: Session cookie login
      tags:
      - Auth
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Login'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/Login'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/Login'
        required: true
      security:
      - EDAJWTAuthentication: []
      responses:
        '403':
          description: Invalid credentials or user is disabled.
        '204':
          description: Login successful.
      summary: Auth session login
      x-summary-source: derived
  /auth/session/logout/:
    post:
      operationId: auth_session_logout
      description: Session logout.
      tags:
      - Auth
      security:
      - cookieAuth: []
      responses:
        '204':
          description: Logout successful.
      summary: Auth session logout
      x-summary-source: derived
  /auth/token/refresh/:
    post:
      operationId: token_refresh
      description: Refresh websocket access token
      tags:
      - Auth
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RefreshToken'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/RefreshToken'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/RefreshToken'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JWTToken'
          description: ''
      summary: Token refresh
      x-summary-source: derived
components:
  schemas:
    RefreshToken:
      type: object
      properties:
        refresh:
          type: string
      required:
      - refresh
    Login:
      type: object
      properties:
        username:
          type: string
        password:
          type: string
      required:
      - password
      - username
    JWTToken:
      type: object
      properties:
        access:
          type: string
      required:
      - access
  securitySchemes:
    EDAJWTAuthentication:
      type: apiKey
      name: X-DAB-JW-TOKEN
      in: header
    cookieAuth:
      type: apiKey
      in: cookie
      name: sessionid