OAuthSettings.userAuthUri

User login helper method.

Use this method to obtain a URI which can be used to redirect the user agent to the login page of the service we want to get access to on behalf of a user.

This URI will contain a dynamically generated state parameter, which should be returned by the service as a query string parameter when the user agent is redirected back to this client. The user session can be started by passing this parameter to the userSession method, along with the authorization code.

  1. string userAuthUri(Session httpSession, string[string] extraParams, string[] scopes)
    class OAuthSettings
    final immutable
    string
    userAuthUri
    (
    scope Session httpSession
    ,
    in string[string] extraParams = null
    ,
    in string[] scopes = null
    )
  2. string userAuthUri(Session httpSession, string[] scopes)

Parameters

httpSession Session

The current HTTP session.

extraParams string[string]

Extra parameters to include in the authentication uri. Use this to pass provider specific parameters that cannot be included in the settings because they won't be the same for every authorization request.

scopes string[]

An array of identifiers specifying the scope of access to be requested. (optional)

Return Value

Type: string

The URI the user agent should be redirected to for login and authorization.

Meta