Skip to content

Update password

Request

Updates the user's existing credentials with a new temporary password, which must be reset the next time they login.

Required permissions: apps:edit, [appId]:edit, authenticators:edit.

Security
ClientAccessToken
Path
user_idstringrequired

The ID of the user

Bodyapplication/jsonrequired
passwordstring

The user's new password

force_replaceboolean

When true the password is temporary and the user will be required to replace it upon successful login

Default:true
device_idstring

The device associated with this password update.

curl -i -X PUT \
  'https://api.sbx.transmitsecurity.io/cis/v1/users/{user_id}/password' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "password": "string",
    "force_replace": true,
    "device_id": "string"
  }'

Responses

Bodyapplication/json
resultobjectrequired
Response
{
  "result": {
    "message": "Password registered"
  }
}