Configuring the connector
This page describes how to configure the connector.
Create a service account
Create a service account with domain-wide delegation of authority:
-
Create a service account.
-
Generate and download the service account’s credentials (a public/private key pair) in the JSON format.
-
Set up domain-wide delegation for the service account and grant the following scopes by entering a comma-delimited list of scopes in the OAuth Scopes field.
Scope Description https://www.googleapis.com/auth/gmail.settings.basic
View, edit, create, or change your email settings and filters in Gmail
https://mail.google.com/
Read, compose, send, or permanently delete your emails from Gmail
https://www.googleapis.com/auth/gmail.modify
Read, compose, and send emails from your Gmail account
https://www.googleapis.com/auth/gmail.readonly
View your email messages and settings
https://www.googleapis.com/auth/gmail.settings.sharing
Manage your sensitive mail settings, including who can manage your mail
For detailed instructions, see Google Workspace documentation.
Specify the application properties
The integration supports various properties that you can use in different scenarios.
These properties should be specified in the application.properties
file.
Service account credentials
The following property specifies the path to the service account key file for authentication at Google Cloud.
Property | Type | Description |
---|---|---|
|
Mandatory |
The path to the service account key file |
Customer-specific properties
The following table lists properties for establishing a connection with SCM.
Property | Type | Description |
---|---|---|
|
Mandatory |
The username of the SCM user |
|
Mandatory |
The password of the SCM user |
|
Mandatory |
The URI of the SCM user |
|
Mandatory |
The ID of the organization in SCM |
|
Mandatory |
The base URL of the Sectigo CA |
CSR properties
The following table lists properties that are required for generating a certificate signing request (CSR).
Property | Type | Description |
---|---|---|
|
Mandatory |
A single value for a domain included in the certificate Common Name (CN) field |
|
Mandatory |
The country name included in the certificate Country (C) field |
|
Mandatory |
The state or province name included in the certificate State (ST) field |
|
Mandatory |
The location name included in the certificate Location (L) field |
|
Mandatory |
The organization name included in the certificate Organization (O) field |
|
Mandatory |
The organization unit included in the certificate Organization Unit (OU) field |
|
Mandatory |
The email address included in the certificate emailAddress field |
|
Optional |
The private key algorithm to use to generate the private key.
The default value is |
|
Optional |
The size of the TLS/SSL key to generate. The possible values are:
|
Certificate issuance properties
The following table lists properties that are used for certificate issuance.
Property | Type | Description |
---|---|---|
|
Mandatory |
The location where the certificate, CSR, private key, and enrollment IDs are stored |
|
Mandatory |
The ID of the client certificate type |
|
Mandatory |
The certificate validity period in days. The values available are dependent on the certificate type. |
Certificate auto-renewal |
||
|
Optional |
The number of days prior to expiration that a certificate renewal process is initiated.
The default expiry window is |
Collect certificate |
||
|
Optional |
The interval (in seconds) between repeated attempts to collect a certificate.
The default value is |
|
Optional |
The maximum time (in seconds) during which repeated attempts to collect a certificate will be made.
The default value is |
Create a file with the user accounts
Create a CSV file (for example, input.csv
) and add the details of the Google Workspace user accounts in the following format.
We recommend that you keep the user accounts file outside the connector’s directory on the client machine. |
[email protected],,firstName1,,lastName1,user1Password
[email protected],[email protected],firstName1,,lastName1,alias1Password
[email protected],[email protected],firstName1,,lastName1,alias2Password
[email protected],,firstName2,middleName1,lastName2,user2Password