LogoutUrlOptions | @authc/authc-spa-js

Hierarchy

LogoutUrlOptions

Index

Properties

Optional client_id

client_id: string

The client_id of your application.

If this property is not set, then the client_id that was used during initialization of the SDK is sent to the logout endpoint.

If this property is set to null, then no client ID value is sent to the logout endpoint.

Optional federated

federated: boolean

When supported by the upstream identity provider, forces the user to logout of their identity provider and from Authc. Read more about how federated logout works at Authc

Optional returnTo

returnTo: string

The URL where Authc will redirect your browser to after the logout.

Note: If the client_id parameter is included, the returnTo URL that is provided must be listed in the Application's "Allowed Logout URLs" in the Authc dashboard. However, if the client_id parameter is not included, the returnTo URL must be listed in the "Allowed Logout URLs" at the account level in the Authc dashboard.