Jump to

• Request
• Response
• Examples

Create an Integration

post

/rest/v16/integrationVendors

This endpoint creates an integration.

Request

Supported Media Types

• application/json

Body ()

Root Schema : integrationVendor-request

Type: object

Show Source

• cert: string
  Title: Certificate

  The string value for the certificate.
• certName: string
  Title: Certificate Name

  The string value for the certificate name.
• integrationType: string
  Title: Integration Type

  The string value for the type of integrationn.
• loginEndpoint: string
  Title: Login Endpoint

  The string value for the login endpoint.
• properties: object properties
• vendorName: string
  Title: Vendor Name

  The string value for the name of the vendor.

{
    "type":"object",
    "properties":{
        "cert":{
            "type":"string",
            "description":"The string value for the certificate.",
            "title":"Certificate"
        },
        "certName":{
            "type":"string",
            "description":"The string value for the certificate name.",
            "title":"Certificate Name"
        },
        "loginEndpoint":{
            "type":"string",
            "description":"The string value for the login endpoint.",
            "title":"Login Endpoint"
        },
        "integrationType":{
            "type":"string",
            "description":"The string value for the type of integrationn.",
            "title":"Integration Type"
        },
        "vendorName":{
            "type":"string",
            "description":"The string value for the name of the vendor.",
            "title":"Vendor Name"
        },
        "properties":{
            "type":"object",
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "name":{
                                "type":"string",
                                "description":"Integration property name.",
                                "title":"Property Name"
                            },
                            "value":{
                                "type":"string",
                                "description":"Integration property value.",
                                "title":"Property Value"
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• items: array items

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "name":{
                        "type":"string",
                        "description":"Integration property name.",
                        "title":"Property Name"
                    },
                    "value":{
                        "type":"string",
                        "description":"Integration property value.",
                        "title":"Property Value"
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "name":{
                "type":"string",
                "description":"Integration property name.",
                "title":"Property Name"
            },
            "value":{
                "type":"string",
                "description":"Integration property value.",
                "title":"Property Value"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• name: string
  Title: Property Name

  Integration property name.
• value: string
  Title: Property Value

  Integration property value.

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"Integration property name.",
            "title":"Property Name"
        },
        "value":{
            "type":"string",
            "description":"Integration property value.",
            "title":"Property Value"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The integration details created.

Body ()

Root Schema : integrationVendor

Match All

Show Source

• object integrationVendor-request
• object integrationVendor-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/definitions/integrationVendor-request"
        },
        {
            "type":"object",
            "properties":{
                "id":{
                    "type":"integer",
                    "description":"The unique integer identifier for the integration.",
                    "title":"Id"
                }
            }
        }
    ]
}

Nested Schema : integrationVendor-request

Type: object

Show Source

• cert: string
  Title: Certificate

  The string value for the certificate.
• certName: string
  Title: Certificate Name

  The string value for the certificate name.
• integrationType: string
  Title: Integration Type

  The string value for the type of integrationn.
• loginEndpoint: string
  Title: Login Endpoint

  The string value for the login endpoint.
• properties: object properties
• vendorName: string
  Title: Vendor Name

  The string value for the name of the vendor.

{
    "type":"object",
    "properties":{
        "cert":{
            "type":"string",
            "description":"The string value for the certificate.",
            "title":"Certificate"
        },
        "certName":{
            "type":"string",
            "description":"The string value for the certificate name.",
            "title":"Certificate Name"
        },
        "loginEndpoint":{
            "type":"string",
            "description":"The string value for the login endpoint.",
            "title":"Login Endpoint"
        },
        "integrationType":{
            "type":"string",
            "description":"The string value for the type of integrationn.",
            "title":"Integration Type"
        },
        "vendorName":{
            "type":"string",
            "description":"The string value for the name of the vendor.",
            "title":"Vendor Name"
        },
        "properties":{
            "type":"object",
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "name":{
                                "type":"string",
                                "description":"Integration property name.",
                                "title":"Property Name"
                            },
                            "value":{
                                "type":"string",
                                "description":"Integration property value.",
                                "title":"Property Value"
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : integrationVendor-allOf[1]

Type: object

Show Source

• id: integer
  Title: Id

  The unique integer identifier for the integration.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"integer",
            "description":"The unique integer identifier for the integration.",
            "title":"Id"
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• items: array items

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "name":{
                        "type":"string",
                        "description":"Integration property name.",
                        "title":"Property Name"
                    },
                    "value":{
                        "type":"string",
                        "description":"Integration property value.",
                        "title":"Property Value"
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "name":{
                "type":"string",
                "description":"Integration property name.",
                "title":"Property Name"
            },
            "value":{
                "type":"string",
                "description":"Integration property value.",
                "title":"Property Value"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• name: string
  Title: Property Name

  Integration property name.
• value: string
  Title: Property Value

  Integration property value.

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"Integration property name.",
            "title":"Property Name"
        },
        "value":{
            "type":"string",
            "description":"Integration property value.",
            "title":"Property Value"
        }
    }
}

Back to Top

Examples

The following examples show how to create an integration by submitting a POST request to the REST resource using cURL. For more information about cURL, see Use cURL.

curl - X POST - i - H "Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQg" - H "Content-type: application/json"
https://sitename.oracle.com/rest/v16/integrationVendors

Retrieve the Certificate from Oracle Identity and Access Management

Request Body Sample

{
  "integrationType": "oAuthProvider",
  "vendorName": "Identity Cloud Service",
  "loginEndpoint": "https://idp.oracle.com",
  "properties": {
    "items": [{
        "name": "issuer",
        "value": "https://identity.oraclecloud.com/"
      }, {
        "name": "tokenEP",
        "value": "/oauth2/v1/token"
      }, {
        "name": "oAuthProviderScope",
        "value": "urn:opc:idm:__myscopes__"
      }, {
        "name": "cpqClientId",
        "value": "836954009fe54f1382d0ba1d607a038d"
      }, {
        "name": "retrieveCertificate",
        "value": "true"
      }, {
        "name": "resourceEP",
        "value": "/admin/v1/SigningCert/jwk"
      }, {
        "name": "clientId",
        "value": "836954009fe54f1382d0ba1d607a038d"
      }, {
        "name": "clientSecret",
        "value": "19745aab-690c-4523-b7d3-03f6e4e3ec38"
      }
    ]
  }
}

Response Body Sample

{
  "integrationType": "oAuthProvider",
  "vendorName": "Identity Cloud Service",
  "loginEndpoint": "https://idp.oracle.com",
  "properties": {
    "items": [{
        "name": "resourceEP",
        "value": "/admin/v1/SigningCert/jwk"
      }, {
        "name": "clientId",
        "value": "836954009fe54f1382d0ba1d607a038d"
      }, {
        "name": "tokenEP",
        "value": "/oauth2/v1/token"
      }, {
        "name": "oAuthProviderScope",
        "value": "urn:opc:idm:__myscopes__"
      }, {
        "name": "retrieveCertificate",
        "value": "true"
      }, {
        "name": "cpqClientId",
        "value": "836954009fe54f1382d0ba1d607a038d"
      }, {
        "name": "issuer",
        "value": "https://identity.oraclecloud.com/"
      }
    ]
  },
  "id": 3022874193,
  "links": [{
      "rel": "self",
      "href": "https://sitename.oracle.com/rest/v16/integrationVendors/3022874193"
    }
  ]
}

Upload the Certificate Directly to Oracle CPQ

Request Body Sample

{
  "integrationType": "oAuthProvider",
  "vendorName": "Identity Cloud Service",
  "loginEndpoint": "https://idp.oracle.com",
  "properties": {
    "items": [{
        "name": "issuer",
        "value": "https://identity.oraclecloud.com/"
      }, {
        "name": "tokenEP",
        "value": "/oauth2/v1/token"
      }, {
        "name": "oAuthProviderScope",
        "value": "urn:opc:idm:__myscopes__"
      }, {
        "name": "cpqClientId",
        "value": "836954009fe54f1382d0ba1d607a038d"
      }, {
        "name": "certificate",
        "value": "-----BEGIN CERTIFICATE-----\nMIIDYTCCAkmgAwIBAgIGAX6+gu4+MA0GCSqGSIb3DQEBCwUAMFkxEzA7hgOvYo5P1G951cwZdEbNHxRyL6+sS7zTnVq9FYXOSK4wLlx5TQ4pH3k3mO7aPLSs8XqodyVuIipsjIzyMPvSUSP1P3KMCAwEAAaMyMDAwDwYDVR0PAQH/BAUDAwf4ADAdBgNVHQ4EFgQUH7RrEqqw5zixsWVgNnKT9253wDUwDQYJKoZIhvcNAQELBQADggEBAFKNX4uSQsu0M/H0lQjyKuoa3b6R9JkGxtxV6kyFA+7iznTfmqnummKeVifvXpGfj9Dssh8uiJofsZ6y9wnXLrwSfGWlJ5zVsv9z9B0+qLjFQaJQGe7zAZA48zIWVY5ukucq881DdLdvPSAAQGjFYNywmd887pvpQq77iAldluXrPIfrJlc3QnnPORtwcBLq+6cYmHZUG3lnC4HA0EdZ96zdPhLXzneRYZRq8oY2c+Bs1uabqqLtU8Ers/fN4EYVll4LvrSbZFsxocfozXj0g4LS/WR2CFhXuEHeQj3P7pgFjjJXvkl7Z5WeQaPleHhcp5ruBIJPPfNQmsoDFX8cys4=\n-----END CERTIFICATE-----\n-----BEGIN CERTIFICATE-----\nMIIDazCCAlOgAwIBAgIINViiv6s6qqgwDQYJKoZIhvcNAQELBQAwWTETMBEGCgmSJomT8ixkARkWA2NvbTEWMBQGCgmSJomT8ixkARkWBm9yYWNsZTEVMBMGCgmSJomT8ixkARkWBWNsb3VkMRMwEQYDVQQDEwpDbG91ZDlDQS0yMCAXDTE2MDUwMzA4MDIxN1oYDzIxMTYwNDA5MDgwMjE3WjBZMRMwEQYKCZImiZPyLGQBGRYDY29t4IBAQC3IFrmt4eQ2Ggx6cp4I9F57BuKBRjH4cbebFM+gL6mvaUsOhtzzZHuR05a5BQYW1CFU7CG2cGEjeSeBqWLcKbq5iXC44gdMcFWH7R5GApNJO3CNI8QZJdbzLWDF0UzPKXxcHwF8niduJuyFwfe/pcW4aWzFdOLKAlIv1iXeungmdhZLg37yh3Zt7WnTAtQFgM0cvxkZlRcreQVisvLtZvTd+wVAUNo57ws/y1cPIBiWwxrvcFDv3+U0I+y2eVqbtmV2nWKeQ1aisBLdQydsuatQM8+C4nFC+BJvfdkYY+6+JNeTc6GCnTpQo3/nkDHH08PGR5Rs+NAdvlshL1GgHbU\n-----END CERTIFICATE-----"
      }
    ]
  }
}

Response Body Sample

{
  "integrationType": "oAuthProvider",
  "vendorName": "Identity Cloud Service",
  "loginEndpoint": "https://idp.oracle.com",
  "properties": {
    "items": [{
        "name": "tokenEP",
        "value": "/oauth2/v1/token"
      }, {
        "name": "oAuthProviderScope",
        "value": "urn:opc:idm:__myscopes__"
      }, {
        "name": "retrieveCertificate",
        "value": "false"
      }, {
        "name": "cpqClientId",
        "value": "836954009fe54f1382d0ba1d607a038d"
      }, {
        "name": "issuer",
        "value": "https://identity.oraclecloud.com/"
      }
    ]
  },
  "id": 3022878194,
  "links": [{
      "rel": "self",
      "href": "https://site.oracle.com/rest/v16/integrationVendors/3022878194"
    }
  ]
}

Back to Top