SharePoint

Windows credentials authentication type

To enable Windows credentials authentication type, you must complete the following steps:

1. Configure PSC and create an endpoint attachment.
2. Specify the credentials in Google Cloud.

Configure PSC and create an endpoint attachment

1. Create an instance group with the IP where SharePoint is hosted.
2. Create an internal passthrough network load balancer and use the instance group that you created as the backend. The TCP internal load balancer must have the global access enabled.
3. Publish the load balancer in Private Service Connect. A service attachment is generated after the load balancer is published.
4. Publish the service and specify the load balancer that you created.
5. Use the service attachment to create an endpoint attachment.
6. After you create the endpoint attachment, create a SharePoint connection with the endpoint attachment IP.

For more information about creating an endpoint attachment, see Create an endpoint attachment.

Specify the Windows credentials details in Google Cloud

When you create the connection in Integration Connectors , you must specify the following details:

In the Authentication section, select Windows credentials as the authentication type and then enter the following details:

• Username: Enter the username.
• Password: Select the password.
• Secret version: Enter the secret version.

Windows credentials connection type

The following table lists the sample configuration values for the Windows credentials connection type.

Azure AD authentication type

To enable Azure AD authentication type, you must complete the following steps:

1. Register your app and obtain the OAuthClientId and OAuthClientSecret.
2. Specify the credentials in Google Cloud.
3. Authorize the connection in Google Cloud.
4. Add the redirect URL to your app.

Register your app and obtain the OAuthClientId and OAuthClientSecret

To register your app and obtain the OAuthClientId and OAuthClientSecret for your app, do the following:

1. Log in to the Azure Portal.
2. In Azure services, select App registrations and then New registration.
3. Enter an application name and select Any Microsoft Entra ID tenant - Multitenant.
4. Click Register.
5. After creating the app, navigate to the Certificates & secrets section, create a client secret for the application, and save the client secret value.
6. In API permissions, select the required Application permissions and Delegated permissions. For the connection to be active, you must grant the following minimum permission:Sites.Read.All.

   The following table lists the permissions that are required to perform operations in the application.

   Delegated permissions	Application permissions
   ConsentRequest.Read.All	AllSites.FullControl
   ConsentRequest.ReadWrite.All	AllSites.Manage
   DelegatedAdminRelationship.Read.All	AllSites.Read
   DelegatedAdminRelationship.ReadWrite.All	AllSites.Write
   DelegatedPermissionGrant.Read.All	EnterpriseResource.Read
   DelegatedPermissionGrant.ReadWrite.All	EnterpriseResource.Write
   Files.Read.All	MyFiles.Read
   Files.ReadWrite.All	MyFiles.Write
   Group.Create	Project.Read
   Group.Read.All	Project.Write
   Group.ReadWrite.All	ProjectWebApp.FullControl
   Sites.FullControl.All	ProjectWebAppReporting.Read
   Sites.FullControl.All	Sites.FullControl.All
   Sites.Manage.All	Sites.Manage.All
   Sites.Read.All	Sites.Read.All
   Sites.ReadWrite.All	Sites.ReadWrite.All
   Sites.Selected	Sites.Search.All
   User.Export.All	Sites.Selected
   User.Read	TaskStatus.Submit
   User.Read.All	TermStore.Read.All
   User.ReadWrite.All	TermStore.Read.All
   	TermStore.ReadWrite.All
   	TermStore.ReadWrite.All
   	User.Read.All
   	User.Read.All
   	User.ReadWrite.All
   	User.ReadWrite.All

7. Save your changes.
8. If you have selected to use permissions that require admin consent, you can grant them from the current tenant on the API Permissions page.
9. To add the scope, go to the Expose an API section and add AllSites.Manage, Sites.FullControl.All scopes and select who can control (Admins and users).
10. Click Save.

Specify the credentials in Google Cloud

When you create the connection in Integration Connectors , you must specify the following details:

