Swagger Petstore - OpenAPI 3.0
POST/api/auth/sign-out

Sign out and clear the session cookie

Clears the session cookie for the authenticated user's browser session. Call this operation when the user has finished using the application.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

2 status codes
200Returns a `success` value confirming that the user has signed out.
successbooleanoptional
500Returned when an unexpected server error occurs.
errorstringrequired

Error handling

A 500 is returned for an unexpected server error. The session cookie identifies the browser session to clear.