Help Center/ CodeArts Repo/ API Reference/ APIs/ SSHKey/ Obtaining the SSH Key List

Updated on 2023-12-04 GMT+08:00

View PDF

Obtaining the SSH Key List

Function

This interface is used to obtain the SSH key list.

URI

GET /v1/users/sshkey

Request Parameters

**Table 1** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Specifies the user token. It can be obtained by calling the IAM API (value of X-Subject-Token in the response header).

Response Parameters

Status code: 200

**Table 2** Response body parameters
Parameter	Type	Description
error	Error object	Response error.
result	PublicKeyList object	Result
status	String	Status code in a response

**Table 3** Error
Parameter	Type	Description
code	String	Error Codes
message	String	Error message

**Table 4** PublicKeyList
Parameter	Type	Description
sshkey	Array of PublicKey objects	Keys
total	Integer	Total number of keys

**Table 5** PublicKey
Parameter	Type	Description
id	String	Key ID Minimum: 1 Maximum: 40
key	String	Key Minimum: 0 Maximum: 2048
title	String	Name

Example Requests

GET https://{endpoint}/v1/users/sshkey

Example Responses

Status code: 200

{
  "result" : {
    "total" : 2,
    "sshkey" : [ {
      "id" : "1015292",
      "title" : "reop1@huawei.com",
      "key" : "ssh-rsa AAAAB3NzaC1yc2EAAAADAQA*********************************************************Bqa/pE8buOrxri6AWqAky0bmtjSuVf reop1@huawei.com"
    }, {
      "id" : "1031709",
      "title" : "reop@huawei.com",
      "key" : "ssh-rsa AAAAB3NzaC1yc2EA*********************************************************U7xcma6HU8nj1E0i46VObWyOONl3gh142BV repo@huawei.com"
    } ]
  },
  "status" : "success"
}