Jump to

• Request
• Response

View the SSH Key Value

get

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

Returns the credential value for the given credential name.

Note: vmspublickey is the only supported credential name.

Request

Path Parameters

• credentialName: string
  Credential name associated with the SSH public 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 details about the SSH public key value.

Root Schema : sshkeyvalue-response

Type: object

The response body contains details about the SSH public key value.

Show Source

• componentType(optional): string
  Type of service component. Possible values include: WLS, 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 given credential name.
• identityDomain(optional): string
  Identity domain ID for the Oracle Integration Classic account.
• lastUpdateMessage(optional): string
  Message returned from the last SSH key update. For example: newly created, updated by username.
• lastUpdateStatus(optional): string
  Status of the last SSH key update.
• 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 Integration Classic instance using an SSH client.
• serviceName(optional): string
  Name of the Oracle Integration Classic instance.
• serviceType(optional): string
  Cloud service type. Valid value is IntegrationCloud for Oracle Integration Classic.

{
    "description":"The response body contains details about the SSH public key value.",
    "properties":{
        "componentType":{
            "type":"string",
            "description":"Type of service component. Possible values include: <code>WLS</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 given credential name."
        },
        "identityDomain":{
            "type":"string",
            "description":"Identity domain ID for the Oracle Integration Classic account."
        },
        "lastUpdateMessage":{
            "type":"string",
            "description":"Message returned from the last SSH key update. For example: <code>newly created</code>, <code>updated by <em>username</em></code>."
        },
        "lastUpdateStatus":{
            "type":"string",
            "description":"Status of the last SSH key update."
        },
        "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 Integration Classic instance using an SSH client."
        },
        "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."
        }
    }
}

Back to Top