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

Commit

Permalink
Merge pull request #2278 from aiven/staceys-fix-nested-points
Browse files Browse the repository at this point in the history
Fix indenting for bullet points
  • Loading branch information
staceysalamon-aiven authored Nov 21, 2023
2 parents 56a50f7 + 6898414 commit 2e46fe9
Show file tree
Hide file tree
Showing 9 changed files with 88 additions and 92 deletions.
10 changes: 5 additions & 5 deletions docs/platform/howto/saml/setup-saml-auth0.rst
Original file line number Diff line number Diff line change
Expand Up @@ -68,18 +68,18 @@ Go back to the **Authentication** page in `Aiven Console <https://console.aiven.

3. Add the configuration settings from Auth0:

* Set the ``SAML IDP URL`` to the ``Identity Provider Login URL`` from Auth0.
* Set the ``SAML Entity ID`` to the ``Issuer URN`` from Auth0 .
* Paste the certificate from Auth0 into the ``SAML Certificate`` field.
* Set the ``SAML IDP URL`` to the ``Identity Provider Login URL`` from Auth0.
* Set the ``SAML Entity ID`` to the ``Issuer URN`` from Auth0 .
* Paste the certificate from Auth0 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.

6. In the **Signup and link accounts URLs** section, copy the appropriate link and send it to your users to switch them to the new IdP:

* **Signup URL**: For users that don't have an Aiven user account and need to create a new Aiven user linked to this IdP.
* **Account link URL**: For users that already have an Aiven user account to link their existing Aiven user with the configured IdP.
* **Signup URL**: For users that don't have an Aiven user account and need to create a new Aiven user linked to this IdP.
* **Account link URL**: For users that already have an Aiven user account to link their existing Aiven user with the configured IdP.

.. note::
If you set up a SAML authentication method before and are now switching to a new IdP, existing users need to log in with the new account link URL to finish the setup.
Expand Down
60 changes: 30 additions & 30 deletions docs/platform/howto/saml/setup-saml-azure.rst
Original file line number Diff line number Diff line change
Expand Up @@ -54,18 +54,18 @@ Set up an Azure application

11. Add the following parameters to the **Basic SAML Configuration**:

.. list-table::
:header-rows: 1
:align: left
.. list-table::
:header-rows: 1
:align: left

* - Parameter
- Value
* - ``Identifier (Entity ID)``
- ``https://api.aiven.io/v1/sso/saml/account/{account_id}/method/{account_authentication_method_id}/metadata``
* - ``Reply URL (Assertion Consumer Service URL)``
- ``https://api.aiven.io/v1/sso/saml/account/{account_id}/method/{account_authentication_method_id}/acs``
* - ``Sign on URL``
- ``https://console.aiven.io``
* - Parameter
- Value
* - ``Identifier (Entity ID)``
- ``Metadata URL``
* - ``Reply URL (Assertion Consumer Service URL)``
- ``ACS URL``
* - ``Sign on URL``
- ``https://console.aiven.io``


12. Click **Save**.
Expand All @@ -77,18 +77,18 @@ Create a claim and add users

2. Create an attribute with the following data:

.. list-table::
:header-rows: 1
:align: left
.. list-table::
:header-rows: 1
:align: left

* - Parameter
- Value
* - ``Name``
- ``email``
* - ``Source``
- ``Attribute``
* - ``Source Attribute``
- ``user.mail``
* - Parameter
- Value
* - ``Name``
- ``email``
* - ``Source``
- ``Attribute``
* - ``Source Attribute``
- ``user.mail``

3. Download the **Certificate (Base64)** from the **SAML Signing Certificate** section.

Expand All @@ -109,21 +109,21 @@ Go back to the **Authentication** page in `Aiven Console <https://console.aiven.

3. Add the configuration settings from Azure:

* Set the ``SAML IDP URL`` to the ``Login URL`` from Azure.
* Set the ``SAML Entity ID`` to the ``Azure AD Identifier`` from Azure.
* Paste the certificate from Azure into the ``SAML Certificate`` field.
* Set the ``SAML IDP URL`` to the ``Login URL`` from Azure.
* Set the ``SAML Entity ID`` to the ``Azure AD Identifier`` from Azure.
* Paste the certificate from Azure 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.

6. In the **Signup and link accounts URLs** section, copy the appropriate link and send it to your users to switch them to the new IdP:

* **Signup URL**: For users that don't have an Aiven user account and need to create a new Aiven user linked to this IdP.
* **Account link URL**: For users that already have an Aiven user account to link their existing Aiven user with the configured IdP.
.. note::
If you set up a SAML authentication method before and are now switching to a new IdP, existing users need to log in with the new account link URL to finish the setup.
* **Signup URL**: For users that don't have an Aiven user account and need to create a new Aiven user linked to this IdP.
* **Account link URL**: For users that already have an Aiven user account to link their existing Aiven user with the configured IdP.

