Webitel: Documentation
Webitel: Documentation
Breadcrumbs

SSO

1. Description

This section is designed to connect authentication providers for user single sign-on (SSO) login. Multiple connection profiles can be configured.

Access to the section and the ability to work with profiles is governed by access permissions for the SSO object and Applications.

Consists of the following elements:

  1. Records registry (Fig. 1.(1));

  2. Create tool (Fig. 1.(2));

  3. Search field (Fig. 1.(3));

  4. Records registry refresh tool (Fig. 1.(4));

  5. Delete tool (Fig. 1.(5));

  6. Pagination (Fig. 1.(6)).

SSO (Integrations).png
Fig. 1. SSO page

1.1. Records registry

The registry is a list of SSO profiles connected in the system, each consisting of the following fields:

  • Checkbox;

  • Name column;

  • Provider column;

  • State column;

  • Edit tool;

  • Delete tool.

1.1.1. Checkbox

Used to select one or more entries. An additional removal tool appears next to the search field after selecting one or more entries. Information about the number of entries chosen for deletion appears when you hover over this tool. When you click on it, a modal confirmation window appears.

It contains the Yes, No, and close ( image2024-3-7_15-21-56.png ) buttons.

  • Clicking the Yes button deletes the entries.

  • Clicking the No button closes the modal window, and the entries are not deleted.

All records on the page will be selected if you select the checkbox in the header.

Confirm deletion modal window.png


Fig. 2. Confirm deletion modal window

1.1.2. Name column

Displays the connection profile's name.

1.1.3. Provider column

Displays the authentication provider's icon. The icon is set automatically by the system and cannot be edited by the user.

1.1.4. State column

Contains a toggle switch responsible for enabling and disabling the SSO profile, according to the switch position:

  • Увімкн.png - profile is enabled;

  • Вимкн.png - profile is disabled.

By default, the profile is disabled.

If the profile is enabled, the user is presented with an SSO authentication option on the login page — provided that the corresponding value of the login_options system setting is also configured (Admin → System → Configuration).

1.1.5. Edit tool

The General tab opens after clicking on this button - %D0%A1%D0%BD%D0%B8%D0%BC%D0%BE%D0%BA%20%D1%8D%D0%BA%D1%80%D0%B0%D0%BD%D0%B0%202024-02-16%20014501.png?version=2&modificationDate=1711149518789&cacheVersion=1&api=v2&width=20 . You can change the object's data and go to other tabs for editing.

1.1.6. Delete tool

Used to remove an object with confirmation through a modal window. When hovering over the delete button ( image-20241231-121409.png ), the tool name is displayed. After clicking the delete button, a confirmation modal window appears. Clicking the Yes button deletes the object. Clicking the No button closes the modal window, and the object is not deleted.

Confirm deletion modal window.png


Fig. 3. Confirm deletion modal window

1.2. Create tool

To create a new connection profile, use the Add button, which opens access to the General detail page.

1.3. Search field

Search is performed by the Name column.

It consists of an input field and a close button ( image-20241218-160723.png ) displayed when the cursor is placed in the input field. To search by part of a word or a number, use the * symbol. You can also use the * character to replace any number of characters.

1.4. Records registry refresh tool

Updating the register table is performed by clicking on the refresh button - image-20241220-111256.png .

1.5. Delete tool

Used to remove an object with confirmation through a modal window. When hovering over the delete button ( image-20241231-121409.png ), the tool name is displayed. After clicking the delete button, a confirmation modal window appears. Clicking the Yes button deletes the object. Clicking the No button closes the modal window, and the object is not deleted.

Confirm deletion modal window.png


Fig. 4. Confirm deletion modal window

1.6. Pagination

It consists of the Rows per page field, which indicates the number of entries (it is possible to set from 1 to 1000) per page, and forward and backward buttons for switching pages.

2. Opportunities

2.1. Creating an SSO profile

Goal

Create a new SSO connection profile

Preconditions

  1. Access to the "Admin" application;

  2. Access to the "SSO" section in Admin;

  3. Permission to create in the "SSO" section.

Steps:

 

  1. Click the Add button. The General detail page opens.

  2. Enter the data.

  3. Go to the Mapping detail page and enter the required data.

  4. Click the Save button.

Result

Data is saved.

2.2. Deleting an SSO profile

Goal

Delete an SSO profile

Preconditions

  1. Access to the "Admin" application;

  2. Access to the "SSO" section in Admin;

  3. Permission to view and delete in the "SSO" section;

  4. At least one profile exists.

Steps:

 

  1. Find the profile to be deleted.

  2. Click the delete button — 9c370541-2dd8-4e0e-9292-355f502cd97f . A confirmation modal window will open.

  3. Click "Yes".

Result

The modal window closes. The profile is deleted.

2.3. Deleting multiple SSO profiles

Goal

Delete several SSO profiles

Preconditions

  1. Access to the "Admin" application;

  2. Access to the "SSO" section in Admin;

  3. Permission to view and delete in the "SSO" section;

  4. At least one profile exists.

Steps:

 

  1. In the records registry, find the profiles to be deleted. Select them using the checkbox.

  2. Click the delete tool at the top of the records registry. A confirmation modal window opens.

  3. Click Yes.

Result

The modal window closes. The selected profiles are deleted.

2.4. Editing SSO profile parameters

Goal

Edit SSO profile parameters

Preconditions

  1. Access to the "Admin" application;

  2. Access to the "SSO" section in Admin;

  3. Permission to view and edit in the "SSO" section;

  4. At least one profile exists.

Steps:

 

  1. In the records registry, find the profile to edit.

  2. Click the edit tool on the record. The General page opens.

  3. Open the required detail page.

  4. Enter changes.

  5. Click the Save button.

Result

Data is saved.

2.5. Enabling an SSO profile

Goal

Enable an SSO profile

Preconditions

  1. Access to the "Admin" application;

  2. Access to the "SSO" section in Admin;

  3. Permission to view and delete in the "SSO" section;

  4. At least one profile exists;

  5. The login_options system setting is configured to allow SSO login.

Steps:

 

  1. Find the profile whose status needs to be changed.

  2. Switch the State toggle to the active position by clicking the toggle itself.

Result

Profile is enabled.