Ansible Playbooks Organizations API

openapi: 3.1.0
info:
  title: Ansible Automation Controller Playbooks Auth Organizations API
  version: '2'
  description: 'REST API for managing and executing Ansible playbooks via the Ansible

    Automation Controller (formerly Ansible Tower / AWX), the enterprise

    automation engine inside the Red Hat Ansible Automation Platform.

    Playbooks live inside projects (SCM-synced from Git, etc.) and are run

    via job templates that bind them to inventories, credentials, and

    extra variables. The API exposes management of inventories, hosts,

    credentials, projects, job templates, workflow job templates,

    schedules, organizations, teams, users, and the launching and

    inspection of jobs.

    '
  contact:
    name: Red Hat Ansible Support
    url: https://access.redhat.com/products/red-hat-ansible-automation-platform/
servers:
- url: https://{controller_host}/api/v2
  description: Self-hosted Ansible Automation Controller deployment
  variables:
    controller_host:
      default: controller.example.com
      description: Hostname of the Automation Controller instance.
security:
- OAuth2Token: []
- BasicAuth: []
tags:
- name: Organizations
paths:
  /organizations/:
    get:
      tags:
      - Organizations
      summary: List organizations
      operationId: listOrganizations
      parameters:
      - $ref: '#/components/parameters/Page'
      - $ref: '#/components/parameters/PageSize'
      - $ref: '#/components/parameters/Search'
      responses:
        '200':
          $ref: '#/components/responses/ListResponse'
    post:
      tags:
      - Organizations
      summary: Create an organization
      operationId: createOrganization
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Organization'
      responses:
        '201':
          description: Created.
  /organizations/{id}/:
    get:
      tags:
      - Organizations
      summary: Retrieve an organization
      operationId: getOrganization
      parameters:
      - $ref: '#/components/parameters/Id'
      responses:
        '200':
          description: An organization.
    patch:
      tags:
      - Organizations
      summary: Partially update an organization
      operationId: patchOrganization
      parameters:
      - $ref: '#/components/parameters/Id'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Organization'
      responses:
        '200':
          description: Updated.
    delete:
      tags:
      - Organizations
      summary: Delete an organization
      operationId: deleteOrganization
      parameters:
      - $ref: '#/components/parameters/Id'
      responses:
        '204':
          description: Deleted.
components:
  schemas:
    Organization:
      type: object
      required:
      - name
      properties:
        name:
          type: string
        description:
          type: string
        max_hosts:
          type: integer
    ListResponse:
      type: object
      properties:
        count:
          type: integer
        next:
          type: string
          nullable: true
        previous:
          type: string
          nullable: true
        results:
          type: array
          items:
            type: object
            additionalProperties: true
  parameters:
    Page:
      name: page
      in: query
      schema:
        type: integer
        minimum: 1
        default: 1
    PageSize:
      name: page_size
      in: query
      schema:
        type: integer
        minimum: 1
        maximum: 200
        default: 25
    Search:
      name: search
      in: query
      schema:
        type: string
    Id:
      name: id
      in: path
      required: true
      schema:
        type: integer
  responses:
    ListResponse:
      description: A paginated list response.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ListResponse'
  securitySchemes:
    OAuth2Token:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Personal or application OAuth2 access token.
    BasicAuth:
      type: http
      scheme: basic
      description: HTTP Basic authentication using local controller credentials.