Skip to main content

Log out

Applies to: API integrators with third-party API access.

Use Content-Type: application/json and optionally X-Locale: en. The third-api-token header is required. See common headers and error handling.

Brief Description​

  • User logout endpoint; invalidates the session associated with the current Access Token.
  • After logout, the original token can no longer be used to call endpoints requiring authentication.

Request URL​

  • https://{GATEWAY_HOST}/polarstar-auth/auth/third-api/logout

Request Method​

  • POST

Parameters​

  • No request body

Response Example​

{
	"code": 200,
	"msg": "success",
	"enMsg": null,
	"data": null
}

Response Parameter Description​

Response data: null on success. A successful logout has no response payload.

Errors: data may be null, a string or an array of messages. Check the HTTP status and code before reading success data. See error handling.

Parameter NameTypeDescription
codeintBusiness status code; 200 indicates success
msgstringLocalized message
datanullnull upon success

Notes​

  • Calling business endpoints with the original token after logout will return code = -4.