Safe Haskell	Safe-Inferred
Language	Haskell2010

Network.OAuth.OAuth2.AuthorizationRequest

Contents

Errors
URLs

Description

Bindings Authorization part of The OAuth 2.0 Authorization Framework RFC6749 https://www.rfc-editor.org/rfc/rfc6749

Synopsis

data Errors
- = InvalidRequest
- | UnauthorizedClient
- | AccessDenied
- | UnsupportedResponseType
- | InvalidScope
- | ServerError
- | TemporarilyUnavailable
authorizationUrl :: OAuth2 -> URI
authorizationUrlWithParams :: QueryParams -> OAuth2 -> URI

Errors

data Errors Source #

Authorization Code Grant Error Responses https://tools.ietf.org/html/rfc6749#section-4.1.2.1 I found hard time to figure a way to test the authorization error flow When anything wrong in /authorize request (redirect to OAuth2 provider), it will end-up at the Provider page hence no way for this library to parse error response. In other words, /authorize ends up with 4xx or 5xx. Revisit this whenever find a case OAuth2 provider redirects back to Relying party with errors.

Constructors

InvalidRequest
UnauthorizedClient
AccessDenied
UnsupportedResponseType
InvalidScope
ServerError
TemporarilyUnavailable

Instances

Instances details

FromJSON Errors Source #
Instance details Defined in Network.OAuth.OAuth2.AuthorizationRequest Methods parseJSON :: Value -> Parser Errors # parseJSONList :: Value -> Parser [Errors] #
ToJSON Errors Source #
Instance details Defined in Network.OAuth.OAuth2.AuthorizationRequest Methods toJSON :: Errors -> Value # toEncoding :: Errors -> Encoding # toJSONList :: [Errors] -> Value # toEncodingList :: [Errors] -> Encoding #
Generic Errors Source #
Instance details Defined in Network.OAuth.OAuth2.AuthorizationRequest Associated Types type Rep Errors :: Type -> Type # Methods from :: Errors -> Rep Errors x # to :: Rep Errors x -> Errors #
Show Errors Source #
Instance details Defined in Network.OAuth.OAuth2.AuthorizationRequest Methods showsPrec :: Int -> Errors -> ShowS # show :: Errors -> String # showList :: [Errors] -> ShowS #
Eq Errors Source #
Instance details Defined in Network.OAuth.OAuth2.AuthorizationRequest Methods (==) :: Errors -> Errors -> Bool # (/=) :: Errors -> Errors -> Bool #
type Rep Errors Source #
Instance details Defined in Network.OAuth.OAuth2.AuthorizationRequest type Rep Errors = D1 ('MetaData "Errors" "Network.OAuth.OAuth2.AuthorizationRequest" "hoauth2-2.6.0-B6PU9XFvhi0G80sxl5r9bL" 'False) ((C1 ('MetaCons "InvalidRequest" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "UnauthorizedClient" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "AccessDenied" 'PrefixI 'False) (U1 :: Type -> Type))) :+: ((C1 ('MetaCons "UnsupportedResponseType" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "InvalidScope" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "ServerError" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "TemporarilyUnavailable" 'PrefixI 'False) (U1 :: Type -> Type))))

URLs

authorizationUrl :: OAuth2 -> URI Source #

See authorizationUrlWithParams

authorizationUrlWithParams :: QueryParams -> OAuth2 -> URI Source #

Prepare the authorization URL. Redirect to this URL asking for user interactive authentication.

Since: 2.6.0