Skip to content
This repository has been archived by the owner on Jan 29, 2024. It is now read-only.

Commit

Permalink
Add instructions for JumpCloud SAML
Browse files Browse the repository at this point in the history
  • Loading branch information
staceysalamon-aiven committed Feb 24, 2023
1 parent 3a639ea commit 373d93f
Showing 1 changed file with 69 additions and 0 deletions.
69 changes: 69 additions & 0 deletions docs/platform/howto/saml/setup-saml-jumpcloud.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
Set up SAML with JumpCloud
===========================

This article explains how to set up SAML with `JumpCloud <https://jumpcloud.com/>`_ for an organization in Aiven. For more information on SAML and instructions for other identity providers, see the :doc:`Set up SAML authentication </docs/platform/howto/saml/saml-authentication>` article.

Prerequisite steps in Aiven Console
------------------------------------

#. In the organization, click **Admin**.

#. Select **Authentication**.

#. Click **Add authentication method**.

#. Enter a name and select SAML. You can also select the teams that users will be added to when they sign up or log in through this authentication method.

You are shown two parameters needed to set up the SAML authentication in Auth0:

* Metadata URL
* ACS URL

Configure SAML on JumpCloud
----------------------------

#. In `JumpCloud <https://console.jumpcloud.com/login>`_, go to **SSO**.

#. Select **Custom SAML App**.

#. Set the ``Audience URI (SP Entity ID)`` to the ``Metadata URL`` from the Aiven Console.

#. Set the ``ACS URL`` to the one from the Aiven Console.

#. Set the ``Default RelayState`` to the homepage of the Aiven Console, https://console.aiven.io.

#. Add an entry in **Attribute statements** with ``name`` of ``email`` and ``value`` of ``email``.

#. Set the ``Login URL`` to th ``ACS URL`` from the Aiven Console.

#. In **User Groups**, assign the application to your user groups.

#. Click **Activate**.

#. Download the certificate.

Finish the configuration in Aiven
----------------------------------

Go back to the **Authentication** page in `Aiven Console <https://console.aiven.io/>`_ to enable the SAML authentication method:

1. Select the name of the JumpCloud method that you created.

2. In the SAML configuration section, click **Edit**.

3. Add the configuration settings from JumpCloud:

* Set the ``SAML IDP URL`` to the ``???`` from JumpCloud.
* Set the ``SAML Entity ID`` to the ``??? `` from JumpCloud .
* Paste the certificate from JumpCloud into the ``SAML Certificate`` field.

4. Click **Edit method** to save your changes.

5. Toggle on **Enable authentication method** at the top of the page.

You can use the **Signup URL** to invite new users, or the **Account link URL** for those that already have an Aiven user account.

Troubleshooting
---------------

If you have issues, you can use the `SAML Tracer browser extension <https://addons.mozilla.org/firefox/addon/saml-tracer/>`_ to check the process step by step.

0 comments on commit 373d93f

Please sign in to comment.