Request configuration for an authorization

Describes errors coming from attempting to parse a url after an OAuth redirection

• Empty: means there were nothing (related to OAuth 2.0) to parse
• Error: a successfully parsed OAuth 2.0 error
• Success: a successfully parsed the response

The response obtained as a result of an authentication (implicit or not)

• token (REQUIRED): The access token issued by the authorization server.

• refreshToken (OPTIONAL): The refresh token, which can be used to obtain new access tokens using the same authorization grant as described in Section 6.

• expiresIn (RECOMMENDED): The lifetime in seconds of the access token. For example, the value "3600" denotes that the access token will expire in one hour from the time the response was generated. If omitted, the authorization server SHOULD provide the expiration time via other means or document the default value.

• scope (OPTIONAL, if identical to the scope requested; otherwise, REQUIRED): The scope of the access token as described by Section 3.3.

• state (REQUIRED if state was present in the authorization request): The exact value received from the client

Describes an OAuth error as a result of an authorization request failure

• error (REQUIRED): A single ASCII error code.

• errorDescription (OPTIONAL) Human-readable ASCII text providing additional information, used to assist the client developer in understanding the error that occurred. Values for the errorDescription parameter MUST NOT include characters outside the set %x20-21 / %x23-5B / %x5D-7E.

• errorUri (OPTIONAL): A URI identifying a human-readable web page with information about the error, used to provide the client developer with additional information about the error. Values for the errorUri parameter MUST conform to the URI-reference syntax and thus MUST NOT include characters outside the set %x21 / %x23-5B / %x5D-7E.

• state (REQUIRED if state was present in the authorization request): The exact value received from the client

Redirects the resource owner (user) to the resource provider server using the specified authorization flow.

Parses the location looking for parameters in the 'fragment' set by the authorization server after redirecting the resource owner (user).

Returns ParseResult Empty when there's nothing or an invalid Url is passed

See 'parseToken', but gives you the ability to provide your own custom parsers.

This is especially useful when interacting with authorization servers that don't quite implement the OAuth2.0 specifications.

For instance, Facebook has several quirks in its implementation:

• It doesn't return any 'token_type'

    tokenParser : Query.Parser (Maybe OAuth.Token)
    tokenParser =
        Query.map (OAuth.makeToken (Just "Bearer"))
            (Query.string "access_token")

• It doesn't return any 'error', but returns instead an 'error_code'

    errorParser : Query.Parser (Maybe OAuth.ErrorCode)
    errorParser =
        Query.map (Maybe.map OAuth.errorCodeFromString)
          (Query.string "error_code")

• It doesn't return an 'error_description', but returns instead an 'error_message'

    authorizationErrorParser : OAuth.ErrorCode -> Query.Parser OAuth.Implicit.AuthorizationError
    authorizationErrorParser errorCode =
        Query.map3 (OAuth.Implicit.AuthorizationError errorCode)
            (Query.string "error_message")
            (Query.string "error_uri")
            (Query.string "state")

• It returns the parameters as query parameters instead of a fragment, and even sometimes add a noise fragment

    patchUrl : Url -> Url
    patchUrl url =
        if url.fragment == Just "_=_" || url.fragment == Nothing then
                { url | fragment = url.query  }

            _ ->
                url

Parsers used in the 'parseToken' function.

• tokenParser: Looks for an 'access_token' and 'token_type' to build a Token
• errorParser: Looks for an 'error' to build a corresponding ErrorCode
• authorizationSuccessParser: Selected when the tokenParser succeeded to parse the remaining parts
• authorizationErrorParser: Selected when the errorParser succeeded to parse the remaining parts

Default parsers according to RFC-6749

Default 'access_token' parser according to RFC-6749

Default 'error' parser according to RFC-6749

Default response success parser according to RFC-6749

Default response error parser according to RFC-6749