Safe Haskell	Safe-Inferred
Language	GHC2021

Network.Globus.Auth

Synopsis

newtype State = State Text
authorizationUrl :: Token ClientId -> Uri Redirect -> NonEmpty Scope -> State -> Uri Authorization
fetchAccessTokens :: MonadIO m => Token ClientId -> Token ClientSecret -> Uri Redirect -> Token Exchange -> m (NonEmpty TokenItem)
redirectUri :: QueryParam param => Uri Redirect -> param
newtype TokenResponse = TokenResponse (NonEmpty TokenItem)
data TokenItem = TokenItem {
- scope :: Scopes
- access_token :: Token Access
- expires_in :: Int
- state :: State
}
scopeToken :: Scope -> NonEmpty TokenItem -> Maybe (Token Access)
fetchUserInfo :: MonadIO m => Token OpenId -> m UserInfoResponse
identityAuth :: Token OpenId -> Option Https
data UserInfoResponse = UserInfoResponse {
- info :: UserInfo
- email :: Maybe UserEmail
- profile :: Maybe UserProfile
}
data UserInfo = UserInfo {
- sub :: Text
- last_authentication :: Int
}
newtype UserEmail = UserEmail Text
data UserProfile = UserProfile {
- name :: Text
- organization :: Text
- preferred_username :: Text
- identity_provider :: Text
- identity_provider_display_name :: Text
}

Documentation

newtype State Source #

Opaque secret identifying the user. Validate on redirect

Constructors

State Text

Instances

Instances details

IsString State Source #
Instance details Defined in Network.Globus.Auth Methods fromString :: String -> State #
Show State Source #
Instance details Defined in Network.Globus.Auth Methods showsPrec :: Int -> State -> ShowS # show :: State -> String # showList :: [State] -> ShowS #
FromJSON State Source #
Instance details Defined in Network.Globus.Auth Methods parseJSON :: Value -> Parser State # parseJSONList :: Value -> Parser [State] # omittedField :: Maybe State #

authorizationUrl :: Token ClientId -> Uri Redirect -> NonEmpty Scope -> State -> Uri Authorization Source #

The end user must visit this url

fetchAccessTokens :: MonadIO m => Token ClientId -> Token ClientSecret -> Uri Redirect -> Token Exchange -> m (NonEmpty TokenItem) Source #

redirectUri :: QueryParam param => Uri Redirect -> param Source #

newtype TokenResponse Source #

fetchAccessTokens returns a non-empty list matching the scopes

Constructors

TokenResponse (NonEmpty TokenItem)

Instances

Instances details

Show TokenResponse Source #
Instance details Defined in Network.Globus.Auth Methods showsPrec :: Int -> TokenResponse -> ShowS # show :: TokenResponse -> String # showList :: [TokenResponse] -> ShowS #
FromJSON TokenResponse Source #
Instance details Defined in Network.Globus.Auth Methods parseJSON :: Value -> Parser TokenResponse # parseJSONList :: Value -> Parser [TokenResponse] # omittedField :: Maybe TokenResponse #

data TokenItem Source #

Constructors

TokenItem
Fields scope :: Scopes access_token :: Token Access expires_in :: Int state :: State

Instances

Instances details

Generic TokenItem Source #
Instance details Defined in Network.Globus.Auth Associated Types type Rep TokenItem :: Type -> Type # Methods from :: TokenItem -> Rep TokenItem x # to :: Rep TokenItem x -> TokenItem #
Show TokenItem Source #
Instance details Defined in Network.Globus.Auth Methods showsPrec :: Int -> TokenItem -> ShowS # show :: TokenItem -> String # showList :: [TokenItem] -> ShowS #
FromJSON TokenItem Source #
Instance details Defined in Network.Globus.Auth Methods parseJSON :: Value -> Parser TokenItem # parseJSONList :: Value -> Parser [TokenItem] # omittedField :: Maybe TokenItem #
type Rep TokenItem Source #
Instance details Defined in Network.Globus.Auth type Rep TokenItem = D1 ('MetaData "TokenItem" "Network.Globus.Auth" "globus-0.1.2-inplace" 'False) (C1 ('MetaCons "TokenItem" 'PrefixI 'True) ((S1 ('MetaSel ('Just "scope") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Scopes) :: S1 ('MetaSel ('Just "access_token") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Token 'Access))) :: (S1 ('MetaSel ('Just "expires_in") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 State))))

