--- title: Add SAPM Account slug: single-connect-api-3-2-0/add-sapm-account description: Learn how to send a POST request using cURL with customized headers and data in this comprehensive code example document. Master the art of efficient and secure data transmission. docTags: createdAt: 2022-11-10T14:24:52.000Z --- { "id": "w-nEStfH90PqpRXUFZA1j", "data": { "url": "{{url}}/aioc-rest-web/rest/sc/sapm/addSapmAccount", "method": "POST", "request": { "pathParameters": [], "queryParameters": [], "headerParameters": [ { "name": "Content-Type", "type": "string", "example": "application/json", "description": "" }, { "name": "Cookie", "type": "string", "example": "{{netrightCookie}} ", "description": "" }, { "name": "X-XSRF-TOKEN", "type": "string", "example": "{{csrftoken}}", "description": "" } ], "bodyDataParameters": [ { "name": "body", "type": "string", "example": "{\t\n\t\"secretName\":\"sapm-dynamic-type\",\n\t\"privateType\":\"YES\",\n\t\"secretType\":\"DYNAMIC\",\n\t\"sapmUserName\":\"root\",\n\t\"password\":\"root\",\n\t\"sapmGroupDbId\":85220,\n\t\"sapmConfigId\":82796,\n\t\"passwordChangePeriod\":\"25\",\n\t\"deviceId\":\"8cc08d2f-36f8-44fa-9c17-47ae77d1a70d\"\n}", "description": "" } ], "formDataParameters": [] }, "responses": [ { "statusCode": "200", "description": "

Add Sapm Account(Dynamic Account)

", "jsonExample": "" }, { "statusCode": "200", "description": "

Add Sapm Account (static strategy - other)

", "jsonExample": "" }, { "statusCode": "200", "description": "

Add Sapm Account (Static Strategy, SSL )

", "jsonExample": "" }, { "statusCode": "200", "description": "Add SAPM Account", "jsonExample": "{\n \"dbId\": 00000,\n \"device\": {\n \"dbId\":0000,\n \"id\": \"4b144118-2505-43a9-6fab60f296f\",\n \"name\": \"10.20.40.00\",\n \"accessProtocol\": \"SSHv2\",\n \"managementIp\": \"10.20.40.00\",\n \"elementType\": {\n \"dbId\": 00000,\n \"elementTypeId\": \"linux\",\n \"elementTypeName\": \"Linux Server\",\n \"vendor\": null,\n \"category\": null,\n \"elementTypeProperties\": [\n {\n \"dbId\": 00000,\n \"elementTypePropertyValue\": \"hostname\",\n \"elementTypePropertyKey\": \"discovery.commands.hostname\",\n \"elementTypePropertyType\": null\n },\n {\n \"dbId\": 00000,\n \"elementTypePropertyValue\": \"uname\",\n \"elementTypePropertyKey\": \"discovery.commands.version.command\",\n \"elementTypePropertyType\": null\n },\n {\n \"dbId\": -00000,\n \"elementTypePropertyValue\": \"abort\",\n \"elementTypePropertyKey\": \"enforcer.terminal.behaviour.ctrl_c\",\n \"elementTypePropertyType\": null\n },\n {\n \"dbId\": -00000,\n \"elementTypePropertyValue\": \"^Enter the date.*\",\n \"elementTypePropertyKey\": \"enforcer.terminal.behaviour.exc_last_line_patterns\",\n \"elementTypePropertyType\": null\n },\n {\n \"dbId\": -00000,\n \"elementTypePropertyValue\": \"^Are you sure.*\",\n \"elementTypePropertyKey\": \"enforcer.terminal.behaviour.exc_last_line_patterns\",\n \"elementTypePropertyType\": null\n },\n {\n \"dbId\": -00000,\n \"elementTypePropertyValue\": \".*(?i)password[:|>].*\",\n \"elementTypePropertyKey\": \"enforcer.terminal.behaviour.exc_last_line_patterns\",\n \"elementTypePropertyType\": null\n },\n {\n \"dbId\": -00000,\n \"elementTypePropertyValue\": \"do_nothing\",\n \"elementTypePropertyKey\": \"enforcer.terminal.behaviour.ctrl_z\",\n \"elementTypePropertyType\": null\n },\n {\n \"dbId\": -00000,\n \"elementTypePropertyValue\": \".*?(>|\\\\$|#|%)\",\n \"elementTypePropertyKey\": \"enforcer.terminal.behaviour.prompt_pattern\",\n \"elementTypePropertyType\": null\n },\n {\n \"dbId\": -00000,\n \"elementTypePropertyValue\": \"-1\",\n \"elementTypePropertyKey\": \"shell.terminal.config.fixed_pty_columns\",\n \"elementTypePropertyType\": null\n },\n {\n \"dbId\": -00000,\n \"elementTypePropertyValue\": \"^Quit.*\",\n \"elementTypePropertyKey\": \"enforcer.terminal.behaviour.exc_last_line_patterns\",\n \"elementTypePropertyType\": null\n },\n {\n \"dbId\": -00000,\n \"elementTypePropertyValue\": \"^Select choice.*\",\n \"elementTypePropertyKey\": \"enforcer.terminal.behaviour.exc_last_line_patterns\",\n \"elementTypePropertyType\": null\n },\n {\n \"dbId\": 00000,\n \"elementTypePropertyValue\": \"Linux\",\n \"elementTypePropertyKey\": \"discovery.model.match.regex\",\n \"elementTypePropertyType\": null\n }\n ]\n },\n \"discoveryTime\": 00000,\n \"properties\": {\n \"pseudoDevice\": \"true\"\n },\n \"deviceGroups\": [\n \"4dd39f0b-2cb1-4089-8281-3912e7b904e0\"\n ],\n \"availability\": null,\n \"currentMaintenanceWindow\": null,\n \"interfaceName\": null,\n \"nameManagementIp\": \"10.20.40.184-10.20.40.184\",\n \"regionName\": null,\n \"pseudoDevice\": true,\n \"domainController\": null,\n \"portNum\": null,\n \"discoverySource\": null\n },\n \"config\": {\n \"configId\": -00000,\n \"name\": \"Linux\",\n \"description\": \"Linux\",\n \"strategy\": \"SSH\",\n \"properties\": {\n \"username.parser\": \"(.*?):.*\",\n \"new.user.found.action\": \"LOG\",\n \"user.list.command\": \"cat /etc/passwd\",\n \"check.password.validation\": \"true\",\n \"change.password.command.template\": \"passwd\\\\n${oldPassword}\\\\n${newPassword}\\\\n${newPassword}\\\\nlogout\"\n },\n \"exactMatch4Search\": false,\n \"recordLimit4Search\": null\n },\n \"changePeriod\": 00000,\n \"username\": \"sapm2\",\n \"password\": \"5B5bycR3kOdleJw0UI86BQ==\",\n \"previousPassword\": \"IGrfdOMqFwhnVxTYOTFVKA==\",\n \"lastChangeTime\": 00000,\n \"nextChangeTime\": 00000,\n \"nextChangeTimeStart4Search\": null,\n \"nextChangeTimeEnd4Search\": null,\n \"passwordSeenStatus\": \"UNSEEN\",\n \"validationStatus\": \"VALID\",\n \"changeStatus\": null,\n \"lastAttemptStatus\": true,\n \"masterAccountId\": null,\n \"permissions\": {},\n \"identicalSapmAccounts\": [],\n \"recordLimit4Search\": null,\n \"validationStatus4Search\": null,\n \"checkPermission4Search\": true,\n \"exactMatch4Search\": false,\n \"acceptedSapmConfigList\": null,\n \"masterAccountId4Search\": null,\n \"searchOnlyMasterAccounts\": false,\n \"searchOnlyOwnRegion\": false,\n \"deviceIp4Search\": null,\n \"secondPartSeenUsername\": null,\n \"firstPartSeenUsername\": null,\n \"changePeriodFormatted\": \"05d 00h 00m\"\n}" }, { "statusCode": "200", "description": "

Add SAPM Account(User Credential)

", "jsonExample": "{\n \"dbId\": 61293,\n \"device\": null,\n \"secretName\": \"sapm-staticstrategy-usercred\",\n \"config\": {\n \"configId\": -2000003,\n \"name\": \"Static User Credentials\",\n \"description\": \"Static User Credentials\",\n \"strategy\": \"STATIC\",\n \"staticSecretType\": \"USER_CREDENTIAL\",\n \"properties\": {\n \"static.secret.type\": \"USER_CREDENTIAL\"\n },\n \"exactMatch4Search\": false,\n \"recordLimit4Search\": null\n },\n \"changePeriod\": 36000,\n \"username\": \"user-1\",\n \"description\": null,\n \"password\": \"QeLRh2OVGzo45m7aS3dpDfC0Qbqd2kA2bOcCdsYfkKnRCfrzEBLyg8zjzPzLHuNVrVwNi5LDjrvk9YtynUXUpA==\",\n \"previousPassword\": null,\n \"lastChangeTime\": 1599046840499,\n \"nextChangeTime\": 1599133240499,\n \"nextChangeTimeStart4Search\": null,\n \"nextChangeTimeEnd4Search\": null,\n \"passwordSeenStatus\": \"UNSEEN\",\n \"validationStatus\": null,\n \"changeStatus\": null,\n \"lastAttemptStatus\": null,\n \"masterAccountId\": null,\n \"permissions\": {},\n \"newPermission\": {},\n \"permissionToDelete\": {},\n \"groupManagerToDelete\": null,\n \"identicalSapmAccounts\": [],\n \"recordLimit4Search\": null,\n \"validationStatus4Search\": null,\n \"checkPermission4Search\": true,\n \"acceptedSapmConfigList\": null,\n \"searchOnlyMasterAccounts\": false,\n \"searchOnlyOwnRegion\": false,\n \"deviceIp4Search\": null,\n \"secondPartSeenUsername\": null,\n \"firstPartSeenUsername\": null,\n \"errorMessage\": null,\n \"successful\": true,\n \"parentSapmGroup\": {\n \"dbId\": 9257,\n \"id\": \"9bcb8c02-ec4b-4ad4-8825-c071c9eac8d1\",\n \"name\": \"test group\",\n \"description\": null,\n \"parentSapmGroupId\": null,\n \"permissions\": {},\n \"newPermission\": {},\n \"permissionToDelete\": {},\n \"children\": [],\n \"userCreate\": \"admin\",\n \"parent\": null,\n \"userPermissionLevel\": 3,\n \"managers\": [],\n \"newGroupManager\": null,\n \"groupManagerToDelete\": null,\n \"approvalStatus\": null,\n \"fullPath\": null,\n \"approvalRequired\": false,\n \"manager\": false,\n \"newApprovalRequired\": false,\n \"auditor\": false\n },\n \"parentSapmName4Search\": null,\n \"secretType\": \"STATIC\",\n \"userCreate\": \"admin\",\n \"managers\": [],\n \"newGroupManager\": null,\n \"userPermissionLevel\": -2147483648,\n \"privateType\": \"YES\",\n \"approvalStatus\": null,\n \"parentSapmGroupDbId\": 9257,\n \"groupFullPath\": \"/test group\",\n \"approvedBy\": null,\n \"approvedDate\": null,\n \"getFullPermissionUser\": false,\n \"skipFillPermission\": false,\n \"sqlSearchSapmParent\": [],\n \"firstResult\": null,\n \"maxResult\": null,\n \"exactMatch4Search\": false,\n \"masterAccountId4Search\": null,\n \"changePeriodFormatted\": \"25d 00h 00m\",\n \"accountWithDynamicStrategy\": false,\n \"approvalRequired\": false,\n \"manager\": false\n}" }, { "statusCode": "200", "description": "

Add Sapm Account(Static Type, Dynamic Stategy)

", "jsonExample": "" }, { "statusCode": "200", "description": "

Add Sapm Account -(Static Strategy SSH key)

", "jsonExample": "" } ], "contentType": "application/json", "description": "

You can add SAPM account using this API. There are several different examples given. As response, it will return the created SAPM Account.

", "examples": { "languages": [ { "id": "RVCZfO0aPENKaGJ9U5pVd", "language": "curl", "label": "cURL", "code": "curl --request POST \\\n --url {{url}}/aioc-rest-web/rest/sc/sapm/addSapmAccount \\\n --header 'accept: application/json'" }, { "id": "eAn53BB80nkwtYJOgCs8_", "language": "javascript", "label": "javascript", "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\n\nvar requestOptions = {\n method: 'POST',\n headers: myHeaders,\n redirect: 'follow'\n};\n\nfetch(\"{{url}}/aioc-rest-web/rest/sc/sapm/addSapmAccount\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "oanbuI_BDyCkO90QHsCF5", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"net/http\"\n\nurl = URI(\"{{url}}/aioc-rest-web/rest/sc/sapm/addSapmAccount\")\n\nhttp = Net::HTTP.new(url.host, url.port);\nrequest = Net::HTTP::Post.new(url)\nrequest[\"accept\"] = \"application/json\"\n\nresponse = http.request(request)\nputs response.read_body\n" }, { "id": "b1-723yaertZzB5UF0kFd", "language": "python", "label": "Python", "code": "import requests\n\nurl = \"{{url}}/aioc-rest-web/rest/sc/sapm/addSapmAccount\"\n\npayload = {}\nheaders = {\n 'accept': 'application/json'\n}\n\nresponse = requests.request(\"POST\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "selectedLanguageId": "RVCZfO0aPENKaGJ9U5pVd" }, "results": { "languages": [ { "id": "m7ceLPug8cn4S5INuI1hV", "language": "200", "code": "// Add Sapm Account(Dynamic Account)\n" }, { "id": "QIvqFLSfZeHg9aUqE2uWY", "language": "200", "code": "// Add Sapm Account (static strategy - other)\n" }, { "id": "NKw-hc5WsprbX4KUSsOzb", "language": "200", "code": "// Add Sapm Account (Static Strategy, SSL )\n" }, { "id": "ai66tOeKH4MTHqeQ2kG7N", "language": "200", "code": "{\n \"dbId\": 00000,\n \"device\": {\n \"dbId\":0000,\n \"id\": \"4b144118-2505-43a9-6fab60f296f\",\n \"name\": \"10.20.40.00\",\n \"accessProtocol\": \"SSHv2\",\n \"managementIp\": \"10.20.40.00\",\n \"elementType\": {\n \"dbId\": 00000,\n \"elementTypeId\": \"linux\",\n \"elementTypeName\": \"Linux Server\",\n \"vendor\": null,\n \"category\": null,\n \"elementTypeProperties\": [\n {\n \"dbId\": 00000,\n \"elementTypePropertyValue\": \"hostname\",\n \"elementTypePropertyKey\": \"discovery.commands.hostname\",\n \"elementTypePropertyType\": null\n },\n {\n \"dbId\": 00000,\n \"elementTypePropertyValue\": \"uname\",\n \"elementTypePropertyKey\": \"discovery.commands.version.command\",\n \"elementTypePropertyType\": null\n },\n {\n \"dbId\": -00000,\n \"elementTypePropertyValue\": \"abort\",\n \"elementTypePropertyKey\": \"enforcer.terminal.behaviour.ctrl_c\",\n \"elementTypePropertyType\": null\n },\n {\n \"dbId\": -00000,\n \"elementTypePropertyValue\": \"^Enter the date.*\",\n \"elementTypePropertyKey\": \"enforcer.terminal.behaviour.exc_last_line_patterns\",\n \"elementTypePropertyType\": null\n },\n {\n \"dbId\": -00000,\n \"elementTypePropertyValue\": \"^Are you sure.*\",\n \"elementTypePropertyKey\": \"enforcer.terminal.behaviour.exc_last_line_patterns\",\n \"elementTypePropertyType\": null\n },\n {\n \"dbId\": -00000,\n \"elementTypePropertyValue\": \".*(?i)password[:|>].*\",\n \"elementTypePropertyKey\": \"enforcer.terminal.behaviour.exc_last_line_patterns\",\n \"elementTypePropertyType\": null\n },\n {\n \"dbId\": -00000,\n \"elementTypePropertyValue\": \"do_nothing\",\n \"elementTypePropertyKey\": \"enforcer.terminal.behaviour.ctrl_z\",\n \"elementTypePropertyType\": null\n },\n {\n \"dbId\": -00000,\n \"elementTypePropertyValue\": \".*?(>|\\\\$|#|%)\",\n \"elementTypePropertyKey\": \"enforcer.terminal.behaviour.prompt_pattern\",\n \"elementTypePropertyType\": null\n },\n {\n \"dbId\": -00000,\n \"elementTypePropertyValue\": \"-1\",\n \"elementTypePropertyKey\": \"shell.terminal.config.fixed_pty_columns\",\n \"elementTypePropertyType\": null\n },\n {\n \"dbId\": -00000,\n \"elementTypePropertyValue\": \"^Quit.*\",\n \"elementTypePropertyKey\": \"enforcer.terminal.behaviour.exc_last_line_patterns\",\n \"elementTypePropertyType\": null\n },\n {\n \"dbId\": -00000,\n \"elementTypePropertyValue\": \"^Select choice.*\",\n \"elementTypePropertyKey\": \"enforcer.terminal.behaviour.exc_last_line_patterns\",\n \"elementTypePropertyType\": null\n },\n {\n \"dbId\": 00000,\n \"elementTypePropertyValue\": \"Linux\",\n \"elementTypePropertyKey\": \"discovery.model.match.regex\",\n \"elementTypePropertyType\": null\n }\n ]\n },\n \"discoveryTime\": 00000,\n \"properties\": {\n \"pseudoDevice\": \"true\"\n },\n \"deviceGroups\": [\n \"4dd39f0b-2cb1-4089-8281-3912e7b904e0\"\n ],\n \"availability\": null,\n \"currentMaintenanceWindow\": null,\n \"interfaceName\": null,\n \"nameManagementIp\": \"10.20.40.184-10.20.40.184\",\n \"regionName\": null,\n \"pseudoDevice\": true,\n \"domainController\": null,\n \"portNum\": null,\n \"discoverySource\": null\n },\n \"config\": {\n \"configId\": -00000,\n \"name\": \"Linux\",\n \"description\": \"Linux\",\n \"strategy\": \"SSH\",\n \"properties\": {\n \"username.parser\": \"(.*?):.*\",\n \"new.user.found.action\": \"LOG\",\n \"user.list.command\": \"cat /etc/passwd\",\n \"check.password.validation\": \"true\",\n \"change.password.command.template\": \"passwd\\\\n${oldPassword}\\\\n${newPassword}\\\\n${newPassword}\\\\nlogout\"\n },\n \"exactMatch4Search\": false,\n \"recordLimit4Search\": null\n },\n \"changePeriod\": 00000,\n \"username\": \"sapm2\",\n \"password\": \"5B5bycR3kOdleJw0UI86BQ==\",\n \"previousPassword\": \"IGrfdOMqFwhnVxTYOTFVKA==\",\n \"lastChangeTime\": 00000,\n \"nextChangeTime\": 00000,\n \"nextChangeTimeStart4Search\": null,\n \"nextChangeTimeEnd4Search\": null,\n \"passwordSeenStatus\": \"UNSEEN\",\n \"validationStatus\": \"VALID\",\n \"changeStatus\": null,\n \"lastAttemptStatus\": true,\n \"masterAccountId\": null,\n \"permissions\": {},\n \"identicalSapmAccounts\": [],\n \"recordLimit4Search\": null,\n \"validationStatus4Search\": null,\n \"checkPermission4Search\": true,\n \"exactMatch4Search\": false,\n \"acceptedSapmConfigList\": null,\n \"masterAccountId4Search\": null,\n \"searchOnlyMasterAccounts\": false,\n \"searchOnlyOwnRegion\": false,\n \"deviceIp4Search\": null,\n \"secondPartSeenUsername\": null,\n \"firstPartSeenUsername\": null,\n \"changePeriodFormatted\": \"05d 00h 00m\"\n}" }, { "id": "H3N6_m43Aw9V8fHyww49a", "language": "200", "code": "{\n \"dbId\": 61293,\n \"device\": null,\n \"secretName\": \"sapm-staticstrategy-usercred\",\n \"config\": {\n \"configId\": -2000003,\n \"name\": \"Static User Credentials\",\n \"description\": \"Static User Credentials\",\n \"strategy\": \"STATIC\",\n \"staticSecretType\": \"USER_CREDENTIAL\",\n \"properties\": {\n \"static.secret.type\": \"USER_CREDENTIAL\"\n },\n \"exactMatch4Search\": false,\n \"recordLimit4Search\": null\n },\n \"changePeriod\": 36000,\n \"username\": \"user-1\",\n \"description\": null,\n \"password\": \"QeLRh2OVGzo45m7aS3dpDfC0Qbqd2kA2bOcCdsYfkKnRCfrzEBLyg8zjzPzLHuNVrVwNi5LDjrvk9YtynUXUpA==\",\n \"previousPassword\": null,\n \"lastChangeTime\": 1599046840499,\n \"nextChangeTime\": 1599133240499,\n \"nextChangeTimeStart4Search\": null,\n \"nextChangeTimeEnd4Search\": null,\n \"passwordSeenStatus\": \"UNSEEN\",\n \"validationStatus\": null,\n \"changeStatus\": null,\n \"lastAttemptStatus\": null,\n \"masterAccountId\": null,\n \"permissions\": {},\n \"newPermission\": {},\n \"permissionToDelete\": {},\n \"groupManagerToDelete\": null,\n \"identicalSapmAccounts\": [],\n \"recordLimit4Search\": null,\n \"validationStatus4Search\": null,\n \"checkPermission4Search\": true,\n \"acceptedSapmConfigList\": null,\n \"searchOnlyMasterAccounts\": false,\n \"searchOnlyOwnRegion\": false,\n \"deviceIp4Search\": null,\n \"secondPartSeenUsername\": null,\n \"firstPartSeenUsername\": null,\n \"errorMessage\": null,\n \"successful\": true,\n \"parentSapmGroup\": {\n \"dbId\": 9257,\n \"id\": \"9bcb8c02-ec4b-4ad4-8825-c071c9eac8d1\",\n \"name\": \"test group\",\n \"description\": null,\n \"parentSapmGroupId\": null,\n \"permissions\": {},\n \"newPermission\": {},\n \"permissionToDelete\": {},\n \"children\": [],\n \"userCreate\": \"admin\",\n \"parent\": null,\n \"userPermissionLevel\": 3,\n \"managers\": [],\n \"newGroupManager\": null,\n \"groupManagerToDelete\": null,\n \"approvalStatus\": null,\n \"fullPath\": null,\n \"approvalRequired\": false,\n \"manager\": false,\n \"newApprovalRequired\": false,\n \"auditor\": false\n },\n \"parentSapmName4Search\": null,\n \"secretType\": \"STATIC\",\n \"userCreate\": \"admin\",\n \"managers\": [],\n \"newGroupManager\": null,\n \"userPermissionLevel\": -2147483648,\n \"privateType\": \"YES\",\n \"approvalStatus\": null,\n \"parentSapmGroupDbId\": 9257,\n \"groupFullPath\": \"/test group\",\n \"approvedBy\": null,\n \"approvedDate\": null,\n \"getFullPermissionUser\": false,\n \"skipFillPermission\": false,\n \"sqlSearchSapmParent\": [],\n \"firstResult\": null,\n \"maxResult\": null,\n \"exactMatch4Search\": false,\n \"masterAccountId4Search\": null,\n \"changePeriodFormatted\": \"25d 00h 00m\",\n \"accountWithDynamicStrategy\": false,\n \"approvalRequired\": false,\n \"manager\": false\n}" }, { "id": "tgzSFzQh-DeO3OYVSeoCH", "language": "200", "code": "// Add Sapm Account(Static Type, Dynamic Stategy)\n" }, { "id": "onfcc4-hcyXNkGelnl67I", "language": "200", "code": "// Add Sapm Account -(Static Strategy SSH key)\n" } ], "selectedLanguageId": "m7ceLPug8cn4S5INuI1hV" } }, "type": "api-oas-v2", "children": [ { "text": "" } ] }