General
The Autodesk Forma Client is responsible for establishing the connection between Integrator and Autodesk Forma using Autodesk Platform Services (APS). It manages authentication, permissions, and API communication.
This article describes how to configure and authorize the client.
For an overview of how the module uses the client, see: [CROSS-REFERENCE: Autodesk Forma Module Overview]
For technical behavior and advanced configuration, see: [CROSS-REFERENCE: Autodesk Forma Technical Details]
Prerequisites
Before configuring the client, an Autodesk Platform Services (APS) application must be created.
The APS application provides:
- Client ID
- Client Secret
- Callback URL
These are required for authentication.
APS Application Configuration
In Autodesk Platform Services:
- Create a new application
- Select the tradition application type
- Add the redirect (callback) URL from Integrator
The callback URL must match exactly, otherwise authorization will fail.
Client Configuration
In Integrator, configure the Autodesk Forma Client with the following:
Client ID
Provided by the APS application.
Client Secret
Provided by the APS application.
Scopes
Defines permissions for the integration. Examples include:
- Data access
- Project access
Note: Changing scopes requires reauthorization.
Use Rate Limiter
When enabled:
- Limits outgoing API requests
- Reduces risk of throttling
- Improves stability for large transfers
Authorization
To authorize the client:
- Click Authorize Client
- Log in using an Autodesk account
- Accept permissions
- Return to Integrator automatically
After successful authorization:
- Access token is stored
- Token expiration and last refresh are visible
Connection Settings
The Connection Settings page links the client to a specific Autodesk Forma environment.
Steps:
- Select the configured client
- Select Hub
- Select Project
- Click Save
Use Test Connection to verify access.
Target Settings
Defines where data will be created in Autodesk Forma.
Folder Selection
- Browse the project folder tree
- Select the target root folder
Stored Values
- Selected Folder ID
- Selected Folder Name
Click Save Changes to store configuration.