.. note::
If you set up a SAML authentication method before and are now switching to a new IdP, existing users need to log in with the new account link URL to finish the setup.

Troubleshooting
---------------
Expand Down
33 changes: 17 additions & 16 deletions docs/platform/howto/saml/setup-saml-fusionauth.rst
Original file line number Diff line number Diff line change
Expand Up @@ -82,16 +82,16 @@ Next, create an application in your FusionAuth instance:
#. Paste the **Metadata URL** and **ACS URL** you copied from the Aiven Console to the **Issuer** and
**Authorized redirect URLs** fields in your FusionAuth application, respectively.

.. list-table::
:header-rows: 1
:align: left
.. list-table::
:header-rows: 1
:align: left

* - Aiven
- FusionAuth
* - Metadata URL
- Issuer
* - ACS URL
- Authorized redirect URLs
* - Aiven
- FusionAuth
* - Metadata URL
- Issuer
* - ACS URL
- Authorized redirect URLs

#. In the **Authentication response** section, change the **Signing key** to the API key you created.

Expand All @@ -114,21 +114,22 @@ Go back to the **Authentication** page in `Aiven Console <https://console.aiven.

4. Add the configuration settings from FusionAuth:

* Set the ``SAML IDP Url`` to the ``Login URL`` from FusionAuth.
* Set the ``SAML Entity ID`` to the ``Entity Id`` from FusionAuth.
* Paste the certificate from the ``Generating certificate`` in FusionAuth into the `SAML Certificate`` field.
* Set the ``SAML IDP Url`` to the ``Login URL`` from FusionAuth.
* Set the ``SAML Entity ID`` to the ``Entity Id`` from FusionAuth.
* Paste the certificate from the ``Generating certificate`` in FusionAuth into the `SAML Certificate`` field.

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

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

7. In the **Signup and link accounts URLs** section, copy the appropriate link and send it to your users to switch them to the new IdP:

* **Signup URL**: For users that don't have an Aiven user account and need to create a new Aiven user linked to this IdP.
* **Account link URL**: For users that already have an Aiven user account to link their existing Aiven user with the configured IdP.
* **Signup URL**: For users that don't have an Aiven user account and need to create a new Aiven user linked to this IdP.
* **Account link URL**: For users that already have an Aiven user account to link their existing Aiven user with the configured IdP.

.. note::
If you set up a SAML authentication method before and are now switching to a new IdP, existing users need to log in with the new account link URL to finish the setup.
.. note::

If you set up a SAML authentication method before and are now switching to a new IdP, existing users need to log in with the new account link URL to finish the setup.

Troubleshooting
---------------
Expand Down
14 changes: 7 additions & 7 deletions docs/platform/howto/saml/setup-saml-google.rst
Original file line number Diff line number Diff line change
Expand Up @@ -68,21 +68,21 @@ Go back to the **Authentication** page in `Aiven Console <https://console.aiven.

3. Add the configuration settings from Google:

* Set the ``SAML IDP URL`` to the ``SSO URL`` from Google.
* Set the ``SAML Entity ID`` to the ``Entity ID`` from Google .
* Paste the certificate from Google into the ``SAML Certificate`` field.
* Set the ``SAML IDP URL`` to the ``SSO URL`` from Google.
* Set the ``SAML Entity ID`` to the ``Entity ID`` from Google .
* Paste the certificate from Google 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.

6. In the **Signup and link accounts URLs** section, copy the appropriate link and send it to your users to switch them to the new IdP:

* **Signup URL**: For users that don't have an Aiven user account and need to create a new Aiven user linked to this IdP.
* **Account link URL**: For users that already have an Aiven user account to link their existing Aiven user with the configured IdP.
* **Signup URL**: For users that don't have an Aiven user account and need to create a new Aiven user linked to this IdP.
* **Account link URL**: For users that already have an Aiven user account to link their existing Aiven user with the configured IdP.

.. note::
If you set up a SAML authentication method before and are now switching to a new IdP, existing users need to log in with the new account link URL to finish the setup.
.. note::
If you set up a SAML authentication method before and are now switching to a new IdP, existing users need to log in with the new account link URL to finish the setup.

