---
title: "Configure remote password reset"
method: POST
path: "/restapi/json/v1/resources/configureremotepasswordreset"
tags: ["Resources"]
---

# Configure remote password reset

`POST /restapi/json/v1/resources/configureremotepasswordreset`

## Request

- Base URL: `https://Hostname:Port`
- URL: `https://Hostname:Port/restapi/json/v1/resources/configureremotepasswordreset`
- Auth: API key in header `AUTHTOKEN`
- TypeScript: <https://skmtc.dev/manageengine/apis/pam360-rest-api/docs/restapi/json/v1/resources/configureremotepasswordreset/post.ts> (a function with typed inputs; its response is checked against the schema)

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)

## Headers

- `orgName` string

## Request body `application/x-www-form-urlencoded`

- ConfigureRemotePasswordResetRequest
  - `operation` object
    - `Details` object
      - `RESOURCETYPE` 'Linux' | 'MS SQL Server' | 'SAP' | 'Windows' | 'WindowsDomain', required: Type of resource. Determines which parameters apply.
      - `RESOURCEIDS` string[], required: List of resource IDs to configure
      - `REMOTEMODE` 'ssh' | 'telnet': [Linux] Remote login method
      - `LINUX_SSHTELNETPORT` string: [Linux] Port for SSH or Telnet connection
      - `LINUX_USERPROMPT` string: [Linux] Prompt displayed after user login
      - `LINUX_LANDINGSERVER` string: [Linux] Landing server to connect before target resource
      - `RESOURCEIDENTIFIER` string: [Linux] Identifies the resource type
      - `REMOTELOGINACCOUNT` string: [Linux] Account name used for remote login
      - `AUTHENTICATION` 'passauth' | 'keyauth': [Linux] Authentication method for login
      - `ELEVATIONTYPE` 'su' | 'sudo': [Linux] How elevated privileges are obtained
      - `ROOTACCOUNT` string: [Linux] Name of the root account
      - `LINUXROOTUSERPROMPT` string: [Linux] Prompt displayed for the root account
      - `REMOVEENTER` string: [Linux] Whether to remove extra Enter key during login
      - `MSSQL_AUTHENTICATION` 'mssql_auth' | 'win_auth': [MS SQL] Authentication mode
      - `MSSQL_PORT` string: [MS SQL] Port for database connection
      - `MSSQL_ACCOUNT` string: [MS SQL] SQL Server account for password reset
      - `MSSQL_INSTANCE_NAME` string: [MS SQL] Named instance identifier
      - `SAP_SYSTEM_NUMBER` string: [SAP] SAP system number (mandatory for SAP)
      - `SAP_ADMIN_ACCOUNT` string: [SAP] Administrator account for SAP system (mandatory for SAP)
      - `ACCOUNTNAME` string: [Windows/WindowsDomain] Account name for password reset (used with local account)
      - `ISWINLOCAL` string: [Windows] true=local account, false=domain account
      - `ISWINDOMAINLOCAL` string: [WindowsDomain] true=local account, false=domain account
      - `WDRESOURCEID` string: [Linux/Windows/WindowsDomain] Windows Domain resource ID (for domain-based auth)
      - `WDACCOUNTID` string: [Linux/Windows/WindowsDomain] Windows Domain account ID (for domain-based auth)
      - `CONNECTION_MODE` 'SSL' | 'Non SSL': [MS SQL/WindowsDomain] Connection security mode
      - `WINAUTH_RESOURCE_NAME` string: [MS SQL] Windows resource name for Windows authentication
      - `WINAUTH_ACCOUNT_NAME` string: [MS SQL] Account name for Windows authentication

## Response `200`

Remote password reset configured

- ConfigureRemotePasswordResetResponse
  - `operation` object
    - `result` OperationResult
      - `message` string: Result message describing the operation outcome
      - `status` string: Operation status
    - `Details` object
      - `CONFIGURATION RESULT` object[]: List of configuration results for each resource involved in the password reset setup
        - `MESSAGE` string: Message indicating the result of the configuration for the resource
        - `STATUS` string: Boolean-like string (`true` or `false`) indicating whether the configuration succeeded
        - `RESOURCENAME` string: Name of the resource for which the password reset was configured
        - `RESOURCEID` string: ID of the resource for which the password reset was configured
    - `name` string

---

[API](https://skmtc.dev/manageengine/apis/pam360-rest-api.md) - [All operations](https://skmtc.dev/manageengine/apis/pam360-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/manageengine/apis/pam360-rest-api/revisions/44a47abb4bdb?raw)