x-amazon-apigateway-authtype properti

Untuk RESTAPIs, ekstensi ini dapat digunakan untuk menentukan jenis kustom dari otorisasi Lambda. Dalam hal ini, nilainya adalah bentuk bebas. Misalnya, API mungkin memiliki beberapa otorisasi Lambda yang menggunakan skema internal yang berbeda. Anda dapat menggunakan ekstensi ini untuk mengidentifikasi skema internal otorisasi Lambda.

Lebih umum, di HTTP APIs dan RESTAPIs, itu juga dapat digunakan sebagai cara untuk menentukan IAM otorisasi di beberapa operasi yang berbagi skema keamanan yang sama. Dalam hal ini, istilah tersebut awsSigv4 adalah istilah yang dicadangkan, bersama dengan istilah apa pun yang diawali olehaws.

Ekstensi ini berlaku untuk skema keamanan apiKey tipe di Open API 2 dan Open API 3.

x-amazon-apigateway-authtype contoh

Contoh Open API 3 berikut mendefinisikan IAM otorisasi di beberapa sumber daya dalam atau RESTAPI: HTTP API

{
  "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"
      }
    }
  }
}

Contoh Open API 3 berikut mendefinisikan authorizer Lambda dengan skema kustom untuk: 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"
}

Lihat juga

otorisasi. authType