Troubleshooting
---------------
Expand Down
14 changes: 7 additions & 7 deletions docs/platform/howto/saml/setup-saml-jumpcloud.rst
Original file line number Diff line number Diff line change
Expand Up @@ -57,21 +57,21 @@ Go back to the **Authentication** page in `Aiven Console <https://console.aiven.

4. Add the configuration settings from JumpCloud:

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

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

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

7. In the **Signup and link accounts URLs** section, copy the appropriate link and send it to your users to switch them to the new IdP:

* **Signup URL**: For users that don't have an Aiven user account and need to create a new Aiven user linked to this IdP.
* **Account link URL**: For users that already have an Aiven user account to link their existing Aiven user with the configured IdP.
* **Signup URL**: For users that don't have an Aiven user account and need to create a new Aiven user linked to this IdP.
* **Account link URL**: For users that already have an Aiven user account to link their existing Aiven user with the configured IdP.

.. note::
If you set up a SAML authentication method before and are now switching to a new IdP, existing users need to log in with the new account link URL to finish the setup.
.. note::
If you set up a SAML authentication method before and are now switching to a new IdP, existing users need to log in with the new account link URL to finish the setup.

Troubleshooting
---------------
Expand Down
35 changes: 15 additions & 20 deletions docs/platform/howto/saml/setup-saml-okta.rst
Original file line number Diff line number Diff line change
Expand Up @@ -86,9 +86,6 @@ This is a two step process. First, you create the SAML SP-Initiated authenticati

* ``X.509 Certificate``

.. image:: /images/platform/howto/saml/okta/okta-saml-settings.png
:alt: SAML settings in Okta showing the application data.

#. Go to the **Assignments** tab.

#. Click **Assign** to assign users or groups to the Okta application.
Expand All @@ -109,33 +106,31 @@ Go back to the **Authentication** page in the `Aiven Console <https://console.ai

3. Add the configuration settings from Okta:

.. list-table::
:header-rows: 1
:align: left
.. list-table::
:header-rows: 1
:align: left

* - Parameter
- Value
* - ``SAML IDP Url``
- ``Identity Provider Single Sign-On URL``
* - ``SAML Entity ID``
- ``Identity Provider Issuer``
* - ``SAML Certificate``
- ``X.509 Certificate``
* - Parameter
- Value
* - ``SAML IDP Url``
- ``Identity Provider Single Sign-On URL``
* - ``SAML Entity ID``
- ``Identity Provider Issuer``
* - ``SAML Certificate``
- ``X.509 Certificate``

.. image:: /images/platform/howto/saml/okta/okta-edit-method.png
:alt: Edit authentication method page in Aiven Console.

4. Toggle on ``IdP login`` and ``Enable authentication method``.

5. Click ``Edit Method`` to save the settings.

6. In the **Signup and link accounts URLs** section, copy the appropriate link and send it to your users to switch them to the new IdP:

* **Signup URL**: For users that don't have an Aiven user account and need to create a new Aiven user linked to this IdP.
* **Account link URL**: For users that already have an Aiven user account to link their existing Aiven user with the configured IdP.
* **Signup URL**: For users that don't have an Aiven user account and need to create a new Aiven user linked to this IdP.
* **Account link URL**: For users that already have an Aiven user account to link their existing Aiven user with the configured IdP.

.. note::
If you set up a SAML authentication method before and are now switching to a new IdP, existing users need to log in with the new account link URL to finish the setup.
.. note::
If you set up a SAML authentication method before and are now switching to a new IdP, existing users need to log in with the new account link URL to finish the setup.

Troubleshooting
---------------
Expand Down
14 changes: 7 additions & 7 deletions docs/platform/howto/saml/setup-saml-onelogin.rst
Original file line number Diff line number Diff line change
Expand Up @@ -74,23 +74,23 @@ Go back to the **Authentication** page in `Aiven Console <https://console.aiven.

3. Add the configuration settings from OneLogin:

* Set the ``SAML IDP URL`` to the ``SAML 2.0 Endpoint (HTTP)`` from OneLogin.
* Set the ``SAML IDP URL`` to the ``SAML 2.0 Endpoint (HTTP)`` from OneLogin.

* Set the ``SAML Entity ID`` to the ``Issuer URL`` from OneLogin.
* Set the ``SAML Entity ID`` to the ``Issuer URL`` from OneLogin.

* Paste the certificate from OneLogin into ``SAML Certificate``.
* Paste the certificate from OneLogin into ``SAML Certificate``.

4. If you set ``SAML Initiator`` to ``OneLogin`` in your OneLogin application, then toggle on ``IdP login``.

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

6. In the **Signup and link accounts URLs** section, copy the appropriate link and send it to your users to switch them to the new IdP:

* **Signup URL**: For users that don't have an Aiven user account and need to create a new Aiven user linked to this IdP.
* **Account link URL**: For users that already have an Aiven user account to link their existing Aiven user with the configured IdP.
* **Signup URL**: For users that don't have an Aiven user account and need to create a new Aiven user linked to this IdP.
* **Account link URL**: For users that already have an Aiven user account to link their existing Aiven user with the configured IdP.

.. note::
If you set up a SAML authentication method before and are now switching to a new IdP, existing users need to log in with the new account link URL to finish the setup.
.. note::
If you set up a SAML authentication method before and are now switching to a new IdP, existing users need to log in with the new account link URL to finish the setup.


Troubleshooting
Expand Down
Binary file not shown.
Binary file not shown.

0 comments on commit 2e46fe9

Please sign in to comment.