Users
Revoke user tokens
Changed onSign users of your account out of the TextPeak platform by revoking their refresh tokens. They must log in again once their current session expires.
When to use. Offboarding a user, or responding to a suspected credential leak. Users outside your account are reported as unauthorized and are not affected.
Authentication: TextPeak API key in the Authorization header (see Authentication in the API Overview).
post/users/revoke_tokens
Request
- Base URLhttps://api.commpeak.com/textpeak
- URLhttps://api.commpeak.com/textpeak/users/revoke_tokens
- AuthAPI key in header Authorization
Request body
Example request
{
"usernames": [
"test@example.com"
]
}Response
Successful Response
Example response
{
"message": "Revocation process completed.",
"results": [
{
"status": "revoked",
"username": "test@example.com"
}
],
"status": "success"
}Changes
- info
endpoint added
- info