TrackRecordPro API Documentation TrackRecordPro

password endpoint

Created by Craig Edwards, last modified on 10 Oct 2017

Summary

API Endpoint Address

https://api.trackrecordpro.co.uk/3.0/password

Minimum Supported API Version3.0
Supported Methods

GET
POST
PUT
DELETE

Access LevelEveryone
DescriptionThis endpoint allows changing of passwords for users. You cannot specify a password when adding a user with the users endpoint POST or PUT methods, so after a new user is added you must call this endpoint to set their password which hashes their password accordingly.

POST password

POST /3.0/password HTTP/1.1

Details

Changing the password of one or more users is done by setting a filter in the URL, and POSTing one JSON field in an object, called new_password:

{"new_password": "mypass123"}

Once this is done the system will confirm the password change. Note that you can change the password for one user (by using a url such as /3.0/users/id=1) or for multiple users (e.g. /3.0/users/email~comech.co.uk)

{
    "request": {
        "url": "\/3.0\/password\/id=2",
        "endpoint": "password",
        "requested_version": "3.0",
        "api_version": 3,
        "request_method": "Post",
        "timestamp": 1507622071,
        "session": null
    },
    "response": {
        "records_updated": 1,
        "records_found": 1
    }
}