Class LogoutApi

getUrl

• getUrl(options?: { redirectUrl?: undefined | string }): Promise<string | null>

• Retrieve a logout url

  // You can specify the url to send the user to after the logout is successful.
  // If no url is passed, you will end up at the IDPs log out page.
  const logoutUrl = await client.logout.getUrl({ redirectUrl: '[url to redirect]' });
  

  Parameters

  • Default value options: { redirectUrl?: undefined | string } = {}

    • Optional redirectUrl?: undefined | string

  Returns Promise<string | null>