> For the complete documentation index, see [llms.txt](https://docs.developers.symphony.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.developers.symphony.com/embedded-modules/embedded-mode/logout.md).

# Logout

### Log out of all Symphony Messaging instances

The `logout` function exposed by the SDK allows you to log the user out of all Symphony Messaging instances. The function is available in Focus and Collaboration modes.

When called, the function will log the user out of Symphony Messaging servers, and then delete all the iFrames controlled by our SDK.

Once logged out, Symphony Messaging is back in a state as if the [first `render` method](https://github.com/SymphonyPlatformSolutions/symphony-developers-documentation/blob/master/broken/spaces/fAel5eAVHAZGcVMDx7ly/pages/IjXRqsoj0pej0L7Uvc0q/README.md#id-2.-rendering-ecp) had never been called so any other function provided by the SDK would not have any effect. **The `render` method needs to be called again.**

```typescript
window.symphony.logout(): Promise<{error?: {type: string; message: string}}>;
```

#### Returned Promise

The Logout function returns a [**JavaScript Promise**](https://www.w3schools.com/js/js_promise.asp) that will resolve once the action has been completed. The promise has the following interface:

\- Success: {}

\- Error:

<table><thead><tr><th width="196">Parameter</th><th width="113">Type</th><th>Description</th></tr></thead><tbody><tr><td>type</td><td>string</td><td>Type of error:<br><code>ERROR</code> for generic errors</td></tr><tr><td>message</td><td>string</td><td>Description of the error</td></tr><tr><td>data</td><td>Object | undefined</td><td>Additional data on the error, if any.</td></tr></tbody></table>

**Use with caution:** This function logs the user out of all the Symphony Messaging instances of their current browser. So if the user is logged in Embedded Mode from two web apps (yours, and another one), then you will log them out of the two apps.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.developers.symphony.com/embedded-modules/embedded-mode/logout.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.