九游平台/ 漏洞管理服务 codearts inspector/ api参考/ / / 认证网站资产
更新时间：2024-10-14 gmt 08:00

认证网站资产-九游平台

功能介绍

认证租户的网站资产

调试

您可以在中调试该接口，支持自动认证鉴权。api explorer可以自动生成sdk代码示例，并提供sdk代码示例调试功能。

uri

post /v3/{project_id}/webscan/domains/authenticate

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

string

用户的project_id，获取方法请参见获取项目id。

最小长度：32

最大长度：32

请求参数

表2 请求header参数

参数

是否必选

参数类型

描述

x-auth-token

是

string

用户token，通过调用iam服务获取用户token接口获取（响应消息头中x-subject-token的值）。

最小长度：1

最大长度：102400
表3 请求body参数

参数

是否必选

参数类型

描述

domain_name

是

string

网站域名

最小长度：1

最大长度：256

auth_mode

否

string

认证方式:

  • file - 文件认证

  • auto - 一键认证

  • free - 免认证，选择此项默认已阅读并了解下述使用要求 使用须知： 1、您的账号已完成实名认证，且非受限账号。 2、您确认您已获得对扫描对象进行扫描的相关合法权利。 3、您确认您的扫描行为有合法合理目的，且符合适用的法律法规要求，不得利用本服务从事任何黑灰产等非法活动。 4、若您违反上述承诺，我们有权立即终止您对本服务的使用，并要求您对我们及相关第三方因此遭受的损失进行赔偿。

缺省值：file

枚举值：

  • file

  • auto

  • free

响应参数

状态码： 200

表4 响应body参数

参数

参数类型

描述

info_code

string

状态码:

  • success - 成功

  • failure - 失败

枚举值：

  • success

  • failure

info_description

string

返回的提示信息

最小长度：0

最大长度：64

usage_notice

string

网站域名认证使用须知

最小长度：0

最大长度：1000

状态码： 400

表5 响应body参数

参数

参数类型

描述

error_code

string

错误码

最小长度：0

最大长度：50

error_msg

string

错误描述

最小长度：0

最大长度：256

状态码： 401

表6 响应body参数

参数

参数类型

描述

error_code

string

错误码

最小长度：0

最大长度：50

error_msg

string

错误描述

最小长度：0

最大长度：256

状态码： 418

表7 响应body参数

参数

参数类型

描述

error_code

string

错误码

最小长度：0

最大长度：50

error_msg

string

错误描述

最小长度：0

最大长度：256

请求示例

post https://{endpoint}/v3/{project_id}/webscan/domains/authenticate
{
  "domain_name" : "https://127.0.0.1:8080",
  "auth_mode" : "free"
}

响应示例

状态码： 200

ok

{
  "info_code" : "success",
  "info_description" : "operation succeeded",
  "usage_notice" : "使用须知： 1、您的账号已完成实名认证，且非受限账号。 2、您确认您已获得对扫描对象进行扫描的相关合法权利。 3、您确认您的扫描行为有合法合理目的，且符合适用的法律法规要求，不得利用本服务从事任何黑灰产等非法活动。 4、若您违反上述承诺，我们有权立即终止您对本服务的使用，并要求您对我们及相关第三方因此遭受的损失进行赔偿。"
}

状态码

状态码

描述

200

ok

400

bad request

401

unauthorized

418

i'm a teapot

错误码

请参见错误码。

父主题：

相关文档

网站地图