Skip to main content
Browse Documentation
HTTP - Management

Force a user to reset their password on next login

Created by c.neale, last modified by m.summerfield on 18 Aug 2022

An administrator can force a user to reset their password when they next login by POST'ing an action with type 'forcePasswordReset' to the user's actions endpoint.

POST/api/security/users/{userIdentifier}/actions/

Parameter

NameParameter typeTypeFormatDescriptionExampleRequired
UserIdentifierpathstringuser identifierFor convenience, User resources can be referenced by using one of several identifiers - username, email address or Id."82f73a9b-2a13-4d63-bcc1-e8ee5047b01c" or "t.durden" or "t.durden@fightclub.com"true

Example

Force a password reset

HTTP
POST: /api/security/users/82f73a9b-2a13-4d63-bcc1-e8ee5047b01c/actions/ { "type": "forcePasswordReset" }

Remarks

Permissions

Member of System Administrators.

Responses

HTTP status codeReasonModel
204Success
403ForbiddenError
404User not foundError
422Validation errorError
500Internal server errorError