Network.Google.OAuth2

Lets you access OAuth2 protocol related APIs.

See: Google OAuth2 API Reference

Service Configuration

oAuth2Service :: Service

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

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

Data TokenInfo

Show TokenInfo

Generic TokenInfo

ToJSON TokenInfo

FromJSON TokenInfo

type Rep TokenInfo

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

Data JWK

Show JWK

Generic JWK

ToJSON JWK

FromJSON JWK

type Rep JWK

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

Data JWKKeysItem

Show JWKKeysItem

Generic JWKKeysItem

ToJSON JWKKeysItem

FromJSON JWKKeysItem

type Rep JWKKeysItem

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

Data UserInfoplus

Show UserInfoplus

Generic UserInfoplus

ToJSON UserInfoplus

FromJSON UserInfoplus

type Rep UserInfoplus

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.