Use this page to create BASIC connections for supported API and cloud storage sources. Each connection stores the credentials and configuration Yarken needs to access the source.
Creating a connection does not load data by itself. A pipeline or Automate workflow must use the connection. For supported consent-based APIs, you can select Auto create pipeline and fetch data instantly. to create the associated pipeline and start the initial data fetch after authorization.
Before you begin
-
You must have the Admin or Cost Model Manager role to manage Connections and Pipelines.
-
Collect the credentials, permissions, and source details required by the connection type.
-
Go to Admin > Pipelines > Connections and select the BASIC tab.
-
Do not include access keys, client secrets, passwords, or other credentials in screenshots, documentation, email, chat, or support tickets.
Choose a connection type
Use the table below to identify the setup method and authentication option for your source.
|
Connection type |
Setup method |
Authentication |
|---|---|---|
|
Microsoft Graph API |
Consent or manual |
Platform Credentials or Custom Credentials |
|
Power BI API |
Consent or manual |
Platform Credentials or Custom Credentials |
|
Google API |
Consent |
Supported Google consent flow |
|
Google Reseller API |
Consent |
Supported Google consent flow |
|
Azure Blob Storage |
Manual |
Account Key or Service Principal |
|
AWS S3 |
Manual |
Access Key and Secret Key |
|
Google Storage |
Manual |
Access Key and Secret Key |
Understand API authentication methods
API connections use one of the following authentication methods. The available method depends on the API provider.
|
Authentication method |
How it works |
What happens after setup |
|---|---|---|
|
Platform Credentials |
Uses the supported provider consent flow. You authorize access through CONNECT API or share a COPY CONSENT URL. You do not enter the application Client ID or Client Secret manually. |
Yarken creates the API connection. If Auto create pipeline and fetch data instantly. is selected, Yarken also creates the associated pipeline and starts the initial data fetch. |
|
Custom Credentials |
You enter your Microsoft Entra application credentials, such as Tenant ID, Client ID, and Client Secret, then test and save the connection. |
Yarken saves the connection. You then create the required API pipeline manually. |
Microsoft Graph API and Power BI API support both Platform Credentials and Custom Credentials. Google API and Google Reseller API use the supported consent flow.
Create a Microsoft Graph API connection
Platform Credentials (consent)
Prerequisites
-
You must have access to a Microsoft Entra tenant.
-
A Global Administrator or Privileged Role Administrator must be available to grant tenant-wide admin consent for the required application permissions.
Procedure
-
Go to Admin > Pipelines > Connections.
-
Select the BASIC tab.
-
Select + NEW CONNECTION.
-
Select Microsoft Graph API as the Connection Type.
-
Confirm Platform Credentials as the Authentication type.
-
Choose one authorization method:
-
CONNECT MICROSOFT GRAPH API — Open the secure authorization flow, sign in, and grant the requested permissions.
-
COPY CONSENT URL — Copy the shareable link and send it to the administrator who will complete consent.
-
-
Keep Auto create pipeline and fetch data instantly. selected when you want Yarken to create the associated pipeline and start the initial data fetch after consent.
-
Complete the Microsoft authorization flow.
Expected result
Yarken creates the Microsoft Graph API connection. If Auto create pipeline and fetch data instantly. is selected, Yarken also creates the associated pipeline and starts the initial data fetch.
Custom Credentials
Prerequisites
-
Tenant ID
-
Tenant Name, where required by the connection form
-
Client ID
-
Client Secret
Procedure
-
Go to Admin > Pipelines > Connections.
-
Select the BASIC tab and select + NEW CONNECTION.
-
Select Microsoft Graph API as the Connection Type.
-
Select Custom Credentials as the Authentication type.
-
Enter the connection name and the required Microsoft Entra application credentials.
-
Select TEST CONNECTION.
-
After the test succeeds, select SAVE.
Expected result
The Microsoft Graph API connection is saved and is available when you create its API pipeline manually.
Create a Power BI API connection
Platform Credentials (consent)
Prerequisites
-
You must have access to a Microsoft Entra tenant.
-
A Global Administrator or Privileged Role Administrator must be available to grant tenant-wide admin consent.
-
Complete the required Power BI tenant and service principal configuration.
See Configure Power BI-specific requirements for Pipeline connections.
Procedure
-
Go to Admin > Pipelines > Connections.
-
Select the BASIC tab and select + NEW CONNECTION.
-
Select Power BI API as the Connection Type.
-
Confirm Platform Credentials as the Authentication type.
-
Choose one authorization method:
-
CONNECT POWER BI API — Open the secure authorization flow, sign in, and grant the requested permissions.
-
COPY CONSENT URL — Copy the shareable link and send it to the administrator who will complete consent.
-
-
Keep Auto create pipeline and fetch data instantly. selected when you want Yarken to create the associated pipeline and start the initial data fetch after consent.
-
Complete the Microsoft authorization flow.
Expected result
Yarken creates the Power BI API connection. If Auto create pipeline and fetch data instantly. is selected, Yarken also creates the associated pipeline configuration and starts the initial data fetch.
Custom Credentials
Prerequisites
-
Complete the required Power BI tenant and service principal configuration.
-
Collect the Tenant ID, Tenant Name where required, Client ID, and Client Secret.
See Configure Power BI-specific requirements for Pipeline connections.
Procedure
-
Go to Admin > Pipelines > Connections.
-
Select the BASIC tab and select + NEW CONNECTION.
-
Select Power BI API as the Connection Type.
-
Select Custom Credentials as the Authentication type.
-
Enter the connection name and the required Microsoft Entra application credentials.
-
Select TEST CONNECTION.
-
After the test succeeds, select SAVE.
Expected result
The Power BI API connection is saved and is available when you create its API pipeline manually.
Create a Google API connection
Consent
Prerequisites
-
You must be a Google Workspace Super Admin for your domain.
-
Enable the Admin SDK API.
-
Enable the Enterprise License Manager API.
Procedure
-
Go to Admin > Pipelines > Connections.
-
Select the BASIC tab and select + NEW CONNECTION.
-
Select Google API as the Connection Type.
-
Select the provider-specific CONNECT option to authorize directly, or select COPY CONSENT URL to share the authorization link with the administrator who will complete consent.
-
Keep Auto create pipeline and fetch data instantly. selected when you want Yarken to create the associated pipeline and start the initial data fetch after consent.
-
Complete the Google authorization flow.
Expected result
Yarken creates the Google API connection. If Auto create pipeline and fetch data instantly. is selected, Yarken also creates the associated pipeline and starts the initial data fetch.
Create a Google Reseller API connection
Consent
Prerequisites
Use a Google administrator account that can grant the permissions requested during authorization.
Procedure
-
Go to Admin > Pipelines > Connections.
-
Select the BASIC tab and select + NEW CONNECTION.
-
Select Google Reseller API as the Connection Type.
-
Select the provider-specific CONNECT option to authorize directly, or select COPY CONSENT URL to share the authorization link.
-
Keep Auto create pipeline and fetch data instantly. selected when you want Yarken to create the associated pipeline and start the initial data fetch after consent.
-
Complete the Google authorization flow.
Expected result
Yarken creates the Google Reseller API connection. If Auto create pipeline and fetch data instantly. is selected, Yarken also creates the associated pipeline and starts the initial data fetch.
Create an Azure Blob Storage connection
Account Key
Prerequisites
-
Storage Account Name
-
Storage Account Access Key
-
Container Name
See View Azure Storage Account Access Keys.
Procedure
-
Go to Admin > Pipelines > Connections.
-
Select the BASIC tab and select + NEW CONNECTION.
-
Select Azure Blob Storage as the Connection Type.
-
Select Account Key as the Authentication type.
-
Enter Name, Account Name, Access Key, and Container Name.
-
Select TEST CONNECTION.
-
After the test succeeds, select SAVE.
Expected result
The Azure Blob Storage connection is created and is available when you configure a cloud storage pipeline or supported Automate workflow.
Service Principal
Prerequisites
-
Storage Account Name
-
Tenant ID
-
Client ID
-
Client Secret
-
Container Name
Ensure the Service Principal can access the Azure Storage Account and container. See Create an Azure Service Principal.
Procedure
-
Go to Admin > Pipelines > Connections.
-
Select the BASIC tab and select + NEW CONNECTION.
-
Select Azure Blob Storage as the Connection Type.
-
Select Service Principal as the Authentication type.
-
Enter Name, Account Name, Tenant ID, Client ID, Client Secret, and Container Name.
-
Select TEST CONNECTION.
-
After the test succeeds, select SAVE.
Expected result
The Azure Blob Storage connection is created and is available when you configure a cloud storage pipeline or supported Automate workflow.
Creating an Azure Blob Storage connection does not create a pipeline automatically.
Create an AWS S3 connection
Manual setup
Prerequisites
-
Access Key
-
Secret Key
-
Bucket Name
-
Region, if you want to specify it instead of using automatic detection during connection testing
See Retrieve AWS Access and Secret keys.
Procedure
-
Go to Admin > Pipelines > Connections.
-
Select the BASIC tab and select + NEW CONNECTION.
-
Select AWS S3 as the Connection Type.
-
Enter Name, Access Key, Secret Key, and Bucket Name.
-
Optionally enter Region. Leave it blank to allow automatic detection during connection testing.
-
Select TEST CONNECTION.
-
After the test succeeds, select SAVE.
Expected result
The AWS S3 connection is created and is available when you configure a cloud storage pipeline or supported Automate workflow. Creating the connection does not create a pipeline automatically.
Create a Google Storage connection
Manual setup
Prerequisites
-
Access Key
-
Secret Key
-
Bucket Name
Procedure
-
Go to Admin > Pipelines > Connections.
-
Select the BASIC tab and select + NEW CONNECTION.
-
Select Google Storage as the Connection Type.
-
Enter Name, Access Key, Secret Key, and Bucket Name.
-
Select TEST CONNECTION.
-
After the test succeeds, select SAVE.
Expected result
The Google Storage connection is created and is available when you configure a cloud storage pipeline or supported Automate workflow. Creating the connection does not create a pipeline automatically.
What happens next
|
How you created the connection |
Next step |
|---|---|
|
API consent with Auto create pipeline and fetch data instantly. selected |
Review the automatically created pipeline and its run status. See Manage BASIC pipelines and Monitor pipeline runs. |
|
API consent without automatic pipeline creation |
Create the API pipeline. See Create BASIC pipelines. |
|
API using Custom Credentials |
Create the API pipeline manually. See Create BASIC pipelines. |
|
Cloud storage |
Create a cloud storage pipeline or configure recurring file ingestion from Automate. See Create BASIC pipelines. |
Related content