Table of Contents

TOidcClient.BuildLogoutUrl Method

Builds the end-session URL for logging out the user at the identity provider.

Remarks

Calls CheckProviderInformation to ensure the end-session endpoint is known. Raises EOidcClientException if the provider does not expose an end-session endpoint.

Syntax

Unit: Sphinx.OidcClient

function TOidcClient.BuildLogoutUrl(const IdTokenHint: string; const PostLogoutRedirectUri: string): string;

Parameters

<-> Parameter Type Description
const IdTokenHint string Optional identity token previously received from the provider. Supplying this hint allows the provider to identify the session to terminate.
const PostLogoutRedirectUri string Optional URI to which the provider should redirect the user after logout completes.

Returns

The fully formed end-session URL to redirect the user to.

See also