Skip to main content

Google Directory

Availability:
Available Airbyte CloudAvailable Airbyte OSSAvailable PyAirbyte
Support Level:
Marketplace
Connector Version:
0.2.25(Last updated 2 days ago)
CDK Version:
0.80.0
Sync Success Rate:
Usage Rate:

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 TypeAirbyte TypeNotes
stringstring
numbernumber
arrayarray
objectobject

Features​

FeatureSupported?(Yes/No)Notes
Full Refresh SyncYes
Incremental SyncNo
Replicate Incremental DeletesComing soon
SSL connectionYes
NamespacesNo

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)​

  1. Click OAuth2.0 authorization then Authenticate your Google Directory account.
  2. 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:

  1. https://www.googleapis.com/auth/admin.directory.user.readonly
  2. https://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

Field
Type
Property name
object
credentials

Changelog​

Expand to review
VersionDatePull RequestSubject
0.2.242024-11-2548638Starting with this version, the Docker image is now rootless. Please note that this and future versions will not be compatible with Airbyte versions earlier than 0.64
0.2.232024-10-2947736Update dependencies
0.2.222024-10-2247071Update dependencies
0.2.212024-10-1246785Update dependencies
0.2.202024-10-0546422Update dependencies
0.2.192024-09-2846136Update dependencies
0.2.182024-09-2145733Update dependencies
0.2.172024-09-1445540Update dependencies
0.2.162024-09-0745268Update dependencies
0.2.152024-08-3145006Update dependencies
0.2.142024-08-2444625Update dependencies
0.2.132024-08-1744243Update dependencies
0.2.122024-08-1043480Update dependencies
0.2.112024-08-0343089Update dependencies
0.2.102024-07-2742615Update dependencies
0.2.92024-07-2042191Update dependencies
0.2.82024-07-1341704Update dependencies
0.2.72024-07-1041468Update dependencies
0.2.62024-07-0941233Update dependencies
0.2.52024-07-0640948Update dependencies
0.2.42024-06-2540319Update dependencies
0.2.32024-06-2239961Update dependencies
0.2.22024-05-2038449[autopull] base image + poetry + up_to_date
0.2.12023-05-3027236Autoformat code
0.2.02023-05-3026775Remove authSpecification from spec; update stream schemas.
0.1.92021-12-068524Update connector fields title/description
0.1.82021-11-027409Support oauth (update publish)
0.1.72021-11-027409Support oauth
0.1.62021-11-027464Migrate to the CDK
0.1.52021-10-206930Fix crash when a group don't have members
0.1.42021-10-197167Add organizations and phones to users schema
Was this page helpful?