OAuth2Authorizer

Définition d'un mécanisme d'autorisation OAuth 2.0, également connu sous le nom de mécanisme d'autorisation JWT (JSON Web Token).

Pour plus d'informations, consultez Contrôle de l'accès aux API HTTP avec les mécanismes d'autorisation JWT dans le Guide du développeur API Gateway.

Syntaxe

Pour déclarer cette entité dans votre modèle AWS Serverless Application Model (AWS SAM), utilisez la syntaxe suivante.

YAML

  AuthorizationScopes: List
  IdentitySource: String
  JwtConfiguration: Map

Propriétés

AuthorizationScopes

Liste des étendues d'autorisation pour cet autorisateur.

Type : liste

Obligatoire : non

AWS CloudFormation compatibilité : cette propriété est unique AWS SAM et n'a pas d' AWS CloudFormation équivalent.

IdentitySource

Expression de source d'identité pour ce mécanisme d'autorisation.

Type : chaîne

Obligatoire : non

AWS CloudFormation compatibilité : cette propriété est unique AWS SAM et n'a pas d' AWS CloudFormation équivalent.

JwtConfiguration

Configuration JWT pour ce mécanisme d'autorisation.

Cela est transmis à la section jwtConfiguration d'un x-amazon-apigateway-authorizer dans la section securitySchemes d'une définition OpenAPI.

Note

Les propriétés audience sont insensibles aux majuscules issuer et minuscules et peuvent être utilisées soit en minuscules comme dans OpenAPI, soit en majuscules et comme dans. Issuer Audience AWS::ApiGatewayV2::Authorizer

Type: carte (map)

Obligatoire : non

AWS CloudFormation compatibilité : cette propriété est unique AWS SAM et n'a pas d' AWS CloudFormation équivalent.

Exemples

Mécanisme d'autorisation OAuth 2.0

Exemple de mécanisme d'autorisation 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