scopeToken :: Scope -> NonEmpty TokenItem -> Maybe (Token Access) Source #

fetchUserInfo :: MonadIO m => Token OpenId -> m UserInfoResponse Source #

You MUST include the OpenId Scope for this to work

identityAuth :: Token OpenId -> Option Https Source #

data UserInfoResponse Source #

Constructors

UserInfoResponse
Fields info :: UserInfo email :: Maybe UserEmail profile :: Maybe UserProfile

Instances

Instances details

FromJSON UserInfoResponse Source #
Instance details Defined in Network.Globus.Auth Methods parseJSON :: Value -> Parser UserInfoResponse # parseJSONList :: Value -> Parser [UserInfoResponse] # omittedField :: Maybe UserInfoResponse #

data UserInfo Source #

Constructors

UserInfo
Fields sub :: Text last_authentication :: Int

Instances

Instances details

Generic UserInfo Source #
Instance details Defined in Network.Globus.Auth Associated Types type Rep UserInfo :: Type -> Type # Methods from :: UserInfo -> Rep UserInfo x # to :: Rep UserInfo x -> UserInfo #
Show UserInfo Source #
Instance details Defined in Network.Globus.Auth Methods showsPrec :: Int -> UserInfo -> ShowS # show :: UserInfo -> String # showList :: [UserInfo] -> ShowS #
FromJSON UserInfo Source #
Instance details Defined in Network.Globus.Auth Methods parseJSON :: Value -> Parser UserInfo # parseJSONList :: Value -> Parser [UserInfo] # omittedField :: Maybe UserInfo #
type Rep UserInfo Source #
Instance details Defined in Network.Globus.Auth type Rep UserInfo = D1 ('MetaData "UserInfo" "Network.Globus.Auth" "globus-0.1.2-inplace" 'False) (C1 ('MetaCons "UserInfo" 'PrefixI 'True) (S1 ('MetaSel ('Just "sub") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "last_authentication") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newtype UserEmail Source #

Constructors

UserEmail Text

Instances

Instances details

Show UserEmail Source #
Instance details Defined in Network.Globus.Auth Methods showsPrec :: Int -> UserEmail -> ShowS # show :: UserEmail -> String # showList :: [UserEmail] -> ShowS #
Eq UserEmail Source #
Instance details Defined in Network.Globus.Auth Methods (==) :: UserEmail -> UserEmail -> Bool # (/=) :: UserEmail -> UserEmail -> Bool #
FromJSON UserEmail Source #
Instance details Defined in Network.Globus.Auth Methods parseJSON :: Value -> Parser UserEmail # parseJSONList :: Value -> Parser [UserEmail] # omittedField :: Maybe UserEmail #

data UserProfile Source #

Constructors

UserProfile
Fields name :: Text organization :: Text preferred_username :: Text identity_provider :: Text identity_provider_display_name :: Text

Instances

Instances details

Generic UserProfile Source #
Instance details Defined in Network.Globus.Auth Associated Types type Rep UserProfile :: Type -> Type # Methods from :: UserProfile -> Rep UserProfile x # to :: Rep UserProfile x -> UserProfile #
Show UserProfile Source #
Instance details Defined in Network.Globus.Auth Methods showsPrec :: Int -> UserProfile -> ShowS # show :: UserProfile -> String # showList :: [UserProfile] -> ShowS #
FromJSON UserProfile Source #
Instance details Defined in Network.Globus.Auth Methods parseJSON :: Value -> Parser UserProfile # parseJSONList :: Value -> Parser [UserProfile] # omittedField :: Maybe UserProfile #
type Rep UserProfile Source #
Instance details Defined in Network.Globus.Auth type Rep UserProfile = D1 ('MetaData "UserProfile" "Network.Globus.Auth" "globus-0.1.2-inplace" 'False) (C1 ('MetaCons "UserProfile" 'PrefixI 'True) ((S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "organization") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "preferred_username") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "identity_provider") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "identity_provider_display_name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))