Tenant Password Update Request - GET

Tenant Password Update Request - GET API Endpoint
StoRegister - Tenant

Tenant Password Update Request API

This endpoint is designed to generate a concurrency stamp for updating the password, preventing duplicate requests. The response will include the newly generated concurrency stamp, which must be sent along with the change password payload to execute the operation successfully.

This API endpoint follows a RESTful architecture, allowing tenants to securely update their passwords by ensuring the uniqueness of each request.

GET
/v1/tenant/profile/change-password/request
Request Content Type
application/json
Response Content Type
application/json

Request Header

  • Authorization: X-API-Key string required

    X-API-Key is a string of letters and numbers used to authenticate and control access to the API. It can be generated in the StoRegister management application.

  • Authorization: X-Token string required

    X-Token represents the user session token. It is a string of characters that uniquely identifies the user's session.

Response Payload:

  • succeeded boolean

    Indicates whether the request to generate the change password concurrency stamp was successful.

  • status string

    escribes the status of the request to generate the change password concurrency stamp.

  • data unique-identifier

    Contains the concurrency stamp for changing the password.

  • errors array

    Holds any error information if applicable.

Request Header

Authorization: X-API-Key --api-key--
Authorization: X-Token --token--

API Response

{
    "data": "A55C13AC-FDCC-45B0-8BE5-138DBA9902E4",
    "succeeded": true,
    "status": "SUCCESS",
    "errors": null
}

Error Codes

  • INVALID_PARAM_CONTACT_BOOK_ID

    INVALID_PARAM_CONTACT_BOOK_ID refers to invalid contact id or invaild user id to retrieve contact details.

  • INVALID_CONTACT_BOOK_DETAILS_INFO

    INVALID_CONTACT_BOOK_DETAILS_INFO refers to unmatched contact details.

  • CONCURRENCY_STAMP_CREATE_FAILED

    CONCURRENCY_STAMP_CREATE_FAILED refers to unable to create concurrency stamp.

  • NO_RECORDS_FOUND

    NO_RECORDS_FOUND means there is no relevant information found.

  • FAILED

    FAILED refers to an unsuccessful API call.

  • SOMETHING_WENT_WRONG

    SOMETHING_WENT_WRONG refers to technical glitch. Please contact administrator.
API Reference documentation