REST API for Oracle Integration 3

Retrieve a Certificate

get

/ic/api/integration/v1/certificates/{id}

Retrieves detailed information about the certificate with the specified ID.

Request

Path Parameters

id(required): string

Certificate composite identifier. The ID consists of the installedType, type, category and the name separated by the | (vertical line) character. Format: installedType%7Ctype%7Ccategory%7Cname. Example: USER%7CPGP%7CPUBLIC%7CTESTPGPPUBLICCERT. When using cURL, substitute the %7C code for the vertical line.

Query Parameters

integrationInstance(required): string

This is the name of the service instance. You can get this value from the About page where it is specified in the Service instance field.

There's no request body for this operation.

Response

Supported Media Types

application/json; charset=utf-8, application/vnd.oracle.resource+json;type=singular

200 Response

Successful operation

Root Schema : CertificateRs

Match All

Show Source

allOf IdResource
object GenericRestResource
object CertificateRs-allOf[2]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/IdResource"
        },
        {
            "$ref":"#/components/schemas/GenericRestResource"
        },
        {
            "type":"object",
            "properties":{
                "keystore":{
                    "type":"string",
                    "description":"Keystore"
                },
                "keyStoreDescription":{
                    "type":"string",
                    "description":"Keystore description"
                },
                "name":{
                    "type":"string",
                    "description":"Certificate alias name"
                },
                "description":{
                    "type":"string",
                    "description":"Certificate description"
                },
                "type":{
                    "type":"string",
                    "description":"Certificate type. Valid values - DIGITALSIGNATURE, PGP, SAML, SIGNKEY & X509"
                },
                "installedType":{
                    "type":"string",
                    "description":"Certificate installed by. Ex - USER"
                },
                "typeDescription":{
                    "type":"string",
                    "description":"Certificate type description"
                },
                "keyPasswords":{
                    "type":"string",
                    "description":"Key password(s). Valid only for type - X509 and category - IDENTITY"
                },
                "keystorePassword":{
                    "type":"string",
                    "description":"Keystore password. Valid only for type - X509 and category - IDENTITY"
                },
                "passPhrase":{
                    "type":"string",
                    "description":"Private key password. Valid only for type - PGP & SIGNKEY and category - PRIVATE"
                },
                "asciiArmored":{
                    "type":"boolean",
                    "description":"ASCII-Armor encryption flag. Valid only for type - PGP and category - PUBLIC"
                },
                "cipherAlgorithm":{
                    "type":"string",
                    "description":"Cipher algorithm. Valid only for type - PGP and category - PUBLIC"
                },
                "issued":{
                    "type":"string",
                    "description":"Certificate issued date",
                    "format":"date-time"
                },
                "expires":{
                    "type":"string",
                    "description":"Certificate expiry date",
                    "format":"date-time"
                },
                "status":{
                    "type":"string",
                    "description":"Certificate status. Ex. - CONFIGURED or INPROGRESS"
                },
                "createdBy":{
                    "type":"string",
                    "description":"Certificate created by"
                },
                "created":{
                    "type":"string",
                    "description":"Certificate created date",
                    "format":"date-time"
                },
                "lastUpdatedBy":{
                    "type":"string",
                    "description":"Certificate updated by"
                },
                "lastUpdated":{
                    "type":"string",
                    "description":"Certificate updated date",
                    "format":"date-time"
                },
                "metaData":{
                    "type":"object",
                    "additionalProperties":{
                        "type":"string"
                    }
                },
                "hash":{
                    "type":"string"
                },
                "content":{
                    "type":"array",
                    "items":{
                        "type":"string",
                        "format":"byte"
                    }
                },
                "secretOCID":{
                    "type":"string"
                }
            }
        }
    ]
}

Nested Schema : IdResource

Match All

Show Source

object GenericRestResource
object IdResource-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/GenericRestResource"
        },
        {
            "type":"object",
            "properties":{
                "projectId":{
                    "type":"string"
                },
                "projectName":{
                    "type":"string"
                },
                "id":{
                    "type":"string"
                }
            }
        }
    ]
}

Nested Schema : GenericRestResource

Type: object

Show Source

links: array links
processing-time: number (float)

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            }
        },
        "processing-time":{
            "type":"number",
            "format":"float"
        }
    }
}

Nested Schema : IdResource-allOf[1]

Type: object

Show Source

id: string
projectId: string
projectName: string

{
    "type":"object",
    "properties":{
        "projectId":{
            "type":"string"
        },
        "projectName":{
            "type":"string"
        },
        "id":{
            "type":"string"
        }
    }
}

Nested Schema : CertificateRs-allOf[2]

Type: object

Show Source

asciiArmored: boolean

ASCII-Armor encryption flag. Valid only for type - PGP and category - PUBLIC
cipherAlgorithm: string

