Google Directory
Overview
The Directory source supports Full Refresh syncs. It uses Google Directory API.
Output schema
This Source is capable of syncing the following Streams:
Data type mapping
| Integration Type | Airbyte Type | Notes |
|---|---|---|
string | string | |
number | number | |
array | array | |
object | object |
Features
| Feature | Supported?(Yes/No) | Notes |
|---|---|---|
| Full Refresh Sync | Yes | |
| Incremental Sync | No | |
| Replicate Incremental Deletes | Coming soon | |
| SSL connection | Yes | |
| Namespaces | No |
Performance considerations
This connector attempts to back off gracefully when it hits Directory API's rate limits. To find more information about limits, see Google Directory's Limits and Quotas documentation.
Getting Started (Airbyte Cloud)
- Click
OAuth2.0 authorizationthenAuthenticate your Google Directory account. - You're done.
Getting Started (Airbyte Open Source)
Google APIs use the OAuth 2.0 protocol for authentication and authorization. This connector supports Web server application and Service accounts scenarios. Therefore, there are 2 options of setting up authorization for this source:
- Use your Google account and authorize over Google's OAuth on connection setup. Select "Default OAuth2.0 authorization" from dropdown list.
- Create service account specifically for Airbyte.
Service account requirements
- Credentials to a Google Service Account with delegated Domain Wide Authority
- Email address of the workspace admin which created the Service Account
Create a Service Account with delegated domain wide authority
Follow the Google Documentation for performing Domain Wide Delegation of Authority to create a Service account with delegated domain wide authority. This account must be created by an administrator of the Google Workspace. Please make sure to grant the following OAuth scopes to the service user:
https://www.googleapis.com/auth/admin.directory.user.readonlyhttps://www.googleapis.com/auth/admin.directory.group.readonly
At the end of this process, you should have JSON credentials to this Google Service Account.
You should now be ready to use the Google Directory connector in Airbyte.
Reference
Config fields reference
Changelog
| Version | Date | Pull Request | Subject |
|---|---|---|---|
| 0.2.1 | 2023-05-30 | 27236 | Autoformat code |
| 0.2.0 | 2023-05-30 | 26775 | Remove authSpecification from spec; update stream schemas. |
| 0.1.9 | 2021-12-06 | 8524 | Update connector fields title/description |
| 0.1.8 | 2021-11-02 | 7409 | Support oauth (update publish) |
| 0.1.7 | 2021-11-02 | 7409 | Support oauth |
| 0.1.6 | 2021-11-02 | 7464 | Migrate to the CDK |
| 0.1.5 | 2021-10-20 | 6930 | Fix crash when a group don't have members |
| 0.1.4 | 2021-10-19 | 7167 | Add organizations and phones to users schema |