Skip to content

Builds the address that ends the person's session on the portal (OpenID Connect RP-Initiated Logout). End the application's own session first, then send the browser there. The portal asks the person before signing them out; someone not signed in to the portal goes straight back.

Usage

sso_sign_out_url(
  client,
  post_logout_redirect_uri = NULL,
  state = NULL,
  id_token_hint = NULL
)

Arguments

client

A client from sso_client().

post_logout_redirect_uri

Optional. Where the portal sends the browser afterwards. It must be one of the client's Return addresses after sign-out on the portal, exactly, or the portal refuses the request.

state

Optional. Returned unchanged on that address. At most 512 characters.

id_token_hint

Optional. The raw ID token, if the app kept it.

Value

The address, a single string.

Details

The address is the discovery document's end_session_endpoint, read from the client's cache (no network call once the document has been read). The query carries, in this order, client_id (always), then id_token_hint, post_logout_redirect_uri and state, each only when given.

Errors

A rusckersso_http_error when the discovery document has no end_session_endpoint (the portal is older than this feature); an error when state is longer than 512 characters.

Examples

if (FALSE) { # \dontrun{
# Needs a reachable portal (or a cached discovery document).
# In a plumber2 or Shiny sign-out handler: forget the app's own session
# first, then redirect.
url <- sso_sign_out_url(
  client,
  post_logout_redirect_uri = "https://app.example.org/signed-out"
)
} # }