Cmdlets for Gmail

Build 20.0.7654

GetOAuthAuthorizationURL

Obtains the OAuth authorization URL used for authentication with Gmail.

Input

Name Type Required Description
Scope String True The scope of access to Gmail. By default, access to all APIs used by this data provider will be specified.

デフォルト値はhttps://mail.google.com/です。

CallbackURL String False This field determines where the response is sent. The value of this parameter must exactly match one of the values registered in the APIs Console, including the HTTP or HTTPS schemes, case, and trailing forward slash ('/').
Prompt String True This field indicates the prompt to present the user. The default is CONSENT, so a given user will see a consent page every time, even if they have previously given consent to the application for a given set of scopes. If it is set to SELECT_ACCOUNT, the user will be prompted to select the account to connect to. Lastly, if it is set to NONE, no authentication or consent screens will be displayed to the user.

使用できる値は次のとおりです。NONE, CONSENT, SELECT_ACCOUNT

デフォルト値はCONSENTです。

AccessType String True This field indicates if your application needs to access Gmail when the user is not present at the browser. This parameter defaults to OFFLINE. If your application needs to refresh access tokens when the user is not present at the browser, then use OFFLINE. This will result in your application obtaining a refresh token the first time your application exchanges an authorization code for a user.

使用できる値は次のとおりです。ONLINE, OFFLINE

デフォルト値はOFFLINEです。

State String False This field indicates any state which may be useful to your application upon receipt of the response. Your application receives the same value it sent, as this parameter makes a round-trip to the Google authorization server and back. Uses include redirecting the user to the correct resource in your site, using nonces, and mitigating the cross-site request forgery.

Result Set Columns

Name Type Description
URL String The URL to complete user authentication.

Copyright (c) 2020 CData Software, Inc. - All rights reserved.
Build 20.0.7654