Creates a User Management template to manage local user accounts on Windows target endpoints. The configuration is saved as a reusable template that can be deployed later. Each entry in configDetails carries one action - addUser, modifyUser, removeUser or changePassword - and several entries may be sent to act on several accounts in one template. Disabling, enabling, locking and unlocking an account are all modifyUser actions driven by the isAccountDisabled and isAccountLock flags. Use the returned templateId with the Deploy Configuration Template API to deploy it to targets.
post /dcapi/config-policies/v2/windows/userMgmt
https://{serverurl}/dcapi/config-policies/v2/windows/userMgmt Copied!
Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
Media type of the request body, as consumed by the endpoint.
Media type of the response body, as produced by the endpoint.
Name of the configuration. Returned as templateName in the response.
Free-text description of the configuration. May be an empty string.
What the configuration is applied to. Must be computer - User Management applies to computers only.
Reapply the configuration at every agent refresh, even when it has already been applied successfully.
Apply the configuration at endpoint startup.
Apply the configuration at the scheduled agent refresh.
Retry the configuration on the endpoint when it fails. noOfRetries sets how many attempts are made.
Honour refreshMinRetry as the minimum gap between two retries at refresh.
Honour logonStartupMinRetry as the minimum gap between two retries at startup or logon.
Number of retry attempts made after a failure. Read only when enableRetry is true.
Minimum number of minutes between two retries at refresh. Read only when enableRefreshMinRetry is true.
Minimum number of minutes between two retries at startup or logon. Read only when enableLogonStartupMinRetry is true.
One entry per user account action - addUser, modifyUser, removeUser or changePassword - applied in the order they appear.
What to do with the account named in userName. Allowed values:
addUser = creates a local account
modifyUser = changes an existing one
removeUser = deletes it
changePassword = resets its password
Disabling, enabling, locking and unlocking are all modifyUser actions driven by isAccountDisabled and isAccountLock - there is no separate disableUser or enableUser action. Mandatory, and matched case-insensitively.
Name of the local account the action applies to. Mandatory, and capped at 20 characters.
Full display name of the account. Read only for addUser and modifyUser.
Description shown against the account on the endpoint. Read only for addUser and modifyUser.
Password to set on the account: the initial password for addUser, or the new password for changePassword, where it is mandatory unless retainOldPassword is true. Sent encrypted and never returned. Windows does not ask for the existing password, so there is no oldPassword field.
Hint shown at the logon screen when the password is entered incorrectly. Read only for addUser and changePassword, and ignored when left empty.
Keep the password already saved against this configuration instead of applying the value in password. Read for addUser, modifyUser and changePassword, and honoured only while editing an existing template - on a new template there is no saved password to keep. Default: false
Overwrite the account when addUser is used and an account of that name already exists. Read only for addUser. Default: false
Also delete the account profile directory from the endpoint. Read only for removeUser. Default: false
Force the user to change the password at the next logon. Allowed values:
1 = enabled
2 = disabled
3 = not configured
Read only for addUser and modifyUser. It cannot be 1 at the same time as userCantChangePassword or pwdNeverExpires. Default: 3
Prevent the user from changing their own password. Allowed values:
1 = enabled
2 = disabled
3 = not configured
Read only for addUser and modifyUser. It cannot be 1 at the same time as userMustChangePassword. Default: 3
Exempt the account password from the expiry policy. Allowed values:
1 = enabled
2 = disabled
3 = not configured
Read only for addUser and modifyUser. It cannot be 1 at the same time as userMustChangePassword. Default: 3
Disable the account. Allowed values:
1 = enabled (the account is disabled)
2 = disabled (the account is usable)
3 = not configured
Read only for addUser and modifyUser - use modifyUser with this flag to disable or re-enable an account. Default: 3
Lock the account out. Allowed values:
1 = enabled (the account is locked)
2 = disabled (the account is unlocked)
3 = not configured
Read only for addUser and modifyUser. Default: 3
Where the home folder lives. Allowed values:
1 = a local path given by localPath
2 = a mapped drive given by connectMap and connectMapTo
Read only for addUser and modifyUser. Default: 1
Comma-separated local groups the account is added to (e.g., "users,administrators"). Read only for addUser and modifyUser. Default: "users"
Comma-separated local groups the account is removed from. Read only for modifyUser.
Path of a script run when the account logs on. Read only for addUser and modifyUser.
Path of the roaming profile directory for the account. Read only for addUser and modifyUser.
Local home folder path for the account. Read only for addUser and modifyUser, and only when homeFolder is 1.
Drive letter, from D: to Z:, the home folder is mapped to. Read only for addUser and modifyUser, and only when homeFolder is 2.
UNC path the home folder drive letter is mapped to (e.g., "\server\share"). Read only for addUser and modifyUser, and only when homeFolder is 2.
Send an email to the addresses listed in email once the deployment finishes.
Notify the endpoint user about this deployment. notificationDuration and notificationEnabledDays are read only when this is true.
Comma-separated email addresses notified about the deployment. May be an empty string when enableEmailNotify is false.
How long a deployment notification stays on screen for the endpoint user. Read only when enableNotification is true.
Number of days for which deployment notifications stay enabled. Read only when enableNotification is true.
curl --request POST \
--url https://appdomains/dcapi/config-policies/v2/windows/userMgmt \
--header 'Accept: application/json' \
--header 'Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52' \
--header 'Content-Type: application/json' \
--data '{"configDetails":[{"action":"addUser","userName":"testuser"}],"label":"Sample USER_MGMT Config","configType":"computer"}'Create a local account and add it to the Users group. The account flags take 1 = enabled, 2 = disabled, 3 = not configured; userMustChangePassword cannot be 1 at the same time as userCantChangePassword or pwdNeverExpires. homeFolder 1 selects a local home folder given by localPath.
{
"applyAtRefresh": false,
"applyAlways": false,
"description": "Created through the Config Policies API.",
"label": "Sample USER_MGMT Config",
"configType": "computer",
"applyAtStartupLogon": true,
"noOfRetries": 2,
"refreshMinRetry": 1,
"notificationEnabledDays": 3,
"enableLogonStartupMinRetry": false,
"logonStartupMinRetry": 1,
"configDetails": [
{
"addMember": "users",
"userDescription": "Local test account",
"userCantChangePassword": 2,
"isAccountDisabled": 2,
"fullName": "Test User",
"pwdNeverExpires": 2,
"userName": "testuser",
"userMustChangePassword": 1,
"password": "P@ssw0rd",
"homeFolder": 1,
"overwriteUser": false,
"localPath": "C:\\Users\\testuser",
"action": "addUser",
"isAccountLock": 3
}
],
"enableNotification": false,
"enableEmailNotify": false,
"notificationDuration": 6,
"enableRetry": false,
"enableRefreshMinRetry": false,
"email": ""
}
curl --request POST \
--url https://appdomains/dcapi/config-policies/v2/windows/userMgmt \
--header 'Accept: application/json' \
--header 'Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52' \
--header 'Content-Type: application/json' \
--data '{"configDetails":[{"action":"removeUser","userName":"olduser"}],"label":"Delete Test User","configType":"computer"}'Delete a local user account. The action is removeUser, and deleteUserProfile also removes the account profile directory from the endpoint.
{
"applyAtRefresh": false,
"applyAlways": false,
"description": "Created through the Config Policies API.",
"label": "Delete Test User",
"configType": "computer",
"applyAtStartupLogon": true,
"noOfRetries": 2,
"refreshMinRetry": 1,
"notificationEnabledDays": 3,
"enableLogonStartupMinRetry": false,
"logonStartupMinRetry": 1,
"configDetails": [
{
"deleteUserProfile": true,
"action": "removeUser",
"userName": "olduser"
}
],
"enableNotification": false,
"enableEmailNotify": false,
"notificationDuration": 6,
"enableRetry": false,
"enableRefreshMinRetry": false,
"email": ""
}
curl --request POST \
--url https://appdomains/dcapi/config-policies/v2/windows/userMgmt \
--header 'Accept: application/json' \
--header 'Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52' \
--header 'Content-Type: application/json' \
--data '{"configDetails":[{"action":"modifyUser","userName":"Guest"}],"label":"Disable Guest Account","configType":"computer"}'Disable a local user account. There is no disableUser action - use modifyUser and set isAccountDisabled to 1 (enabled).
{
"applyAtRefresh": false,
"applyAlways": false,
"description": "Created through the Config Policies API.",
"label": "Disable Guest Account",
"configType": "computer",
"applyAtStartupLogon": true,
"noOfRetries": 2,
"refreshMinRetry": 1,
"notificationEnabledDays": 3,
"enableLogonStartupMinRetry": false,
"logonStartupMinRetry": 1,
"configDetails": [
{
"userMustChangePassword": 3,
"userCantChangePassword": 3,
"isAccountDisabled": 1,
"action": "modifyUser",
"pwdNeverExpires": 3,
"userName": "Guest",
"isAccountLock": 3
}
],
"enableNotification": false,
"enableEmailNotify": false,
"notificationDuration": 6,
"enableRetry": false,
"enableRefreshMinRetry": false,
"email": ""
}
curl --request POST \
--url https://appdomains/dcapi/config-policies/v2/windows/userMgmt \
--header 'Accept: application/json' \
--header 'Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52' \
--header 'Content-Type: application/json' \
--data '{"configDetails":[{"action":"modifyUser","userName":"helpdesk"}],"label":"Enable Admin Account","configType":"computer"}'Re-enable a disabled local user account and remove it from the Administrators group. There is no enableUser action - use modifyUser and set isAccountDisabled to 2 (disabled).
{
"applyAtRefresh": false,
"applyAlways": false,
"description": "Created through the Config Policies API.",
"label": "Enable Admin Account",
"configType": "computer",
"applyAtStartupLogon": true,
"noOfRetries": 2,
"refreshMinRetry": 1,
"notificationEnabledDays": 3,
"enableLogonStartupMinRetry": false,
"logonStartupMinRetry": 1,
"configDetails": [
{
"userMustChangePassword": 3,
"removeMember": "administrators",
"userCantChangePassword": 3,
"isAccountDisabled": 2,
"action": "modifyUser",
"pwdNeverExpires": 3,
"userName": "helpdesk",
"isAccountLock": 2
}
],
"enableNotification": false,
"enableEmailNotify": false,
"notificationDuration": 6,
"enableRetry": false,
"enableRefreshMinRetry": false,
"email": ""
}
curl --request POST \
--url https://appdomains/dcapi/config-policies/v2/windows/userMgmt \
--header 'Accept: application/json' \
--header 'Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52' \
--header 'Content-Type: application/json' \
--data '{"configDetails":[{"action":"changePassword","userName":"helpdesk"}],"label":"Reset Helpdesk Password","configType":"computer"}'Reset the password of an existing local account. The action is changePassword and password carries the new value; retainOldPassword keeps the password already saved against the template instead. The existing password of the account is not required on Windows.
{
"applyAtRefresh": false,
"applyAlways": false,
"description": "Created through the Config Policies API.",
"label": "Reset Helpdesk Password",
"configType": "computer",
"applyAtStartupLogon": true,
"noOfRetries": 2,
"refreshMinRetry": 1,
"notificationEnabledDays": 3,
"enableLogonStartupMinRetry": false,
"logonStartupMinRetry": 1,
"configDetails": [
{
"password": "N3wP@ssw0rd",
"passwordHint": "Quarterly rotation",
"retainOldPassword": false,
"action": "changePassword",
"userName": "helpdesk"
}
],
"enableNotification": false,
"enableEmailNotify": false,
"notificationDuration": 6,
"enableRetry": false,
"enableRefreshMinRetry": false,
"email": ""
}
Success response returned when the configuration is saved as a reusable template.
Unique identifier of the created template. Pass it to the Deploy Configuration Template API to deploy this template to targets.
Name of the created template. It is the label sent in the request.
Type of configuration the template was created for. Allowed values:
computer
user
Login name of the API user who created the template.
Error response when the request contains invalid or missing required fields.
Product error code. 50003 = CONFIG_INVALID_INPUT_DATA: configDetails is missing or empty, or the configuration could not be resolved for this endpoint. 20003 = SERVICE_NOT_AVAILABLE: the configuration is deprecated for the requested configType.
Localised error message for the error code.
Unauthorized error code returned when authentication credentials are missing, expired, or invalid (authentication=required)
Authentication failure reason
Error response returned when the server does not have enough free disk space to store the configuration files.
Product error code. 170013 = INTERNAL_SERVER_ERROR: raised by the storage pre-check before the template is saved.
Localised error message for the error code.
Rate limit error code returned when the API call threshold (configured via threshold/duration in security XML) is exceeded; client is locked out for lock-period minutes
Rate limit exceeded message with retry guidance
Error response returned when the template could not be saved because of an unexpected server error.
Product error code. 1003 = INTERNAL_ERROR: the template could not be persisted. 50001 = CONFIG_INTERNAL_ERROR: an internal configuration error occurred while processing the request.
Localised error message for the error code.
Success response for deployUserMgmt
{
"templateName": "deployUserMgmt",
"templateId": 316,
"configType": "computer",
"addedUser": "admin"
}
Error response for deployUserMgmt
{
"errorCode": 50003,
"errorMsg": "Some Input field missing in configuration"
}
Success response for deleteUser
{
"templateName": "deleteUser",
"templateId": 317,
"configType": "computer",
"addedUser": "admin"
}
Error response for deleteUser
{
"errorCode": 50003,
"errorMsg": "Some Input field missing in configuration"
}
Success response for disableUser
{
"templateName": "disableUser",
"templateId": 318,
"configType": "computer",
"addedUser": "admin"
}
Error response for disableUser
{
"errorCode": 50003,
"errorMsg": "Some Input field missing in configuration"
}
Success response for enableUser
{
"templateName": "enableUser",
"templateId": 319,
"configType": "computer",
"addedUser": "admin"
}
Error response for enableUser
{
"errorCode": 50003,
"errorMsg": "Some Input field missing in configuration"
}
Success response for changeUserPassword
{
"templateName": "changeUserPassword",
"templateId": 320,
"configType": "computer",
"addedUser": "admin"
}
Error response for changeUserPassword - action is changePassword but password is missing
{
"errorCode": 50003,
"errorMsg": "Some Input field missing in configuration"
}
User is not authorized to create the configuration policy
{
"errorCode": 1001,
"errorMsg": "Access denied - You are not allowed to access the requested resource."
}
Storage pre-check rejected the request before the template was saved
{
"errorCode": 170013,
"errorMsg": "The server machine does not have sufficient disk space. Please free up space and try again."
}
Request rejected because the caller exceeded the configured rate limit
{
"errorCode": "IAM0019",
"url": "/dcapi/config-policies/v2/windows/userMgmt",
"errorMsg": "The URL /dcapi/config-policies/v2/windows/userMgmt was called too many times. Please retry after a while."
}
Unexpected server error while saving the configuration as a template
{
"errorCode": 1003,
"errorMsg": "An Internal Error occurred, try again later."
}
![]()
Duration: 1 minute | Threshold: 30 | Lock period: 5 minutes
Duration - Time window for the threshold.
Threshold - Number of API calls allowed within the specified duration.
Lock Period - Wait time before consecutive API requests.
© 2026, Zoho Corporation Pvt. Ltd. All Rights Reserved.