检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
自定义认证 自定义认证包含两种认证:前端自定义认证和后端自定义认证。 前端自定义认证:如果您希望使用自己的认证系统,而不是APP认证/华为IAM认证对API的访问进行认证鉴权时,您可以使用自定义认证,通过您自定义的函数进行认证鉴权。 后端自定义认证:当不同的后端服务使用不同的认证
扩展定义 x-apigateway-auth-type x-apigateway-request-type x-apigateway-match-mode x-apigateway-cors x-apigateway-is-send-fg-body-base64 x-apigateway-any-method
校验API定义 功能介绍 校验API定义。校验API的路径或名称是否已存在 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/apigw/instances/{instance_id}/apis/check 表1 路径参数 参数 是否必选 参数类型
objects 自定义的响应头 数组长度:0 - 10 表5 ResponseInfoHeader 参数 是否必选 参数类型 描述 key 否 String 分组自定义响应的响应头的key,支持英文字母、数字和中划线,长度为1到128位 value 否 String 分组自定义响应的响应
objects 自定义的响应头 数组长度:0 - 10 表5 ResponseInfoHeader 参数 是否必选 参数类型 描述 key 否 String 分组自定义响应的响应头的key,支持英文字母、数字和中划线,长度为1到128位 value 否 String 分组自定义响应的响应
API签名认证是否支持自定义认证方式? 支持。 有关自定义认证详细指导,请参考自定义认证。 父主题: API认证鉴权
删除自定义认证 操作场景 当自定义的认证已不再需要时,可以删除自定义认证。 自定义认证依赖函数工作流服务。如果当前Region没有上线函数工作流服务,则不支持使用自定义认证。 已在API中使用的自定义认证无法被删除。 前提条件 已创建自定义认证。 操作步骤 进入共享版控制台。 在“开放API
创建自定义认证 操作场景 自定义认证包含两种认证:前端自定义认证和后端自定义认证。 前端自定义认证:如果您希望使用自己的认证系统,而不是APP认证/华为IAM认证对API的访问进行认证鉴权时,您可以使用自定义认证,通过您自定义的函数进行认证鉴权。 后端自定义认证:当不同的后端服务
objects 自定义的响应头 数组长度:0 - 10 表4 ResponseInfoHeader 参数 是否必选 参数类型 描述 key 否 String 分组自定义响应的响应头的key,支持英文字母、数字和中划线,长度为1到128位 value 否 String 分组自定义响应的响应
错误类型的响应定义,其中key为错误类型。key的枚举值为: AUTH_FAILURE:认证失败 AUTH_HEADER_MISSING:认证身份来源缺失 AUTHORIZER_FAILURE:自定义认证失败 AUTHORIZER_CONF_FAILURE:自定义认证配置错误 A
认证身份来源信息缺失 AUTHORIZER_FAILURE: 自定义认证方返回认证失败 AUTHORIZER_CONF_FAILURE:自定义认证方异常,通信失败、返回异常响应等错误 AUTHORIZER_IDENTITIES_FAILURE: 前端自定义认证的身份来源信息缺失或不合法错误 BACKEND_UNAVAILABLE:
错误类型的响应定义,其中key为错误类型。key的枚举值为: AUTH_FAILURE:认证失败 AUTH_HEADER_MISSING:认证身份来源缺失 AUTHORIZER_FAILURE:自定义认证失败 AUTHORIZER_CONF_FAILURE:自定义认证配置错误 A
名称 是否必选 类型 说明 id 是 String 自定义认证的ID 请求消息 无 响应消息 表3 参数说明 名称 类型 说明 id String 编号 name String 自定义认证的名称 type String 自定义认证类型: FRONTEND:前端 BACKEND:后端
创建自定义认证 功能介绍 创建自定义认证 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI POST /v1.0/apigw/authorizers 请求消息 表2 参数说明 名称 是否必选 类型 说明 name
删除自定义认证 功能介绍 删除自定义认证 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI DELETE /v1.0/apigw/authorizers/{id} URI中的参数说明如下表所示。 表2 参数说明
String 自定义认证的ID 请求消息 表3 参数说明 名称 是否必选 类型 说明 name 是 String 自定义认证的名称。 长度为3 ~ 64位的字符串,字符串由中文、英文字母、数字、“_”组成,且只能以英文或中文开头。 type 是 String 自定义认证类型: FRONTEND:前端
ld_api_id String 自定义后端服务ID。 暂不支持 need_body Boolean 是否发送body id String 自定义认证编号 create_time String 创建时间 roma_app_id String 自定义认证所属应用编号 暂不支持 roma_app_name
证信息。函数作为自定义认证的后端函数,对API网关中的API进行认证授权。 图1 后端自定义认证示意图 使用自定义认证调用API的流程如下图所示: 图2 使用自定义认证调用API 自定义认证依赖函数服务。如果当前Region没有上线函数服务,则不支持使用自定义认证。 操作步骤 在FunctionGraph中开发函数。
自定义认证 创建自定义认证 删除自定义认证 父主题: 共享版操作指导(仅存量用户使用)
Integer 满足条件的自定义认证总数 size Integer 本次返回的列表长度 authorizer_list Array 自定义认证列表 表4 authorizer_list参数说明 名称 类型 说明 id String 编号 name String 自定义认证的名称 type