Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.

properti x-amazon-apigateway-authtype

Untuk REST API, ekstensi ini dapat digunakan untuk menentukan jenis kustom dari otorizer 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 dari otorizer Lambda.

Lebih umum, di API HTTP dan REST API, ini juga dapat digunakan sebagai cara untuk menentukan otorisasi IAM 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 OpenAPI 2 dan OpenAPI 3.

contoh x-amazon-apigateway-authtype

Contoh OpenAPI 3 berikut mendefinisikan otorisasi IAM di beberapa sumber daya dalam REST API atau 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 OpenAPI 3 berikut mendefinisikan otorizer 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

Authorizer.AuthType