logout

client.logout({
  // Optional arguments
  redirectTo: string,
  removeCredentials: boolean
})

About this command

Kill current user SSO session.

Use the Revoke refresh token endpoint to invalidate all active user tokens on a specific client_id.

Examples

client.logout({
  redirectTo: 'https://my-site.com/logout'
})

Parameters

redirectTo string

The URL to which the user is redirected afterward. This URL must be whitelisted in the Allowed logout callback URLs field of your ReachFive Console SSO settings (Security  SSO). Whitelisted URLs can be used with all account identity clients.

removeCredentials boolean

Delete the user credentials with the Credentials Management API.

Defaults to false.

This feature is experimental, please check your browser compatibility.

Response

Type: Promise[void]