OAuth2Authorizer

Definizione di un autorizzatore OAuth 2.0, anche noto come autorizzatore Web token JSON (JWT).

Per ulteriori informazioni consulta la sezione Controlling access to HTTP APIs with JWT authorizers (Controllo dell'accesso alle API HTTP con le autorizzazioni JWT) nella Guida per gli sviluppatori dell’API Gateway.

Sintassi

Per dichiarare questa entità nel modelloAWS Serverless Application Model (AWS SAM), utilizzare la sintassi seguente.

YAML

  AuthorizationScopes: List
  IdentitySource: String
  JwtConfiguration: Map

Proprietà

AuthorizationScopes

Elenco degli ambiti di autorizzazione per questo autorizzatore.

Type: Elenco

Richiesto: No

AWS CloudFormationcompatibilità: Questa proprietà è unicaAWS SAM e non ha unAWS CloudFormation equivalente.

IdentitySource

Espressione di origine dell'identità per questo autorizzatore.

Type: Stringa

Richiesto: No

AWS CloudFormationcompatibilità: Questa proprietà è unicaAWS SAM e non ha unAWS CloudFormation equivalente.

JwtConfiguration

Configurazione JWT per questo autorizzatore.

Questo viene passato allajwtConfiguration sezione di anx-amazon-apigateway-authorizer nellasecuritySchemes sezione di una definizione OpenAPI.

Nota

Usa le lettere minuscoleissuer eaudience le proprietà conAWS::Serverless::HttpApi e le lettere maiuscoleIssuer eAudience le proprietà con AWS::ApiGatewayV2::Authorizer.

Type: Eseguire la mappatura

Richiesto: No

AWS CloudFormationcompatibilità: Questa proprietà è unicaAWS SAM e non ha unAWS CloudFormation equivalente.

Examples (Esempi)

Autorizzatore OAuth 2.0

Esempio di autorizzatore 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