Adding an SSH Key

Description

This API is used to add an SSH key.

URI

POST /v1/users/sshkey

Request Parameters

**Table 1** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. It can be obtained by calling the IAM API used to obtain a user token. 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 length: 0 Maximum length: 2,048
title	Yes	String	Key name

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
error	Error object	Response error
result	PublicKey object	Response result
status	String	Response status

**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 length: 1 Maximum length: 40
key	String	Key Minimum length: 0 Maximum length: 2,048
title	String	Key name

Request Examples

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

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

Response Examples

Status code: 200

Request succeeded

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