Jump to

• Request
• Response
• Examples

Retrieve the SSH Key Description Using Query Parameters

get

/paas/api/v1.1/instancemgmt/{domainName}/services/SOA/credentials/crednames

Returns one or more credential descriptions 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 SOA 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

• domainName: string
  Identity domain ID for the Oracle SOA 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 SOA 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

• X-ID-TENANT-NAME: string
  Identity domain ID for the Oracle SOA Cloud Service account.

Back to Top

Response

Supported Media Types

• application/json

200 Response

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

Body ()

Root Schema : keydescquery-response

Type: object

The response body contains general information about one or more SSH keys (including their descriptions).

Show Source

• canonicalUrl: string
  URL to query the credential key value.
• credName: string
  Credential name. Currently, the only supported credential name is vmspublickey.
• credType: string
  Credential type. Only supported value is SSH.
• description: string
  Credential description of the given credential name.
• hasMore: 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: string
  Identity domain ID for the Oracle SOA Cloud Service account.
• items: string
  Groups credential description details returned by the query.
• serviceName: string
  Name of the Oracle SOA Cloud Service instance.
• serviceType: string
  Cloud service type. Valid value is jaas for Oracle SOA Cloud Service.
• totalResults: integer
  Number of results returned by the query.

{
    "required":[
        "canonicalUrl",
        "credName",
        "credType",
        "description",
        "hasMore",
        "identityDomain",
        "items",
        "serviceName",
        "serviceType",
        "totalResults"
    ],
    "description":"The response body contains general information about one or more SSH keys (including their descriptions).",
    "properties":{
        "canonicalUrl":{
            "type":"string",
            "description":"URL to query the credential key value."
        },
        "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 given 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 SOA Cloud Service account."
        },
        "items":{
            "type":"string",
            "description":"Groups credential description details returned by the query."
        },
        "serviceName":{
            "type":"string",
            "description":"Name of the Oracle SOA Cloud Service instance."
        },
        "serviceType":{
            "type":"string",
            "description":"Cloud service type. Valid value is <code>jaas</code> for Oracle SOA 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 descriptions 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/{domainName}/services/SOA/credentials/crednames?credname=vmspublickey&serviceName=ExampleInstance"

Example of Response Header

The following example shows the response header.

HTTP/1.1 200 OK
Date: Tue, 30 Aug 2021 02:09:24 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":"SOA",
      "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\/SOA\/instances\/ExampleInstance\/credentials\/crednames\/vmspublickey"
   }],
   "hasMore":false,
   "totalResults":1
}

Back to Top