# How to Use
We are about to make the 1search Client Portal public soon, which means authentication is required for both visiting the swagger page and pipeline to access the 1search infra stack.
# How to login
Go to 1search Client Portal and login: https://clientportal.syd.prd.1search.csnglobal.net/ from up and right corner Login button and pick the only active sub button "Via AzureAD".
If you already logged in in AzureAD then you don't have to do anything and will be redirected back to the portal page. If not please login using your carsales AD credential.
# How to authenticate in Swagger
After login, click your email button and click "Swagger" to go to the good old swagger page.
From there you can use the swagger as usual, and because now Client Portal is public you can use the swagger without connecting to a VPN.
# How to authenticate in API and Pipeline
Login to Client Portal first.
Open the panel ApiKey Put: /ApiKey
Click Try it out and Execute to create an API key.
Important
Please note the API key down somewhere safe once you get it back in response. It only shows you once after you create it.
Please make sure no one else except you or your delegated person/team has access this ApiKey. If it is exploited then your 1search stack could be modified by anyone who owns the ApiKey.
Now you can call all of those apis from any agent with header "Authorization" and fill in the ApiKey. For example:
curl --location
--request DELETE 'clientportal.syd.stg.1search.csnglobal.net/client/External/mike.tyson@carsales.com.au' \
--header 'Authorization: ca9f015d-b3fb-4006-ae29-6a9455689a76'
# Changing and Verifying Configs
Each of the configuration sections in the "Configs" tab of the Client Portal can be changed and configured to the user's desire. A more in-depth description of how this is done can be found in the Configurations section of the documentation where each configuration is explained.
Upon completing your desired configuration there is a button below labeled Verify. Clicking this button will check that your configurations are written correctly and there are no errors. A popup box will appear with the result, if everything is ok, the next button that is labeled save can be clicked and will save the configs so they can be used.
# Clearing Memory Usage Alerts With The Infra tab
Using the Infra tab within the client portal you will see a notification displaying the current status of the memory alert, this will usually be displaying a green "OK" unless a memory usage alert is detected, in this case, a red "Alerted" will display along with a "Clear" button next to it. Clicking the clear button will remove the memory usage alert and return its status to "OK".