In the Authentication section, select AzureAD as the authentication type and then enter the following details:

• Client ID: Enter the client ID that is used for requesting access tokens.
• Scopes: Enter a comma-separated list of desired scopes. For example, Sites.FullControl.All
• Client secret: Enter the secret that contains the client secret for the connected app that you created.
• Secret version: Secret version for the secret selected above.
• Authorization URL: The authorization URL that you generate when you create an OAuth client. Enter the URL in the following format: https://login.microsoftonline.com/TENANT_IDENTIFIER/oauth2/v2.0/authorize?prompt=consent. For example, https://login.microsoftonline.com/9byyyyyyyyy8112/oauth2/v2.0/authorize?prompt=consent.

Authorize the connection in Google Cloud

1. In the Connections page, locate the newly created connection.

   The Status for the new connector will be Authorization required.

2. Click Authorization required.

   This shows the Edit authorization pane.

3. Copy the Redirect URI value to your external application. For more information, see Add the redirect URL to your app.
4. Verify the authorization details.
5. Click Authorize.

   If the authorization is successful, the connection status will be set to Active in the Connections page.

Add the redirect URL to your app

1. In the Azure portal, click Azure services > App registrations.
2. Click on your App name.
3. Click add redirect URI.
4. Click Add a platform.
5. In the Web dialog, paste the redirect URI that you copied when you authorized the connection in Google Cloud.

Azure AD connection type

The following table lists the sample configuration values for the Azure AD connection type:

OAuth 2.0 - client credentials with JWT bearer authentication type

To enable OAuth 2.0 - client credentials with JWT bearer authentication type, you must complete the following steps:

1. Create a certificate.
2. Upload the certificate to Azure portal.
3. Obtain a private key.
4. Complete the setup.
5. Specify the OAuth 2.0 JWT bearer credentials in Google Cloud.

Create a certificate

1. Create an empty folder on your computer.
2. Create a text file in the folder.
3. Copy the PowerShell script from the Granting access via Azure AD App-Only page and paste it into the text file.
4. Rename the text file to the following name: Create-SelfSignedCertificate.ps1.
5. Run Windows PowerShell in the folder.
6. Go to the directory which contains the text file.
7. Copy the following command: .\Create-SelfSignedCertificate.ps1 -CommonName "CERTIFICATE_NAME" -StartDate 2022-09-25 -EndDate 2023-10-25

   Enter a unique name for CERTIFICATE_NAME. Change the StartDate to the current date and the EndDate to a date of your choice.

8. Paste the copied command with your changes to Windows PowerShell and then press Enter.

   Windows PowerShell prompts to Enter the password to protect the Private Key. Make sure to save the password for later use.

   Windows PowerShell creates two files: MyCertificate.pfx and MyCertificate.cer.

Upload the certificate to Azure portal

1. Sign in to Azure Portal and register a new application by specifying the following details:
   • Name: enter a name for the application.
   • Supported account types: select Accounts in this organizational directory only (Account name only - Single tenant).
2. Go to API Permissions > Add permission > Request API permissions > SharePoint.
3. Select Application permissions and then add your required permissions.
4. Select Grant admin consent and then select Yes.
5. After creating the app, navigate to the Certificates & Secrets section.
6. Select Upload Certificate and then upload your CER certificate from your computer. After the upload finishes, select Add.

   Don't add client secrets in the app as it interferes with the certificate-based authentication flow.

7. Go to Manifest, find KeyCredentials and then copy the customKeyIdentifier as the Thumbprint. You will use this later. You've now registered the app and linked the certificate.

Obtain a private key

You can obtain a private key by converting the PFX file to a PEM file using OpenSSL.

1. From the command prompt, go to the folder with your PFX file and run the following command: openssl pkcs12 -in MyCertificate.pfx -out MyCertificate.pem -nodes
2. Enter the PFX password which you used in the certificate creation process.
3. Open the PEM file in a text editor and copy the entire text, which is your private key.

