本文导读

功能介绍
调用方法
URI
请求参数
响应参数
请求示例
响应示例
状态码
错误码

展开导读

文档首页/ API网关 APIG/ API参考/ 专享版API（V2）/ 专享版-自定义认证管理/ 创建自定义认证

创建自定义认证

更新时间：2024-11-11 GMT+08:00

在线调试

CLI示例

查看PDF

功能介绍

创建自定义认证

调用方法

请参见如何调用API。

URI

POST /v2/{project_id}/apigw/instances/{instance_id}/authorizers

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	项目ID，获取方式请参见获取项目ID。
instance_id	是	String	实例ID，在API网关控制台的“实例信息”中获取。

请求参数

表2 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

表3 请求Body参数
参数	是否必选	参数类型	描述
name	是	String	自定义认证的名称。长度为3 ~ 64位的字符串，字符串由中文、英文字母、数字、“_”组成，且只能以英文或中文开头。
type	是	String	自定义认证类型 FRONTEND：前端 BACKEND：后端不支持修改
authorizer_type	是	String	只能为：FUNC
authorizer_uri	是	String	函数地址。
network_type	否	String	对接函数的网络架构类型 V1：非VPC网络架构 V2：VPC网络架构缺省值：V1
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	参数位置
validation	否	String	参数校验表达式，默认为null，不做校验

响应参数

状态码： 201

表5 响应Body参数
参数	参数类型	描述
name	String	自定义认证的名称。长度为3 ~ 64位的字符串，字符串由中文、英文字母、数字、“_”组成，且只能以英文或中文开头。
type	String	自定义认证类型 FRONTEND：前端 BACKEND：后端不支持修改
authorizer_type	String	只能为：FUNC
authorizer_uri	String	函数地址。
network_type	String	对接函数的网络架构类型 V1：非VPC网络架构 V2：VPC网络架构缺省值：V1
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
id	String	自定义认证编号
create_time	String	创建时间
roma_app_id	String	自定义认证所属应用编号暂不支持
roma_app_name	String	自定义认证所属应用名称暂不支持

表6 Identity
参数	参数类型	描述
name	String	参数名称
location	String	参数位置
validation	String	参数校验表达式，默认为null，不做校验

状态码： 400

表7 响应Body参数
参数	参数类型	描述
error_code	String	错误码
error_msg	String	错误描述

状态码： 401

表8 响应Body参数
参数	参数类型	描述
error_code	String	错误码
error_msg	String	错误描述

状态码： 403

表9 响应Body参数
参数	参数类型	描述
error_code	String	错误码
error_msg	String	错误描述

状态码： 404

**表10** 响应Body参数
参数	参数类型	描述
error_code	String	错误码
error_msg	String	错误描述

状态码： 500

**表11** 响应Body参数
参数	参数类型	描述
error_code	String	错误码
error_msg	String	错误描述

请求示例

创建一个前端自定义认证

{
  "name" : "Authorizer_demo",
  "type" : "FRONTEND",
  "authorizer_type" : "FUNC",
  "authorizer_uri" : "urn:fss:xx-xxx:106506b9a92342df9a5025fc12351cfc:function:defau:apigDemo_1592617458814",
  "network_type" : "V1",
  "authorizer_version" : "v1",
  "authorizer_alias_uri" : "urn:fss:xx-xxx-4:106506b9a92342df9a5025fc12351cfc:function:defau:apigDemo_1592617458814:!v1",
  "identities" : [ {
    "name" : "header",
    "location" : "HEADER"
  } ],
  "user_data" : "authorizer_test"
}

响应示例

状态码： 201

Created

{
  "name" : "Authorizer_demo",
  "type" : "FRONTEND",
  "authorizer_type" : "FUNC",
  "authorizer_uri" : "urn:fss:xx-xxx-4:106506b9a92342df9a5025fc12351cfc:function:defau:apigDemo_1592617458814",
  "network_type" : "V1",
  "authorizer_version" : "v1",
  "authorizer_alias_uri" : "urn:fss:xx-xxx-4:106506b9a92342df9a5025fc12351cfc:function:defau:apigDemo_1592617458814:!v1",
  "identities" : [ {
    "name" : "header",
    "location" : "HEADER"
  } ],
  "ttl" : 0,
  "user_data" : "authorizer_test",
  "id" : "0d982c1ac3da493dae47627b6439fc5c",
  "create_time" : "2020-07-31T11:55:43Z"
}

状态码： 400

Bad Request

{
  "error_code" : "APIG.2011",
  "error_msg" : "Invalid parameter value,parameterName:type. Please refer to the support documentation"
}

状态码： 401

Unauthorized

{
  "error_code" : "APIG.1002",
  "error_msg" : "Incorrect token or token resolution failed"
}

状态码： 403

Forbidden

{
  "error_code" : "APIG.1005",
  "error_msg" : "No permissions to request this method"
}

状态码： 404

Not Found

{
  "error_code" : "APIG.3019",
  "error_msg" : "The function URN does not exist"
}

状态码： 500

Internal Server Error

{
  "error_code" : "APIG.9999",
  "error_msg" : "System error"
}

状态码

状态码	描述
201	Created
400	Bad Request
401	Unauthorized
403	Forbidden
404	Not Found
500	Internal Server Error

错误码

请参见错误码。

父主题： 专享版-自定义认证管理

上一篇：专享版-自定义认证管理

下一篇：修改自定义认证

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！您可在我的云声建议查看反馈及问题处理状态。

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消

如您有其它疑问，您也可以通过华为云社区问答频道来与我们联系探讨

智能客服提问云社区提问

创建自定义认证

功能介绍

调用方法

URI

请求参数

响应参数

请求示例

响应示例

状态码

错误码

相关文档

意见反馈

文档内容是否对您有帮助？

7*24

备案

专业服务

退订

建议反馈

售前咨询热线

文档反馈