@itentialopensource/adapter-tcpwave
Version:
This adapter integrates with system described as: tcpwaveRestapiStore.
1,754 lines (1,753 loc) • 1.37 MB
JSON
{
"id": "@itentialopensource/adapter-tcpwave",
"type": "Adapter",
"export": "Tcpwave",
"title": "Tcpwave",
"src": "adapter.js",
"roles": [
"admin"
],
"methods": [
{
"name": "iapUpdateAdapterConfiguration",
"summary": "Updates the adapter configuration",
"description": "Updates the adapter configuration file with the provided changes",
"input": [
{
"name": "configFile",
"type": "string",
"info": "The name of the file to change",
"required": true,
"schema": {
"title": "configFile",
"type": "string"
}
},
{
"name": "changes",
"type": "object",
"info": "JSON object containing the configuration changes",
"required": true,
"schema": {
"title": "changes",
"type": "object"
}
},
{
"name": "entity",
"type": "string",
"info": "The entity in which the changes are being made",
"required": false,
"schema": {
"title": "entity",
"type": "string"
}
},
{
"name": "type",
"type": "string",
"info": "The type of file to change - action, schema, or mock",
"required": false,
"schema": {
"title": "type",
"type": "string"
}
},
{
"name": "action",
"type": "string",
"info": "The action to be changed",
"required": false,
"schema": {
"title": "action",
"type": "string"
}
},
{
"name" : "replace",
"type": "boolean",
"info": "True to replace entire mock data, false to merge/append",
"required": false,
"schema": {
"title": "replace",
"type" : "boolean"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapUpdateAdapterConfiguration"
},
"task": true
},
{
"name": "iapSuspendAdapter",
"summary": "Suspends the adapter",
"description": "Suspends the adapter",
"input": [
{
"name": "mode",
"type": "enum",
"enumerals": [
"pause",
"error"
],
"info": "How incoming requests are handled. Defaults to 'pause'",
"description": "How incoming requests are handled. Defaults to 'pause'",
"schema": {
"title": "mode",
"type": "string"
},
"required": false
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing the adapter suspended status",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapSuspendAdapter"
},
"task": true
},
{
"name": "iapUnsuspendAdapter",
"summary": "Unsuspends the adapter",
"description": "Unsuspends the adapter",
"input": [],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing the adapter suspended status",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapUnsuspendAdapter"
},
"task": true
},
{
"name": "iapGetAdapterQueue",
"summary": "Return the requests that are waiting in the queue if throttling is enabled",
"description": "Return the requests that are waiting in the queue if throttling is enabled",
"input": [],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing the adapter queue",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapGetAdapterQueue"
},
"task": true
},
{
"name": "iapFindAdapterPath",
"summary": "Provides the ability to see if a particular API path is supported by the adapter",
"description": "Provides the ability to see if a particular API path is supported by the adapter",
"input": [
{
"name": "apiPath",
"type": "string",
"info": "The API Path you want to check - make sure to not include base path and version",
"description": "The API Path you want to check - make sure to not include base path and version",
"schema": {
"title": "apiPath",
"type": "string"
},
"required": true
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapFindAdapterPath"
},
"task": true
},
{
"name": "iapTroubleshootAdapter",
"summary": "Runs troubleshoot script for adapter",
"description": "Runs troubleshoot script for adapter",
"input": [
{
"name": "props",
"type": "object",
"info": "Object containing configuration, healthcheck and auth properties {'connProps':{'host': 'api.service.com', 'base_path': '/', 'protocol': 'http', 'port': 443, 'version': 'v1'},'healthCheckEndpoint': '/healthcheck', 'auth': {'auth_method': 'no authentication', 'username': 'username', 'password': 'password'}}",
"required": true,
"schema": {
"title": "props",
"type": "object"
}
},
{
"name": "persistFlag",
"type": "boolean",
"info": "Whether the input properties should be saved",
"required": true,
"schema": {
"title": "persistFlag",
"type": "boolean"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing the test results",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapTroubleshootAdapter"
},
"task": true
},
{
"name": "iapRunAdapterHealthcheck",
"summary": "Runs healthcheck script for adapter",
"description": "Runs healthcheck script for adapter",
"input": [],
"output": {
"name": "result",
"type": "boolean",
"description": "Whether healthcheck passed or failed",
"schema": {
"title": "result",
"type": "boolean"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapRunAdapterHealthcheck"
},
"task": true
},
{
"name": "iapRunAdapterConnectivity",
"summary": "Runs connectivity check script for adapter",
"description": "Runs connectivity check script for adapter",
"input": [],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing the test results",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapRunAdapterConnectivity"
},
"task": true
},
{
"name": "iapRunAdapterBasicGet",
"summary": "Runs basicGet script for adapter",
"description": "Runs basicGet script for adapter",
"input": [],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing the test results",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapRunAdapterBasicGet"
},
"task": true
},
{
"name": "iapMoveAdapterEntitiesToDB",
"summary": "Moves entities from an adapter into the IAP database",
"description": "Moves entities from an adapter into the IAP database",
"input": [],
"output": {
"name": "res",
"type": "object",
"description": "A JSON Object containing status, code and the response from the mongo transaction",
"schema": {
"title": "res",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapMoveAdapterEntitiesToDB"
},
"task": true
},
{
"name": "iapDeactivateTasks",
"summary": "Deactivate the inputted tasks",
"description": "Deactivate the inputted tasks",
"input": [
{
"name": "tasks",
"type": "array",
"description": "Tasks to deactivate",
"schema": {
"title": "tasks",
"type": "array"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing success status",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapDeactivateTasks"
},
"task": true
},
{
"name": "iapActivateTasks",
"summary": "Activate the inputted tasks",
"description": "activate the inputted tasks",
"input": [
{
"name": "tasks",
"type": "array",
"description": "Tasks to activate",
"schema": {
"title": "tasks",
"type": "array"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing success status",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapActivateTasks"
},
"task": true
},
{
"name": "iapPopulateEntityCache",
"summary": "Populate the cache for the given entities",
"description": "Populate the cache for the given entities",
"input": [
{
"name": "entityTypes",
"type": "array",
"info": "the entity type(s) to populate",
"required": true,
"schema": {
"title": "entityTypes",
"type": "array"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapPopulateEntityCache"
},
"task": true
},
{
"name": "iapRetrieveEntitiesCache",
"summary": "Retrieves data from cache for specified entity type",
"description": "Retrieves data from cache for specified entity type",
"input": [
{
"name": "entityType",
"type": "string",
"info": "entity of which to retrieve",
"required": true,
"schema": {
"title": "entityType",
"type": "string"
}
},
{
"name": "options",
"type": "object",
"info": "settings of which data to return and how to return it",
"required": false,
"schema": {
"title": "options",
"type": "object"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapRetrieveEntitiesCache"
},
"task": true
},
{
"name": "getDevice",
"summary": "Get the Appliance",
"description": "Get the Appliance",
"input": [
{
"name": "deviceName",
"type": "string",
"info": "An Appliance Device Name",
"required": true,
"schema": {
"title": "deviceName",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/getDevice"
},
"task": false
},
{
"name": "getDevicesFiltered",
"summary": "Get Appliances that match the filter",
"description": "Get Appliances that match the filter",
"input": [
{
"name": "options",
"type": "object",
"info": "options - e.g. { 'start': 1, 'limit': 20, 'filter': { 'name': 'abc123' } }",
"required": true,
"schema": {
"title": "options",
"type": "object"
}
}
],
"output": {
"name": "result",
"type": "array",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "array"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/getDevicesFiltered"
},
"task": false
},
{
"name": "isAlive",
"summary": "Checks the status for the provided Appliance",
"description": "Checks the status for the provided Appliance",
"input": [
{
"name": "deviceName",
"type": "string",
"info": "An Appliance Device Name",
"required": true,
"schema": {
"title": "deviceName",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "boolean",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "boolean"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/isAlive"
},
"task": false
},
{
"name": "getConfig",
"summary": "Gets a config for the provided Appliance",
"description": "Gets a config for the provided Appliance",
"input": [
{
"name": "deviceName",
"type": "string",
"info": "An Appliance Device Name",
"required": true,
"schema": {
"title": "deviceName",
"type": "string"
}
},
{
"name": "format",
"type": "string",
"info": "The format to be returned - this is ignored as we always return json",
"required": false,
"schema": {
"title": "format",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/getConfig"
},
"task": false
},
{
"name": "iapGetDeviceCount",
"summary": "Gets a device count from the system",
"description": "Gets a device count from the system",
"input": [],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapGetDeviceCount"
},
"task": false
},
{
"name": "iapExpandedGenericAdapterRequest",
"summary": "Makes the requested generic call with additional options",
"description": "Makes the requested generic call with additional options via metadata",
"input": [
{
"name": "metadata",
"type": "object",
"info": "metadata for the call (optional)",
"description": "metadata for the call - allows for many enhancements (optional)",
"schema": {
"title": "metadata",
"type": "object"
},
"required": false
},
{
"name": "uriPath",
"type": "string",
"info": "the path of the api call - do not include the host, port, base path or version",
"description": "the path of the api call",
"schema": {
"title": "uriPath",
"type": "string"
},
"required": false
},
{
"name": "restMethod",
"type": "string",
"info": "the rest method (GET, POST, PUT, PATCH, DELETE)",
"description": "the rest method (GET, POST, PUT, PATCH, DELETE)",
"schema": {
"title": "restMethod",
"type": "string"
},
"required": false
},
{
"name": "pathVars",
"type": "object",
"info": "the parameters to be put within the url path (optional)",
"description": "the parameters to be put within the url path (optional)",
"schema": {
"title": "pathVars",
"type": "object"
},
"required": false
},
{
"name": "queryData",
"type": "object",
"info": "the query parameters to be put on the url (optional)",
"description": "the query parameters to be put on the url (optional)",
"schema": {
"title": "queryData",
"type": "object"
},
"required": false
},
{
"name": "requestBody",
"type": "object",
"info": "the payload to be sent with the request (optional)",
"description": "the payload to be sent with the request (optional)",
"schema": {
"title": "requestBody",
"type": "object"
},
"required": false
},
{
"name": "addlHeaders",
"type": "object",
"info": "additional headers to be put on the call (optional)",
"description": "additional headers to be put on the call (optional)",
"schema": {
"title": "addlHeaders",
"type": "object"
},
"required": false
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapExpandedGenericAdapterRequest"
},
"task": true
},
{
"name": "genericAdapterRequest",
"summary": "Makes the requested generic call",
"description": "Makes the requested generic call",
"input": [
{
"name": "uriPath",
"type": "string",
"info": "the path of the api call - do not include the host, port, base path or version",
"description": "the path of the api call",
"schema": {
"title": "uriPath",
"type": "string"
},
"required": true
},
{
"name": "restMethod",
"type": "string",
"info": "the rest method (GET, POST, PUT, PATCH, DELETE)",
"description": "the rest method (GET, POST, PUT, PATCH, DELETE)",
"schema": {
"title": "restMethod",
"type": "string"
},
"required": true
},
{
"name": "queryData",
"type": "object",
"info": "the query parameters to be put on the url (optional)",
"description": "the query parameters to be put on the url (optional)",
"schema": {
"title": "queryData",
"type": "object"
},
"required": false
},
{
"name": "requestBody",
"type": "object",
"info": "the payload to be sent with the request (optional)",
"description": "the payload to be sent with the request (optional)",
"schema": {
"title": "requestBody",
"type": "object"
},
"required": false
},
{
"name": "addlHeaders",
"type": "object",
"info": "additional headers to be put on the call (optional)",
"description": "additional headers to be put on the call (optional)",
"schema": {
"title": "addlHeaders",
"type": "object"
},
"required": false
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/genericAdapterRequest"
},
"task": true
},
{
"name": "genericAdapterRequestNoBasePath",
"summary": "Makes the requested generic call",
"description": "Makes the requested generic call",
"input": [
{
"name": "uriPath",
"type": "string",
"info": "the path of the api call - do not include the host, port, base path or version",
"description": "the path of the api call",
"schema": {
"title": "uriPath",
"type": "string"
},
"required": true
},
{
"name": "restMethod",
"type": "string",
"info": "the rest method (GET, POST, PUT, PATCH, DELETE)",
"description": "the rest method (GET, POST, PUT, PATCH, DELETE)",
"schema": {
"title": "restMethod",
"type": "string"
},
"required": true
},
{
"name": "queryData",
"type": "object",
"info": "the query parameters to be put on the url (optional)",
"description": "the query parameters to be put on the url (optional)",
"schema": {
"title": "queryData",
"type": "object"
},
"required": false
},
{
"name": "requestBody",
"type": "object",
"info": "the payload to be sent with the request (optional)",
"description": "the payload to be sent with the request (optional)",
"schema": {
"title": "requestBody",
"type": "object"
},
"required": false
},
{
"name": "addlHeaders",
"type": "object",
"info": "additional headers to be put on the call (optional)",
"description": "additional headers to be put on the call (optional)",
"schema": {
"title": "addlHeaders",
"type": "object"
},
"required": false
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/genericAdapterRequestNoBasePath"
},
"task": true
},
{
"name": "iapRunAdapterLint",
"summary": "Run the adapter lint script to return the results",
"description": "Run the adapter lint script to return the results",
"input": [],
"output": {
"name": "result",
"type": "string",
"description": "A string containing the run results",
"schema": {
"title": "result",
"type": "string"
}
},
"roles": [
"admin"
],
"route": {
"verb": "GET",
"path": "/iapRunAdapterLint"
},
"task": true
},
{
"name": "iapRunAdapterTests",
"summary": "Run the adapter test scripts (baseunit and unit) to return the results",
"description": "Run the adapter test scripts (baseunit and unit) to return the results",
"input": [],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "GET",
"path": "/iapRunAdapterTests"
},
"task": true
},
{
"name": "iapGetAdapterInventory",
"summary": "Provide inventory information abbout the adapter",
"description": "Provide inventory information abbout the adapter",
"input": [],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "GET",
"path": "/iapGetAdapterInventory"
},
"task": true
},
{
"name": "aclCreate",
"summary": "ACL Create",
"description": "Creates a new Access Control List (ACL) in the TCPWave IPAM. This list is used to control the behavior of DNS when applied to the Allow-Notify, Allow-Query, Allow-Transfer etc. ACL cannot be created when the object(s) or subnet(s) or network(s) used to create ACL are not managed in the IPAM.\n Below example shows sample request JSON:\n {\"aclElementList\":\\[{\"exclude\":0,\"sequence\":1,\"value\":\"10.2.3.5\"}\\],\"name\":\"test-client\",\"description\":\"Testing REST API\"}",
"input": [
{
"name": "body",
"type": "object",
"info": "ACL details: object",
"required": true,
"schema": {
"title": "body",
"type": "object"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/aclCreate"
},
"task": true
},
{
"name": "aclUpdate",
"summary": "ACL Edit",
"description": "Updates an existing Access Control List(ACL) in the TCPWave IPAM. ACL cannot be updated when the object(s) or subnet(s) or network(s) used\n to update ACL are not managed in the IPAM.\n Below example shows sample request JSON:\n {\"name\":\"test-client\",\"newName\":\"new-test-client\",\"description\":\"ACL added to the TCPWave IPAM by Professional Services\",\"aclElementList\":[{\"value\":\"10.24.6.8\",\"sequence\":\"1\",\"exclude\":\"0\"},{\"value\":\"10.24.6.9\",\"sequence\":\"2\",\"exclude\":\"0\"},{\"value\":\"10.24.11.9\",\"sequence...(description truncated)",
"input": [
{
"name": "body",
"type": "object",
"info": "ACL details: object",
"required": true,
"schema": {
"title": "body",
"type": "object"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/aclUpdate"
},
"task": true
},
{
"name": "aclList",
"summary": "ACL List",
"description": "Obtains the list of Access Control List(ACL) defined and managed by the TCPWave IPAM which are used to control the behavior of DNS when applied to the Allow-Notify, Allow-Query, Allow-Transfer etc.",
"input": [],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "GET",
"path": "/aclList"
},
"task": true
},
{
"name": "aclGet",
"summary": "ACL Details",
"description": "Provides the list of Access Control List(ACL) in the TCPWave IPAM which are used to control the behavior of DNS when applied to the Allow-Notify, Allow-Query, Allow-Transfer etc.",
"input": [
{
"name": "name",
"type": "string",
"info": "ACL Name: string",
"required": true,
"schema": {
"title": "name",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/aclGet"
},
"task": true
},
{
"name": "aclGetReferences",
"summary": "ACL References",
"description": "Provides the list of Option Templates, Zone Templates and AD enabled Zones in the TCPWave IPAM which use specific Access Control List(ACL)",
"input": [
{
"name": "name",
"type": "string",
"info": "ACL Name: string",
"required": true,
"schema": {
"title": "name",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/aclGetReferences"
},
"task": true
},
{
"name": "aclMultiDelete",
"summary": "ACL Delete Multiple",
"description": "Deletes multiple existing Access Control Lists(ACLs) from the TCPWave IPAM data repository. This action is audited. Below example shows sample request JSON: [\"test-client\"]",
"input": [
{
"name": "body",
"type": "array",
"info": "List of ACL names: array",
"required": true,
"schema": {
"title": "body",
"type": "array"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/aclMultiDelete"
},
"task": true
},
{
"name": "aclPage",
"summary": "Search ACL",
"description": "Provides the list of searched Access Control List(ACL) on search screen in the TCPWave IPAM.",
"input": [
{
"name": "page",
"type": "number",
"info": "Page Number: 123",
"required": false,
"schema": {
"title": "page",
"type": "number"
}
},
{
"name": "rows",
"type": "number",
"info": "Number of Rows: 123",
"required": false,
"schema": {
"title": "rows",
"type": "number"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/aclPage"
},
"task": true
},
{
"name": "adUserAdd",
"summary": "Active Directory User Add",
"description": "Creates a mapping of existing Active Directory Domain Services (AD DS) to User Principal Name (UPN) into the TCPWave IPAM. A UPN is the name of a system user in an e-mail address format.Example: username@user.associated.internet.domain.\nBelow example shows sample request JSON:\n{\"dc_ip\":\"10.1.2.3\",\"dnsDomainName\":\"apac.nsroot.net\",\"dnsIp\":\"10.1.2.4\",\"dnsServerName\":\"server1\",\"encryption_type\":\"RC4-HMAC-NT\",\"file_data\":\"File Data\",\"file_name\":\"filename\",\"principal_name\":\"server1@domain.com\",\"princ...(description truncated)",
"input": [
{
"name": "body",
"type": "object",
"info": ": object",
"required": false,
"schema": {
"title": "body",
"type": "object"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/adUserAdd"
},
"task": true
},
{
"name": "adUserList",
"summary": "Active Directory User list",
"description": "Obtains a list of Active Directory Domain Services (AD DS) User Principal Name (UPN) which Obtains a List of all permissions associated with a given admin group. Functional Admin can list the permissions of any admin group. Rest of the Admins are restricted to the admin groups that belong to their organization. A UPN is the name of a system user in an e-mail address format. Example: username@user.associated.internet.domain.",
"input": [],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "GET",
"path": "/adUserList"
},
"task": true
},
{
"name": "adUserDelete",
"summary": "Active Directory User Delete",
"description": "Removes mapping of existing Active Directory Domain Services (AD DS) User Principal Name (UPN) from the TCPWave IPAM. Beloew example shows sample example\n[{\n\"dnsIp\": \"192.168.0.215\",\n\"encryption_type\": \"RC4-HMAC-NT\",\n\"id\": 8,\n\"principal_name\": \"TCPWave00001Remote.domain.com\",\n\"principal_type\": \"KRB5_NT_PRINCIPAL\",\n\"realm\": \"DOMAIN.COM\",\n\"service_type\": \"LOCAL\"\n}]",
"input": [
{
"name": "body",
"type": "array",
"info": "List of ActiveDirectory details: array",
"required": true,
"schema": {
"title": "body",
"type": "array"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/adUserDelete"
},
"task": true
},
{
"name": "adUserAuthenticate",
"summary": "Authenticate Active Directory User",
"description": "Validates authentication between TCPWave DNS and Active Directory Domain Services (AD DS) using Kerberos authentication to use the interoperability features provided by the Kerberos Key Distribution Center (KDC) service.\n Below example shows sample request JSON:\n {\"service_type\":\"DNS\",\"principal_name\":\"DEV-DNSROOT-AUTH-001.plab.tcpwave.com\",\"principal_type\":\"KRB5_NT_PRINCIPAL\",\"realm\":\"TCPWAVE.COM\",\"dnsIp\":\"10.1.10.187\",\"encryption_type\":\"RC4-HMAC-NT\",\"dc_ip\":\"10.1.10.170\"}",
"input": [
{
"name": "body",
"type": "object",
"info": "ActiveDirectory details: object",
"required": true,
"schema": {
"title": "body",
"type": "object"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/adUserAuthenticate"
},
"task": true
},
{
"name": "del",
"summary": "Admin Group Delete",
"description": "Deletes an existing Admin group. Functional Admin can delete an Admin Group belonging to any organization. Super Admin and User Admin can update Admin Groups only in the organization that they belong to.\n Below example shows sample request JSON:\n{\"name\":\"QA Admin group-1\",\"organization_name\":\"QAOrg\"}",
"input": [
{
"name": "id",
"type": "number",
"info": "Admin Group ID: 123",
"required": false,
"schema": {
"title": "id",
"type": "number"
}
},
{
"name": "name",
"type": "string",
"info": "Admin Group Name: string",
"required": true,
"schema": {
"title": "name",
"type": "string"
}
},
{
"name": "organizationId",
"type": "string",
"info": "Organization ID associated with Admin Group: string",
"required": false,
"schema": {
"title": "organizationId",
"type": "string"
}
},
{
"name": "organizationName",
"type": "string",
"info": "Organization Name associated with Admin Group: string",
"required": true,
"schema": {
"title": "organizationName",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/del"
},
"task": true
},
{
"name": "edit",
"summary": "Admin Group Modify",
"description": "Updates an existing Admin group. Functional Admin can update an Admin Group belonging to any organization. Super Admin and User Admin can update Admin Groups only in the organization that they belong to.\n Below example shows sample request JSON:\n{ \"*name\"*:\"QA Admin group-1\", \"*oldName\"*:\"*QA Admin group\"*, \"*organization_name\"*:\"*QAOrg\"* \"description\":\"Admin group\"}",
"input": [
{
"name": "body",
"type": "object",
"info": ": object",
"required": false,
"schema": {
"title": "body",
"type": "object"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/edit"
},
"task": true
},
{
"name": "adminGroupPage",
"summary": "Search Admin Group",
"description": "Search all admin groups associated with an organization in the TCPWave IPAM.",
"input": [
{
"name": "page",
"type": "number",
"info": "total result pages: 123",
"required": true,
"schema": {
"title": "page",
"type": "number"
}
},
{
"name": "rows",
"type": "number",
"info": "rows per page: 123",
"required": true,
"schema": {
"title": "rows",
"type": "number"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/adminGroupPage"
},
"task": true
},
{
"name": "get",
"summary": "Admin Group Details",
"description": "Obtains details of all Admin Groups defined and managed by the TCPWave IPAM. Functional Admin gets the list of all admin groups. Rest of the Admins get only the list of admin groups associated with the organization that they belong to.",
"input": [
{
"name": "adminGroupId",
"type": "number",
"info": "Admin Group ID: 123",
"required": false,
"schema": {
"title": "adminGroupId",
"type": "number"
}
},
{
"name": "adminGroupName",
"type": "string",
"info": "Admin Group Name: string",
"required": true,
"schema": {
"title": "adminGroupName",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/get"
},
"task": true
},
{
"name": "list",
"summary": "Admin Group List",
"description": "Obtains a List of all Admin Groups defined and managed by the TCPWave IPAM. Functional Admin gets the list of all admin groups. Rest of the Admins get only the list of admin groups associated with the organization that they belong to.",
"input": [
{
"name": "orgId",
"type": "number",
"info": "Organization ID: 123",
"required": false,
"schema": {
"title": "orgId",
"type": "number"
}
},
{
"name": "orgName",
"type": "string",
"info": "Organization Name: string",
"required": true,
"schema": {
"title": "orgName",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/list"
},
"task": true
},
{
"name": "create",
"summary": "Admin Group Add",
"description": "Creates a new admin group. Functional Admin can create an Admin Group in any organization. Super Admin and User Admin can create Admin Groups only in the organization that they belong to.\n Below example shows sample request JSON:\n{ \"*name\"*:\"QA Admin group\", \"*organization_name\"*:\"QAOrg\", \"*description\"*:\"*Admin group\"* }",
"input": [
{
"name": "body",
"type": "object",
"info": ": object",
"required": false,
"schema": {
"title": "body",
"type": "object"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/create"
},
"task": true
},
{
"name": "categoryList",
"summary": "Threshold Category List",
"description": "Obtains a list of monitored service categories to subscribe for email notifications in the TCPWave IPAM.",
"input": [],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "GET",
"path": "/categoryList"
},
"task": true
},
{
"name": "listCategoryMonitorService",
"summary": "List Monitoring Services",
"description": "Obtains a list of monitoring services for the given category to subscribe for alarm notifications in the TCPWave IPAM.",
"input": [
{
"name": "category",
"type": "string",
"info": "Category: string",
"required": true,
"schema": {
"title": "category",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/listCategoryMonitorService"
},
"task": true
},
{
"name": "listComponents",
"summary": "List Alarm Subscription Components",
"description": "Obtains a list of components such as Network, Subnet, Zone, IPAM etc for the given monitoring services in the TCPWave IPAM.",
"input": [
{
"name": "serviceList",
"type": "string",
"info": "Comma separated list of monitoring services: string",
"required": true,
"schema": {
"title": "serviceList",
"type": "string"
}
},
{
"name": "orgName",
"type": "string",
"info": "Organization name: string",
"required": true,
"schema": {
"title": "orgName",
"type": "string"
}
},
{
"name": "draw",
"type": "number",
"info": "Page Draw Param: 123",
"required": false,
"schema": {
"title": "draw",
"type": "number"
}
},
{
"name": "start",
"type": "number",
"info": "Starting Appliance Group Range: 123",
"required": true,
"schema": {
"title": "start",
"type": "number"
}
},
{
"name": "length",
"type": "number",
"info": "Page Length: 123",
"required": true,
"schema": {
"title": "length",
"type": "number"
}
},
{
"name": "filterRules",
"type": "string",
"info": "Filter String: string",
"required": false,
"schema": {
"title": "filterRules",
"type": "string"
}
},
{
"name": "sort",
"type": "string",
"info": "Sort String: string",
"required": false,
"schema": {
"title": "sort",
"type": "string"
}
},
{
"name": "order",
"type": "string",
"info": "Sort Order(asc/desc): string",