View the SSH Key Description
/paas/api/v1.1/instancemgmt/{identityDomainId}/services/jaas/instances/{serviceId}/credentials/crednames/{credentialName}
Note: vmspublickey
is the only supported credential name.
Request
-
credentialName: string
Credential name associated with the SSH key. Currently, the only credential name you can use is
vmspublickey
. -
identityDomainId: string
Identity domain ID for the Oracle Java Cloud Service account.
-
serviceId: string
Name of the Oracle Java Cloud Service instance.
-
Authorization: string
Base64 encoded user name and password separated by a colon or OAuth access token obtained from Oracle Identity Cloud Service. See Authenticate.
-
X-ID-TENANT-NAME: string
Identity domain ID for the Oracle Java Cloud Service account.
Response
- application/json
200 Response
The response body contains information about the SSH key, including its description.
See Status Codes for information about other possible HTTP status codes.
object
-
canonicalUrl(optional):
string
URL to query the credential key value.
-
credName(optional):
string
Credential name. Currently, the only supported credential name is
vmspublickey
. -
credType(optional):
string
Credential type. Only supported value is
SSH
. -
description(optional):
string
Credential description of the given credential name.
-
identityDomain(optional):
string
Identity domain ID for the Oracle Java Cloud Service account.
-
serviceName(optional):
string
Name of the Oracle Java Cloud Service instance.
-
serviceType(optional):
string
Cloud service type. Valid value is
jaas
for Oracle Java Cloud Service.
Examples
The following example shows how to view information about the SSH public key for the given credential name by submitting a GET request on the REST resource using cURL.
-
Currently, the only supported credential name is
vmspublickey
. -
The command in this example uses the URL structure
https://rest_server_url/resource-path
, whererest_server_url
is the REST server to contact for your identity domain (or Cloud Account). See Send Requests.
cURL Command
curl -i -X GET -u username:password -H "X-ID-TENANT-NAME:ExampleIdentityDomain" https://rest_server_url/paas/api/v1.1/instancemgmt/ExampleIdentityDomain/services/jaas/instances/ExampleInstance/credentials/crednames/vmspublickey
Example of Response Header
The following shows an example of the response header.
HTTP/1.1 200 OK
Date: Tue, 19 Apr 2016 21:38:40 GMT
Transfer-Encoding: chunked
Content-Type: application/json
Example of Response Body
The following example shows the response returned in JSON format.
{
"identityDomain":"ExampleIdentityDomain",
"serviceType":"jaas",
"serviceName":"ExampleInstance",
"credName":"vmspublickey",
"credType":"SSH",
"description":"Service user ssh public key which can be used to access the service VM instances",
"canonicalUrl":"https:\/\/rest_server_url\/paas\/api\/v1.1\/instancemgmt\/ExampleIdentityDomain\/service\/jaas\/instances\/ExampleInstance\/credentials\/crednames\/vmspublickey"
}