From 373d93f80298c71310dbbbf245b0bdf6bedfc44d Mon Sep 17 00:00:00 2001 From: Stacey Salamon Date: Fri, 24 Feb 2023 17:21:37 +0100 Subject: [PATCH] Add instructions for JumpCloud SAML --- .../howto/saml/setup-saml-jumpcloud.rst | 69 +++++++++++++++++++ 1 file changed, 69 insertions(+) create mode 100644 docs/platform/howto/saml/setup-saml-jumpcloud.rst diff --git a/docs/platform/howto/saml/setup-saml-jumpcloud.rst b/docs/platform/howto/saml/setup-saml-jumpcloud.rst new file mode 100644 index 0000000000..56b9226b44 --- /dev/null +++ b/docs/platform/howto/saml/setup-saml-jumpcloud.rst @@ -0,0 +1,69 @@ +Set up SAML with JumpCloud +=========================== + +This article explains how to set up SAML with `JumpCloud `_ for an organization in Aiven. For more information on SAML and instructions for other identity providers, see the :doc:`Set up 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 `_, 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 `_ 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 `_ to check the process step by step.