With the BlackLine® OAuth2 connector, you can use commands in a chain to interact with BlackLine, such as to:
- List and download reports from BlackLine
- Import and manage data in BlackLine, including:
- Currency rates
To set up the connector, you'll need:
- The host name of the BlackLine instance to connect to, such as
- The username and API key of an integration user set up for a BlackLine service account
Note: The integration user needs API authorization roles and integration permissions, as well as the roles and scopes required for the tasks the connector will perform. To create the API key in BlackLine, click Generate for API Key under User Information on the integration user's details.
- The version of the BlackLine API the integration user's credentials are for—1.0 or 2.0
- The integration user's client credentials and OAuth scopes, provided by your BlackLine integration team
Note: If you need the client ID, client secret, or scopes, contact your BlackLine representative.
Set up the BlackLine OAuth2 connector
Note: To make the connector available for use in your organization's chains, an org security administrator first enables it from Configuration.
- From Chain Builder, click Connections , and then Create at the top right.
- Under BizApp Connection, select BlackLine OAuth2 and the default CloudRunner.
- Enter a unique name and description to help identify the connection.
- Under Properties, enter the connection's details:
Property Details Username Enter the user name of the BlackLine integration user. Password Enter the API key generated for the BlackLine integration user.
Note: To create or refresh the API key in BlackLine, click Generate for API Key under User Information on the integration user's details. This is not the password used to sign in to BlackLine online.
Client ID Enter the client ID provided by your BlackLine integration team. Client secret Enter the client secret provided by your BlackLine integration team. Scopes Enter the integration user's OAuth scopes, provided by your BlackLine integration team. The connector will use these same scopes. Instance host name Enter the host name for the BlackLine instance to connect to, without the
https://. For example, for the default development environment,
API version Select whether the integration user's credentials are for version 1.0 or 2.0 of the BlackLine API.
Note: All sensitive credentials are automatically encrypted and stored at Advanced Encryption Standard (AES)-256 encryption.
- Select the environments to use the connection, and click Save.
- To test the connection, create and run a chain with the BlackLine OAuth2 connector's List Reports command, and verify it returns a valid output.
If the connection to BlackLine fails:
- Verify the client credentials and OAuth scopes provided by your BlackLine integration team. If you need the OAuth scopes or the client ID or secret, contact your BlackLine representative.
- Ensure the integration user's username and API key are correct.
Note: The integration user's API key may expire. To refresh the API key in BlackLine, click Generate for API Key under User Information on the integration user's details.
- Verify the integration user has API authorization and proper roles and scopes to perform the tasks related to the connection's commands.
- Verify the correct BlackLine instance host name is entered for the connector.