openapi: 3.0.0
info:
version: 2015-07-09
x-release: v4
title: APIs.io Engineering Platform Amazon API Gateway 2014 11 13 Oidc API
description:
Amazon API Gateway helps developers deliver robust, secure, and scalable mobile and web application back ends. API Gateway allows developers to securely connect mobile and web applications to APIs that run on AWS Lambda, Amazon EC2, or other publicly addressable web services that are hosted outside of AWS.
x-logo: url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png backgroundColor: '#FFFFFF' termsOfService: https://aws.amazon.com/service-terms/ contact: name: Mike Ralphson email: mike.ralphson@gmail.com url: https://github.com/mermade/aws2openapi x-twitter: PermittedSoc license: name: Apache 2.0 License url: http://www.apache.org/licenses/ x-providerName: amazonaws.com x-serviceName: apigateway x-origin: - contentType: application/json url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/apigateway-2015-07-09.normal.json converter: url: https://github.com/mermade/aws2openapi version: 1.0.0 x-apisguru-driver: external x-apiClientRegistration: url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct x-apisguru-categories: - cloud x-preferred: true servers: - url: http://apigateway.{region}.amazonaws.com variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The Amazon API Gateway multi-region endpoint - url: https://apigateway.{region}.amazonaws.com variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The Amazon API Gateway multi-region endpoint - url: http://apigateway.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The Amazon API Gateway endpoint for China (Beijing) and China (Ningxia) - url: https://apigateway.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The Amazon API Gateway endpoint for China (Beijing) and China (Ningxia) security: - hmac: [] tags: - name: Oidc description: Endpoints to manage GitHub OIDC configuration using the REST API. paths: /orgs/{org}/actions/oidc/customization/sub: get: summary: APIs.io Engineering Platform Get the customization template for an OIDC subject claim for an organization description: 'Gets the customization template for an OpenID Connect (OIDC) subject claim. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.' tags: - Oidc operationId: oidc/get-oidc-custom-sub-template-for-org externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/actions/oidc#get-the-customization-template-for-an-oidc-subject-claim-for-an-organization parameters: - $ref: '#/components/parameters/org' responses: '200': description: A JSON serialized template for OIDC subject claim customization content: application/json: schema: $ref: '#/components/schemas/oidc-custom-sub' examples: default: $ref: '#/components/examples/oidc-custom-sub' x-github: enabledForGitHubApps: true category: actions subcategory: oidc put: summary: APIs.io Engineering Platform Set the customization template for an OIDC subject claim for an organization description: 'Creates or updates the customization template for an OpenID Connect (OIDC) subject claim. OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.' tags: - Oidc operationId: oidc/update-oidc-custom-sub-template-for-org externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-an-organization parameters: - $ref: '#/components/parameters/org' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/oidc-custom-sub' examples: default: $ref: '#/components/examples/oidc-custom-sub' responses: '201': description: Empty response content: application/json: schema: $ref: '#/components/schemas/empty-object' examples: default: value: null '404': $ref: '#/components/responses/not_found' '403': $ref: '#/components/responses/forbidden' x-github: enabledForGitHubApps: true previews: [] category: actions subcategory: oidc components: responses: forbidden: description: Forbidden content: application/json: schema: $ref: '#/components/schemas/basic-error' not_found: description: Resource not found content: application/json: schema: $ref: '#/components/schemas/basic-error' schemas: basic-error: title: Basic Error description: Basic Error type: object properties: message: type: string documentation_url: type: string url: type: string status: type: string empty-object: title: Empty Object description: An object without any properties. type: object properties: {} additionalProperties: false oidc-custom-sub: title: Actions OIDC Subject customization description: Actions OIDC Subject customization type: object properties: include_claim_keys: description: Array of unique strings. Each claim key can only contain alphanumeric characters and underscores. type: array items: type: string required: - include_claim_keys examples: oidc-custom-sub: value: include_claim_keys: - repo - context parameters: org: name: org description: The organization name. The name is not case sensitive. in: path required: true schema: type: string securitySchemes: hmac: type: apiKey name: Authorization in: header description: Amazon Signature authorization v4 x-amazon-apigateway-authtype: awsSigv4 externalDocs: description: Amazon Web Services documentation url: https://docs.aws.amazon.com/apigateway/ x-hasEquivalentPaths: true