Builds the request components required to get a token in exchange of the resource owner (user) credentials

let req : Http.Request TokenResponse
    req = makeTokenRequest toMsg authentication |> Http.request

Request configuration for a Password authentication

let authentication =
      -- Optional, unless required by the resource provider
      { credentials = credentials
      -- Resource owner's password
      , password = "<user-password>"
      -- Scopes requested, can be empty
      , scope = ["read:whatever"]
      -- Token endpoint of the resource provider
      , url = "<token-endpoint>"
      -- Resource owner's username
      , username = "<user-username>"
      }

Describes at least a clientId and if defined, a complete set of credentials with the secret. Optional but may be required by the authorization server you interact with to perform a 'Basic' authentication on top of the authentication request.

  { clientId = "<my-client-id>"
  , secret = "<my-client-secret>"
  }

The response obtained as a result of an authentication:

• 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.

Describes an OAuth error as a result of a 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.

Parts required to build a request. This record is given to Http.request in order to create a new request and may be adjusted at will.

Json decoder for a positive response. You may provide a custom response decoder using other decoders from this module, or some of your own craft.

defaultAuthenticationSuccessDecoder : Decoder AuthenticationSuccess
defaultAuthenticationSuccessDecoder =
    D.map4 AuthenticationSuccess
        tokenDecoder
        refreshTokenDecoder
        expiresInDecoder
        scopeDecoder

Json decoder for an errored response.

case res of
    Err (Http.BadStatus { body }) ->
        case Json.decodeString OAuth.Password.defaultAuthenticationErrorDecoder body of
            Ok { error, errorDescription } ->
                doSomething


            _ ->
                parserFailed


    _ ->
        someOtherError

Json decoder for an 'expire' timestamp

Json decoder for a 'scope'

Json decoder for a 'scope', allowing comma- or space-separated scopes

Json decoder for an 'access_token'

Json decoder for a 'refresh_token'

Json decoder for 'error' field

Json decoder for 'error_description' field

Json decoder for 'error_uri' field