Guide: Setting Up Your TideCloak License
This guide will walk you through the process of requesting, managing, and renewing a TideCloak license to ensure uninterrupted service within your identity and access management system.
Prerequisites
Before you begin, ensure that you have:
- Access to a TideCloak admin account.
- The latest version of TideCloak installed.
- A basic understanding of TideCloak realms and user registration
1: Create a New Realm
Before requesting a license, ensure that you have a realm set up in TideCloak. If you're not sure how to create a realm, refer to the following setup guide:
- How to Create a Realm in TideCloak – This guide walks you through configuring a realm with the necessary settings for this tutorial.
2: Add Tide as an Identity Provider
Once your realm is set up, the next step is to add Tide as your Identity Provider (IDP).
-
On the left-hand side, select Identity Providers .
-
Click Tide.
-
This will create a Tide instance for your realm, and a new tab labeled Settings will appear on the page.
On this page, you will have the option to configure settings specific to Licensing and Mappers for Tide, allowing you to customize the behavior and attributes passed through the Identity Provider.
3. Access the License Page
Once Tide has been added as your Identity Provider, click to the Manage License button within the Tide settings.
-
Click on the License button inside the Tide settings.
-
Inside this page, you will be able to view your Active License and the Activity Log , which shows the upcoming license that will be used upon renewal as well as the history of past license-related actions.
4. Request a License
Once user registration is enabled, you can proceed with requesting a license.
- Go to the Licenses tab within the Tide settings.
- Click the Request License button.
- Because this is a free-tier subscription, the user will only need to enter their email address.
- Click Subscribe .
After completing this step, you will be redirected back to the Identity Provider page, and your license will be created. The Active License will be displayed, showing details such as the License Details, Expiry Date , Maximum User Accounts ,and Current User Accounts .
5. Managing the License
Once your license is active, you can manage it through the Licenses tab.
- In the Licenses tab, click on Manage Subscription .
- You will be redirected to a page where ou can manage your subscription.
- On this page, you will have the option to cancel your current plan or upgrade your plan .
This allows you to easily control your subscription settings, including making changes or canceling your plan as needed.
6. Renewing a License
TideCloak automatically renews licenses on a monthly basis.
- When a license is renewed, the customer will receive an email with instructions to secure updated settings.
- Click on the Secure Settings link in the email to re-sign your settings using the new license.
Note that this process occurs every month, ensuring that your license is automatically renewed without any manual intervention, apart from re-signing the settings.