Class GoogleAuthorizationCodeRequestUrl (1.50.0)

public class GoogleAuthorizationCodeRequestUrl : AuthorizationCodeRequestUrl

Google-specific implementation of the OAuth 2.0 URL for an authorization web page to allow the end user to authorize the application to access their protected resources and that returns an authorization code, as specified in https://developers.google.com/accounts/docs/OAuth2WebServer.

Inheritance

Object > AuthorizationRequestUrl > AuthorizationCodeRequestUrl > GoogleAuthorizationCodeRequestUrl

Inherited Members

AuthorizationCodeRequestUrl.Build()

AuthorizationRequestUrl.ResponseType

AuthorizationRequestUrl.ClientId

AuthorizationRequestUrl.RedirectUri

AuthorizationRequestUrl.Scope

AuthorizationRequestUrl.State

AuthorizationRequestUrl.AuthorizationServerUrl

Namespace

Google.Apis.Auth.OAuth2.Requests

Assembly

Google.Apis.Auth.dll

Constructors

GoogleAuthorizationCodeRequestUrl(Uri)

public GoogleAuthorizationCodeRequestUrl(Uri authorizationServerUrl)

Constructs a new authorization code request with the given authorization server URL. This constructor sets the AccessType to offline.

Parameter
Name	Description
`authorizationServerUrl`	`Uri`

Properties

AccessType

public string AccessType { get; set; }

Gets or sets the access type. Set online to request on-line access or offline to request off-line access or null for the default behavior. The default value is offline.

Property Value
Type	Description
`String`

ApprovalPrompt

public string ApprovalPrompt { get; set; }

Gets or sets prompt for consent behavior auto to request auto-approval orforce to force the approval UI to show, or null for the default behavior.

Property Value
Type	Description
`String`

IncludeGrantedScopes

public string IncludeGrantedScopes { get; set; }

Gets or sets the include granted scopes to determine if this authorization request should use incremental authorization (https://developers.google.com/+/web/api/rest/oauth#incremental-auth). If true and the authorization request is granted, the authorization will include any previous authorizations granted to this user/application combination for other scopes.

Property Value
Type	Description
`String`

Remarks

Currently unsupported for installed apps.

LoginHint

public string LoginHint { get; set; }

Gets or sets the login hint. Sets email address or sub identifier. When your application knows which user it is trying to authenticate, it may provide this parameter as a hint to the Authentication Server. Passing this hint will either pre-fill the email box on the sign-in form or select the proper multi-login session, thereby simplifying the login flow.

Property Value
Type	Description
`String`

Nonce

public string Nonce { get; set; }

Gets or sets the nonce; a random value generated by your app that enables replay protection. See https://developers.google.com/identity/protocols/OpenIDConnect for more details.

Property Value
Type	Description
`String`

Prompt

public string Prompt { get; set; }

Gets of sets prompt for consent behaviour. Value can be null, "none", "consent", or "select_account". See OpenIDConnect documentation for details.

Property Value
Type	Description
`String`

UserDefinedQueryParams

public IEnumerable<KeyValuePair<string, string>> UserDefinedQueryParams { get; set; }

Gets or sets a collection of user defined query parameters to facilitate any not explicitly supported by the library which will be included in the resultant authentication URL.

Property Value
Type	Description
`IEnumerable<KeyValuePair<String, String>>`

Remarks

The name of this parameter is used only for the constructor and will not end up in the resultant query string.

Extension Method

Utilities.ThrowIfNull<T>(T, String)