# x-apigateway-auth-type
**含义**：基于Swagger的apiKey认证格式，定义API网关支持的特有认证方式。
**作用域** ：[Security Scheme Object(2.0)](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#security-scheme-object)/[Security Scheme Object(3.0)](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.0.md#security-scheme-object)
**Swa** **gger** **示例**：
```
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
```
**OpenAPI示例**：
```
securitySchemes:
    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
```
表1参数说明 
| 参数                     | 是否必选 | 类型     | 说明                                                                                                                                                                                                                                            |
|:---|:---|:---|:---|
| x-apigateway-auth-type | 是    | String | API认证类型。 - AppSigv1：APP认证。  - IAM：IAM认证。   |
| type                   | 是    | String | 认证类型，仅支持apiKey。                                                                                                                                                                                                                               |
| name                   | 是    | String | 用于认证的参数名称。                                                                                                                                                                                                                                    |
| in                     | 是    | String | 仅支持header。                                                                                                                                                                                                                                    |
| description            | 否    | String | 描述信息。                                                                                                                                                                                                                                         |