OAuth2Authorizer

Definizione di un autorizzatore OAuth 2.0, noto anche come autorizzatore JSON Web Token (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 tuo modello AWS Serverless Application Model (AWS SAM), usa la seguente sintassi.

YAML

  AuthorizationScopes: List
  IdentitySource: String
  JwtConfiguration: Map

Proprietà

AuthorizationScopes

Elenco degli ambiti di autorizzazione per questo autorizzatore.

Tipo: Elenco

Required: No

AWS CloudFormation compatibilità: questa proprietà è unica AWS SAM e non ha un AWS CloudFormation equivalente.

IdentitySource

Espressione di origine dell'identità per questo autorizzatore.

▬Tipo: stringa

Required: No

AWS CloudFormation compatibilità: questa proprietà è unica AWS SAM e non ha un AWS CloudFormation equivalente.

JwtConfiguration

Configurazione JWT per questo autorizzatore.

Questo viene passato alla jwtConfiguration sezione di an x-amazon-apigateway-authorizer nella securitySchemes sezione di una definizione OpenAPI.

Nota

Le proprietà issuer e audience non fanno distinzione tra maiuscole e minuscole e possono essere utilizzate sia in minuscolo come in OpenAPI che in maiuscolo e come in. Issuer Audience AWS::ApiGatewayV2::Authorizer

Tipo: Mappa

Required: No

AWS CloudFormation compatibilità: questa proprietà è unica AWS SAM e non ha un AWS CloudFormation equivalente.

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