Complete the setup

1. Copy the Client ID and Tenant ID from the newly registered app in the Azure portal.
2. Sign in with SharePoint List Service Principal authentication with the following credentials:
• Client ID
• Tenant ID
• Private key
• Thumbprint (private key password)

Specify the OAuth 2.0 JWT bearer credentials in Google Cloud

When you create the connection in Integration Connectors , you must specify the following details:

In the Authentication section, select OAuth 2.0 client credentials with JWT bearer as the authentication type and then enter the following details:

• In the Client ID field, enter the client ID that is used for requesting access tokens. This is the consumer key generated when you registered the app in the Azure portal.
• In the Private key field, select the Secret Manager secret containing the contents of the private key file in PEM format. The private key should match the public key/certificate provided to Connector.
• In the Secret version field, select the version for the secret selected above.
• In the Private key password field, select the secret manager secret containing the password (paraphrase) of the private key file. Use the same password that you set to protect the private key when you created the certificate.
• In the Secret version field, select the version for the secret selected above.
• In the Azure Tenant field, enter the Microsoft online tenant being used to access data.

JWT Bearer Certificate connection type

The following table lists the sample configuration values for the OAuth 2.0 JWT Bearer Certificate connection type.

OAuth 2.0 - client secret connection type

To enable the OAuth 2.0 client secret connection type, you must complete the following steps:

1. Register the add-in.
2. Grant permissions to the add-in.
3. Specify the OAuth 2.0 client credentials in Google Cloud
4. Re-authorization for authorization code

Register the add-in

1. Navigate to the Register Add-In page using the following URL: https://<SITE_NAME>.SharePoint.com/_layouts/15/appregnew.aspx.
2. In the App information section, generate the client ID and client secret.
3. Specify values for Title, App domain, and redirect URI.
4. Click Create.The add-in is registered, and the SharePoint App displays the created information.

Grant permissions to the add-in

1. Navigate to the SharePoint site using the following URL: https://<SITE_NAME>-admin.sharepoint.com/_layouts/15/appinv.aspx. You are redirected to the Grant Permission page.
2. In the App ID field, enter the client ID which you generated earlier, and click Lookup. The values for Title, App Domain, and Redirect URL are populated.
3. Enter the following permission request in XML format:

         <AppPermissionRequests AllowAppOnlyPolicy="true">
         <AppPermissionRequest Scope="http://sharepoint.com/content/tenant" Right="FullControl"/>
         </AppPermissionRequests>
           

4. Click Create. The Sharepoint App displays a permission consent dialog.
5. Click Trust it.

Specify the OAuth 2.0 client credentials in Google Cloud

When you create the connection in Integration Connectors, you must specify the following details:

In the Authentication section, select OAuth 2.0 client credentials with client secret as the authentication type and then enter the following details:

• In the Client ID field, enter the client ID provided by connector for the app you created.
• In the Client Secret field, select the Secret Manager secret containing the client secret for the connected app you created.
• In the Secret version field, select the version of the client secret.

Re-authorization for authorization code

If you use the Authorization code authentication type and have made any configuration changes in your SharePoint application, you must re-authorize your SharePoint connection. To re-authorize a connection, perform the following steps:

1. Click on the required connection in the Connections page.

   This opens the connection details page.

2. Click Edit to edit the connection details.
3. Verify the OAuth 2.0 - Authorization code details in the Authentication section.

   If required, make the necessary changes.

4. Click Save. This takes you to the connection details page.
5. Click Edit authorization in the Authentication section. This shows the Authorize pane.
6. Click Authorize.

   If the authorization is successful, the connection status will be set to Active in the Connections page.

Client credential connection type

The following table lists the sample configuration values for the OAuth 2.0 client credentials connection type.

Actions

This section lists some of the actions supported by the connector. To understand how to configure the actions, see Action examples.

DeleteAttachment action

