Integration Vendors REST APIs
Overview
The Integration Vendors endpoints retrieve OAuth/CRM integration details and perform actions to create, delete, and update OAuth and Customer Relationship Management (CRM) integrations.
Administration
Get List of Integrations | ||
---|---|---|
Description |
This endpoint returns a list of integrations from the Integration Center. |
|
URI Endpoint |
/rest/v17/integrationVendors |
|
Endpoint Parameters |
q |
This endpoint supports query specifications that follow Oracle CPQ query and pagination parameters syntax. Query specifications follow a subset of MongoDB syntax and can be used to organize or narrow return data. For more information, see Manage Collections. The following attributes can be filtered:
|
HTTP Method | GET | |
Request Body Parameters |
None |
|
Response Body Parameters |
The response contains a collection of integrations |
https://site.oracle.com/rest/v17/integrationVendors
{ "items": [{ "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": 3022910233, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/integrationVendors/3022910233" } ] } ], "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/integrationVendors" } ] }
https://site.oracle.com/rest/v17/integrationVendors/3022910233
{ "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": 3022910233, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/integrationVendors/3022910233" } ] }
Example of Retrieving the Certificate from Oracle Identity and Access Management
https://sitename.oracle.com/rest/v17/integrationVendors
{ "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" } ] } }
{ "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/v17/integrationVendors/3022874193" } ] }
Example of Uploading the Certificate Directly to Oracle CPQ
https://sitename.oracle.com/rest/v17/integrationVendors
{ "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-----" } ] } }
{ "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/v17/integrationVendors/3022878194" } ] }
https://sitename.oracle.com/rest/v17/integrationVendors/3022874193
https://sitename.oracle.com/rest/v17/integrationVendors/3022874193
{ "properties": { "items": [{ "name": "cpqClientId", "value": "836954009fe54f1382d0ba1d607a038d" }, { "name": "oAuthProviderScope", "value": "urn:opc:idm:__myscopes__" } ] } }
{ "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/v17/integrationVendors/3022874193" } ] }