Jump to

• Request
• Response

View the SSH Key Description

get

/paas/api/v1.1/instancemgmt/{identityDomainId}/services/IntegrationCloud/instances/{service_name}/credentials/crednames/{credentialName}

Returns the credential description for the given credential name.

Note: vmspublickey is the only supported credential name.

Request

Path Parameters

• 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 Integration Classic account.
• service_name: string
  Name of the Oracle Integration Classic instance.

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 information about the SSH key, including its description.

Root Schema : sshkeydesc-response

Type: object

The response body contains information about the SSH key, including its description.

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.
• identityDomain(optional): string
  Identity domain ID for the Oracle Integration Classic account.
• serviceName(optional): string
  Name of the Oracle Integration Classic instance.
• serviceType(optional): string
  Cloud service type. Valid value is IntegrationCloud for Oracle Integration Service.

{
    "description":"The response body contains information about the SSH key, including its description.",
    "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."
        },
        "identityDomain":{
            "type":"string",
            "description":"Identity domain ID for the Oracle Integration Classic account."
        },
        "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 Service."
        }
    }
}

Back to Top