[[["易于理解","easyToUnderstand","thumb-up"],["解决了我的问题","solvedMyProblem","thumb-up"],["其他","otherUp","thumb-up"]],[["很难理解","hardToUnderstand","thumb-down"],["信息或示例代码不正确","incorrectInformationOrSampleCode","thumb-down"],["没有我需要的信息/示例","missingTheInformationSamplesINeed","thumb-down"],["翻译问题","translationIssue","thumb-down"],["其他","otherDown","thumb-down"]],["最后更新时间 (UTC):2025-08-22。"],[],[],null,["# Google Workspace Admin SDK\n\n| **Preview**\n|\n|\n| This product or feature is subject to the \"Pre-GA Offerings Terms\" in the General Service Terms section\n| of the [Service Specific Terms](/terms/service-terms#1).\n|\n| Pre-GA products and features are available \"as is\" and might have limited support.\n|\n| For more information, see the\n| [launch stage descriptions](/products#product-launch-stages).\n\nGoogle Workspace Admin SDK\n==========================\n\nThe Google Workspace Admin SDK connector lets you perform the supported operations on [Google Workspace Admin SDK](https://developers.google.com/admin-sdk/directory/reference/rest).\n\nBefore you begin\n----------------\n\nBefore using the Google Workspace Admin SDK connector, do the following tasks:\n\n- In your Google Cloud project:\n - Ensure that network connectivity is set up. For information about network patterns, see [Network connectivity](/integration-connectors/docs/network-connectivity-private).\n - Grant the [roles/connectors.admin](/integration-connectors/docs/connectors-access-permissions#iam-roles-for-integration-connectors) IAM role to the user configuring the connector.\n - Grant the following IAM roles to the service account that you want to use for the connector:\n - `roles/secretmanager.viewer`\n - `roles/secretmanager.secretAccessor`\n\n A service account is a special type of Google account intended to represent a non-human\n user that needs to authenticate and be authorized to access data in Google APIs.\n If you don't have a service account, you must create a service account. The connector and the service account must belong to the same project. For more\n information, see\n [Creating a service account](/iam/docs/creating-managing-service-accounts#creating).\n - Enable the following services:\n - `secretmanager.googleapis.com` (Secret Manager API)\n - `connectors.googleapis.com` (Connectors API)\n\n To understand how to enable services, see [Enabling services](/service-usage/docs/enable-disable#enabling).\n\n\n If these services or permissions have not been enabled for your project previously, you are prompted to enable them\n when configuring the connector.\n- If you are using the service account authentication instead of OAuth 2.0 authentication, ensure that appropriate permissions are given to the service account. For more information, see [IAM roles and permissions]().\n\nConfigure the connector\n-----------------------\n\nA connection is specific to a data source. It\nmeans that if you have many data sources, you must create a separate connection\nfor each data source. To create a connection, do the following:\n\n1. In the [Cloud console](https://console.cloud.google.com), go to the **Integration Connectors \\\u003e Connections** page and then select or create a Google Cloud project.\n\n\n [Go to the Connections page](https://console.cloud.google.com/connectors/connections)\n2. Click **+ Create new** to open the **Create Connection** page.\n3. In the **Location** section, choose the location for the connection.\n 1. **Region** : Select a location from the drop-down list.\n\n For the list of all the supported regions, see [Locations](/integration-connectors/docs/locations).\n 2. Click **Next**.\n\n- In the **Connection Details** section, set the following fields:\n 1. **Connector** : Select **Google Workspace Admin SDK** from the drop down list of available connectors.\n 2. **Connector version**: Select the connector version from the drop down list of available versions.\n 3. In the **Connection Name** field, enter a name for the connection instance.\n\n Connection names must meet the following criteria:\n - Connection names can use letters, numbers, or hyphens.\n - Letters must be lower-case.\n - Connection names must begin with a letter and end with a letter or number.\n - Connection names cannot exceed 49 characters.\n 4. Optionally, enter a **Description** for the connection instance.\n 5. Optionally, select **Enable cloud logging** if you want to log the connector execution details.\n 6. **Service Account** : Select a service account that has the [required roles](#before-you-begin).\n 7. Optionally, configure the **Connection node settings** :\n\n\n - **Minimum number of nodes**: Enter the minimum number of connection nodes.\n - **Maximum number of nodes**: Enter the maximum number of connection nodes.\n\n A node is a unit (or replica) of a connection that processes transactions.\n More nodes are required to process more transactions for a connection and conversely,\n fewer nodes are required to process fewer transactions.\n To understand how the nodes affect your connector pricing, see\n [Pricing for connection nodes](/integration-connectors/docs/pricing#pricing-for-connection-nodes). If you don't enter any values, by default\n the minimum nodes are set to 2 (for better availability) and the maximum nodes are set to 50.\n | **Note:** You can customize the connection node values only if you are a Pay-as-you-go customer.\n 8. Optionally, click **+ Add label** to add a label to the connection in the form of a key-value pair.\n 9. Click **Next**.\n 10. In the **Authentication** section, enter the authentication details.\n 1. Select an **Authentication type** and enter the relevant details.\n\n You can choose any of the following authentication types:\n - OAuth 2.0 - Authorization code\n - Service account\n 2. To understand how to configure these authentication types, see [Configure authentication](#configure-auth).\n 3. Click **Next**.\n 11. **Review**: Review your connection and authentication details.\n 12. Click **Create**.\n\n ### Configure authentication\n\n Enter the details based on the authentication you want to use.\n - **OAuth 2.0 - Authorization code**\n - **Client ID**: The client ID required to connect to your backend Google service.\n - **Scopes** : Select the required OAuth 2.0 scopes from the drop-down. To view all the supported OAuth 2.0 scopes for your required Google service, see the relevant section in the [OAuth 2.0 Scopes for Google APIs](https://developers.google.com/identity/protocols/oauth2/scopes) page.\n - **Client Secret**: Select the Secret Manager secret containing the password associated with the client secret.\n - **Secret version**: Select the secret version.\n - **Service account**\n\n Select this option to authenticate using the service account that you provided in\n the preceding steps when configuring this connection. Ensure that you have\n provided the service account that has the relevant IAM roles and permissions required for authentication.\n - **Scopes** : Select the required OAuth 2.0 scopes from the drop-down. For more information, see [Access scopes](/compute/docs/access/service-accounts#accesscopesiam).\n\n Actions\n -------\n\n\n This connector provides a layer of abstraction for the objects of\n the connected backend service. You can access the backend's objects\n only through this abstraction. The abstraction is exposed\n to you as actions. An `Action` is a first class\n function that is made available to the integration\n through the connector interface. An action lets you make\n changes to an entity or entities, and varies from connector\n to connector. However, it is possible\n that a connector doesn't support any action,\n in which case the `Actions` list will be empty.\n | **Note:** You can view the actions of the connector in the [Connectors task](/application-integration/docs/connectors-task).\n\n Use the Google Workspace Admin SDK connection in an integration\n ---------------------------------------------------------------\n\n After you create the connection, it becomes available in\n Application Integration. You can use the connection in an integration through the [Connectors task](/application-integration/docs/configure-connectors-task).\n\n Get help from the Google Cloud community\n ----------------------------------------\n\n You can post your questions and discuss this connector in the Google Cloud community at [Cloud Forums](https://www.googlecloudcommunity.com/gc/Integration-Services/bd-p/cloud-integration-services).\n\n What's next\n -----------\n\n - Understand how to [suspend and resume a connection](/integration-connectors/docs/suspend-resume-connection).\n - Understand how to [monitor connector usage](/integration-connectors/docs/cloud-monitoring).\n - Understand how to [view connector logs](/integration-connectors/docs/view-connector-logs)."]]