openapi: 3.1.0
info:
  title: Amazon API Gateway Management ApiKeys Authorizers API
  description: The API Gateway Management API allows backend services to send messages to connected clients of a deployed WebSocket API and to disconnect clients. Requests are made against the deployed stage's callback URL.
  version: '2018-11-29'
  contact:
    name: AWS Support
    url: https://aws.amazon.com/premiumsupport/
  termsOfService: https://aws.amazon.com/service-terms/
servers:
- url: https://{api_id}.execute-api.{region}.amazonaws.com/{stage}
  description: WebSocket API callback endpoint
  variables:
    api_id:
      default: example
      description: WebSocket API identifier
    region:
      default: us-east-1
      description: AWS region
    stage:
      default: prod
      description: Deployment stage name
security:
- sigv4: []
tags:
- name: Authorizers
  description: Manage authorizers
paths:
  /v2/apis/{api_id}/authorizers:
    parameters:
    - $ref: '#/components/parameters/ApiId'
    get:
      operationId: getAuthorizers
      summary: Amazon API Gateway List Authorizers
      description: Gets a collection of authorizers for an API.
      tags:
      - Authorizers
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Authorizers'
              examples:
                getAuthorizers200Example:
                  summary: Default getAuthorizers 200 response
                  x-microcks-default: true
                  value:
                    Items:
                    - example-value
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    post:
      operationId: createAuthorizer
      summary: Amazon API Gateway Create an Authorizer
      description: Creates an authorizer for an API.
      tags:
      - Authorizers
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateAuthorizerRequest'
            examples:
              createAuthorizerRequestExample:
                summary: Default createAuthorizer request
                x-microcks-default: true
                value:
                  Name: my-resource
                  AuthorizerType: REQUEST
                  IdentitySource:
                  - example-value
                  AuthorizerUri: https://example.com/resource/123
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Authorizer'
              examples:
                createAuthorizer201Example:
                  summary: Default createAuthorizer 201 response
                  x-microcks-default: true
                  value:
                    AuthorizerId: abc123
                    Name: my-resource
                    AuthorizerType: example-value
                    IdentitySource:
                    - example-value
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    CreateAuthorizerRequest:
      type: object
      required:
      - Name
      - AuthorizerType
      - IdentitySource
      properties:
        Name:
          type: string
          description: Name of the authorizer.
          example: my-resource
        AuthorizerType:
          type: string
          description: Type of authorizer.
          enum:
          - REQUEST
          - JWT
          example: REQUEST
        IdentitySource:
          type: array
          description: Identity sources to use.
          items:
            type: string
          example:
          - example-value
        AuthorizerUri:
          type: string
          description: URI of the Lambda authorizer (REQUEST type).
          example: https://example.com/resource/123
    Authorizer:
      type: object
      properties:
        AuthorizerId:
          type: string
          description: Authorizer identifier.
          example: abc123
        Name:
          type: string
          description: Authorizer name.
          example: my-resource
        AuthorizerType:
          type: string
          description: Type of authorizer (REQUEST or JWT).
          example: example-value
        IdentitySource:
          type: array
          description: Identity sources for the authorizer.
          items:
            type: string
          example:
          - example-value
    Authorizers:
      type: object
      properties:
        Items:
          type: array
          items:
            $ref: '#/components/schemas/Authorizer'
          example:
          - example-value
  parameters:
    ApiId:
      name: api_id
      in: path
      required: true
      description: API identifier.
      schema:
        type: string
  securitySchemes:
    sigv4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4 signed request.
externalDocs:
  description: Amazon API Gateway Management API Reference
  url: https://docs.aws.amazon.com/apigatewaymanagementapi/latest/reference/Welcome.html