Invalidate customer credentials

Here, you can learn how to make an API call to invalidate customer credentials. Once the call succeeds, your customer cannot authenticate using the invalidated credentials.

Sample API call

To create customer credentials, make the following API call.

https://auth-api.sandbox.tuumplatform.com/api/v1/credentials/invalidate

Learn more about the endpoint in the Tuum developer portal.

Invalidate customer credentials

POST https://auth-api.sandbox.tuumplatform.com/api/v1/credentials/invalidate

Learn more about the endpoint in the Tuum developer portal.

Sample request

Below is an example request body of the API call to invalidate customer credentials.

JSON

{
"personId": "ID-1038",
"username": "customer_username",
"password": "customer_password"
}

cURL

curl 'https://auth-api.sandbox.tuumplatform.com/api/v1/credentials/invalidate' \
-H 'x-auth-token: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHBpcnlEVGltZSI6IjIwMjMtMDctMjhUMTM6MjE6MTYiLCJyb2xlcyI6WyJBRE1JTiJdLCJuYW1lIjoiSm9obiBPZmZpY2VyIiwiZW1wbG95ZWVJZCI6IjEiLCJ0ZW5hbnRDb2RlIjoiTUIiLCJleHAiOjE2OTA1NTA0NzZ9.KFAC4t3rgo6Cc2yr9V2-h6ZfgOyKLXyI9u22FLa_gvQ' \
-H 'Content-Type: application/json' \
-d '{
"personId": "ID-1038",
"username": "customer_username",
"password": "customer_password"
}'

Please make sure to input the username and password of the particular customer when submitting your request.

To make a successful API call, you must include the JSON Web Token of the authenticated employee with specific user rights as a header parameter with the value of x-auth-token. Kindly adhere to the instructions given in the explanations for header parameters.

Sample response

Below you find an example response body to the API call above.

Response

{
    "errors": null,
    "validationErrors": null,
    "data": null
}

Result

After making the API call, the customer's credentials become invalid, making it impossible to authenticate themselves.