openid-connect-0.1.0.0: An OpenID Connect library that does all the heavy lifting for you

CopyrightThis 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/sthenauth/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.
LicenseBSD-2-Clause
Safe HaskellNone
LanguageHaskell2010

OpenID.Connect.TokenResponse

Contents

Description

 
Synopsis

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
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 #

ToJSON (TokenResponse (Maybe Text)) Source # 
Instance details

Defined in OpenID.Connect.TokenResponse

ToJSON (TokenResponse Text) Source # 
Instance details

Defined in OpenID.Connect.TokenResponse

FromJSON (TokenResponse (Maybe Text)) Source # 
Instance details

Defined in OpenID.Connect.TokenResponse

FromJSON (TokenResponse Text) Source # 
Instance details

Defined in OpenID.Connect.TokenResponse

type Rep (TokenResponse a) Source # 
Instance details

Defined in OpenID.Connect.TokenResponse

Re-exports

newtype Words Source #

Space separated list of words.

Since: 0.1.0.0

Constructors

Words 
Instances
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

FromJSON Words Source # 
Instance details

Defined in OpenID.Connect.JSON

type Rep Words Source # 
Instance details

Defined in OpenID.Connect.JSON

type Rep Words = D1 (MetaData "Words" "OpenID.Connect.JSON" "openid-connect-0.1.0.0-HIrgHH8NHCEDSSsyi1W2Yn" 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