build_authentication_uri


Description:

public string build_authentication_uri (string? login_hint, bool include_granted_scopes)

Build an authentication URI to open in the user’s web browser (or an embedded browser widget).

This will display an authentication page from Google, including an authentication form and confirmation of the authorisation domains being requested by this Authorizer. The user will authenticate in the browser, then an authorisation code will be returned via the redirect_uri, ready to be passed to request_authorization.

If login_hint is non-%NULL, it will be passed to the server as a hint of which user is attempting to authenticate, which can be used to pre-fill the e-mail address box in the authentication form.

If include_granted_scopes is true, the authentication request will automatically include all authorisation domains previously granted to this user/application pair, allowing for incremental authentication — asking for permissions as needed, rather than all in one large bundle at the first opportunity. If include_granted_scopes is false, incremental authentication will not be enabled, and only the domains passed to the OAuth2Authorizer constructor will eventually be authenticated. See the reference documentation for more details.

Parameters:

this

a OAuth2Authorizer

login_hint

optional e-mail address or sub identifier for the user

include_granted_scopes

true to enable incremental authorisation

Returns:

the authentication URI to open in a web browser; free with g_free




2022 vala-language.org