Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

...

Overview

The project's primary purpose was to develop a backend module that gets SSO(Single Sign On) Token from Cisco IDS and passes that token to the agent for their XMPP subscription and calls all cisco finesse APIs.

Prerequisites

The following are the mandatory prerequisites for a smooth installation.

...

Deployment Steps

Run Utility as a Docker Container

  1. Pull the latest release of SSO Utility from gdrive and extract the zip folders.

  2. run the following command in Linux server
    mkdir –m777 SSO_utility

  3. this will create the SSO_utility directory. 

  4. use cd command to go into the SSO_utility directory
    cd SSO_utility

  5. upload the extracted files into this directory.

  6. Edit your environment variable file.

  7. now run deploy.sh file using the following command:
    bash deploy.sh

    and you can see after completion your docker image is running

  8. if you see any permission denied error kindly run the following command and after that run step 7 again

    Add Permission

    Code Block
    languagebash
    cd ..
    chmod -R 777 SSO_utility
    cd SSO_utility

Run Utility as a Windows Service

Pull the latest release of SSO Utility Service from gdrive and extract the zip folders into some directory and follow the step to run the service in windows as a service:

...

  1. navigate to the directory where you have extracted the utility.

  2. Edit your configuration file.

  3. open the windows PowerShell/ cmd as administrator, navigate to the directory where nssm.exe, scheduling-tasks-0.0.1-SNAPSHOT.jar and run.bat files are placed. 

  4. run the .\nssm.exe install SSO_Utility command.

  5. windows popup will appear, select the path of run.bat file.

  6. Click install service and close the PowerShell/ cmd

  7. open windows services settings, search for SSO_Utility, and open that service.

  8. check startup type is Automatic or not, if not select Automatic.

  9.  then press the start, and the extension module will be up in the background.

Edit Configurations

open the environment-variable.env file using vi or vim command as mentioned bellow:

...

Info

Note

** IF you want to change certificates, then use Deploy Creating Local Image, replace your certificate files in the cert folder, and update the environment-variable.env file.

Register Your Application on IDS

  1. Navigate to the Identity Service Management console by going to: https://<your_CCX_Host>:8553/idsadmin

  2. Login using the Cisco UCCX/UCCE application user credentials.

  3. Select the Clients icon on the left side of the navigation.

  4. Click on the New button on the upper right-hand side.

  5. Fill the form

    • Enter a unique name for the client (partner application).

    • Enter one or more redirect URLs to which the authorization code has to be delivered. https://<utility_server_Host>:<utility_port>/idscallback

    • Click the '+' button on the right of the input field.

    • Add multiple IPs if you have deployed multiple SSO utility instances.

  6. Click the Add button to add the client

  7. you can see the client_id in the second column of clients table

    Image Removed17abdf42-b139-40f4-a306-83be6700486e.pngImage Added

Verification Test

Call the following API to test if the utility is working and your configuration are updated.

Request

URL

Response Code

Response Body

GET

https://<ServerIP>:<ServerPort>/testbackend

200OK

system is working fine

...