Create OCI Connector 3.0

Parameter	Mandatory/Optional	Data Type	Description
connectorAppInfos	Mandatory		Parent parameter that holds the list of ConnectorAppInfo which includes App Name, identifiers and tag details. Connector name can be one or more apps from list [AI, CI, CSA]. AI-Asset Inventory, CI- Cloud Inventory, CSA- Cloud Security Assessment
homeRegion	Mandatory	String	Specify the home region for the connector. Example: ap-singapore-1
runFrequency	Mandatory	Integer	Specify the connector's run frequency. The run frequency decides the rate at which the connector should poll the cloud provider and retrieve the data.
name	Mandatory	Integer	Specify a name for the connector.
authRecord	Mandatory		Parent parameter that holds the authentication parameteres that the connector uses to connect to the cloud platform.
tenantId	Mandatory	String	Specify the tenant ID of the connector.
userId	Mandatory	String	Specify the user ID of the connector.
fingerprint	Mandatory	String	Specify the fingerprint of the connector.
privateKey	Mandatory	String	Specify the private key for the connector.
disabled	Optional	Boolean	Specify if the connector should be enabled or disabled.
description	Optional	String	Specify a description for the new connector.
passphrase	Optional	String	Specify a passphrase for the new connector.

API request (JSON)

{
  "ServiceRequest": {
    "data": {
      "OciAssetDataConnector": {
        "homeRegion": "us-ashburn-1",
        "runFrequency": 240,
        "name": "OCI Connector with API",
        "description": "Created via Public API",
        "disabled": false,
        "authRecord": {
          "tenantId": "",
          "userId": "",
          "fingerprint": "",
          "privateKey": "",
          "passphrase": ""
        },
        "connectorAppInfos": {
          "set": {
            "ConnectorAppInfoQList": [
              {
                "set": {
                  "ConnectorAppInfo": {
                    "name": "AI",
                    "identifier": "oxxx.xxx---xq",
                    "tagId": xxxxxxxxx
                  }
                }
              },
              {
                "set": {
                  "ConnectorAppInfo": {
                    "name": "CI",
                    "identifier": "oxxxx.xxx---xq",
                    "tagId": xxxxxxxxx
                  }
                }
              },
              {
                "set": {
                  "ConnectorAppInfo": {
                    "name": "CSA",
                    "identifier": "oxxxx.xxx----xq",
                    "tagId": xxxxxxxxx
                  }
                }
              }
            ]
          }
        }
      }
    }
  }
}

API response (JSON)

{
    "ServiceResponse": {
        "data": [
            {
                "OciAssetDataConnector": {
                    "authRecord": {
                        "tenantId": "oxxx.x-xxq"
                    },
                    "name": "OCI Connector with API",
                    "connectorAppInfos": {
                        "list": [
                            {
                                "ConnectorAppInfoQList": {
                                    "list": [
                                        {
                                            "ConnectorAppInfo": {
                                                "name": "CSA",
                                                "identifier": "oxxx.x-xxq"
                                            }
                                        }
                                    ]
                                }
                            },
                            {
                                "ConnectorAppInfoQList": {
                                    "list": [
                                        {
                                            "ConnectorAppInfo": {
                                                "name": "CI",
                                                "identifier": "oxxx.xxxxxx-xxq"
                                            }
                                        }
                                    ]
                                }
                            },
                            {
                                "ConnectorAppInfoQList": {
                                    "list": [
                                        {
                                            "ConnectorAppInfo": {
                                                "name": "AI",
                                                "identifier": "oxxx-xxq"
                                            }
                                        }
                                    ]
                                }
                            }
                        ]
                    },
                    "description": "Created via Public API",
                    "id": xxxxxxx,
                    "disabled": "false",
                    "lastSync": "2023-08-09T10:59:00Z",
                    "isDeleted": "false"
                }
            }
        ],
        "responseCode": "SUCCESS",
        "count": 1
    }
}

Create OCI Connector

Input ParameterInput Parameter

Sample: Create a new OCI connectorSample: Create a new OCI connector