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

APIs.io Engineering Platform Oidc API

Endpoints to manage GitHub OIDC configuration using the REST API.

This API exposes 2 operations across 1 path, and defines 3 schemas. It is described by OpenAPI 3.0.0, at version 2015-07-09.

Requests are made against 4 base URLs: http://apigateway.{region}.amazonaws.com, https://apigateway.{region}.amazonaws.com, http://apigateway.{region}.amazonaws.com.cn, https://apigateway.{region}.amazonaws.com.cn.

2 operations 1 paths 3 schemas 1 GET1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
2015-07-09
Base URL
https://{bucketname}.s3.amazonaws.com
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

APIs.io Engineering Platform Oidc API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (hmac). By default, every request must be authenticated.

  • hmac — Amazon Signature authorization v4

Paths & Operations 2

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

Oidc 2

Endpoints to manage GitHub OIDC configuration using the REST API.

GET
/orgs/{org}/actions/oidc/customization/sub
APIs.io Engineering Platform Get the customization template for an OIDC subject claim for an organization
oidc/get-oidc-custom-sub-template-for-org 1 param → 200
PUT
/orgs/{org}/actions/oidc/customization/sub
APIs.io Engineering Platform Set the customization template for an OIDC subject claim for an organization
oidc/update-oidc-custom-sub-template-for-org 1 param body → 201404403

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are basic-error (4 properties), oidc-custom-sub (1 property). Each schema is shown below with its type and property counts.

basic-error
object
Basic Error
4 properties
empty-object
object
An object without any properties.
oidc-custom-sub
object
Actions OIDC Subject customization
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

engineering-platform-oidc-api-openapi.yml Raw ↑