Network.Google.OAuth2

Obtains end-user authorization grants for use with other Google APIs.

See: Google OAuth2 API Reference

Service Configuration

oAuth2Service :: ServiceConfig

Default request referring to version v2 of the Google OAuth2 API. This contains the host and root path used as a starting point for constructing service requests.

OAuth Scopes

userInfoProFileScope :: Proxy '["https://www.googleapis.com/auth/userinfo.profile"]

View your basic profile info

plusLoginScope :: Proxy '["https://www.googleapis.com/auth/plus.login"]

Know the list of people in your circles, your age range, and language

userInfoEmailScope :: Proxy '["https://www.googleapis.com/auth/userinfo.email"]

View your email address

plusMeScope :: Proxy '["https://www.googleapis.com/auth/plus.me"]

Know who you are on Google

API Declaration

type OAuth2API = UserInfoV2MeGetResource :<|> (UserInfoGetResource :<|> (GetCertForOpenIdConnectMethod :<|> TokenInfoMethod))

Represents the entirety of the methods and resources available for the Google OAuth2 API service.

Methods

oauth2.getCertForOpenIdConnect

module Network.Google.Method.OAuth2.GetCertForOpenIdConnect

oauth2.tokeninfo

module Network.Google.Method.OAuth2.TokenInfo

Resources

oauth2.userinfo.get

module Network.Google.Resource.OAuth2.UserInfo.Get

oauth2.userinfo.v2.me.get

module Network.Google.Resource.OAuth2.UserInfo.V2.Me.Get

Types

TokenInfo

data TokenInfo

Instances

Eq TokenInfo

Defined in Network.Google.OAuth2.Types.Product

Methods

(==) :: TokenInfo -> TokenInfo -> Bool

(/=) :: TokenInfo -> TokenInfo -> Bool

Data TokenInfo

Defined in Network.Google.OAuth2.Types.Product

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> TokenInfo -> c TokenInfo

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c TokenInfo

toConstr :: TokenInfo -> Constr

dataTypeOf :: TokenInfo -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c TokenInfo)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c TokenInfo)

gmapT :: (forall b. Data b => b -> b) -> TokenInfo -> TokenInfo

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> TokenInfo -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> TokenInfo -> r

gmapQ :: (forall d. Data d => d -> u) -> TokenInfo -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> TokenInfo -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> TokenInfo -> m TokenInfo

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> TokenInfo -> m TokenInfo

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> TokenInfo -> m TokenInfo

Show TokenInfo

Defined in Network.Google.OAuth2.Types.Product

Methods

showsPrec :: Int -> TokenInfo -> ShowS

show :: TokenInfo -> String

showList :: [TokenInfo] -> ShowS

Generic TokenInfo

Defined in Network.Google.OAuth2.Types.Product

Associated Types

type Rep TokenInfo :: Type -> Type

Methods

from :: TokenInfo -> Rep TokenInfo x

to :: Rep TokenInfo x -> TokenInfo

ToJSON TokenInfo

Defined in Network.Google.OAuth2.Types.Product

Methods

toJSON :: TokenInfo -> Value

toEncoding :: TokenInfo -> Encoding

toJSONList :: [TokenInfo] -> Value

toEncodingList :: [TokenInfo] -> Encoding

FromJSON TokenInfo

Defined in Network.Google.OAuth2.Types.Product

Methods

parseJSON :: Value -> Parser TokenInfo

parseJSONList :: Value -> Parser [TokenInfo]

type Rep TokenInfo

Defined in Network.Google.OAuth2.Types.Product

