Users

Revoke user tokens

Changed on

Sign 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 URL
    https://api.commpeak.com/textpeak
  • URL
    https://api.commpeak.com/textpeak/users/revoke_tokens
  • Auth
    API key in header Authorization

Request body

usernamesstring[] required

E-mail addresses of the users to sign out. Only users of your own account are affected.

Example request

{
  "usernames": [
    "test@example.com"
  ]
}

Response

Successful Response

statusstring required

Always success when the request was valid.

messagestring required

Revocation process completed., or Revocation process completed. No tokens were revoked.

Example response

{
  "message": "Revocation process completed.",
  "results": [
    {
      "status": "revoked",
      "username": "test@example.com"
    }
  ],
  "status": "success"
}

Changes