Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Red Hat Satellite Organizations API

Manage organizations which provide multi-tenancy isolation for hosts, content, and subscriptions.

Red Hat Satellite Organizations API is one of 9 APIs that Red Hat Satellite publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 24 JSON Schema definitions.

Tagged areas include Organizations. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, authentication docs, a getting-started guide, an API reference, and 24 JSON Schemas.

This API exposes 2 operations across 2 paths, and defines 1 schema. It is described by OpenAPI 3.1.0, at version 6.18.0.

Requests are made against a single base URL, https://satellite.example.com.

2 operations 2 paths 1 schemas 2 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
6.18.0
Base URL
https://satellite.example.com/api/v2
Authentication
HTTP Basic, OAuth 2.0
License
Resource Areas
1

Authentication & Security 2

Red Hat Satellite Organizations API declares 2 security schemes for authenticating requests. It accepts HTTP basic authentication (basicAuth). It supports OAuth 2.0 (oAuth2) using the implicit flow. By default, every request must be authenticated.

  • basicAuth — HTTP Basic authentication using Satellite username and password.
  • oAuth2 — OAuth 2.0 Personal Access Token authentication for Satellite users.

Paths & Operations 2

Across 2 paths, the API surfaces 2 operations — 2 GET. Each is listed below with its method, path, parameters, and response codes.

Organizations 2

Manage organizations which provide multi-tenancy isolation for hosts, content, and subscriptions.

GET
/api/v2/organizations
List Organizations
listOrganizations 4 params → 200401
GET
/api/v2/organizations/{id}
Show an Organization
showOrganization 1 param → 200404401

Schemas 1

The contract defines 1 schema that model the data the API accepts and returns. The most detailed is Organization (7 properties). Each schema is shown below with its type and property counts.

Organization
object
An organization providing multi-tenancy isolation for content, hosts, and subscriptions.
7 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

red-hat-satellite-organizations-api-openapi.yml Raw ↑

Other APIs Red Hat Satellite publishes across the network.

Red Hat Satellite Hammer CLI
Red Hat Satellite Foreman API
Red Hat Satellite Katello API
Red Hat Satellite Ansible Collection
Red Hat Satellite Content Views API
Red Hat Satellite Hosts API
Red Hat Satellite Lifecycle Environments API
Red Hat Satellite Subscriptions API