Add Custom Terms and Conditions

This topic describes Terms & Conditions for SwaggerHub On-Premise 2.5 and higher.

You can add custom Terms & Conditions that users will need to accept before they can create a SwaggerHub account or log in. Users who do not accept these terms will not be able to browse the API catalog (including public API definitions) and otherwise use SwaggerHub.

Configure custom terms & conditions

The administrator can enable and configure custom terms & conditions as follows:

  1. In the KOTS Admin Console, click Config in the menu bar at the top.

  2. Scroll down to the bottom to the Other section.

  3. Select the Enable Terms & Conditions check box.

  4. Select how often the users will have to accept the terms – only once or at every log in.

    Note

    The only once option means the users will be asked to accept the terms at the next login and also every time the terms are updated.

  5. Paste the text of your Terms & Conditions. The text area will accept plain text and HTML. Images are not supported. If the text includes links to other pages (e.g., more detailed explanation or policy pages) those links should open in a separate browser tab.

  6. Click Save Config.

  7. Deploy your changes.

How custom terms & conditions work

Once custom terms have been enabled, any users who sign up or log in will be prompted to accept those terms. This applies to both single sign-on users and internal authentication users. The Accept button becomes enabled only after the user scrolls down until the end of the text to ensure that the user has completely read the terms & conditions.

Depending on the configuration options, the terms need to be accepted either at every login or just once. If the terms are ever updated, users will be prompted to accept the updated terms at their next login.

Users who do not accept the terms will not be able to log in, browse the API catalog (including public API definitions), and otherwise use SwaggerHub until they accept the terms.

Update custom terms & conditions

  1. In the KOTS Admin Console, click Config in the menu bar at the top.

  2. Scroll down to the bottom to the Other section.

  3. Change the text of the terms and conditions as required.

  4. Click Save Config.

  5. Deploy your changes.

See when terms & conditions were last updated

To check when custom terms & conditions were last updated, follow the instructions on the Maintenance Operations page.

Disable custom terms & conditions

  1. In the KOTS Admin Console, click Config in the menu bar at the top.

  2. Scroll down to the bottom to the Other section.

  3. Unselect the Enable Terms & Conditions check box.

  4. Click Save Config.

  5. Deploy your changes.

Publication date: