Resources

Configure remote password reset

Configure remote password reset for resources. The RESOURCETYPE field determines which parameters apply. Supported resource types and their specific parameters:

Linux — REMOTEMODE, LINUX_SSHTELNETPORT, LINUX_USERPROMPT, LINUX_LANDINGSERVER, RESOURCEIDENTIFIER, REMOTELOGINACCOUNT, AUTHENTICATION (passauth/keyauth), ELEVATIONTYPE (su/sudo), ROOTACCOUNT, LINUXROOTUSERPROMPT, REMOVEENTER, WDRESOURCEID, WDACCOUNTID

MS SQL Server — MSSQL_AUTHENTICATION (mssql_auth/win_auth), MSSQL_PORT, MSSQL_ACCOUNT, MSSQL_INSTANCE_NAME, WINAUTH_RESOURCE_NAME, WINAUTH_ACCOUNT_NAME, CONNECTION_MODE (SSL)

SAP — SAP_SYSTEM_NUMBER, SAP_ADMIN_ACCOUNT (both mandatory)

Windows — ISWINLOCAL (true=local account, false=domain account), ACCOUNTNAME (when local), WDRESOURCEID + WDACCOUNTID (when domain)

Windows Domain — ISWINDOMAINLOCAL (true=local, false=domain), ACCOUNTNAME (when local), WDRESOURCEID + WDACCOUNTID (when domain), CONNECTION_MODE (SSL/Non SSL)

post/restapi/json/v1/resources/configureremotepasswordreset

Request

Headers

orgNamestring

Name of the Organization (for MSP/multi-org deployments)

Request body application/x-www-form-urlencoded

Example request

{
  "operation": {
    "Details": {
      "RESOURCETYPE": "Linux",
      "RESOURCEIDS": [
        "301",
        "302"
      ],
      "REMOTEMODE": "ssh",
      "LINUX_SSHTELNETPORT": "22",
      "LINUX_USERPROMPT": "$",
      "LINUX_LANDINGSERVER": "test",
      "RESOURCEIDENTIFIER": "linux",
      "REMOTELOGINACCOUNT": "test",
      "AUTHENTICATION": "passauth",
      "ELEVATIONTYPE": "sudo",
      "ROOTACCOUNT": "root",
      "LINUXROOTUSERPROMPT": "#",
      "REMOVEENTER": "false",
      "MSSQL_AUTHENTICATION": "mssql_auth",
      "MSSQL_PORT": "1433",
      "MSSQL_ACCOUNT": "sa",
      "MSSQL_INSTANCE_NAME": "sample",
      "SAP_SYSTEM_NUMBER": "00",
      "SAP_ADMIN_ACCOUNT": "test",
      "ACCOUNTNAME": "admin",
      "ISWINLOCAL": "false",
      "ISWINDOMAINLOCAL": "true",
      "WDRESOURCEID": "1",
      "WDACCOUNTID": "1",
      "CONNECTION_MODE": "SSL",
      "WINAUTH_RESOURCE_NAME": "Windows Server Operation",
      "WINAUTH_ACCOUNT_NAME": "Admin"
    }
  }
}

Response

Remote password reset configured

Example response

{
  "operation": {
    "Details": {
      "CONFIGURATION RESULT": [
        {
          "MESSAGE": "SUCCESS",
          "STATUS": "true",
          "RESOURCENAME": "sql",
          "RESOURCEID": "601"
        }
      ]
    },
    "name": "CONFIGURE REMOTE PASSWORD RESET"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.