OAuth2

Logout OAuth client session

Revokes the current OAuth client session for the authenticated user, clears auth cookies, and returns the auth UI logout URL.

post/oauth/logout

Request

  • Base URL: https://api.carbonvoice.app
  • URL: https://api.carbonvoice.app/oauth/logout
  • Auth: one of:
    • API key in header pxtoken
    • OAuth 2 (implicit, authorization URL https://api.carbonvoice.app/oauth/authorize)

Request body

post_logout_redirect_uristring

Where to send the browser after the auth UI finishes logout. Must match an allowed logout or callback URL for the client.

Example request

{
  "post_logout_redirect_uri": "https://developer.carbonvoice.app/auth-callback"
}

Response

auth_logout_urlstring required

Auth UI logout URL that clears the provider session before returning to the requesting app.

post_logout_redirect_uristring required

Validated URL that the auth UI will redirect back to after logout.

Example response

{
  "auth_logout_url": "https://auth.carbonvoice.app/rlogout?post_logout_redirect_uri=https%3A%2F%2Fdeveloper.carbonvoice.app%2Fauth-callback",
  "post_logout_redirect_uri": "https://developer.carbonvoice.app/auth-callback"
}

Changes

No recorded changes to this operation across all 1 revision of this API.