View Keys

Details

API DetailsRelease-Specific Information
CloudCenter Platform 4xCloudCenter Suite 5x
NameView keys
Description

This API call allows users to view their own user keys for SSH or SFTP access

Allowed Role(s)WM_USER
MethodGET
URIv1/user/keys

cloudcenter-ccm-backend/api/v1/user/keys

Sample Request
curl -k -X GET -H "Accept: application/json" -u cliqradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/v1/user/keys
curl -k -X GET -H "Accept: application/json" -u cliqradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/cloudcenter-ccm-backend/api/v1/user/keys"
ReleaseIntroduced in CloudCenter 4.0.

Modified in CloudCenter Suite 5.0.0

NotesFor additional context on <PORT> usage in the following example(s), see Base URI Format.
Back To LinksCloudCenter Platform 4x APIWorkload Manager API

ESB Header

action: get.user.keys 

See the Enterprise Service Bus (ESB) section for additional context.

Not applicable

Sample Response

{
    "apiKey": {
        "key": "D3DD6F7874E6B26B"
    },
    "sshKeys": [
        {
            "key": "-----BEGIN RSA PRIVATE KEY-----\nMI...bpZokAxQ==\n-----END RSA PRIVATE KEY-----\n",
            "cloudAccountId": "1",
            "cloudAccountName": "V's US DC OpenStack cloud account",
            "cloudRegionId": "1",
            "cloud": "OpenStack-regionOne"
        },
        {
            "key": "-----BEGIN RSA PRIVATE KEY-----\nMI...1N1p57Tm\n-----END RSA PRIVATE KEY-----",
            "cloudAccountId": "2",
            "cloudAccountName": "642111779657",
            "cloudRegionId": "2",
            "cloud": "Amazon-eu-west-1"
        }
    ],
    "sftpKeys": []
}

Request Attributes

None.

Response Attributes

apiKey
  • Description: Identifies the API access key. See API Management Key for additional details.
  • Type: API key data type

    key
sshKeys
  • Description: Information about SSH access keys
  • Type: Array of mapped data types

    key
    cloudAccountId
    • Description: Unique, system-generated identifier for the cloudAccount

    • Type: String

    cloudAccountName
    • Description:The account name associated with this  cloud
    • Type: String
    cloudRegionId
    • Description: Unique, system-generated identifier for a cloud region
    • Type: String
    cloud
    • DescriptionThe name of this cloud
    • Type: String
sftpKeys (click for additional details)
© 2017-2019 Cisco Systems, Inc. All rights reserved