HttpApiAuth

Configurez l'autorisation pour contrôler l'accès à votre API HTTP Amazon API Gateway.

Pour plus d'informations sur la configuration de l'accès aux API HTTP, consultez Contrôle et gestion de l'accès à une API HTTP dans API Gateway 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

  Authorizers: OAuth2Authorizer | LambdaAuthorizer
  DefaultAuthorizer: String
  EnableIamAuthorizer: Boolean

Propriétés

Authorizers

Le mécanisme d'autorisation utilisé pour contrôler l'accès à votre API API Gateway.

Type : Autorisateur OAuth2 | LambdaAuthorizer

Obligatoire : non

Par défaut : aucun

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

Remarques supplémentaires : AWS SAM ajoute les autorisateurs à la définition d'OpenAPI.

DefaultAuthorizer

Spécifiez l'autorisation par défaut à utiliser pour autoriser les appels d'API vers votre API API Gateway. Vous pouvez spécifier AWS_IAM en tant que mécanisme d'autorisation par défaut si EnableIamAuthorizer est défini sur true. Sinon, spécifiez un mécanisme d'autorisation que vous avez défini dans Authorizers.

Type : chaîne

Obligatoire : non

Par défaut : aucun

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

EnableIamAuthorizer

Spécifiez si l'autorisation IAM doit être utilisée pour la route API.

Type : valeur booléenne

Obligatoire : non

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

Exemples

Mécanismes d'autorisation OAuth 2.0

Exemple de mécanisme d'autorisation OAuth 2.0

YAML

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

Mécanisme d'autorisation IAM

Exemple de mécanisme d'autorisation IAM

YAML

Auth:
  EnableIamAuthorizer: true
  DefaultAuthorizer: AWS_IAM