type Rep TokenInfo = D1 (MetaData "TokenInfo" "Network.Google.OAuth2.Types.Product" "gogol-oauth2-0.4.0-S6BIeg93lU9Ut3r7VdeWX" False) (C1 (MetaCons "TokenInfo'" PrefixI True) (((S1 (MetaSel (Just "_tiAudience") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_tiEmail") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_tiExpiresIn") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int32))) :*: S1 (MetaSel (Just "_tiAccessType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 (MetaSel (Just "_tiScope") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_tiVerifiedEmail") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 (MetaSel (Just "_tiUserId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_tiTokenHandle") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_tiIssuedTo") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))))))

tokenInfo :: TokenInfo

Creates a value of TokenInfo with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• tiAudience
• tiEmail
• tiExpiresIn
• tiAccessType
• tiScope
• tiVerifiedEmail
• tiUserId
• tiTokenHandle
• tiIssuedTo

tiAudience :: Lens' TokenInfo (Maybe Text)

Who is the intended audience for this token. In general the same as issued_to.

tiEmail :: Lens' TokenInfo (Maybe Text)

The email address of the user. Present only if the email scope is present in the request.

tiExpiresIn :: Lens' TokenInfo (Maybe Int32)

The expiry time of the token, as number of seconds left until expiry.

tiAccessType :: Lens' TokenInfo (Maybe Text)

The access type granted with this token. It can be offline or online.

tiScope :: Lens' TokenInfo (Maybe Text)

The space separated list of scopes granted to this token.

tiVerifiedEmail :: Lens' TokenInfo (Maybe Bool)

Boolean flag which is true if the email address is verified. Present only if the email scope is present in the request.

tiUserId :: Lens' TokenInfo (Maybe Text)

The obfuscated user id.

tiTokenHandle :: Lens' TokenInfo (Maybe Text)

The token handle associated with this token.

tiIssuedTo :: Lens' TokenInfo (Maybe Text)

To whom was the token issued to. In general the same as audience.

JWK

data JWK

Instances

Eq JWK

Defined in Network.Google.OAuth2.Types.Product

Methods

(==) :: JWK -> JWK -> Bool

(/=) :: JWK -> JWK -> Bool

Data JWK

Defined in Network.Google.OAuth2.Types.Product

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> JWK -> c JWK

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c JWK

toConstr :: JWK -> Constr

dataTypeOf :: JWK -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c JWK)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c JWK)

gmapT :: (forall b. Data b => b -> b) -> JWK -> JWK

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> JWK -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> JWK -> r

gmapQ :: (forall d. Data d => d -> u) -> JWK -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> JWK -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> JWK -> m JWK

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> JWK -> m JWK

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> JWK -> m JWK

Show JWK

Defined in Network.Google.OAuth2.Types.Product

Methods

showsPrec :: Int -> JWK -> ShowS

show :: JWK -> String

showList :: [JWK] -> ShowS

Generic JWK

Defined in Network.Google.OAuth2.Types.Product

Associated Types

type Rep JWK :: Type -> Type

Methods

from :: JWK -> Rep JWK x

to :: Rep JWK x -> JWK

ToJSON JWK

Defined in Network.Google.OAuth2.Types.Product

Methods

toJSON :: JWK -> Value

toEncoding :: JWK -> Encoding

toJSONList :: [JWK] -> Value

toEncodingList :: [JWK] -> Encoding

FromJSON JWK

Defined in Network.Google.OAuth2.Types.Product

Methods

parseJSON :: Value -> Parser JWK

parseJSONList :: Value -> Parser [JWK]

type Rep JWK

Defined in Network.Google.OAuth2.Types.Product

type Rep JWK = D1 (MetaData "JWK" "Network.Google.OAuth2.Types.Product" "gogol-oauth2-0.4.0-S6BIeg93lU9Ut3r7VdeWX" True) (C1 (MetaCons "JWK'" PrefixI True) (S1 (MetaSel (Just "_jKeys") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe [JWKKeysItem]))))

jwk :: JWK

Creates a value of JWK with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• jKeys

jKeys :: Lens' JWK [JWKKeysItem]

JWKKeysItem

data JWKKeysItem

Instances

Eq JWKKeysItem

Defined in Network.Google.OAuth2.Types.Product

Methods

(==) :: JWKKeysItem -> JWKKeysItem -> Bool

(/=) :: JWKKeysItem -> JWKKeysItem -> Bool

Data JWKKeysItem

Defined in Network.Google.OAuth2.Types.Product

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> JWKKeysItem -> c JWKKeysItem

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c JWKKeysItem

toConstr :: JWKKeysItem -> Constr

dataTypeOf :: JWKKeysItem -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c JWKKeysItem)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c JWKKeysItem)

gmapT :: (forall b. Data b => b -> b) -> JWKKeysItem -> JWKKeysItem

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> JWKKeysItem -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> JWKKeysItem -> r

gmapQ :: (forall d. Data d => d -> u) -> JWKKeysItem -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> JWKKeysItem -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> JWKKeysItem -> m JWKKeysItem

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> JWKKeysItem -> m JWKKeysItem

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> JWKKeysItem -> m JWKKeysItem

Show JWKKeysItem

Defined in Network.Google.OAuth2.Types.Product

Methods

showsPrec :: Int -> JWKKeysItem -> ShowS

show :: JWKKeysItem -> String

showList :: [JWKKeysItem] -> ShowS

Generic JWKKeysItem

Defined in Network.Google.OAuth2.Types.Product

Associated Types

type Rep JWKKeysItem :: Type -> Type

Methods

from :: JWKKeysItem -> Rep JWKKeysItem x

to :: Rep JWKKeysItem x -> JWKKeysItem

ToJSON JWKKeysItem

Defined in Network.Google.OAuth2.Types.Product

Methods

toJSON :: JWKKeysItem -> Value

toEncoding :: JWKKeysItem -> Encoding

toJSONList :: [JWKKeysItem] -> Value

toEncodingList :: [JWKKeysItem] -> Encoding

FromJSON JWKKeysItem

Defined in Network.Google.OAuth2.Types.Product

Methods

parseJSON :: Value -> Parser JWKKeysItem

parseJSONList :: Value -> Parser [JWKKeysItem]

type Rep JWKKeysItem

Defined in Network.Google.OAuth2.Types.Product

