Skip to end of banner
Go to start of banner

POST users/change_password

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 8 Current »

Available from CRM.COM R12.5.0, CRM.COM R13.2.0 and CRM.COM R14.0.0 onwards

This method changes a user's password. A single user's password is changed by each call

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

user_identifier

(mandatory)

User IdentifierThe user's identifier. The allowed user identifier fields are the following

Name

Type

Description

id

(semi-optional)

String

The ID of the user

username

(semi-optional)

String

The username of the user

old_password

(mandatory)

StringThe user's old password

password

(mandatory)

StringThe user's new password

password_confirmation

(mandatory)

StringThe user's new password confirmation

Restrictions

  • It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.

Response Data

N/A

Examples

 Example 1

HTTP Method: POST

 

Request

 

Body

 {
    "token": "{{token}}",
    "user_identifier":{"username":"trainee4"},
    "old_password":"crm.com",
    "password":"crm.com1",
    "password_confirmation":"crm.com1"
}

 

Response

 
  • No labels