Salesforce Docs Portal

Logout from Salesforce Orgs

To provide user logout functionality, use the logout function to log out from one or more Salesforce orgs. The function returns a LogoutResponse with the same structure as BootstrapResponse.

import { logout } from "@salesforce/analytics-embedding-sdk";

// Logout from all orgs
const response = await logout();

// Logout from specific orgs
const response = await logout([
  "https://org1.lightning.force.com",
  "https://org2.lightning.force.com",
]);

console.log(response.status); // 'Success', 'Partial Success', or 'Failure'
console.log(response.message); // Detailed logout message

Example Logout Response

{
  "message": "Log out for all orgs complete",
  "status": "Success",
  "orgStates": {
    "https://org1.lightning.force.com": {
      "state": "LOGGED_OUT",
      "reason": ""
    },
    "https://org2.lightning.force.com": {
      "state": "LOGGED_OUT",
      "reason": ""
    }
  }
}

See Also