Jump to

• Request
• Response

Retrieve the SSH Key Description Using Query Parameters

get

/paas/api/v1.1/instancemgmt/{identityDomainId}/services/IntegrationCloud/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 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 Integration Classic 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 Integration Classic 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 Integration Classic account.

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK.

Body ()

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

Root Schema : keydescquery-response

Type: object

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

Show Source

• 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.
• 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 Integration Classic account.
• items(optional): string
  Groups credential description details returned by the query.
• serviceName(optional): string
  Name of the Oracle Integration Classic instance.
• serviceType(optional): string
  Cloud service type. Valid value is IntegrationCloud for Oracle Integration Classic.
• totalResults(optional): integer
  Number of results returned by the query.

{
    "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 Integration Classic account."
        },
        "items":{
            "type":"string",
            "description":"Groups credential description details returned by the query."
        },
        "serviceName":{
            "type":"string",
            "description":"Name of the Oracle Integration Classic instance."
        },
        "serviceType":{
            "type":"string",
            "description":"Cloud service type. Valid value is <code>IntegrationCloud</code> for Oracle Integration Classic."
        },
        "totalResults":{
            "type":"integer",
            "description":"Number of results returned by the query."
        }
    }
}

Back to Top