Use the users API endpoint with the POST method to expire a user’s password.
When you expire a user’s password, the system prompts the user to choose a new password the next time they sign in to ProntoForms.
Prerequisites
Note the User ID of the user whose password you want to expire.
Base URL
https://api.prontoforms.com
Endpoint
POST
/api/1.1/users/{UserID}/expirepassword
Expires a user’s password.
URL structure
Copy
https://api.prontoforms.com/api/1.1/users/{userID}/expirepasswordRequest parameters
None
Request header
Include the standard authorization header. This includes the username and password, where username is the API Key ID and password is the API Key Secret.
cURL examples
curl -v -k -u {username}:{password} -X POST https://api.prontoforms.com/api/1.1/users/{UserID}/expirepasswordwhere username is the API Key ID and password is the API Key Secret.
Request body
None
Response codes
200—OK
Response examples
This endpoint does not return a response body.
Error codes
| Error code | Error message | HTTP response code | Description |
|---|---|---|---|
| AccessDenied | Access Denied: You are not allowed to access the requested resource. | 403 | The user doesn’t exist in your team. |
| ObjectNotFound | Object Not Found: The object you requested could not be found. | 404 | The system couldn’t find the user. Verify that the User ID is correct. |
Comments
0 comments
Please sign in to leave a comment.