文档首页/ 代码托管 CodeArts Repo/ API参考/ API/ SSH Key/ 检验私钥是否有拉取代码的权限
更新时间：2024-10-26 GMT+08:00
查看PDF
分享

检验私钥是否有拉取代码的权限

功能介绍

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

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。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

错误码

请参见错误码。

父主题： SSH Key

相关文档