Copyright	This file is part of the package openid-connect. It is subject to the license terms in the LICENSE file found in the top-level directory of this distribution and at: https://code.devalot.com/open/openid-connect No part of this package including this file may be copied modified propagated or distributed except according to the terms contained in the LICENSE file.
License	BSD-2-Clause
Safe Haskell	None
Language	Haskell2010

OpenID.Connect.TokenResponse

Contents

Token Response
Re-exports

Description

Synopsis

data TokenResponse a = TokenResponse {
- accessToken :: Text
- tokenType :: Text
- expiresIn :: Maybe Int
- refreshToken :: Maybe Text
- scope :: Maybe Words
- idToken :: a
- atHash :: Maybe Text
}
newtype Words = Words {
- toWordList :: NonEmpty Text
}
toWords :: MonadPlus m => Text -> m Words
fromWords :: Words -> Text

Token Response

data TokenResponse a Source #

Authentication access token response.

RFC 6749 section 5.1. with an additional field specified in OpenID Connect Core 1.0 section 3.1.3.3.

Constructors

TokenResponse

Fields

accessToken :: Text
The access token issued by the authorization server.
tokenType :: Text
The type of the token issued as described in Section 7.1. Value is case insensitive.
expiresIn :: Maybe Int
The lifetime in seconds of the access token.
refreshToken :: Maybe Text
The refresh token, which can be used to obtain new access tokens using the same authorization grant as described in Section 6.
scope :: Maybe Words
The scope of the access token as described by Section 3.3.
idToken :: a
ID Token value associated with the authenticated session.
atHash :: Maybe Text
Some flows include this hash. Access Token hash value. Its value is the base64url encoding of the left-most half of the hash of the octets of the ASCII representation of the access_token value, where the hash algorithm used is the hash algorithm used in the alg Header Parameter of the ID Token's JOSE Header.

Instances

Instances details

Functor TokenResponse Source #
Instance details Defined in OpenID.Connect.TokenResponse Methods fmap :: (a -> b) -> TokenResponse a -> TokenResponse b # (<$) :: a -> TokenResponse b -> TokenResponse a #
Generic (TokenResponse a) Source #
Instance details Defined in OpenID.Connect.TokenResponse Associated Types type Rep (TokenResponse a) :: Type -> Type # Methods from :: TokenResponse a -> Rep (TokenResponse a) x # to :: Rep (TokenResponse a) x -> TokenResponse a #
ToJSON (TokenResponse (Maybe Text)) Source #
Instance details Defined in OpenID.Connect.TokenResponse Methods toJSON :: TokenResponse (Maybe Text) -> Value # toEncoding :: TokenResponse (Maybe Text) -> Encoding # toJSONList :: [TokenResponse (Maybe Text)] -> Value # toEncodingList :: [TokenResponse (Maybe Text)] -> Encoding #
ToJSON (TokenResponse Text) Source #
Instance details Defined in OpenID.Connect.TokenResponse Methods toJSON :: TokenResponse Text -> Value # toEncoding :: TokenResponse Text -> Encoding # toJSONList :: [TokenResponse Text] -> Value # toEncodingList :: [TokenResponse Text] -> Encoding #
FromJSON (TokenResponse (Maybe Text)) Source #
Instance details Defined in OpenID.Connect.TokenResponse Methods parseJSON :: Value -> Parser (TokenResponse (Maybe Text)) # parseJSONList :: Value -> Parser [TokenResponse (Maybe Text)] #
FromJSON (TokenResponse Text) Source #
Instance details Defined in OpenID.Connect.TokenResponse Methods parseJSON :: Value -> Parser (TokenResponse Text) # parseJSONList :: Value -> Parser [TokenResponse Text] #
type Rep (TokenResponse a) Source #
Instance details Defined in OpenID.Connect.TokenResponse type Rep (TokenResponse a) = D1 ('MetaData "TokenResponse" "OpenID.Connect.TokenResponse" "openid-connect-0.1.2-B62HIuqFNv7LEYaHnJG4Mg" 'False) (C1 ('MetaCons "TokenResponse" 'PrefixI 'True) ((S1 ('MetaSel ('Just "accessToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :: (S1 ('MetaSel ('Just "tokenType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :: S1 ('MetaSel ('Just "expiresIn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Int)))) :: ((S1 ('MetaSel ('Just "refreshToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "scope") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Words))) :: (S1 ('MetaSel ('Just "idToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 a) :: S1 ('MetaSel ('Just "atHash") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text))))))

Re-exports

newtype Words Source #

Space separated list of words.

Since: 0.1.0.0

Constructors

Words
Fields toWordList :: NonEmpty Text

Instances

Instances details

Show Words Source #
Instance details Defined in OpenID.Connect.JSON Methods showsPrec :: Int -> Words -> ShowS # show :: Words -> String # showList :: [Words] -> ShowS #
Generic Words Source #
Instance details Defined in OpenID.Connect.JSON Associated Types type Rep Words :: Type -> Type # Methods from :: Words -> Rep Words x # to :: Rep Words x -> Words #
Semigroup Words Source #
Instance details Defined in OpenID.Connect.JSON Methods (<>) :: Words -> Words -> Words # sconcat :: NonEmpty Words -> Words # stimes :: Integral b => b -> Words -> Words #
ToJSON Words Source #
Instance details Defined in OpenID.Connect.JSON Methods toJSON :: Words -> Value # toEncoding :: Words -> Encoding # toJSONList :: [Words] -> Value # toEncodingList :: [Words] -> Encoding #
FromJSON Words Source #
Instance details Defined in OpenID.Connect.JSON Methods parseJSON :: Value -> Parser Words # parseJSONList :: Value -> Parser [Words] #
type Rep Words Source #
Instance details Defined in OpenID.Connect.JSON type Rep Words = D1 ('MetaData "Words" "OpenID.Connect.JSON" "openid-connect-0.1.2-B62HIuqFNv7LEYaHnJG4Mg" 'True) (C1 ('MetaCons "Words" 'PrefixI 'True) (S1 ('MetaSel ('Just "toWordList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (NonEmpty Text))))

toWords :: MonadPlus m => Text -> m Words Source #

Decode a list of words from Text.

Since: 0.1.0.0

fromWords :: Words -> Text Source #

Encode a list of words into Text.

Since: 0.1.0.0