Using OAuth to Access Timeline

OAuth is an authorization protocol that allows granting one service (application) the right to access user resources on another service. The protocol eliminates the need to pass the application a username and password and allows a third-party application to gain limited access to an application or service, on behalf of a resource owner.

For interaction between Recording Service and Timeline components, it is recommended to register Recording Service as a client on the Timeline website.

Before you begin

Role required: admin

Basic steps

  1. Register Recording Service as a client on the Timeline website and obtain credentials (Client ID and Client Secret).
    For more information, see the 'Registering a New Client on Timeline website' section below.
  2. In the Recording Service website specify the authentication details to Timeline using the credentials you obtained in step 1.
    For more information, see the 'Configuring connection setting in Recording Service' section below.

Registering a New OAuth Client on the Timeline website

  1. Open the Timeline website and login using credentials specified during the Timeline installation.
  2. Go to Account Settings > OAuth tab and click Register client.
  3. In the registration form, fill in the following fields:
    1. Name
      Enter a unique name that identifies the application that you require OAuth access for. For example, RecordingService.
      Note. The specified name is then presented to a user in the consent screen on the Recording Service website, make it clear to your users.
    2. App URL
      Enter the URL that hosts Recording Service. For example,
      Note. To get the correct App URL and Redirect URI for the Recording Service, open the Recording Service website in your browser and go to the Settings tab. There you will find the "Timeline Authentication Guide". Find the value you need, copy, and paste it into the appropriate field on the Register OAuth Client form on the Timeline website.
    3. Redirect URI
      Enter the callback URL that the authorization server redirects to. Enter the full URL of the clients requesting access to the resource, appended by /api/auth/callback. For example,
    4. Confidential client
      Select Confidential clients as Recording Service is able to securely authenticate with the authorization server, for example being able to keep their registered client secret safe.
    5. Client logo
      This is optional. You may upload an image to use as the application logo. The logo appears on the approval page when you receive a request to grant a client application access to a restricted resource on the instance.
    6. Scopes
      Select Read projects and Write projects scope values to request access to submit data from Recording Service to Timeline. An application can request one or more scopes, this information is then presented to a user in the consent screen, and the access token issued to the application will be limited to the scopes granted.
  4. Click Register and you will be able to see Client ID the auto-generated unique ID of the application. Copy Client ID and Client Secret fields for use on Recording Service.

Configuring authentication setting in Recording Service

  1. Open Recording Service website you installed in the "Recording Service installation" step and login.
  2. Go to the Settings > Timeline authentication and fill the fields in:
    1. Timeline URL
      Enter the URI of the Timeline website.
    2. Client ID and Client Secret
      Enter the Client ID and Client Secret you obtain after registering the client in step 4 'Registering a New Client on the Timeline website' section.
  3. Click Save connection.
    Please wait for notification. If the connection is successful, it displays Save. Otherwise, an error appears: 'The server is unreachable, please notify the administrators and try again later'.
    If connection fails:
    1. Check the connection settings you specified above.
    2. Make sure the Timeline website is available.
    3. Check the firewall settings. For more information, see the 'Network Connection Settings'.
    4. Make sure the ports specified during the Recording Service installation are not being used by other applications. For more information, see the "Check TCP/IP port availability".

22.09.2023 8:59:47

Usage of Cookies. In order to optimize the website functionality and improve your online experience ABBYY uses cookies. You agree to the usage of cookies when you continue using this site. Further details can be found in our Privacy Notice.