This action deletes an attachment.

Input parameters of the DeleteAttachment action

CheckInDocument action

This action lets you check in a document.

Input parameters of the CheckInDocument action

CheckOutDocument action

This action lets you check out a file.

Input parameters of the CheckOutDocument action

DiscardCheckOutDocument action

This action lets you undo a file check out.

Input parameters of the DiscardCheckOutDocument action

CopyDocument action

This action lets you copy a file from one location to another location.

Input parameters of the CopyDocument action

UploadDocument action

This action lets you upload a file.

Input parameters of the UploadDocument action

DownloadDocument action

This action lets you download a file.

Input parameters of the DownloadDocument action

MoveAttachmentOrDocument action

This action lets you move a file from one folder to another folder.

Input parameters of the MoveAttachmentOrDocument action

CreateFolder action

This action lets you create a folder.

Input parameters of the CreateFolder action

AddAttachments action

This action lets you add an attachment.

Input parameters of the AddAttachments action

DownloadAttachments action

This action lets you download attachments.

Input parameters of the DownloadAttachments action

Action examples

This section describes how to perform some of the actions in this connector.

Example - Delete an attachment

This example deletes the specified file.

1. In the Configure connector task dialog, click Actions.
2. Select the DeleteAttachment action, and then click Done.
3. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

   {
   "ListTitle": "My lists",
   "ItemId": "1",
   "FileName": "sitepages.txt"
   }

If the action is successful, the DeleteAttachment task's connectorOutputPayload response parameter will have a value similar to the following:

[{
"Status": "Success"
}]

Example - Check in a document

This example checks in a document.

1. In the Configure connector task dialog, click Actions.
2. Select the CheckInDocument action, and then click Done.
3. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

   {
   "RelativeURL": "/Shared Documents/TestFolder",
   "DocumentName": "Document.txt",
   "Comment": "Comment test"
   }

If the action is successful, the CheckInDocument task's connectorOutputPayload response parameter will have a value similar to the following:

[{
"Status": "Success"
}]

Example - Check out a file

This example checks out a file.

1. In the Configure connector task dialog, click Actions.
2. Select the CheckOutDocument action, and then click Done.
3. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

   {
   "RelativeURL": "/Shared Documents/TestFolder",
   "DocumentName": "Document.txt"
   }

If the action is successful, the CheckOutDocument task's connectorOutputPayload response parameter will have a value similar to the following:

[{
"Status": "Success"
}]

Example - Discard a check out

This example reverts a file check out.

1. In the Configure connector task dialog, click Actions.
2. Select the DiscardCheckOutDocument action, and then click Done.
3. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

   {
   "RelativeURL": "/Shared Documents/TestFolder",
   "DocumentName": "Document.docx"
   }

If the action is successful, the DiscardCheckOutDocument task's connectorOutputPayload response parameter will have a value similar to the following:

[{
"Status": "Success"
}]

Example - Copy a file

This example copies a file from one location to another location.

1. In the Configure connector task dialog, click Actions.
2. Select the CopyDocument action, and then click Done.
3. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

   {
   "SourceFileRelativeUrl": "/Shared Documents/Document.docx",
   "DestFileRelativeUrl": "/Shared Documents/TestFolder/Document123.docx"
   }

If the action is successful, the CopyDocument task's connectorOutputPayload response parameter will have a value similar to the following:

[{
"Status": "Success"
}]

Example - Upload a text file

This example uploads a text file to the specified location.

1. In the Configure connector task dialog, click Actions.
2. Select the UploadDocument action, and then click Done.
3. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

   {
   "FileName": "test.txt",
   "RelativeUrl": "/Shared Documents/TestFolder",
   "Content": "abcd"
   }

If the action is successful, the UploadDocument task's connectorOutputPayload response parameter will have a value similar to the following:

[{
"Status": "Success"
}]

Example - Upload a binary file

