KEYCLOAK-7166 Added a new section about identity broker logout.

This commit is contained in:
Torbjørn Skyberg Knutsen 2018-08-24 15:19:37 +02:00 committed by Marek Posolda
parent 3101c4ed98
commit 6234e4d14c
4 changed files with 10 additions and 0 deletions

View file

@ -1,5 +1,6 @@
==== Logout ==== Logout
[[_java_adapter_logout]]
You can log out of a web application in multiple ways. You can log out of a web application in multiple ways.
For Java EE servlet containers, you can call HttpServletRequest.logout(). For other browser applications, you can redirect the browser to For Java EE servlet containers, you can call HttpServletRequest.logout(). For other browser applications, you can redirect the browser to
`$$http://auth-server/auth/realms/{realm-name}/protocol/openid-connect/logout?redirect_uri=encodedRedirectUri$$`, which logs you out if you have an SSO session with your browser. `$$http://auth-server/auth/realms/{realm-name}/protocol/openid-connect/logout?redirect_uri=encodedRedirectUri$$`, which logs you out if you have an SSO session with your browser.

View file

@ -84,6 +84,7 @@ include::topics/identity-broker/mappers.adoc[]
include::topics/identity-broker/session-data.adoc[] include::topics/identity-broker/session-data.adoc[]
include::topics/identity-broker/first-login-flow.adoc[] include::topics/identity-broker/first-login-flow.adoc[]
include::topics/identity-broker/tokens.adoc[] include::topics/identity-broker/tokens.adoc[]
include::topics/identity-broker/logout.adoc[]
include::topics/sessions.adoc[] include::topics/sessions.adoc[]
include::topics/sessions/administering.adoc[] include::topics/sessions/administering.adoc[]
include::topics/sessions/revocation.adoc[] include::topics/sessions/revocation.adoc[]

View file

@ -0,0 +1,7 @@
=== Identity broker logout
When logout from {project_name} is triggered, {project_name} will send a request to the external identity provider
that was used to login to Keycloak, and the user will be logged out from this identity provider as well.
It is possible to skip this behaviour and avoid logout at the external identity provider.
See link:{adapterguide_logout_link}[adapter logout documentation] for more details.

View file

@ -19,6 +19,7 @@
:authorizationguide_link: {project_doc_base_url}/authorization_services/ :authorizationguide_link: {project_doc_base_url}/authorization_services/
:adapterguide_name: Securing Applications and Services Guide :adapterguide_name: Securing Applications and Services Guide
:adapterguide_link: {project_doc_base_url}/securing_apps/ :adapterguide_link: {project_doc_base_url}/securing_apps/
:adapterguide_logout_link: {adapterguide_link}#_java_adapter_logout
:adminguide_name: Server Administration Guide :adminguide_name: Server Administration Guide
:adminguide_link: {project_doc_base_url}/server_admin/ :adminguide_link: {project_doc_base_url}/server_admin/
:adminguide_bruteforce_name: Password guess: brute force attacks :adminguide_bruteforce_name: Password guess: brute force attacks