/
Google OAuth2 Account

Google OAuth2 Account

Feb 10, 2022

In this article

Overview

Use this account type to connect Google Directory Snaps with datasources that use Google OAuth2 accounts.

Prerequisites

  • None.

Account Settings

Parameter Name

Data Type

Description

Default Value

Example

Parameter Name

Data Type

Description

Default Value

Example

Label

String

Required. The name for the account. Preferably, update the account name if your project includes more than one account of the same type.

N/A

gsuite

Access token

String

Required. An object that describes the security context of SnapLogic. The token includes the identity and privileges of the user account.

The access token is retrieved when setting up the account for the endpoint. The OAuth2 flow is executed at the endpoint and the resulting access token is stored in this property.

Access tokens have limited lifetimes; you must get a new access token after it expires.

If the access token is refreshable, an optional refresh token can be stored. You get a new access token after the expiry of the existing access token if a refresh token was not defined, or if both the access and the refresh token expire.

N/A

N/A

Refresh token

String

The refresh token for the application. The refresh token is retrieved when setting up the account for the endpoint. There, the OAuth2 flow is executed and the resulting refresh token can be stored in this property. If the refresh token is stored, the access token is automatically refreshed before it expires.

N/A

N/A

Access token expiration

Integer

The time (in seconds) until which the access token must be valid.

N/A

1578932169

OAuth2 Endpoint

String

Required. URL of the endpoint's authorization.

https://accounts.google.com
/o/oauth2/auth

https://accounts.google.com
/o/oauth2/auth

OAuth2 Token

String

Required. URL of the endpoint's access token.

https://accounts.google.com
/o/oauth2/token

https://accounts.google.com
/o/oauth2/token

Auth endpoint config

String

Provides custom properties for the OAuth2 auth endpoint.

N/A

N/A

Access type

String

The access type for the token. If offline, it will be persisted in the account.

offline

offline

Approval prompt

String

The approval type for the token.

force

force

Application scope

String

The Snap-defined scope for the execution of the application. For example, the Snap can define that the application must allow only reading of data.

https://www.googleapis.com
/auth/admin.directory.user

https://www.googleapis.com
/auth/admin.directory.user

Auto-refresh token

String

Decides whether the token must be automatically refreshed by using the refresh token property.

  • If selected, the token is automatically refreshed.

  • If not selected, the auto-refresh does not work and the token expires.

Not selected

Not selected

Authorize

String

Starts the OAuth authorization flow. The account is saved before it is authorized.

N/A

N/A

Refresh

String

Refresh access token. Available after the account has been saved.

N/A

N/A

Limitations

  • None.

Troubleshooting

  • None.