Click Boarding uses a single point of authentication for our applications. This application is referred to as the Identity application. This document is going to walk through how the URLs are constructed and what each part does.
The below root URLs are our starting point for accessing Identity.
- Production: https://sso.clickboarding.com
- UAT: https://sso.clickboardinguat.com
First we are going to add the /Login path to let Identity know we want to login.
Our second step is going to be to add a ?. This signifies that we are going to add what are known as query parameters. We will add two query parameters. One to let Identity know what application to authenticate against and one to specify which client.
Our query parameter to let Identity know which application we want to access is going to be structured as App=[appName].
- For Admin: App=Admin
- For Employee/Candidate: App=Candidate
- For Click Hub: App=ClickHub
Next we need to add an & to join a second query parameter.
Our second query parameter will let Identity know which client it should try to authenticate against. The structure is Sub=[clientSubdomain]. Note that Click Hub does not use a subdomain query parameter since there is no specific client we immediately access.
If a client has a defined subdomain the client's unique subdomain MUST be included. To check this you can view the Company Settings or run the Client/{id} - GET. Note that if a client uses SSO in any capacity or is in a single tenant environment, they have a subdomain. If a client does not have a subdomain, they will use the generic click subdomain.
We are now ready to put this all together to get our desired URLs.
- Production: https://sso.clickboarding.com/Login?App=[appName]&Sub=*
- UAT: https://sso.clickboardinguat.com/Login?App=[appName]&Sub=*
Let's look at a few examples to solidify this. Let's pretend we have the following:
Example One: Accessing the Admin UAT environment for a client that has a unique subdomain
- Environment the user wants to access: UAT
- Application the user wants to access: Admin
- Client subdomain: abc
Example Two: Accessing the Employee/Candidate Production environment for a client that does not have unqiue subdomain
- Environment the user wants to access: Production
- Application the user wants to access: Employee/Candidate
- Generic subdomain: click
Example Three: Click Boarding employee wanting to access Click Hub in Production
- Environment the user wants to access: Production
- Application the user wants to access: Click Hub
Comments
0 comments
Article is closed for comments.