---
title: Security Management
slug: epmm/v1web-service-api-guide/security-management
createdAt: 2026-10-06T08:06:05.546Z
---

The Security Management API addresses authentication tasks. These tasks apply to both local users and LDAP users.

## Update Password for a User

This API changes the password for a single user. 

**Example**:

https\://\<Ivanti EPMM>/api/v1/sm/authentication/users/jdoe

For security reasons, include the old and new passwords in the HTTP request body rather than as query parameters. For example:

PUT /api/v1/sm/authentication/users/jdoe HTTP/1.1

Host: \<Ivanti EPMM>

Content-Length: 44

Accept: application/json

Authorization: Basic \<token>

Content-Type: application/x-www-form-urlencoded

oldpassword=abcd1234\&newpassword=wxy!13579

| URI:<br />https\:///api/v1/sm/authentication/users/ | Updates password for input username.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| --------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Http Method:                                        | PUT                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| Format:                                             | xml, json                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| Request:                                            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| username                                            | Required.<br /><br />Unique login user name.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| oldpassword                                         | Current password of the user.<br /><br />Note: For security reasons, include this parameter in HTTP request body.<br /><br />Required only if the Ivanti EPMM setting to save the user password is set to Yes.  You can set this value in the Admin Portal, using Settings \| Preferences.<br /><br />When oldpassword is required, make sure that the value you provide in the request is correct. If it is not included or is not correct, the response contains a failure message.<br /><br />Note: When you create a local user using the API to [Register a Device](docId\:xVPydpQ15KAOMBsuI5Iwg), Ivanti EPMM sets the user’s password to the user ID (called username in this request). |
| newpassword                                         | Required.<br /><br />New password of the user.<br /><br />The password must be between 8 and 20 characters.<br /><br />Note: For security reasons, include this parameter in HTTP request body.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
|                                                     |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| Response Status Code:                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| ‘404 – No Data Found’                               | There is no data.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| ‘200 – OK’                                          | Data is present and the response is returned.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| Response:                                           |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| \<securityManagementWebServiceResponse>             |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| \<userName>jdoe\</userName>                         |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| \<messages>                                         |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| \<message>                                          |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| Password changed successfully for user: jdoe        | Status Message.<br />Success shown if the method execution is successful.<br />A descriptive error message is shown if the method execution failed.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| \</ message >                                       |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| \</messages>                                        |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| \</securityManagementWebServiceResponse>            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |

## Find a User

This API finds a single user by username or email address. User details will be returned only if the search finds an exact match of the username or email address. 

**Example**:

https\://\<Ivanti EPMM>/api/v1/sm/users/jdoe

