{"_id":"53ff947e23a37e1d5cebafca","parentDoc":null,"is_link":false,"project":"53fe6dc5addab8973c1af267","user":"53fe6d8baddab8973c1af266","editedParams2":true,"version":{"_id":"53fe6dc5addab8973c1af26a","__v":19,"project":"53fe6dc5addab8973c1af267","createdAt":"2014-08-27T23:46:13.941Z","releaseDate":"2014-08-27T23:46:13.941Z","categories":["53fe6dc5addab8973c1af26b","53fe71a2addab8973c1af276","53fe7d89addab8973c1af2b0","53fe7d8daddab8973c1af2b1","53fe836faddab8973c1af2ce","53ff9a4823a37e1d5cebafe1","53ff9e3723a37e1d5cebaff7","53ffaca523a37e1d5cebb039","53ffad2e23a37e1d5cebb03c","5400c7d2ec93b29b61d4f7be","5400f0e1ec93b29b61d4f7dd","54d5636323010a0d001aca81","54d565c1276f8e0d00feab54","54ff40532882a10d00546927","556606d25561af0d008208b7","558c91900b236c2500d37c9a","56180a14f8c9632100ac7599","564fb3a59b4fab1700187518","5702e2d2f2d6f336005e901f"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"__v":0,"category":{"_id":"53fe836faddab8973c1af2ce","__v":4,"version":"53fe6dc5addab8973c1af26a","pages":["53fe84c8addab8973c1af2d4","53ff936c23a37e1d5cebafc7","53ff947e23a37e1d5cebafca","55b27b2788093a21008bef06"],"project":"53fe6dc5addab8973c1af267","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2014-08-28T01:18:39.777Z","from_sync":false,"order":3,"slug":"api-reference","title":"API Reference"},"editedParams":true,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2014-08-28T20:43:42.112Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"basic_auth":false,"settings":"","try":false,"examples":{"codes":[]},"method":"post","results":{"codes":[{"name":"Success","code":"{\n    clef_id: '1234567',\n    success: true\n}","language":"json","status":200},{"status":403,"name":"Failure — Invalid App","code":"# provided application ID does not exist or secret is incorrect\n\n{\n    error: 'Invalid App.'\n}","language":"json"},{"code":"# provided logout token is invalid\n\n{\n    error: 'Invalid Logout Token.'\n}","language":"text","name":"Failure — Invalid Token","status":403}]},"auth":"never","params":[{"_id":"53ff947e23a37e1d5cebafcd","ref":"","in":"body","required":false,"desc":"The logout token received in the logout webhook","default":"","type":"string","name":"logout_token"},{"_id":"53ff947e23a37e1d5cebafcc","ref":"","in":"body","required":false,"desc":"Your application ID","default":"","type":"string","name":"app_id"},{"_id":"53ff947e23a37e1d5cebafcb","ref":"","in":"body","required":false,"desc":"Your application secret","default":"","type":"string","name":"app_secret"}],"url":"/logout"},"isReference":false,"order":2,"body":"After your servers are hit with the [logout webhook](/v1.0/docs/handling-the-logout-webhook), you must exchange the logout token for a clef ID. Use this route to make that exchange.\n\nThe `/logout` route takes URL-encoded form data.","excerpt":"The API route to exchange a logout token for a Clef ID","slug":"apiv1logout","type":"endpoint","title":"/api/v1/logout"}

post/api/v1/logout

The API route to exchange a logout token for a Clef ID

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

logout_token:
string
The logout token received in the logout webhook
app_id:
string
Your application ID
app_secret:
string
Your application secret

Result Format


Documentation

After your servers are hit with the [logout webhook](/v1.0/docs/handling-the-logout-webhook), you must exchange the logout token for a clef ID. Use this route to make that exchange. The `/logout` route takes URL-encoded form data.

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}