Obtaining the SSH Key List
Function
This API is used to obtain the public key list of CodeArts Repo.
URI
GET /v1/users/sshkey
Request Parameters
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| X-Auth-Token | Yes | String | Explanation: User token. It can be obtained by calling the corresponding IAM API. The value of X-Subject-Token in the response header is the user token. Constraints: Mandatory Range: 1–100,000 characters. Default value: None |
Response Parameters
| Parameter | Type | Description |
|---|---|---|
| error | Error object | Explanation: Response error. Range: None |
| result | PublicKeyList object | Explanation: SSH key list. |
| status | String | Explanation: Response status of the API. Range:
|
| Parameter | Type | Description |
|---|---|---|
| sshkey | Array of PublicKey objects | Explanation: SSH key list. |
| total | Integer | Explanation: Total number of SSH keys. Range: 0–2147483647 |
| Parameter | Type | Description |
|---|---|---|
| code | String | Explanation: Error code returned when the API fails to be called. Range:
|
| message | String | Explanation: Error message returned when the API fails to be called. Range:
|
Example Requests
GET https://{endpoint}/v1/users/sshkey Example Responses
Status code: 200
OK
{
"result" : {
"total" : 2,
"sshkey" : [ {
"id" : "1015292",
"title" : "reop1@test.com",
"key" : "ssh-rsa AAAAB3NzaC1yc2EAAAADAQA*********************************************************Bqa/pE8buOrxri6AWqAky0bmtjSuVf reop1@test.com"
}, {
"id" : "1031709",
"title" : "reop@test.com",
"key" : "ssh-rsa AAAAB3NzaC1yc2EA*********************************************************U7xcma6HU8nj1E0i46VObWyOONl3gh142BV repo@test.com"
} ]
},
"status" : "success"
} Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.