| URI:<br />https\:///api/v1/sm/users/                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | Finds the user specified for input username or email address |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------ |
| Http Method:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | GET                                                          |
| Format:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         | xml, json                                                    |
| Request:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |                                                              |
|                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |                                                              |
| Response Status Code:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |                                                              |
| ‘404 – No Data Found’                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           | There is no data.                                            |
| ‘200 – OK’                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | Data is present and the response is returned.                |
| Response:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |                                                              |
| \<securityManagementWebServiceResponse><br />    \<userName>miadmin\</userName><br />    \<messages/><br />    \<user id="9001"><br />        \<uuid>f89d8cbf-59d7-47e6-97c2-4681ed8f954a\</uuid><br />        \<principal>miadmin\</principal><br />        \<createdAt>1374085200000\</createdAt><br />        \<displayName>miadmin\</displayName><br />        \<email>miadmin\@Ivanti.com\</email><br />        \<enabled>true\</enabled><br />        \<firstName>miadmin\</firstName><br />        \<forcePasswordChange>false\</forcePasswordChange><br />        \<googleAppsEncryptionAlgVersion>0\</googleAppsEncryptionAlgVersion><br />        \<lastAdminPortalLoginTime>1374178220915\</lastAdminPortalLoginTime><br />        \<lastName>\</lastName><br />        \<opaque>true\</opaque><br />        \<roles>ROLE\_MPW\_LOCK\</roles><br />        \<roles>ROLE\_USER\_MANAGEMENT\_RW\</roles><br />        \<roles>ROLE\_MAI\_RW\</roles><br />        \<roles>ROLE\_APPS\_AND\_FILES\_RW\</roles><br />        \<roles>ROLE\_SENTRY\_FOR\_IPAD\</roles><br />        \<roles>ROLE\_ADMIN\_LOCATE\</roles><br />        \<roles>ROLE\_LOG\_R\</roles><br />        \<roles>ROLE\_TROUBLESHOOTING\_RW\</roles><br />        \<roles>ROLE\_EVENT\_CENTER\_RW\</roles><br />        \<roles>ROLE\_ADMIN\_WIPE\</roles><br />        \<roles>ROLE\_SELECTIVE\_WIPE\</roles><br />        \<roles>ROLE\_MPW\_REG\</roles><br />        \<roles>ROLE\_SECURITY\_AND\_POLICIES\_RW\</roles><br />        \<roles>ROLE\_MPW\_LOCATE\</roles><br />        \<roles>ROLE\_API\</roles><br />        \<roles>ROLE\_SMARTPHONES\_AND\_DEVICES\_RW\</roles><br />        \<roles>ROLE\_MPW\_WIPE\</roles><br />        \<roles>ROLE\_USER\_PORTAL\_RW\</roles><br />        \<roles>ROLE\_CONNECTOR\</roles><br />        \<roles>ROLE\_SETTINGS\_RW\</roles><br />        \<userSource>76\</userSource><br />    \</user><br />\</securityManagementWebServiceResponse> |                                                              |

## Search LDAP Users

This API finds users by username. The search string cannot be less than 2 characters. If the search results are more than the search limit (can be configured in mifs.properties) an error is returned. Default search limit is 100.

**Example**:

https\://\<Ivanti EPMM>/api/v1/sm/users/search/ldap/?userid=jdoe

| URI:<br />https\:///api/v1/sm/users/search/ldap/                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | Finds the users for the specified username search string.                                                             |
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- |
| Http Method:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | GET                                                                                                                   |
| Format:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 | xml, json                                                                                                             |
| Request:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |                                                                                                                       |
| userid                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | Required.<br />Username search string. Minimum 2 characters.                                                          |
| Response Status Code:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |                                                                                                                       |
| ‘404 – No Data Found’                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   | There is no data.                                                                                                     |
| ‘200 – OK’                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | Data is present and the response is returned.                                                                         |
| ‘400- Bad Request’                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | 1. If the input search string is less than 2 characters.<br />2. If the search results are more than the limit.<br /> |
| Response:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |                                                                                                                       |
| \<securityManagementWebServiceResponse><br />    \<userName>testuser000\</userName><br />    \<messages/><br />    \<users><br />        \<user><br />            \<principal>testuser0001\</principal><br />            \<displayName>testuser0001\</displayName><br />            \<email>testuser0001\@auto1.Ivanti.com\</email><br />            \<enabled>false\</enabled><br />            \<firstName>Test\</firstName><br />            \<forcePasswordChange>false\</forcePasswordChange><br />            \<lastName>User0001\</lastName><br />            \<opaque>true\</opaque><br />            \<userSource>68\</userSource><br />        \</user>   <br />        \<user><br />            \<principal>testuser0003\</principal><br />            \<displayName>testuser0003\</displayName><br />            \<email>testuser0003\@auto1.Ivanti.com\</email><br />            \<enabled>false\</enabled><br />            \<firstName>Test\</firstName><br />            \<forcePasswordChange>false\</forcePasswordChange><br />            \<lastName>User0003\</lastName><br />            \<opaque>true\</opaque><br />            \<userSource>68\</userSource><br />        \</user><br />\</users><br />\</securityManagementWebServiceResponse> |                                                                                                                       |

