> For the complete documentation index, see [llms.txt](https://docs.balkan.id/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.balkan.id/getting-started/setting-up-your-tenant/application-integrations/direct-application-integrations/sharefile-integration-setup.md).
# ShareFile Integration Setup
### Getting Started
Use this guide to connect ShareFile to your BalkanID tenant. You will need credentials from ShareFile and access to the Integrations section in BalkanID.
BalkanID signs in to ShareFile as a dedicated service account rather than as one of your administrators. Create that account before you collect any credentials, and give it the access described under **Prepare a ShareFile service account** below.
#### Requirements:
Before you begin, collect the following values from ShareFile:
* **Subdomain**
* **Client ID**
* **Client Secret**
* **Username**
* **Password**
{% hint style="info" %}
**Subdomain** is your ShareFile account subdomain on its own, not a full web address. If you sign in at `https://example.sharefile.com`, the value to enter is `example`.
{% endhint %}
### Prepare a ShareFile service account
BalkanID reads ShareFile through this one account, so what the account can see is what BalkanID can extract.
1. Sign in to ShareFile as an administrator and go to **People** > **Manage Users**.
2. Create a user for BalkanID, or pick an existing one to dedicate to it, and note its email address and password. These are the **Username** and **Password** you will enter in BalkanID.
3. Give the account these permissions:
* **Manage Employees** and **Manage Clients**, so it can read the other users on the account.
* **Share distribution groups** and **Edit other users' shared distribution groups**, so it can read distribution groups and who belongs to them.
4. Give the account access to every folder whose permissions you want reviewed. Folders it cannot open are not extracted, so its folder access decides how much of your content BalkanID can report on.
5. Set the account so that its password does not expire, and exempt it from single sign-on enforcement and two-step verification. BalkanID signs in with the username and password directly, so anything that interrupts that sign-in will stop the integration from connecting.
### Configure ShareFile within your BalkanID tenant
1. To find the **Client ID** and **Client Secret**, sign in to ShareFile and click **Get an API Key**.
2. In the **API Key Generator**, enter an **Application Name**, a **Description** and a **Redirect URI**.
3. Click **Generate API Key**, then copy the **Client Id** and **Client Secret** it shows you. The secret is displayed once, so record it now.
4. In BalkanID, go to **Integrations** and click **Add integration**.
Integrations
5. Search for ShareFile, select it, and click **Next**.
Connect a new application
6. Under **Select Extraction Type**, keep **Direct Configuration** selected and enter your **Subdomain**, **Client ID**, **Client Secret**, **Username** and **Password**, then click **Next.**
Direct Configuration
7. Click Next to move onto Optional Configuration.
8. Fill **Optional Configuration**, if required.
Optional Configuration
9. Once you have filled in the information, click **Save**. Your integration is now configured and you will see the status of the integration displayed alongside other integrations on the Integrations page. When data is available, the integration Status column will read **Connected** and the integration Message will read **Data available**.
### What BalkanID extracts from ShareFile
* **Users** — both employee and client users, each labelled with its account type.
* **Roles** — the account permissions each user holds.
* **Distribution groups** — each group and the users who belong to it.
* **Folders** — each folder and the access granted on it, including whether a user or group can view, download, upload, delete or manage permissions, and who owns it.
Where a distribution group has been granted access to a folder, BalkanID also attributes that access to each member of the group, so a user's effective folder access is visible without opening the group.
### Things to know
* ShareFile applies access controls to folders, not to individual files, so BalkanID reports folder access only.
* ShareFile access controls are not cumulative. A subfolder either inherits its parent's list of people or replaces it, and BalkanID reads only the permissions attached directly to a folder.
* Folders the service account cannot open are not visible to BalkanID at all, so widen its folder access if coverage looks incomplete.
* A user's status and last sign-in are read per user. If ShareFile does not return them, the user's status is reported as unknown.
* Groups nested inside other distribution groups are not expanded.
### Integration Scopes
| **Read Only Scopes** | **Lifecycle Management Scopes** |
| ---------------------------------------------------------------------------------------------------------------------- | ------------------------------- |
|
Manage Employees Manage Clients Share distribution groups Edit other users' shared distribution groups
| N/A |
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:
```
GET https://docs.balkan.id/getting-started/setting-up-your-tenant/application-integrations/direct-application-integrations/sharefile-integration-setup.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
