OAuth2Authorizer

Ketentuan untuk otorisasi OAuth 2.0, juga dikenal sebagai otorisasi JSON Web Token (JWT).

Untuk informasi selengkapnya, lihat Mengendalikan akses ke API HTTP dengan otorisasi JWT di Panduan Developer API Gateway.

Sintaks

Untuk mendeklarasikan entitas ini dalam template AWS Serverless Application Model (AWS SAM) Anda, gunakan sintaks berikut.

YAML

  AuthorizationScopes: List
  IdentitySource: String
  JwtConfiguration: Map

Properti

AuthorizationScopes

Daftar cakupan otorisasi untuk pemberi kuasa ini.

Tipe: Daftar

Wajib: Tidak

AWS CloudFormation kompatibilitas: Properti ini unik AWS SAM dan tidak memiliki AWS CloudFormation padanan.

IdentitySource

Ekspresi sumber identitas untuk otorisasi ini.

Tipe: String

Wajib: Tidak

AWS CloudFormation kompatibilitas: Properti ini unik AWS SAM dan tidak memiliki AWS CloudFormation padanan.

JwtConfiguration

Konfigurasi JWT untuk otorisasi ini.

Ini diteruskan ke bagian jwtConfiguration dari x-amazon-apigateway-authorizer di bagian securitySchemes dari ketentuan OpenAPI.

catatan

Properti issuer dan audience tidak peka huruf besar/kecil dan dapat digunakan baik huruf kecil seperti di OpenAPI atau huruf besar dan seperti dalam. Issuer Audience AWS::ApiGatewayV2::Authorizer

Tipe: Peta

Wajib: Tidak

AWS CloudFormation kompatibilitas: Properti ini unik AWS SAM dan tidak memiliki AWS CloudFormation padanan.

Contoh

Otorisasi OAuth 2.0

Contoh otorisasi OAuth 2.0

YAML

Auth:
  Authorizers:
    OAuth2Authorizer:
      AuthorizationScopes:
        - scope1
      JwtConfiguration:
        issuer: "https://www.example.com/v1/connect/oauth2"
        audience:
          - MyApi
      IdentitySource: "$request.querystring.param"
  DefaultAuthorizer: OAuth2Authorizer