实例、API、路由、接口开启消费者认证

请求参数

Authorization

Header 参数

jwt

string

可选

默认值:

eyJhbGciOiJIUzI1NiJ9.eyJ1c2VySWQiOjE4MjA3NCwidGVuYW50SWQiOjk5NDg3MDcsInVzZXJOYW1lIjoiY3R5dW4wYTFjMzI1MmI2MjQ0NzEyMTcyNTQyMjU3MSIsInRlbmFudE5hbWUiOiJtc2FwX21zZV9jc21fZGV2X21hc3RlckBxcS5jb20jcGFhczQwIiwidGVuYW50Q29kZSI6IkN0eXVuM2UxNjIxYTY3YjQwNDY0MjE3MjU0MjI1NzEiLCJidXNpVXNlcklkIjpudWxsLCJidXNpVGVuYW50SWQiOm51bGwsImJ1c2lUZW5hbnROYW1lIjpudWxsLCJhY2NvdW50VHlwZSI6MCwiaXNPd25lciI6dHJ1ZSwicmVhbE5hbWUiOiJtc2FwX21zZV9jc21fZGV2IiwicmVxU291cmNlIjoiMDEiLCJ2ZXJzaW9uTm8iOiIzLjAuMCIsInJlc1Bvb2xDb2RlIjoiYjM0MmI3N2VmMjZiMTFlY2IwYWMwMjQyYWMxMTAwMDIiLCJwcml2YXRlS2V5IjpudWxsLCJvdXRlclRlbmFudElkIjoiM2UxNjIxYTY3YjQwNDY0MmIxMDAxMDc3YzcxYmE3OWYiLCJvdXRlclVzZXJJZCI6IjBhMWMzMjUyYjYyNDQ3MTJiNmNiM2FhMGU1YTc5M2JmIiwiYWdlbnRVc2VySWQiOm51bGwsImFnZW50VGVuYW50SWQiOm51bGwsImlhdCI6MTczMjUxOTQ3NCwiaXNzIjoiZmlyc3R6dXVsIiwiZXhwIjoyMzMyNTE5NDc0fQ.XiXnJQmUSVc8I-IVY99JE5VmHMvM8dydDpD9xC5St8g

Body 参数application/json

apiCode

string

可选

类型为API, 路由或接口时需传所属的apiCode

authorizeType

string

必需

授权类型, 1-route 2-interface 3-API 4-instance

basicTokenDTO

object (BasicTokenDTO)

可选

hideCredentials

boolean

可选

是否隐藏认证信息。false：不隐藏，认证信息透传到后端服务，true：隐藏，认证信息不透传。默认值：false

示例值:

false

consumerAuthType

string

可选

认证类型: 1-JWT 2-HMAC 3-Key 4-Basic;enable为true时必填

enable

boolean

是否开启认证

必需

hmacTokenDTO

object (HmacTokenDTO)

可选

algorithm

string

签名算法

可选

示例值:

hmac-sha256

hideCredentials

boolean

可选

是否隐藏认证信息。false：不隐藏，认证信息透传到后端服务，true：隐藏，认证信息不透传。默认值：false

示例值:

false

instanceCode

string

实例编码

必需

jwtTokenDTO

object (JwtTokenDTO)

可选

cookie

string

可选

从 cookie 的位置校验 token 参数，默认值为 jwt。JWT 类型请求参数

示例值:

jwt

header

string

可选

从 header 的位置校验 token 参数，默认值为 authorization，header 优先级高于query、cookie，JWT 类型请求参数

示例值:

authorization

hideCredentials

boolean

可选

是否隐藏认证信息。false：不隐藏，认证信息透传到后端服务，true：隐藏，认证信息不透传。默认值：false

示例值:

false

query

string

可选

从 query 的位置校验 token 参数，默认值为 jwt，query 优先级高于 cookie。JWT 类型请求参数

示例值:

jwt

keyTokenDTO

object (KeyTokenDTO)

可选

header

string

可选

设置我们从哪个 header 获取 key。

示例值:

Authorization

hideCredentials

boolean

可选

是否隐藏认证信息。false：不隐藏，认证信息透传到后端服务，true：隐藏，认证信息不透传。默认值：false

示例值:

false

query

string

可选

设置我们从哪个 query string 获取 key，优先级低于 header。

