OAuth2Authorizer

OAuth 2.0 권한 부여자에 대한 정의로, authorizer(JWT) 권한 부여자라고도 합니다.

자세한 내용은 API Gateway 개발자 가이드에서 JWT 권한 부여자를 사용하는 HTTP API에 대한 액세스 제어를 참조하십시오.

구문

AWS Serverless Application Model (AWS SAM) 템플릿에서 이 엔티티를 선언하려면 다음 구문을 사용하십시오.

YAML

  AuthorizationScopes: List
  IdentitySource: String
  JwtConfiguration: Map

속성

AuthorizationScopes

이 권한 부여자의 권한 부여 범위 목록.

유형: 목록

필수 항목 여부: 아니요

AWS CloudFormation 호환성: 이 속성은 AWS SAM 고유하며 AWS CloudFormation 이에 상응하는 속성이 없습니다.

IdentitySource

이 권한 부여자의 ID 소스 표현식.

타입: 문자열

필수 항목 여부: 아니요

AWS CloudFormation 호환성: 이 속성은 AWS SAM 고유하며 AWS CloudFormation 이에 상응하는 속성이 없습니다.

JwtConfiguration

이 권한 부여자의 JWT 구성.

이는 OpenAPI 정의의 securitySchemes 섹션에 있는 x-amazon-apigateway-authorizer의 jwtConfiguration 섹션으로 전달됩니다.

참고

속성 issuer 및 audience 은 대소문자를 구분하지 않으며 OpenAPI에서처럼 소문자를 사용하거나 대문자처럼 사용할 수 있습니다. Issuer Audience AWS::ApiGatewayV2::Authorizer

유형: 맵

필수 항목 여부: 아니요

AWS CloudFormation 호환성: 이 속성은 AWS SAM 고유하며 이에 상응하는 속성이 없습니다. AWS CloudFormation

예

OAuth 2.0 권한 부여자

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