九游平台/ 代码托管 codearts repo/ api参考/ / / 检验私钥是否有拉取代码的权限
更新时间：2024-10-26 gmt 08:00

检验私钥是否有拉取代码的权限-九游平台

功能介绍

调用该接口，您可检验私钥是否有拉取代码仓库的权限。

调试

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

uri

post /v1/users/sshkey/privatekey/verify

请求参数

表1 请求header参数

参数

是否必选

参数类型

描述

x-auth-token

是

string

参数解释：

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

约束限制：

不涉及。

取值范围：

长度为[1,100000]个字符。

默认取值：

不涉及。
表2 请求body参数

参数

是否必选

参数类型

描述

repository_uuid

是

string

参数解释：

仓库uuid(由createrepository接口返回)。

取值范围：

由数字和字母组成，且长度为32个字符。

private_key

是

string

参数解释：

密钥，由用户上传。

取值范围：

只能数字组成，且长度为[0-2048]个字符。

响应参数

表3 响应body参数

参数

参数类型

描述

error

error object

参数解释：

接口调用时，响应错误。

取值范围：

无。

result

string

参数解释：

接口调用的响应结果。

取值范围：

无。

status

string

参数解释：

调用此接口的响应状态。

取值范围：

  • success，表示接口调用成功。
  • failed，表示接口调用失败。
表4 error

参数

参数类型

描述

code

string

参数解释：

调用此接口失败时返回的错误码。

message

string

参数解释：

调用此接口失败时返回的提示信息。

请求示例

post https://{endpoint}/v1/users/sshkey/privatekey/verify
{
  "private_key" : "-----begin rsa private key-----****-----end rsa private key-----",
  "repository_uuid" : "9b2fab276e9240e09cd01ed0400fc439"
}

响应示例

状态码： 200

ok

{
  "status" : "success"
}

状态码

状态码

描述

200

ok

错误码

请参见错误码。

父主题：

相关文档

网站地图