Adding an SSH Key

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

View PDF

Function

Adding an SSH Key

URI

POST /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 an IAM API. The value of X-Subject-Token in the response header is the user token.

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
key	Yes	String	Key Minimum: 0 Maximum: 2048
title	Yes	String	Name

Response Parameters

Status code: 200

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

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

**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

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

{
  "title" : "repo@huawei.com",
  "key" : "ssh-rsa AAAAB3NzaC1yc2EA*********************************************************U7xcma6HU8nj1E0i46VObWyOONl3gh142BV repo@huawei.com"
}

Example Responses

Status code: 200

{
  "result" : {
    "id" : "1034531",
    "title" : "repo@huawei.com",
    "key" : "ssh-rsa AAAAB3NzaC1yc2EA*********************************************************U7xcma6HU8nj1E0i46VObWyOONl3gh142BV repo@huawei.com"
  },
  "status" : "success"
}