This example uploads a binary file to the specified location. When uploading a binary file, specify the content to upload as a Base64 encoded string.

1. In the Configure connector task dialog, click Actions.
2. Select the UploadDocument action, and then click Done.
3. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

   {
   "FileName": "test.txt",
   "RelativeUrl": "/Shared Documents/TestFolder",
   "ContentBytes": "SGVsbG8gd29ybGQK",
   "HasBytes": "true"
   }

If the action is successful, the UploadDocument task's connectorOutputPayload response parameter will have a value similar to the following:

[{
"Status": "Success"
}]

Example - Download a file

This example downloads a file.

1. In the Configure connector task dialog, click Actions.
2. Select the DownloadDocument action, and then click Done.
3. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

   {
   "RemoteFile": "/TestFolder/test.txt",
   "Library": "Shared Documents"
   }

If the action is successful, the DownloadDocument task's connectorOutputPayload response parameter will have a value similar to the following:

[{
"Success": "True",
"Content": "Test File",
}]

Example - Download a binary file

This example downloads a binary file.

1. In the Configure connector task dialog, click Actions.
2. Select the DownloadDocument action, and then click Done.
3. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

   {
   "RemoteFile": "/TestFolder/test1.png",
   "Library": "Shared Documents"
   "HasBytes": "true"  
   }

If the action is successful, the DownloadDocument task's connectorOutputPayload response parameter will have a value similar to the following:

[{
"Success": "True",
"ContentBytes": "VGVzdCBGaWxl",
}]

Example - Download a file from a specific site

This example downloads a file from a specific site.

1. In the Configure connector task dialog, click Actions.
2. Select the DownloadDocument action, and then click Done.
3. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

   {
     "RemoteFile": "	http://z8**.sharepoint.com/sites/SharepointGCS/Docs/SharpointGCS.docx",
     "Library": "Docs",
     "HasBytes": true
   }
   

If the action is successful, the DownloadDocument task's connectorOutputPayload response parameter will have a value similar to the following:

[
  {
    "Success": "True",
    "ContentBytes": "UEsDBAoAAAAAAAAAIQD/////TwEAAE8BAAAQAAAAW3RyYXNoXS8wMDAwLmRhdP////nFmjQeC1QbGmk9o7n0xjiLgudAMOrYQBpOZdZp5/OrWkWbudVPccasL5uVSKun3URrHAxow7iMUm2WSi7nlGy2Mr+sjJxQSrYFcFtDQyo/QSutWhbNcAODEWh14mklzxCS9C5CW3Fmwme/gMKGjGoXlSVyvtDoB+u0A6XtA8bkWTnPNHSvxcepoAKIdsR96imCvxe4MxOWqHWnQkLDyjNMOMrrQeMDF7nOMCCvPlVn5Vd6KlDYnHlW1zLOcQf6WmKl2xN4Z8WBXZfkrJZqPv6yNdWyp8ADRmgTdRSqDkPpQqzvqWj3qpdiRZqSwyBRtfr2kHBumkTNjSi6drBMFMxZEgrktw6ZxuEXcx3v16cXd6k5JVO3kOXMg/HFnH"
  }
]

To download a file from a specific site, you must provide the complete address of the remote file.

Example - Move an attachment

This example moves an attachment from one location to another location.

1. In the Configure connector task dialog, click Actions.
2. Select the MoveAttachmentOrDocument action, and then click Done.
3. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

   {
   "SourceFileURL": "/Shared Documents/test.txt",
   "DestinationFolderURL": "/Shared Documents/TestFolder"
   }

If the action is successful, the MoveAttachmentOrDocument task's connectorOutputPayload response parameter will have a value similar to the following:

[{
"Result": "Success"
}]

Example - Create a folder

This example creates a folder in the specified location.

1. In the Configure connector task dialog, click Actions.
2. Select the CreateFolder action, and then click Done.
3. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

   {
   "RelativeURL": "/Shared Documents/TestFolder",
   "FolderName": "TestFolder123"
   }