## Authenticate a User

This API authenticates a single user by username. 

**Example**:

https\://\<Ivanti EPMM>/api/v1/sm/authentication

For security reasons, include the password in the HTTP request body rather than as a query parameter. For example:

POST /api/v1/sm/authentication HTTP/1.1

Host: \<Ivanti EPMM>

Content-Length: 31

Accept: application/json

Authorization: Basic \<token>

username=jdoe\&password=abcd1234

| URI:<br />https\:///api/v1/sm/users/                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | Finds the user specified for input username.                                                                                                              |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Http Method:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | POST                                                                                                                                                      |
| Format:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         | xml, json                                                                                                                                                 |
| Request:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |                                                                                                                                                           |
| username                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | String<br />Required<br /><br />Note: For security reasons, include this parameter in HTTP request body.                                                  |
| Password                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | String<br />Required<br />The password must be between 8 and 20 characters.<br />Note: For security reasons, include this parameter in HTTP request body. |
| Response Status Code:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |                                                                                                                                                           |
| ‘401 – Unauthorized’                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | If the username/password is invalid.                                                                                                                      |
| ‘200 – OK’                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | If username and password are valid then User details are returned in the response.                                                                        |
| Response:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |                                                                                                                                                           |
| \<securityManagementWebServiceResponse><br />    \<userName>miadmin\</userName><br />    \<messages/><br />    \<user id="9001"><br />        \<uuid>f89d8cbf-59d7-47e6-97c2-4681ed8f954a\</uuid><br />        \<principal>miadmin\</principal><br />        \<createdAt>1374085200000\</createdAt><br />        \<displayName>miadmin\</displayName><br />        \<email>miadmin\@Ivanti.com\</email><br />        \<enabled>true\</enabled><br />        \<firstName>miadmin\</firstName><br />        \<forcePasswordChange>false\</forcePasswordChange><br />        \<googleAppsEncryptionAlgVersion>0\</googleAppsEncryptionAlgVersion><br />        \<lastAdminPortalLoginTime>1374178220915\</lastAdminPortalLoginTime><br />        \<lastName>\</lastName><br />        \<opaque>true\</opaque><br />        \<roles>ROLE\_MPW\_LOCK\</roles><br />        \<roles>ROLE\_USER\_MANAGEMENT\_RW\</roles><br />        \<roles>ROLE\_MAI\_RW\</roles><br />        \<roles>ROLE\_APPS\_AND\_FILES\_RW\</roles><br />        \<roles>ROLE\_SENTRY\_FOR\_IPAD\</roles><br />        \<roles>ROLE\_ADMIN\_LOCATE\</roles><br />        \<roles>ROLE\_LOG\_R\</roles><br />        \<roles>ROLE\_TROUBLESHOOTING\_RW\</roles><br />        \<roles>ROLE\_EVENT\_CENTER\_RW\</roles><br />        \<roles>ROLE\_ADMIN\_WIPE\</roles><br />        \<roles>ROLE\_SELECTIVE\_WIPE\</roles><br />        \<roles>ROLE\_MPW\_REG\</roles><br />        \<roles>ROLE\_SECURITY\_AND\_POLICIES\_RW\</roles><br />        \<roles>ROLE\_MPW\_LOCATE\</roles><br />        \<roles>ROLE\_API\</roles><br />        \<roles>ROLE\_SMARTPHONES\_AND\_DEVICES\_RW\</roles><br />        \<roles>ROLE\_MPW\_WIPE\</roles><br />        \<roles>ROLE\_USER\_PORTAL\_RW\</roles><br />        \<roles>ROLE\_CONNECTOR\</roles><br />        \<roles>ROLE\_SETTINGS\_RW\</roles><br />        \<userSource>76\</userSource><br />    \</user><br />\</securityManagementWebServiceResponse> |                                                                                                                                                           |