Cipher algorithm. Valid only for type - PGP and category - PUBLIC
content: array content
created: string (date-time)

Certificate created date
createdBy: string

Certificate created by
description: string

Certificate description
expires: string (date-time)

Certificate expiry date
hash: string
installedType: string

Certificate installed by. Ex - USER
issued: string (date-time)

Certificate issued date
keyPasswords: string

Key password(s). Valid only for type - X509 and category - IDENTITY
keystore: string

Keystore
keyStoreDescription: string

Keystore description
keystorePassword: string

Keystore password. Valid only for type - X509 and category - IDENTITY
lastUpdated: string (date-time)

Certificate updated date
lastUpdatedBy: string

Certificate updated by
metaData: object metaData

Additional Properties Allowed: additionalProperties
name: string

Certificate alias name
passPhrase: string

Private key password. Valid only for type - PGP & SIGNKEY and category - PRIVATE
secretOCID: string
status: string

Certificate status. Ex. - CONFIGURED or INPROGRESS
type: string

Certificate type. Valid values - DIGITALSIGNATURE, PGP, SAML, SIGNKEY & X509
typeDescription: string

Certificate type description

{
    "type":"object",
    "properties":{
        "keystore":{
            "type":"string",
            "description":"Keystore"
        },
        "keyStoreDescription":{
            "type":"string",
            "description":"Keystore description"
        },
        "name":{
            "type":"string",
            "description":"Certificate alias name"
        },
        "description":{
            "type":"string",
            "description":"Certificate description"
        },
        "type":{
            "type":"string",
            "description":"Certificate type. Valid values - DIGITALSIGNATURE, PGP, SAML, SIGNKEY & X509"
        },
        "installedType":{
            "type":"string",
            "description":"Certificate installed by. Ex - USER"
        },
        "typeDescription":{
            "type":"string",
            "description":"Certificate type description"
        },
        "keyPasswords":{
            "type":"string",
            "description":"Key password(s). Valid only for type - X509 and category - IDENTITY"
        },
        "keystorePassword":{
            "type":"string",
            "description":"Keystore password. Valid only for type - X509 and category - IDENTITY"
        },
        "passPhrase":{
            "type":"string",
            "description":"Private key password. Valid only for type - PGP & SIGNKEY and category - PRIVATE"
        },
        "asciiArmored":{
            "type":"boolean",
            "description":"ASCII-Armor encryption flag. Valid only for type - PGP and category - PUBLIC"
        },
        "cipherAlgorithm":{
            "type":"string",
            "description":"Cipher algorithm. Valid only for type - PGP and category - PUBLIC"
        },
        "issued":{
            "type":"string",
            "description":"Certificate issued date",
            "format":"date-time"
        },
        "expires":{
            "type":"string",
            "description":"Certificate expiry date",
            "format":"date-time"
        },
        "status":{
            "type":"string",
            "description":"Certificate status. Ex. - CONFIGURED or INPROGRESS"
        },
        "createdBy":{
            "type":"string",
            "description":"Certificate created by"
        },
        "created":{
            "type":"string",
            "description":"Certificate created date",
            "format":"date-time"
        },
        "lastUpdatedBy":{
            "type":"string",
            "description":"Certificate updated by"
        },
        "lastUpdated":{
            "type":"string",
            "description":"Certificate updated date",
            "format":"date-time"
        },
        "metaData":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "hash":{
            "type":"string"
        },
        "content":{
            "type":"array",
            "items":{
                "type":"string",
                "format":"byte"
            }
        },
        "secretOCID":{
            "type":"string"
        }
    }
}

Nested Schema : links

Type: array

Show Source

Array of: object Link

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Link"
    }
}

Nested Schema : Link

Type: object

Show Source

href: string
media-type: string
rel: string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "media-type":{
            "type":"string"
        }
    }
}

Nested Schema : content

Type: array

Show Source

Array of: string(byte)

{
    "type":"array",
    "items":{
        "type":"string",
        "format":"byte"
    }
}

Nested Schema : metaData

Type: object

Additional Properties Allowed

Show Source

string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

404 Response

Certificate not found

500 Response

Server error

Examples

The following example shows how to get details of a certificate by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL. For more information about endpoint URL structure, see Send Requests.

Example: Get details about PGP Public certificate TESTPGPPUBLICCERT

The id is in the form: installedType%7Ctype%7Ccategory%7Cname. The %7C is the encoded | (vertical line).

curl -X GET -H 'Authorization: Bearer access_token' -H "Accept:application/json" https://design.integration.region.ocp.oraclecloud.com/ic/api/integration/v1/certificates/USER%7CPGP%7CPUBLIC%7CTESTPGPPUBLICCERT?integrationInstance=service-instance