Red Hat Organizations API

openapi: 3.2.0
info:
  title: Red Hat Organizations API
  contact:
    name: Red Hat Support
    url: https://access.redhat.com/support
  termsOfService: https://www.redhat.com/en/about/terms-use
  version: '1.0'
  description: 'Operations tagged Organizations across 3 of this provider''s published API definitions: red-hat-ansible-automation-platform-openapi.yml, red-hat-quay-openapi.yml, red-hat-satellite-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://ansible-platform.example.com
  description: Ansible Automation Platform Server
- url: https://quay.io/api/v1
  description: Quay.io Production API Server
- url: https://satellite.example.com
  description: Red Hat Satellite Server
tags:
- name: Organizations
  description: Operations for managing organizations that provide multi-tenancy and access control boundaries.
paths:
  /api/v2/organizations/:
    get:
      operationId: listOrganizations
      summary: Red Hat List Organizations
      description: Retrieves a paginated list of organizations that provide multi-tenancy boundaries for access control and resource management.
      tags:
      - Organizations
      parameters:
      - $ref: '#/components/parameters/PageParam'
      - $ref: '#/components/parameters/PageSizeParam'
      - $ref: '#/components/parameters/SearchParam'
      responses:
        '200':
          description: Successfully retrieved organizations
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedList'
              examples:
                Listorganizations200Example:
                  summary: Default listOrganizations 200 response
                  x-microcks-default: true
                  value:
                    count: 10
                    next: https://www.example.com
                    previous: https://www.example.com
                    results:
                    - {}
        '401':
          $ref: '#/components/responses/UnauthorizedError'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      security:
      - bearerAuth: []
    servers:
    - url: https://ansible-platform.example.com
      description: Ansible Automation Platform Server
  /organization/{orgname}:
    get:
      operationId: getOrganization
      summary: Red Hat Get an Organization
      description: Retrieves the details of a specific organization, including its member count and settings.
      tags:
      - Organizations
      parameters:
      - $ref: '#/components/parameters/OrgNameParam'
      responses:
        '200':
          description: Successfully retrieved organization details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Organization'
              examples:
                Getorganization200Example:
                  summary: Default getOrganization 200 response
                  x-microcks-default: true
                  value:
                    name: Example Title
                    email: user@example.com
                    invoice_email: user@example.com
                    is_admin: true
                    is_member: true
        '401':
          $ref: '#/components/responses/UnauthorizedError_2'
        '404':
          $ref: '#/components/responses/NotFoundError'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      security:
      - bearerAuth: []
    servers:
    - url: https://quay.io/api/v1
      description: Quay.io Production API Server
  /api/v2/organizations:
    get:
      operationId: listOrganizations
      summary: Red Hat List Organizations
      description: Retrieves the list of organizations in Satellite that provide multi-tenancy isolation.
      tags:
      - Organizations
      parameters:
      - $ref: '#/components/parameters/PageParam'
      - $ref: '#/components/parameters/PerPageParam'
      - $ref: '#/components/parameters/SearchParam_2'
      responses:
        '200':
          description: Successfully retrieved organizations
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedOrganizationList'
              examples:
                Listorganizations200Example:
                  summary: Default listOrganizations 200 response
                  x-microcks-default: true
                  value:
                    total: 10
                    subtotal: 10
                    page: 10
                    per_page: 10
                    results:
                    - id: abc123
                      name: Example Title
                      label: Example Title
                      description: A sample description.
        '401':
          $ref: '#/components/responses/UnauthorizedError_3'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      security:
      - basicAuth: []
    servers:
    - url: https://satellite.example.com
      description: Red Hat Satellite Server
components:
  parameters:
    SearchParam:
      name: search
      in: query
      description: A search term to filter results by name or description.
      schema:
        type: string
    PageParam:
      name: page
      in: query
      description: The page number for paginated results.
      schema:
        type: integer
        minimum: 1
        default: 1
    PageSizeParam:
      name: page_size
      in: query
      description: The number of results to return per page.
      schema:
        type: integer
        minimum: 1
        maximum: 200
        default: 25
    OrgNameParam:
      name: orgname
      in: path
      required: true
      description: The name of the organization.
      schema:
        type: string
    SearchParam_2:
      name: search
      in: query
      description: A scoped search filter expression.
      schema:
        type: string
    PerPageParam:
      name: per_page
      in: query
      description: The number of results per page.
      schema:
        type: integer
        minimum: 1
        maximum: 1000
        default: 20
  schemas:
    Error:
      type: object
      description: An error response from the API.
      properties:
        detail:
          type: string
          description: A human-readable description of the error.
          example: example_value
    PaginatedList:
      type: object
      description: A generic paginated list response.
      properties:
        count:
          type: integer
          example: 10
        next:
          type: string
          format: uri
          nullable: true
          example: https://www.example.com
        previous:
          type: string
          format: uri
          nullable: true
          example: https://www.example.com
        results:
          type: array
          items:
            type: object
          example: []
    Organization:
      type: object
      description: A Quay organization.
      properties:
        name:
          type: string
          description: The name of the organization.
          example: Example Title
        email:
          type: string
          format: email
          description: The organization contact email.
          example: user@example.com
        invoice_email:
          type: boolean
          description: Whether invoices are sent to the organization email.
          example: user@example.com
        is_admin:
          type: boolean
          description: Whether the current user is an admin of this organization.
          example: true
        is_member:
          type: boolean
          description: Whether the current user is a member of this organization.
          example: true
    PaginatedOrganizationList:
      type: object
      properties:
        total:
          type: integer
          example: 10
        subtotal:
          type: integer
          example: 10
        page:
          type: integer
          example: 10
        per_page:
          type: integer
          example: 10
        results:
          type: array
          items:
            type: object
            properties:
              id:
                type: integer
              name:
                type: string
              label:
                type: string
              description:
                type: string
          example: []
  responses:
    UnauthorizedError:
      description: Authentication credentials are missing or invalid.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    NotFoundError:
      description: The requested resource was not found.
    UnauthorizedError_2:
      description: Authentication credentials are missing or invalid.
    UnauthorizedError_3:
      description: Authentication credentials are missing or invalid.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: OAuth 2.0 Bearer token for authenticating API requests to the automation controller.
    basicAuth:
      type: http
      scheme: basic
      description: HTTP Basic Authentication using a valid Satellite username and password. Alternatively, a personal access token can be used.
x-refined-from:
- red-hat-ansible-automation-platform-openapi.yml
- red-hat-quay-openapi.yml
- red-hat-satellite-openapi.yml