Webitel: Documentation
Webitel: Documentation
Breadcrumbs

General (SSO)

1. Description

Designed to enter connection parameters for the authentication provider.

Consists of the following fields (Fig. 1):

  1. Name;

  2. Application (client) ID;

  3. Token verification/retrieval block;

  4. Client secret;

  5. Discovery URL;

  6. Scopes.

General (SSO).png
Fig. 1. General detail page

1.1. Name field

Required field. This field specifies the name of the connection profile. The name is displayed on the login page, on the SSO button.

Note! The name should be short.

1.2. Application (client) ID field

Required field. Specifies the identifier of the application created in the authentication provider.

1.3. Token verification/retrieval block

This block is designed to verify the correctness of the entered provider connection parameters using the Inspect button.

The button becomes active after all required fields on the General detail page are filled in.

After clicking the button:

  • the selected provider's login page opens in a new browser tab;

  • the user needs to enter their credentials (may be personal) — this is only required to verify the connection;

  • after a successful login, the tab closes, and the user is returned to Webitel;

  • the received token is displayed on the SSO profile page.

Inspect button.png
Fig. 2. Active Inspect button

1.4. Client secret field

Required field. Specifies the connection credentials. The value may have a limited validity period depending on the provider.

After the profile is saved, the field value is hidden.

The password visibility icon Іконка відображення паролю.png displays the field value and changes to a hide icon Іконка приховування паролю.png . Clicking it again hides the value and returns the icon to its previous state.

1.5. Discovery URL field

Required field. Specifies the link from which the system retrieves the settings for connecting to the provider (for Microsoft, this is the "OpenID Connect metadata document").

1.6. Scopes field

Optional field. A multi-select of additional user data access permissions that the provider will pass in the token (for example, the email scope adds the user's email address to the token).

The openid scope is mandatory and is added automatically, even if not specified by the user.

2. Opportunities

2.1. Modify or Set Parameters

Goal

Modify or set parameters

Preconditions

  1. Access to the "Admin" application;

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

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

  4. At least one profile exists, or a new one is created.

Steps:

 

  1. Click the field to be changed.

  2. Enter the required changes.

  3. Click the Save button.

Result

Data is saved.