x-amazon-apigateway-authtype Eigentum

Denn diese Erweiterung kann verwendet werden RESTAPIs, um einen benutzerdefinierten Typ eines Lambda-Autorisierers zu definieren. In diesem Fall liegt der Wert in Freiform vor. Beispielsweise API kann ein mehrere Lambda-Autorisierer haben, die unterschiedliche interne Schemata verwenden. Sie können diese Erweiterung verwenden, um das interne Schema eines Lambda-Genehmigers zu identifizieren.

Häufiger kann es in HTTP APIs und auch verwendet werden RESTAPIs, um die IAM Autorisierung für mehrere Operationen zu definieren, die dasselbe Sicherheitsschema verwenden. In diesem Fall ist der Begriff awsSigv4 ein reservierter Begriff, zusammen mit jedem Begriff, dem ein Präfix aws vorangestellt ist.

Diese Erweiterung gilt für das apiKey Typsicherheitsschema in Open API 2 und Open API 3.

x-amazon-apigateway-authtype Beispiel

Das folgende Open API 3-Beispiel definiert die IAM Autorisierung für mehrere Ressourcen in einem REST API oder HTTPAPI:

{
  "openapi" : "3.0.1",
  "info" : {
    "title" : "openapi3",
    "version" : "1.0"
  },
  "paths" : {
    "/operation1" : {
      "get" : {
        "responses" : {
          "default" : {
            "description" : "Default response"
          }
        },
        "security" : [ {
          "sigv4Reference" : [ ]
        } ]
      }
    },
    "/operation2" : {
      "get" : {
        "responses" : {
          "default" : {
            "description" : "Default response"
          }
        },
        "security" : [ {
          "sigv4Reference" : [ ]
        } ]
      }
    }
  },
  "components" : {
    "securitySchemes" : {
      "sigv4Reference" : {
        "type" : "apiKey",
        "name" : "Authorization",
        "in" : "header",
        "x-amazon-apigateway-authtype": "awsSigv4"
      }
    }
  }
}

Das folgende Open API 3-Beispiel definiert einen Lambda-Authorizer mit einem benutzerdefinierten Schema für: REST API

{
  "openapi" : "3.0.1",
  "info" : {
    "title" : "openapi3 for REST API",
    "version" : "1.0"
  },
  "paths" : {
    "/protected-by-lambda-authorizer" : {
      "get" : {
        "responses" : {
          "200" : {
            "description" : "Default response"
          }
        },
        "security" : [ {
          "myAuthorizer" : [ ]
        } ]
      }
    }
  },
  "components" : {
    "securitySchemes" : {
      "myAuthorizer" : {
        "type" : "apiKey",
        "name" : "Authorization",
        "in" : "header",
        "x-amazon-apigateway-authorizer" : {
          "identitySource" : "method.request.header.Authorization",
          "authorizerUri" : "arn:aws:apigateway:us-east-1:lambda:path/2015-03-31/functions/arn:aws:lambda:us-east-1:account-id:function:function-name/invocations",
          "authorizerResultTtlInSeconds" : 300,
          "type" : "request",
          "enableSimpleResponses" : false
        },
        "x-amazon-apigateway-authtype": "Custom scheme with corporate claims"
      }
    }
  },
  "x-amazon-apigateway-importexport-version" : "1.0"
}

Weitere Informationen finden Sie auch unter

Autorisierer. authType