Jump to

• Request
• Response
• Examples

Retrieve the SSH Key Value Using Query Parameters

get

/paas/api/v1.1/instancemgmt/{identityDomainId}/services/jaas/credentials

Returns one or more SSH key values for the given query parameters.

• Use the ?credname query parameter to retrieve results for a given credential name.
• Use the ?serviceName query parameter to retrieve results for a given Oracle Java Cloud Service instance.

Note the following:

• By default, 50 keys are returned by a given query. Use the ?limitRowCount query parameter to control the page size (number of results returned in a single request).
• Use the ?offset query parameter to fetch additional results, if available. By default, offset is 0 (zero).

Request

Path Parameters

• identityDomainId: string
  Identity domain ID for the Oracle Java Cloud Service account.

Query Parameters

• credname(optional): string
  Unique credential name.

  Note: vmspublickey is the only supported credential name. This is the default if a credential name is not supplied.

• serviceName(optional): string
  Name of the Oracle Java Cloud Service instance. If a service name is not supplied, the request will return all service instances for the given identity domain ID.

Header Parameters

• 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.

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK.

The response body contains details about one or more SSH keys.

See Status Codes for information about other possible HTTP status codes.

Body ()

Root Schema : keyvaluequery-response

Type: object

Show Source

• componentType(optional): string
  Type of service component. Possible values include: WLS, OTD, DB.
• computeKeyName(optional): string
  Compute sshkey object key name.
• 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 credential name.
• hasMore(optional): boolean
  Flag that specifies whether the list returned by the query is full (false) or partial (true).

  When the list is partial, use the offset query parameter to fetch additional results. By default, offset is 0 (zero) and limitRowCount is 50.

• identityDomain(optional): string
  Identity domain ID for the Oracle Java Cloud Service account.
• items(optional): string
  Groups SSH key value details returned by the query.
• lastUpdateMessage(optional): string
  Message returned from the last update for the SSH key. For example: newly created, updated by username.
• lastUpdateStatus(optional): string
  Status of the last update for the SSH key.
• lastUpdateTime(optional): string
  Date and time the SSH key was last updated.
• osUserName(optional): string
  Virtual machine OS user name. Only supported value is opc.
• parentType(optional): string
  Valid value is SERVICE.
• publicKey(optional): string
  Public key for the secure shell (SSH). This key is used for authentication when connecting to the Oracle Java Cloud Service instance using an SSH client.
• serviceName(optional): string
  Name of the Oracle Java Cloud Service instance.
• serviceState(optional): string
  State of the service instance. For example, RUNNING.
• serviceType(optional): string
  Cloud service type. Valid value is jaas for Oracle Java Cloud Service.
• totalResults(optional): integer
  Number of results returned by the query.

{
    "properties":{
        "componentType":{
            "type":"string",
            "description":"Type of service component. Possible values include: <code>WLS</code>, <code>OTD</code>, <code>DB</code>."
        },
        "computeKeyName":{
            "type":"string",
            "description":"Compute sshkey object key name."
        },
        "credName":{
            "type":"string",
            "description":"Credential name. Currently, the only supported credential name is <code>vmspublickey</code>."
        },
        "credType":{
            "type":"string",
            "description":"Credential type. Only supported value is <code>SSH</code>."
        },
        "description":{
            "type":"string",
            "description":"Credential description of the credential name."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Flag that specifies whether the list returned by the query is full (<code>false</code>) or partial (<code>true</code>). <p>When the list is partial, use the <code>offset</code> query parameter to fetch additional results. By default, <code>offset</code> is 0 (zero) and <code>limitRowCount</code> is 50."
        },
        "identityDomain":{
            "type":"string",
            "description":"Identity domain ID for the Oracle Java Cloud Service account."
        },
        "items":{
            "type":"string",
            "description":"Groups SSH key value details returned by the query."
        },
        "lastUpdateMessage":{
            "type":"string",
            "description":"Message returned from the last update for the SSH key. For example: <code>newly created</code>, <code>updated by <em>username</em></code>."
        },
        "lastUpdateStatus":{
            "type":"string",
            "description":"Status of the last update for the SSH key."
        },
        "lastUpdateTime":{
            "type":"string",
            "description":"Date and time the SSH key was last updated."
        },
        "osUserName":{
            "type":"string",
            "description":"Virtual machine OS user name. Only supported value is <code>opc</code>."
        },
        "parentType":{
            "type":"string",
            "description":"Valid value is <code>SERVICE</code>."
        },
        "publicKey":{
            "type":"string",
            "description":"Public key for the secure shell (SSH). This key is used for authentication when connecting to the Oracle Java Cloud Service instance using an SSH client."
        },
        "serviceName":{
            "type":"string",
            "description":"Name of the Oracle Java Cloud Service instance."
        },
        "serviceState":{
            "type":"string",
            "description":"State of the service instance. For example, <code>RUNNING</code>."
        },
        "serviceType":{
            "type":"string",
            "description":"Cloud service type. Valid value is <code>jaas</code> for Oracle Java Cloud Service."
        },
        "totalResults":{
            "type":"integer",
            "description":"Number of results returned by the query."
        }
    }
}

Back to Top

Examples

The following example shows how to retrieve SSH key values by using query parameters in a GET request on the REST resource using cURL.

Note:

• Currently, the only supported credential name is vmspublickey.

• The command in this example uses the URL structure https://rest_server_url/resource-path, where rest_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/credentials?credname=vmspublickey&serviceName=ExampleInstance"

Example of Response Header

The following shows an example of the response header.

HTTP/1.1 200 OK
Date: Tue, 30 Aug 2016 02:12:51 GMT
Transfer-Encoding: chunked
Content-Type: application/json

Example of Response Body

The following example shows the response returned in JSON format for a given credential name and service name.

{
    "items":[
    {
        "identityDomain":"ExampleIdentityDomain",
        "serviceType":"JaaS",
        "serviceName":"ExampleInstance",
        "credName":"vmspublickey",
        "credType":"SSH",
        "componentType":"WLS",
        "parentType":"SERVICE",
        "lastUpdateTime":"2016-04-19T19:29:49.257+0000",
        "lastUpdateStatus":"success",
        "lastUpdateMessage":"newly created",
        "osUserName":"opc",
        "computeKeyName":"\/OPCWLS\/myuser\/jaas.ExampleInstance.wls.ora_user",
        "publicKey":"ssh-rsa ZXZXB3NzaC1yc2EAAAABJQAAAQEAr57JqX\/vDab9T+WNxymhCIYSZhv9kVeUTtT0BhvW6WV2BQC
vN1YfiHsSvAt25YoKBOYM925CPUClbIySfwQEpNhZVtw+mUlKd1SNP3ZMgSakHQG8gbtrVwPcpxdeTiYXlEYXetZv20g2PF9JRcN6lYsjS41fhotfytW4IsZ
+Vf7PN44\/kpU\/W\/qPcePK6HlY+iLUKzN\/tBCenCBJgrRYj5FUQBf1Ujli4nl0mJ3HKC4pbZ4V0OoxL0Yt\/qRDUJOrUQilzapABzftzTstVAeaSAsp9t
r+k8+MxsI37AvJwy1PvhWW4MU1x8y7gfJPsFfJ9lFH5T6PiZasBtpPWGEeeE== rsa-key-20133333",
        "description":"Service user ssh public key which can be used to access the service VM instances",
        "serviceState":"RUNNING"
    }],
    "hasMore":false,
    "totalResults":1
}

Back to Top