Authorize components

Before you install any on-premises component (Broker, Workstation Agent, or DSA), you must generate an authorization file for it. The authorization file is a credentials file that contains a client ID and secret, confirming the component is trusted and allowed to connect to OpenLM Platform.

Generate one authorization file per component type before you begin installation. A single Workstation Agent file can be shared across many agent machines, while Broker and DSA are typically authorized individually.

Generate an authorization file

1. Open the app launcher (grid icon, top-right) and select Platform Administration → Identity, then open the Authorization tab.
2. Select Add Client.
3. Select the client type and enter a description (required):
   • Broker — for an OpenLM Broker.
   • Agent — for a Workstation Agent.
   • Dsa — for a Directory Synchronization Agent.
4. Optionally, select Encrypted authorization client to generate an encrypted credentials file.
5. Select Save.

Adding a Broker client in the Identity Authorization tab

6. In the Secret Key dialog, copy the Client ID and Secret Key, or select Download to save the entire file as .json.

The generated Client ID and Secret Key

Keep the downloaded .json file accessible — you will upload it during each component's installation.

warning

If you delete an authorization entry later, components using it immediately lose access to the system. To rotate a client secret, select the entry and choose Reset Secret, then download the new file. The previous secret becomes invalid.

For full details on Identity service configuration, including SSO, RBAC, and user management, see Identity.

Next step

Continue to Install Broker to deploy your first on-premises component.