Obtaining the Key List of the Current User
Function
This API is used to obtain the key list of the current user.
Debugging
You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.
URI
GET https://{hostURL}/v4/user/keys
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| offset | No | Integer | Definition Offset, which starts from 0. Value range: 0~2147483647 Default value: 0 |
| limit | No | Integer | Definition Number of returned records. Value range: 1~100 Default value: 20 |
| query | No | String | Definition Title of the key. Range 1–2,000 characters. |
Request Parameters
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| X-Auth-Token | Yes | String | Definition User token. Obtain a token by calling the IAM API for obtaining a user token. The value of X-Subject-Token in the response header is the user token. Constraints Mandatory. Range 1–100,000 characters. Default Value N/A. |
Response Parameters
Status code: 200
| Parameter | Type | Description |
|---|---|---|
| keys | Array of SSHKeyDto objects | Definition Key list. Range 0–1,000 characters. |
| total | Integer | Definition Number of results. Value range: 1~2147483647 |
| Parameter | Type | Description |
|---|---|---|
| id | Integer | Definition: Key ID Value range: 1~2147483647 |
| title | String | Definition: Secret name Value range: 1–1,000 characters. |
| key | String | Definition Public key. Range 1–1,000 characters. |
| created_at | String | Definition Creation time. Range 1–1,000 characters. |
Status code: 401
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Definition Error code. |
| error_msg | String | Definition Error message. |
Status code: 403
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Definition Error code. |
| error_msg | String | Definition Error message. |
Example Requests
GET https://{endpoint}/v4/user/keys Example Responses
Status code: 200
Obtain the key list of the current user.
{
"keys" : [ {
"id" : 2111842119,
"title" : "lssh",
"key" : "ssh-rsa AAAAB3...",
"created_at" : "2022-12-14T11:22:57.000+08:00"
} ]
} Status code: 401
Unauthorized
{
"error_code" : "DEV.00000003",
"error_msg" : "Authentication information expired."
} Status code: 403
Bad Request
{
"error_code" : "CH.004403",
"error_msg" : "Insufficient permissions. Apply for the required permissions and try again."
} Status Codes
| Status Code | Description |
|---|---|
| 200 | Obtain the key list of the current user. |
| 401 | Unauthorized |
| 403 | Bad Request |
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.
