Timeline Authentication
For interaction between Recording Service and Timeline, a new OAuth connection must be configured.
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.
Basic steps
- 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. - 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
Role required: Timeline account admin
- Open the Timeline website and log in using the credentials specified during the Timeline installation.
- Click your user avatar at the bottom of the left bar and then select Account. Expand the drop-down list of account sections by clicking the name of the current one in the upper-left corner (Details by default). Then click Register client.
- In the Register OAuth client form, fill in the following fields:
- 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, making it clear to your users. - App URL
Enter the URL that hosts Recording Service. For example, https://recorder.myCompany.com
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. - 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: https://recorder.myCompany.com/api/auth/callback - Client details
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.
This section also displays a preview, showing how the approval page will look like for users. - Client type
Select Confidential as Recording Service is able to securely authenticate with the authorization server, for example being able to keep their registered client secret safe. - Grant type and OpenID Connect
You can leave these options with default selections. - 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. - 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
Permission required: Recording Service admin.
Your account must be added to the Active Directory group specified during the Recording Service installation, which contains the email addresses of the Recording Service administrators.
- Open Recording Service website.
- Go to Settings > Timeline Authentication and fill in the fields:
- Timeline URL
Enter the URI of the Timeline website. - Client ID and Client Secret
Enter the Client ID and Client Secret you obtain after registering the client in the 'Registering a New Client on the Timeline website' step section. - Click Save.
Please wait for a 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: - Check the connection settings you specified above.
- Make sure the Timeline website is available.
- Check the firewall settings. For more information, see the 'Network Connection Settings'.
- Make sure the ports specified during the Recording Service installation are not being used by other applications. For more information, see "Check TCP/IP port availability".
9/5/2024 4:23:54 PM