In this section, you can connect external clients to Timeline so they can exchange data.
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.
To connect external clients so they can access your Timeline account for login and data exchange click your user avatar at the bottom of the left bar, select Account, and navigate to the OAuth tab. Then click Register client and fill in the required fields in the appeared Register OAuth client window.
Below you can find an example of OAuth client registration based on Recording Service connection.
Show Recording Service connection example
- In the Register OAuth client form, fill in the following fields:
- Name
Enter a unique name that identifies the application to which you require OAuth access. 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 (application homepage).
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.
Example: https://recorder.myCompany.com/api/auth/callback
- 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.
- 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.
- 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 which is the auto-generated unique ID of the application. Copy Client ID and Client Secret fields for use on Recording Service.