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 data

HTTP method: POST

URL format: https://baseUrl/versionNumber/customEndpointRoute/userEndpoint?key=apiKey&logout=true

Example:

https://app.rested.dev/api/1/ce/examples/auth?key=d59eb2859c284168ac48aef65046d5dd&logout=true

Request Parameters

The following table describes the Request parameters.

Parameter	Description	Required
baseUrl	Base url for calling the API. Value: app.rested.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.rested.dev	Yes
key	The API Key of the project.	Yes
logout	Required to perform a logout. Value: true	Yes

Request Cookies

Header	Description	Required
__Secure-rested-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: // using fetch { credentials: 'include' } // using axios { withCredentials: true } 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 Headers

Header	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 codes

Error code	Description
400	Possible reasons: Endpoint or API Key not valid.
403	Missing API Key, not allowed origin or disallowed request without orign.

Successful response

It returns a 204 after a successful logout.

Cookies: None