Red Hat Satellite Organizations API

openapi: 3.1.0
info:
  title: Red Hat Satellite REST Content Views Organizations API
  description: The Red Hat Satellite REST API provides programmatic access to Red Hat Satellite server functionality including host management, content view management, subscription management, lifecycle environments, and provisioning. The API is built on the Foreman and Katello upstream projects and follows RESTful conventions with JSON request and response bodies.
  version: 6.18.0
  contact:
    name: Red Hat Support
    url: https://access.redhat.com/support
  license:
    name: GPL-3.0
    url: https://www.gnu.org/licenses/gpl-3.0.html
  x-logo:
    url: https://www.redhat.com/profiles/rh/themes/redhatdotcom/img/logo.png
servers:
- url: https://satellite.example.com
  description: Red Hat Satellite Server
security:
- basicAuth: []
- oAuth2: []
tags:
- name: Organizations
  description: Manage organizations which provide multi-tenancy isolation for hosts, content, and subscriptions.
  externalDocs:
    url: https://apidocs.theforeman.org/foreman/latest/apidoc/v2/organizations.html
paths:
  /api/v2/organizations:
    get:
      operationId: listOrganizations
      summary: List Organizations
      description: Retrieve a list of all organizations. Organizations provide multi-tenancy isolation for content, hosts, and subscriptions.
      tags:
      - Organizations
      parameters:
      - $ref: '#/components/parameters/searchQuery'
      - $ref: '#/components/parameters/orderQuery'
      - $ref: '#/components/parameters/pageQuery'
      - $ref: '#/components/parameters/perPageQuery'
      responses:
        '200':
          description: Successful response containing a list of organizations.
          content:
            application/json:
              schema:
                type: object
                properties:
                  total:
                    type: integer
                  subtotal:
                    type: integer
                  page:
                    type: integer
                  per_page:
                    type: integer
                  results:
                    type: array
                    items:
                      $ref: '#/components/schemas/Organization'
              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
                      title: Example Title
                      description: A sample description.
                      created_at: '2026-01-15T10:30:00Z'
                      updated_at: '2026-01-15T10:30:00Z'
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /api/v2/organizations/{id}:
    get:
      operationId: showOrganization
      summary: Show an Organization
      description: Retrieve details for a specific organization.
      tags:
      - Organizations
      parameters:
      - name: id
        in: path
        required: true
        description: Organization identifier.
        schema:
          type: integer
        example: abc123
      responses:
        '200':
          description: Successful response containing organization details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Organization'
              examples:
                Showorganization200Example:
                  summary: Default showOrganization 200 response
                  x-microcks-default: true
                  value:
                    id: abc123
                    name: Example Title
                    label: Example Title
                    title: Example Title
                    description: A sample description.
                    created_at: '2026-01-15T10:30:00Z'
                    updated_at: '2026-01-15T10:30:00Z'
        '404':
          $ref: '#/components/responses/NotFound'
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  parameters:
    pageQuery:
      name: page
      in: query
      description: Page number for paginated results (starting at 1).
      schema:
        type: integer
        minimum: 1
        default: 1
    perPageQuery:
      name: per_page
      in: query
      description: Number of results per page. Use "all" to retrieve all results without pagination.
      schema:
        oneOf:
        - type: integer
          minimum: 1
        - type: string
          enum:
          - all
        default: 20
    searchQuery:
      name: search
      in: query
      description: Scoped search query string to filter results. Supports field-based search syntax (e.g., "name ~ web*").
      schema:
        type: string
    orderQuery:
      name: order
      in: query
      description: Sort field and direction (e.g., "name ASC" or "id DESC").
      schema:
        type: string
  schemas:
    Organization:
      type: object
      description: An organization providing multi-tenancy isolation for content, hosts, and subscriptions.
      properties:
        id:
          type: integer
          description: Unique identifier for the organization.
          example: abc123
        name:
          type: string
          description: Organization name.
          example: Example Title
        label:
          type: string
          description: Unique label for the organization.
          example: Example Title
        title:
          type: string
          description: Organization title.
          example: Example Title
        description:
          type:
          - string
          - 'null'
          description: Organization description.
          example: A sample description.
        created_at:
          type: string
          format: date-time
          example: '2026-01-15T10:30:00Z'
        updated_at:
          type: string
          format: date-time
          example: '2026-01-15T10:30:00Z'
  responses:
    NotFound:
      description: The requested resource was not found.
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: object
                properties:
                  message:
                    type: string
                    example: Resource not found.
    Unauthorized:
      description: Authentication credentials are missing or invalid.
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: object
                properties:
                  message:
                    type: string
                    example: Unable to authenticate user.
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: HTTP Basic authentication using Satellite username and password.
    oAuth2:
      type: oauth2
      description: OAuth 2.0 Personal Access Token authentication for Satellite users.
      flows:
        implicit:
          authorizationUrl: https://satellite.example.com/users/extlogin
          scopes: {}
externalDocs:
  description: Red Hat Satellite API Documentation
  url: https://docs.redhat.com/en/documentation/red_hat_satellite/6.18/html/using_the_satellite_rest_api/index