Logout
Use the logout endpoint to logout your user. The Access token must be included in the request, either in the httpOnly cookie or in the Authorization header.
#
Request dataHTTP method: POST
URL format: https://baseUrl/versionNumber/customEndpointRoute/userEndpoint?key=apiKey&logout=true
Example:
https://app.yawe.dev/api/1/ce/examples/auth?key=d59eb2859c284168ac48aef65046d5dd&logout=true
#
Request ParametersThe following table describes the Request parameters.
Parameter | Description | Required |
baseUrl | Base url for calling the API. Value: app.yawe.dev/api | Yes |
versionNumber | Service version. Value: The current value is 1. | Yes |
customEndpointRoute | The route which identifies custom endpoints. Default value: ce | Yes |
userEndpoint | The endpoint name generated by the user. Value: the name created at https://app.yawe.dev | Yes |
key | The API Key of the project. | Yes |
logout | Required to perform a logout. Value: true | Yes |
#
Request CookiesHeader | Description | Required |
__Secure-yawe-access-token | The Access token is required for secure endpoints. It is obtained when doing a login and it is stored in an httpOnly cookie. To automatically include it in the request you need to set the following property:
Alternatively you can also use the Authorization header. For more information please refer to  the login documentation and Secure Endpoints documentation. | Yes - if endpoint is secure and Authorization header is not used |
#
Request HeadersHeader | Description | Required |
Authorization | The Access token is required for secure endpoints. You should use this header if you are not using the httpOnly cookie to access a Secure endpoint. For more information please refer to  the login documentation and Secure Endpoints documentation. | Yes - if endpoint is secure and httpOnly cookie is not used |
#
Response data#
Error codesError code | Description |
400 | Possible reasons:
|
403 | Missing API Key, not allowed origin or disallowed request without orign. |
#
Successful responseIt returns a 204 after a successful logout.
Cookies: None