Copyright | (c) 2015 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
Lets you access OAuth2 protocol related APIs.
- oAuth2Service :: Service
- type OAuth2API = UserInfoV2MeGetResource :<|> (UserInfoGetResource :<|> (GetCertForOpenIdConnectMethod :<|> TokenInfoMethod))
- module Network.Google.Method.OAuth2.GetCertForOpenIdConnect
- module Network.Google.Method.OAuth2.TokenInfo
- module Network.Google.Resource.OAuth2.UserInfo.Get
- module Network.Google.Resource.OAuth2.UserInfo.V2.Me.Get
- data TokenInfo
- tokenInfo :: TokenInfo
- tiAudience :: Lens' TokenInfo (Maybe Text)
- tiEmail :: Lens' TokenInfo (Maybe Text)
- tiExpiresIn :: Lens' TokenInfo (Maybe Int32)
- tiAccessType :: Lens' TokenInfo (Maybe Text)
- tiScope :: Lens' TokenInfo (Maybe Text)
- tiVerifiedEmail :: Lens' TokenInfo (Maybe Bool)
- tiUserId :: Lens' TokenInfo (Maybe Text)
- tiTokenHandle :: Lens' TokenInfo (Maybe Text)
- tiIssuedTo :: Lens' TokenInfo (Maybe Text)
- data JWK
- jwk :: JWK
- jKeys :: Lens' JWK [JWKKeysItem]
- data JWKKeysItem
- jwkKeysItem :: JWKKeysItem
- 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
- data UserInfoplus
- userInfoplus :: UserInfoplus
- uiHd :: Lens' UserInfoplus (Maybe Text)
- uiEmail :: Lens' UserInfoplus (Maybe Text)
- uiLink :: Lens' UserInfoplus (Maybe Text)
- uiLocale :: Lens' UserInfoplus (Maybe Text)
- uiGivenName :: Lens' UserInfoplus (Maybe Text)
- uiFamilyName :: Lens' UserInfoplus (Maybe Text)
- uiPicture :: Lens' UserInfoplus (Maybe Text)
- uiGender :: Lens' UserInfoplus (Maybe Text)
- uiName :: Lens' UserInfoplus (Maybe Text)
- uiVerifiedEmail :: Lens' UserInfoplus Bool
- uiId :: Lens' UserInfoplus (Maybe Text)
Service Configuration
oAuth2Service :: Service Source
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.
API Declaration
type OAuth2API = UserInfoV2MeGetResource :<|> (UserInfoGetResource :<|> (GetCertForOpenIdConnectMethod :<|> TokenInfoMethod)) Source
Represents the entirety of the methods and resources available for the Google OAuth2 API service.
Methods
oauth2.getCertForOpenIdConnect
oauth2.tokeninfo
Resources
oauth2.userinfo.get
oauth2.userinfo.v2.me.get
Types
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 :: Lens' TokenInfo (Maybe Text) Source
Who is the intended audience for this token. In general the same as issued_to.
tiEmail :: Lens' TokenInfo (Maybe Text) Source
The email address of the user. Present only if the email scope is present in the request.
tiExpiresIn :: Lens' TokenInfo (Maybe Int32) Source
The expiry time of the token, as number of seconds left until expiry.
tiAccessType :: Lens' TokenInfo (Maybe Text) Source
The access type granted with this token. It can be offline or online.
tiScope :: Lens' TokenInfo (Maybe Text) Source
The space separated list of scopes granted to this token.
tiVerifiedEmail :: Lens' TokenInfo (Maybe Bool) Source
Boolean flag which is true if the email address is verified. Present only if the email scope is present in the request.
tiIssuedTo :: Lens' TokenInfo (Maybe Text) Source
To whom was the token issued to. In general the same as audience.
JWK
jKeys :: Lens' JWK [JWKKeysItem] Source
JWKKeysItem
data JWKKeysItem Source
UserInfoplus
data UserInfoplus Source
userInfoplus :: UserInfoplus Source
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 :: Lens' UserInfoplus (Maybe Text) Source
The hosted domain e.g. example.com if the user is Google apps user.
uiGivenName :: Lens' UserInfoplus (Maybe Text) Source
The user's first name.
uiFamilyName :: Lens' UserInfoplus (Maybe Text) Source
The user's last name.
uiVerifiedEmail :: Lens' UserInfoplus Bool Source
Boolean flag which is true if the email address is verified. Always verified because we only return the user's primary email address.