API网关 APIG-创建自定义认证:请求参数

时间:2023-12-01 09:43:02

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

表3 请求Body参数

参数

是否必选

参数类型

描述

name

String

自定义认证的名称。 长度为3 ~ 64位的字符串,字符串由中文、英文字母、数字、“_”组成,且只能以英文或中文开头。

type

String

自定义认证类型

  • FRONTEND:前端

  • BACKEND:后端

不支持修改

枚举值:

  • FRONTEND

  • BACKEND

authorizer_type

String

只能为:FUNC

枚举值:

  • FUNC

authorizer_uri

String

函数地址。

network_type

String

对接函数的网络架构类型

  • V1:非VPC网络架构

  • V2:VPC网络架构

缺省值:V1

枚举值:

  • V1

  • V2

authorizer_version

String

函数版本。

当函数别名URN和函数版本同时传入时,函数版本将被忽略,只会使用函数别名URN

最大长度:64

authorizer_alias_uri

String

函数别名地址。

当函数别名URN和函数版本同时传入时,函数版本将被忽略,只会使用函数别名URN

identities

Array of Identity objects

认证来源

ttl

Integer

缓存时间

user_data

String

用户数据

ld_api_id

String

自定义后端服务ID。

暂不支持

need_body

Boolean

是否发送body

表4 Identity

参数

是否必选

参数类型

描述

name

String

参数名称

location

String

参数位置

枚举值:

  • HEADER

  • QUERY

validation

String

参数校验表达式,默认为null,不做校验

support.huaweicloud.com/api-apig/CreateCustomAuthorizerV2.html