REST API for Oracle Integration 3

Upload a Certificate

post

/ic/api/integration/v1/certificates

Uploads a certificate. If you are using cURL, use the -F option to specify the file to import. The request must contain the following attributes added with the -F option: name, type, category and file. Description is optional.

Request

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.

Supported Media Types

multipart/form-data

Root Schema : schema

Type: object

Show Source

ascii: boolean

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

Certificate category. Valid values - TRUST & IDENTITY for type - X509 , OWSM for type - SAML and PRIVATE & PUBLIC for type - PGP & SIGNKEY
cipher: string

Cipher algorithm. Valid only for type - PGP and category - PUBLIC
file: string (binary)

Certificate file
installedType: string

Certificate installed by. Ex - USER
keyPasswords: string

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

Keystore password. Valid only for type - X509 and category - PRIVATE
name: string

Certificate alias name
passPhrase: string

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

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

{
    "type":"object",
    "properties":{
        "file":{
            "type":"string",
            "description":"Certificate file",
            "format":"binary"
        },
        "name":{
            "type":"string",
            "description":"Certificate alias name"
        },
        "installedType":{
            "type":"string",
            "description":"Certificate installed by. Ex - USER"
        },
        "type":{
            "type":"string",
            "description":"Certificate type. Valid values - DIGITALSIGNATURE, PGP, SAML, SIGNKEY & X509"
        },
        "category":{
            "type":"string",
            "description":"Certificate category. Valid values - TRUST & IDENTITY for type - X509 , OWSM for type - SAML and PRIVATE & PUBLIC for type - PGP & SIGNKEY"
        },
        "passPhrase":{
            "type":"string",
            "description":"Private key password. Valid only for type - PGP & SIGNKEY and category - PRIVATE"
        },
        "ascii":{
            "type":"boolean",
            "description":"ASCII-Armor encryption flag. Valid only for type - PGP and category - PUBLIC"
        },
        "cipher":{
            "type":"string",
            "description":"Cipher algorithm. Valid only for type - PGP and category - PUBLIC"
        },
        "keystorePassword":{
            "type":"string",
            "description":"Keystore password. Valid only for type - X509 and category - PRIVATE"
        },
        "keyPasswords":{
            "type":"string",
            "description":"Key password(s). Valid only for type - X509 and category - IDENTITY"
        }
    }
}

Response

204 Response

Successful operation

409 Response

Certificate already exists

500 Response

Server error

Examples

The following example shows how to upload a certificate by submitting a POST 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.

The request must contain the following attributes specified with the -F option: name, type, category, and file. Description is optional.

Example: Upload a PGP Public certificate

curl -X POST -H 'Authorization: Bearer access_token' -H "Content-Type:multipart/form-data" -F "name=TESTPGPPUBLICCERT" -F "description=Type PGP Category PUBLIC Certificate" -F "type=PGP" -F "category=PUBLIC" -F "file=@public.asc" -F "ascii=true" -F "cipher=CAST5" https://design.integration.region.ocp.oraclecloud.com/ic/api/integration/v1/certificates?integrationInstance=service-instance

Example: Upload a Draft PGP Public certificate

Note:

Without file attributes, you can upload PGP certificates in Draft state.

curl -X POST -H 'Authorization: Bearer access_token' -H "Content-Type:multipart/form-data" -F "name=TESTPGPPUBLICCERT" -F "description=Type PGP Category PUBLIC Certificate" -F "type=PGP" -F "category=PUBLIC" https://design.integration.region.ocp.oraclecloud.com/ic/api/integration/v1/certificates?integrationInstance=service-instance

Example: Upload a SAML certificate

curl -X POST -H 'Authorization: Bearer access_token' -H "Content-Type:multipart/form-data" -F "name=TESTSAMLCERT" -F "description=Type SAML Category OWSM Certificate" -F "type=SAML" -F "category=OWSM" -F "file=@saml.crt" https://design.integration.region.ocp.oraclecloud.com/ic/api/integration/v1/certificates?integrationInstance=service-instance