API网关 APIGAPI网关 APIG

更新时间:2021/06/18 GMT+08:00
分享

修改自定义认证

功能介绍

修改自定义认证

调试

您可以在API Explorer中调试该接口。

URI

PUT /v2/{project_id}/apigw/instances/{instance_id}/authorizers/{authorizer_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

租户项目编号

instance_id

String

实例编号

authorizer_id

String

自定义认证的ID

请求参数

表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

函数urn

identities

Array of AuthorizerCreateIdentitiesReq objects

认证来源

ttl

Integer

缓存时间

user_data

String

用户数据

表4 AuthorizerCreateIdentitiesReq

参数

是否必选

参数类型

描述

name

String

参数名称

location

String

参数位置

枚举值:

  • HEADER

  • QUERY

validation

String

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

响应参数

状态码: 200

表5 响应Body参数

参数

参数类型

描述

name

String

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

type

String

自定义认证类型

  • FRONTEND:前端

  • BACKEND:后端

枚举值:

  • FRONTEND

  • BACKEND

authorizer_type

String

只能为:FUNC

枚举值:

  • FUNC

authorizer_uri

String

函数地址。

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

参数位置

枚举值:

  • HEADER

  • QUERY

validation

String

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

状态码: 401

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码: 403

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码: 404

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码: 500

表10 响应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",
  "identities" : [ {
    "name" : "header",
    "location" : "HEADER",
    "user_data" : "authorizer_test"
  } ]
}

响应示例

状态码: 200

OK

{
  "name" : "Authorizer_demo",
  "type" : "FRONTEND",
  "authorizer_type" : "FUNC",
  "authorizer_uri" : "urn:fss:xx-xxx-4:106506b9a92342df9a5025fc12351cfc:function:defau:apigDemo_1592617458814",
  "identities" : [ {
    "name" : "header",
    "location" : "HEADER"
  } ],
  "ttl" : 5,
  "user_data" : "authorizer_test",
  "id" : "0d982c1ac3da493dae47627b6439fc5c",
  "create_time" : "2020-07-08T03:27:52.000+0000"
}

状态码: 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.3081",
  "error_msg" : "authorizer with id: 0d982c1ac3da493dae47627b6439fc5c not found"
}

状态码: 500

Internal Server Error

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

状态码

状态码

描述

200

OK

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

错误码

请参见错误码

分享:

    相关文档

    相关产品