示例值:

jwt

relationCode

string

必需

授权类型对应的资源编码

示例

{
    "apiCode": "string",
    "authorizeType": "string",
    "basicTokenDTO": {
        "hideCredentials": false
    },
    "consumerAuthType": "string",
    "enable": true,
    "hmacTokenDTO": {
        "algorithm": "hmac-sha256",
        "hideCredentials": false
    },
    "instanceCode": "string",
    "jwtTokenDTO": {
        "cookie": "jwt",
        "header": "authorization",
        "hideCredentials": false,
        "query": "jwt"
    },
    "keyTokenDTO": {
        "header": "Authorization",
        "hideCredentials": false,
        "query": "jwt"
    },
    "relationCode": "string"
}

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://m1.apifoxmock.com/m1/2270273-0-default/AGW/v1/consumer/auth/enable' \
--header 'jwt: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VySWQiOjE4MjA3NCwidGVuYW50SWQiOjk5NDg3MDcsInVzZXJOYW1lIjoiY3R5dW4wYTFjMzI1MmI2MjQ0NzEyMTcyNTQyMjU3MSIsInRlbmFudE5hbWUiOiJtc2FwX21zZV9jc21fZGV2X21hc3RlckBxcS5jb20jcGFhczQwIiwidGVuYW50Q29kZSI6IkN0eXVuM2UxNjIxYTY3YjQwNDY0MjE3MjU0MjI1NzEiLCJidXNpVXNlcklkIjpudWxsLCJidXNpVGVuYW50SWQiOm51bGwsImJ1c2lUZW5hbnROYW1lIjpudWxsLCJhY2NvdW50VHlwZSI6MCwiaXNPd25lciI6dHJ1ZSwicmVhbE5hbWUiOiJtc2FwX21zZV9jc21fZGV2IiwicmVxU291cmNlIjoiMDEiLCJ2ZXJzaW9uTm8iOiIzLjAuMCIsInJlc1Bvb2xDb2RlIjoiYjM0MmI3N2VmMjZiMTFlY2IwYWMwMjQyYWMxMTAwMDIiLCJwcml2YXRlS2V5IjpudWxsLCJvdXRlclRlbmFudElkIjoiM2UxNjIxYTY3YjQwNDY0MmIxMDAxMDc3YzcxYmE3OWYiLCJvdXRlclVzZXJJZCI6IjBhMWMzMjUyYjYyNDQ3MTJiNmNiM2FhMGU1YTc5M2JmIiwiYWdlbnRVc2VySWQiOm51bGwsImFnZW50VGVuYW50SWQiOm51bGwsImlhdCI6MTczMjUxOTQ3NCwiaXNzIjoiZmlyc3R6dXVsIiwiZXhwIjoyMzMyNTE5NDc0fQ.XiXnJQmUSVc8I-IVY99JE5VmHMvM8dydDpD9xC5St8g' \
--header 'Content-Type: application/json' \
--data-raw '{
    "apiCode": "string",
    "authorizeType": "string",
    "basicTokenDTO": {
        "hideCredentials": false
    },
    "consumerAuthType": "string",
    "enable": true,
    "hmacTokenDTO": {
        "algorithm": "hmac-sha256",
        "hideCredentials": false
    },
    "instanceCode": "string",
    "jwtTokenDTO": {
        "cookie": "jwt",
        "header": "authorization",
        "hideCredentials": false,
        "query": "jwt"
    },
    "keyTokenDTO": {
        "header": "Authorization",
        "hideCredentials": false,
        "query": "jwt"
    },
    "relationCode": "string"
}'

返回响应

🟢200成功

*/*

OK

Body

OpenApi响应体

error

string

错误码

可选

示例值:

AGW_1000

message

string

API调用结果

可选

示例值:

success

requestId

string

请求唯一id

可选

示例值:

7a2828074ef6e32e041a2ef124b19e63

returnObj

object

返回数据

可选

statusCode

integer <int32>

接口状态码

可选

示例值:

2000

示例

{
    "error": "AGW_1000",
    "message": "success",
    "requestId": "7a2828074ef6e32e041a2ef124b19e63",
    "returnObj": {},
    "statusCode": 2000
}

🟢201成功

🟠401没有权限

🟠403禁止访问

🟠404记录不存在