type Rep JWKKeysItem = D1 (MetaData "JWKKeysItem" "Network.Google.OAuth2.Types.Product" "gogol-oauth2-0.4.0-S6BIeg93lU9Ut3r7VdeWX" False) (C1 (MetaCons "JWKKeysItem'" PrefixI True) ((S1 (MetaSel (Just "_jkiAlg") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: (S1 (MetaSel (Just "_jkiUse") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_jkiKid") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 (MetaSel (Just "_jkiN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_jkiE") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_jkiKty") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))))

jwkKeysItem :: JWKKeysItem

Creates a value of JWKKeysItem with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• jkiAlg
• jkiUse
• jkiKid
• jkiN
• jkiE
• jkiKty

jkiAlg :: Lens' JWKKeysItem Text

jkiUse :: Lens' JWKKeysItem Text

jkiKid :: Lens' JWKKeysItem (Maybe Text)

jkiN :: Lens' JWKKeysItem (Maybe Text)

jkiE :: Lens' JWKKeysItem (Maybe Text)

jkiKty :: Lens' JWKKeysItem Text

UserInfoplus

data UserInfoplus

Instances

Eq UserInfoplus

Defined in Network.Google.OAuth2.Types.Product

Methods

(==) :: UserInfoplus -> UserInfoplus -> Bool

(/=) :: UserInfoplus -> UserInfoplus -> Bool

Data UserInfoplus

Defined in Network.Google.OAuth2.Types.Product

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> UserInfoplus -> c UserInfoplus

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c UserInfoplus

toConstr :: UserInfoplus -> Constr

dataTypeOf :: UserInfoplus -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c UserInfoplus)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c UserInfoplus)

gmapT :: (forall b. Data b => b -> b) -> UserInfoplus -> UserInfoplus

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> UserInfoplus -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> UserInfoplus -> r

gmapQ :: (forall d. Data d => d -> u) -> UserInfoplus -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> UserInfoplus -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> UserInfoplus -> m UserInfoplus

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> UserInfoplus -> m UserInfoplus

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> UserInfoplus -> m UserInfoplus

Show UserInfoplus

Defined in Network.Google.OAuth2.Types.Product

Methods

showsPrec :: Int -> UserInfoplus -> ShowS

show :: UserInfoplus -> String

showList :: [UserInfoplus] -> ShowS

Generic UserInfoplus

Defined in Network.Google.OAuth2.Types.Product

Associated Types

type Rep UserInfoplus :: Type -> Type

Methods

from :: UserInfoplus -> Rep UserInfoplus x

to :: Rep UserInfoplus x -> UserInfoplus

ToJSON UserInfoplus

Defined in Network.Google.OAuth2.Types.Product

Methods

toJSON :: UserInfoplus -> Value

toEncoding :: UserInfoplus -> Encoding

toJSONList :: [UserInfoplus] -> Value

toEncodingList :: [UserInfoplus] -> Encoding

FromJSON UserInfoplus

Defined in Network.Google.OAuth2.Types.Product

Methods

parseJSON :: Value -> Parser UserInfoplus

parseJSONList :: Value -> Parser [UserInfoplus]

type Rep UserInfoplus

Defined in Network.Google.OAuth2.Types.Product

type Rep UserInfoplus = D1 (MetaData "UserInfoplus" "Network.Google.OAuth2.Types.Product" "gogol-oauth2-0.4.0-S6BIeg93lU9Ut3r7VdeWX" False) (C1 (MetaCons "UserInfoplus'" PrefixI True) (((S1 (MetaSel (Just "_uiHd") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_uiEmail") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_uiLink") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_uiLocale") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_uiGivenName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 (MetaSel (Just "_uiFamilyName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_uiPicture") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_uiGender") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 (MetaSel (Just "_uiName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_uiVerifiedEmail") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Bool) :*: S1 (MetaSel (Just "_uiId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))))))

userInfoplus :: UserInfoplus

Creates a value of UserInfoplus with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• uiHd
• uiEmail
• uiLink
• uiLocale
• uiGivenName
• uiFamilyName
• uiPicture
• uiGender
• uiName
• uiVerifiedEmail
• uiId

uiHd :: Lens' UserInfoplus (Maybe Text)

The hosted domain e.g. example.com if the user is Google apps user.

uiEmail :: Lens' UserInfoplus (Maybe Text)

The user's email address.

uiLink :: Lens' UserInfoplus (Maybe Text)

URL of the profile page.

uiLocale :: Lens' UserInfoplus (Maybe Text)

The user's preferred locale.

uiGivenName :: Lens' UserInfoplus (Maybe Text)

The user's first name.

uiFamilyName :: Lens' UserInfoplus (Maybe Text)

The user's last name.

uiPicture :: Lens' UserInfoplus (Maybe Text)

URL of the user's picture image.

uiGender :: Lens' UserInfoplus (Maybe Text)

The user's gender.

uiName :: Lens' UserInfoplus (Maybe Text)

The user's full name.

uiVerifiedEmail :: Lens' UserInfoplus Bool

Boolean flag which is true if the email address is verified. Always verified because we only return the user's primary email address.

uiId :: Lens' UserInfoplus (Maybe Text)

The obfuscated ID of the user.