x-apigateway-auth-type
Meaning: Swagger-based apiKey authentication format, which defines an authentication mode provided by APIG.
Scope of effect: Security Scheme Object (2.0)
Swagger:
securityDefinitions:
  apig-auth-app:
    in: header
    name: Authorization
    type: apiKey
    x-apigateway-auth-type: AppSigv1
  apig-auth-iam:
    in: header
    name: unused
    type: apiKey
    x-apigateway-auth-type: IAM
 | 
       Parameter  | 
     
       Mandatory  | 
     
       Type  | 
     
       Description  | 
    
|---|---|---|---|
| 
       x-apigateway-auth-type  | 
     
       Yes  | 
     
       String  | 
     
       Authentication mode used on APIG. AppSigv1 and IAM are supported.  | 
    
| 
       type  | 
     
       Yes  | 
     
       String  | 
     
       Authentication type. Only apiKey is supported.  | 
    
| 
       name  | 
     
       Yes  | 
     
       String  | 
     
       Name of the parameter for authentication.  | 
    
| 
       in  | 
     
       Yes  | 
     
       String  | 
     
       Only header is supported.  | 
    
| 
       description  | 
     
       No  | 
     
       String  | 
     
       Description about the authentication.  | 
    
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.