If the action is successful, the CreateFolder task's connectorOutputPayload response parameter will have a value similar to the following:

[{
"Id": "110842b7-2393-4f11-9391-3d75214e9fb8",
"Status": "Success"
}]

Example - Add an attachment

This example adds an attachment to the specified list.

1. In the Configure connector task dialog, click Actions.
2. Select the AddAttachments action, and then click Done.
3. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

   {
   "ListTitle": "My Lists",
   "FileName": "TestAttachment2",
   "Content": "abcd text",
   "ItemId": "1"
   }

If the action is successful, the AddAttachments task's connectorOutputPayload response parameter will have a value similar to the following:

[{
"RelativeUrl": "/Lists/My lists/Attachments/1/TestAttachment2",
"Status": "Success"
}]

Example - Add a binary attachment

This example adds a binary attachment to the specified list.

1. In the Configure connector task dialog, click Actions.
2. Select the AddAttachments action, and then click Done.
3. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

   {
   "ListTitle": "My Lists",
   "FileName": "TestAttachment3",
   "ContentBytes": "VGVzdCBGaWxl",
   "HasBytes": "true",  
   "ItemId": "1"
   }

If the action is successful, the AddAttachments task's connectorOutputPayload response parameter will have a value similar to the following:

[{
"RelativeUrl": "/Lists/My lists/Attachments/1/TestAttachment3",
"Status": "Success"
}]

Example - Download an attachment

This example downloads an attachment.

1. In the Configure connector task dialog, click Actions.
2. Select the DownloadAttachments action, and then click Done.
3. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

   {
   "RemoteFile": "/Shared Documents/Document.txt"
   }

If the action is successful, the DownloadAttachments task's connectorOutputPayload response parameter will have a value similar to the following:

[{
"Success": "True",
"Content": "Test File",
}]

Example - Download a binary attachment

This example downloads a binary attachment.

1. In the Configure connector task dialog, click Actions.
2. Select the DownloadAttachments action, and then click Done.
3. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

   {
   "RemoteFile": "/Shared Documents/Document.docx",
   "HasBytes": "true"
   }

If the action is successful, the DownloadAttachments task's connectorOutputPayload response parameter will have a value similar to the following:

[{
"Success": "True",
"ContentBytes": "VGVzdCBGaWxl",
}]

Entity operation examples

This section shows how to perform some of the entity operations in this connector.

Example - List all files

This example lists all the files in the Files entity.

1. In the Configure connector task dialog, click Entities.
2. Select Files from the Entity list.
3. Select the List operation, and then click Done.
4. Optionally, in Task Input section of the Connectors task, you can filter your result set by specifying a filter clause. You can also specify multiple filter conditions by using the logic operators.

Example - Get a list

This example gets a list with the specified ID from the My Lists entity.

1. In the Configure connector task dialog, click Entities.
2. Select My Lists from the Entity list.
3. Select the Get operation, and then click Done.
4. In the Task Input section of the Connectors task, click EntityId and then enter 3 in the Default Value field.

   Here, 3 is a primary key value in the My Lists entity.

Example - Create a record

This example creates a record in the My Lists entity.

1. In the Configure connector task dialog, click Entities.
2. Select My Lists from the Entity list.
3. Select the Create operation, and then click Done.
4. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

   {
   "AuthorId": 11.0, 
   "BaseName": "3_",
   "Attachments": false,
   "Title": "Created List New"
   }

   If the integration is successful, your connector task's connectorOutputPayload field will have a value similar to the following:

   [{
   "ID": 3.0
   }]

Example - Delete a record

This example deletes the record with the specified ID in the My Lists entity.

1. In the Configure connector task dialog, click Entities.
2. Select My Lists from the Entity list.
3. Select the Delete operation, and then click Done.
4. In the Task Input section of the Connectors task, click entityId and then enter 2 in the Default Value field.