Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Keycloak(docs): Update Keycloak SAML SSO docs. #10995

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added docs/assets/SAML-Service-provider.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/SAML-release-attribute.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/sp-url.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
38 changes: 38 additions & 0 deletions docs/janssen-server/keycloak/keycloak-saml-sso.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,44 @@ _This content is a work in progress_

_This content is a work in progress_
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove this if not needed.



## Testing Jans SAML SSO with sptest

### Configure IDP [Janssen Server]

In this tutorial, we are going to use [Iamshowcase](https://sptest.iamshowcase.com) as a service provider. Lets create a TR, Apply following steps in Janssen Server:

- Download sp metadata: `wget https://sptest.iamshowcase.com/testsp_metadata.xml`
- Open Jans TUI and navigate to **Jans SAML > Service Providers > Add Service Provider**:

<img src= "../../assets/SAML-Service-provider.png">

- Release some attributes, for example: `email`, `username`

<img src= "../../assets/SAML-release-attribute.png">

- Finally Save it.

### Configure SP [IAMShowcase]

Since We are done at Janssen Server side, now let's connect SP with the IDP:

- browse and download IDP Metadata: `https://<yoour-janssen-server>/kc/realms/jans/protocol/saml/descriptor`
- Go to: https://sptest.iamshowcase.com/instructions#spinit and upload the IDP metadata.
- It will give you an SP link to test the SAML SSO flow:

<img src ="../../assets/sp-url.png">

### Test SSO

Copy that link and open it in a browser. You can open it in incognito mode to avoid session issue. So, It will redirect you to janssen login page. Once you logged in with user credentials it will redirect back to the SP's protected page and show the user session details.

### FAQ

* Check KC scheduler log for any TR issue `/opt/kc-scheduler/logs/scheduler.log`
* Also check file directory inside `/opt/idp/configs/keycloak/sp/metadata`


## Have questions in the meantime?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove this if not needed.

You can ask questions through [GitHub Discussions](https://github.com/JanssenProject/jans/discussions) or the [community chat on Gitter](https://gitter.im/JanssenProject/Lobby). Any questions you have will help determine what information our documentation should cover.
Expand Down
Loading