Network.Google.Auth

Explicitly specify your Google credentials, or retrieve them from the underlying OS.

Credentials

data Credentials (s :: [Symbol])

The supported credential mechanisms.

Constructors

FromMetadata !ServiceId

Obtain and refresh access tokens from the underlying GCE host metadata at http://169.254.169.254.

FromClient !OAuthClient !(OAuthCode s)

Obtain and refresh access tokens using the specified client secret and authorization code obtained from.

See the OAuth2 Installed Application documentation for more information.

FromAccount !ServiceAccount

Use the specified service_account and scopes to sign and request an access token. The ServiceAccount will also be used for subsequent token refreshes.

A ServiceAccount is typically generated through the Google Developer Console.

FromUser !AuthorizedUser

Use the specified authorized_user to obtain and refresh access tokens.

An AuthorizedUser is typically created by the gcloud init command of the Google CloudSDK Tools.

Instances

AllowScopes s => AllowScopes (Credentials s :: Type)

Defined in Network.Google.Auth.Scope

Methods

allowScopes :: proxy (Credentials s) -> [OAuthScope]

Application Default Credentials

getApplicationDefault :: (MonadIO m, MonadCatch m) => Manager -> m (Credentials s)

Performs credentials discovery in the following order:

1. Read the default credentials from a file specified by the environment variable GOOGLE_APPLICATION_CREDENTIALS if it exists.
2. Read the platform equivalent of ~/.config/gcloud/application_default_credentials.json if it exists. The ~/.config component of the path can be overriden by the environment variable CLOUDSDK_CONFIG if it exists.
3. Retrieve the default service account application credentials if running on GCE. The environment variable NO_GCE_CHECK can be used to skip this check if set to a truthy value such as 1 or true.

The specified Scopes are used to authorize any service_account that is found with the appropriate OAuth2 scopes, otherwise they are not used. See the top-level module of each individual gogol-* library for a list of available scopes, such as Network.Google.Compute.computeScope.

See: Application Default Credentials

fromWellKnownPath :: (MonadIO m, MonadCatch m) => m (Credentials s)

Attempt to load either a service_account or authorized_user formatted file to obtain the credentials neccessary to perform a token refresh.

The specified Scopes are used to authorize any service_account that is found with the appropriate scopes, otherwise they are not used. See the top-level module of each individual gogol-* library for a list of available scopes, such as Network.Google.Compute.computeScope.

See: cloudSDKConfigPath, defaultCredentialsPath.

fromFilePath :: (MonadIO m, MonadCatch m) => FilePath -> m (Credentials s)

Attempt to load either a service_account or authorized_user formatted file to obtain the credentials neccessary to perform a token refresh from the specified file.

The specified Scopes are used to authorize any service_account that is found with the appropriate scopes, otherwise they are not used. See the top-level module of each individual gogol-* library for a list of available scopes, such as Network.Google.Compute.computeScope.

saveAuthorizedUserToWellKnownPath

Arguments

:: (MonadIO m, MonadCatch m)

=> Bool

Force to save if True

-> AuthorizedUser

-> m ()

Save AuthorizedUser See: cloudSDKConfigPath, defaultCredentialsPath.

saveAuthorizedUser

Arguments

:: (MonadIO m, MonadCatch m)

=> FilePath

-> Bool

Force to save if True

-> AuthorizedUser

-> m ()

Save AuthorizedUser

Service account user impersonation

serviceAccountUser :: forall s. AllowScopes s => Maybe Text -> Credentials s -> Credentials s

Set the user to be impersonated for a service account with domain wide delegation. See https://developers.google.com/identity/protocols/OAuth2ServiceAccount

Installed Application Credentials

installedApplication :: OAuthClient -> OAuthCode s -> Credentials s

Create new Installed Application credentials.

Since it is intended that the user opens the URL generated by formURL in a browser and the resulting OAuthCode is then received out-of-band, you must ensure that the scopes passed to formURL and the type of OAuthCode correctly match, otherwise an authorization error will occur.

For example, doing this via getLine and copy-paste:

{-# LANGUAGE ScopedTypeVariables #-}

import Data.Proxy     (Proxy (..))
import Data.Text      as T
import Data.Text.IO   as T
import System.Exit    (exitFailure)
import System.Info    (os)
import System.Process (rawSystem)

redirectPrompt :: AllowScopes (s :: [Symbol]) => OAuthClient -> proxy s -> IO (OAuthCode s)
redirectPrompt c p = do
  let url = formURL c p
  T.putStrLn $ "Opening URL " `T.append` url
  _ <- case os of
    "darwin" -> rawSystem "open"     [unpack url]
    "linux"  -> rawSystem "xdg-open" [unpack url]
    _        -> T.putStrLn "Unsupported OS" >> exitFailure
  T.putStrLn "Please input the authorisation code: "
  OAuthCode <$> T.getLine

This ensures the scopes passed to formURL and the type of OAuthCode s are correct.

formURL :: AllowScopes (s :: [Symbol]) => OAuthClient -> proxy s -> Text

Given an OAuthClient and a list of scopes to authorize, construct a URL that can be used to obtain the OAuthCode.

See: Forming the URL.

Authorizing Requests

authorize :: (MonadIO m, MonadCatch m, AllowScopes s) => Request -> Store s -> Logger -> Manager -> m Request

Apply the (by way of possible token refresh) a bearer token to the authentication header of a request.

Thread-safe Storage

data Store (s :: [Symbol])

Data store which ensures thread-safe access of credentials.

initStore :: (MonadIO m, MonadCatch m, AllowScopes s) => Credentials s -> Logger -> Manager -> m (Store s)

Construct storage containing the credentials which have not yet been exchanged or refreshed.

retrieveAuthFromStore :: (MonadIO m, MonadCatch m, AllowScopes s) => Store s -> m (Auth s)

Retrieve auth from storage

data Auth (s :: [Symbol])

An OAuthToken that can potentially be expired, with the original credentials that can be used to perform a refresh.

Constructors

Auth

Fields

• _credentials :: !(Credentials s)
• _token :: !(OAuthToken s)

authToAuthorizedUser :: AllowScopes s => Auth s -> Either Text AuthorizedUser

authToAuthorizedUser converts Auth into an AuthorizedUser by returning Right if there is a FromClient-constructed Credentials and a refreshed token; otherwise, returning Left with error message.

exchange :: forall m s. (MonadIO m, MonadCatch m, AllowScopes s) => Credentials s -> Logger -> Manager -> m (Auth s)

Perform the initial credentials exchange to obtain a valid OAuthToken suitable for authorizing requests.

refresh :: forall m s. (MonadIO m, MonadCatch m, AllowScopes s) => Auth s -> Logger -> Manager -> m (Auth s)

Refresh an existing OAuthToken.

Default Constants

checkGCEVar :: String

The NO_GCE_CHECK environment variable.

cloudSDKConfigDir :: String

The environment variable name which is used to specify the directory containing the application_default_credentials.json generated by gcloud init.

defaultCredentialsFile :: String

The environment variable pointing the file with local Application Default Credentials.

Handling Errors

class AsAuthError a where

Minimal complete definition

_AuthError

Methods

_AuthError :: Prism' a AuthError

A general authentication error.

_RetrievalError :: Prism' a HttpException

An error occured while communicating over HTTP with either then local metadata or remote accounts.google.com endpoints.

_MissingFileError :: Prism' a FilePath

The specified default credentials file could not be found.

_InvalidFileError :: Prism' a (FilePath, Text)

An error occured parsing the default credentials file.

_TokenRefreshError :: Prism' a (Status, Text, Maybe Text)

An error occured when attempting to refresh a token.

Instances

AsAuthError SomeException

Defined in Network.Google.Internal.Auth

Methods

_AuthError :: Prism' SomeException AuthError

_RetrievalError :: Prism' SomeException HttpException

_MissingFileError :: Prism' SomeException FilePath

_InvalidFileError :: Prism' SomeException (FilePath, Text)

_TokenRefreshError :: Prism' SomeException (Status, Text, Maybe Text)

AsAuthError AuthError

Defined in Network.Google.Internal.Auth

Methods

_AuthError :: Prism' AuthError AuthError

_RetrievalError :: Prism' AuthError HttpException

_MissingFileError :: Prism' AuthError FilePath

_InvalidFileError :: Prism' AuthError (FilePath, Text)

_TokenRefreshError :: Prism' AuthError (Status, Text, Maybe Text)

data AuthError

An error thrown when attempting to readwrite AuthNAuthZ information.

Constructors

RetrievalError HttpException

MissingFileError FilePath

InvalidFileError FilePath Text

TokenRefreshError Status Text (Maybe Text)

FileExistError FilePath

Instances

Show AuthError

Defined in Network.Google.Internal.Auth

Methods

showsPrec :: Int -> AuthError -> ShowS

show :: AuthError -> String

showList :: [AuthError] -> ShowS

Exception AuthError

Defined in Network.Google.Internal.Auth

Methods

toException :: AuthError -> SomeException

fromException :: SomeException -> Maybe AuthError

displayException :: AuthError -> String

AsAuthError AuthError

Defined in Network.Google.Internal.Auth

Methods

_AuthError :: Prism' AuthError AuthError

_RetrievalError :: Prism' AuthError HttpException

_MissingFileError :: Prism' AuthError FilePath

_InvalidFileError :: Prism' AuthError (FilePath, Text)

_TokenRefreshError :: Prism' AuthError (Status, Text, Maybe Text)

OAuth Types

data OAuthClient

A client identifier and accompanying secret used to obtain/refresh a token.

Constructors

OAuthClient

Fields

• _clientId :: !ClientId
• _clientSecret :: !GSecret

Instances

Eq OAuthClient

Defined in Network.Google.Internal.Auth

Methods

(==) :: OAuthClient -> OAuthClient -> Bool

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

Show OAuthClient

Defined in Network.Google.Internal.Auth

Methods

showsPrec :: Int -> OAuthClient -> ShowS

show :: OAuthClient -> String

showList :: [OAuthClient] -> ShowS

data OAuthToken (s :: [Symbol])

An OAuth bearer type token of the following form:

{
  \"token_type\": \"Bearer\",
  \"access_token\": \"eyJhbGci...\",
  \"refresh_token\": \"1/B3gq9K...\",
  \"expires_in\": 3600,
  ...
}

The _tokenAccess field will be inserted verbatim into the Authorization: Bearer ... header for all HTTP requests.

Constructors

OAuthToken

Fields

• _tokenAccess :: !AccessToken
• _tokenRefresh :: !(Maybe RefreshToken)
• _tokenExpiry :: !UTCTime

Instances

Eq (OAuthToken s)

Defined in Network.Google.Internal.Auth

Methods

(==) :: OAuthToken s -> OAuthToken s -> Bool

(/=) :: OAuthToken s -> OAuthToken s -> Bool

Show (OAuthToken s)

Defined in Network.Google.Internal.Auth

Methods

showsPrec :: Int -> OAuthToken s -> ShowS

show :: OAuthToken s -> String

showList :: [OAuthToken s] -> ShowS

FromJSON (UTCTime -> OAuthToken s)

Defined in Network.Google.Internal.Auth

Methods

parseJSON :: Value -> Parser (UTCTime -> OAuthToken s)

parseJSONList :: Value -> Parser [UTCTime -> OAuthToken s]

newtype OAuthCode (s :: [Symbol])

An OAuth client authorization code.

Constructors

OAuthCode Text

Instances

Eq (OAuthCode s)

Defined in Network.Google.Internal.Auth

Methods

(==) :: OAuthCode s -> OAuthCode s -> Bool

(/=) :: OAuthCode s -> OAuthCode s -> Bool

Ord (OAuthCode s)

Defined in Network.Google.Internal.Auth

Methods

compare :: OAuthCode s -> OAuthCode s -> Ordering

(<) :: OAuthCode s -> OAuthCode s -> Bool

(<=) :: OAuthCode s -> OAuthCode s -> Bool

(>) :: OAuthCode s -> OAuthCode s -> Bool

(>=) :: OAuthCode s -> OAuthCode s -> Bool

max :: OAuthCode s -> OAuthCode s -> OAuthCode s

min :: OAuthCode s -> OAuthCode s -> OAuthCode s

Read (OAuthCode s)

Defined in Network.Google.Internal.Auth

Methods

readsPrec :: Int -> ReadS (OAuthCode s)

readList :: ReadS [OAuthCode s]

readPrec :: ReadPrec (OAuthCode s)

readListPrec :: ReadPrec [OAuthCode s]

Show (OAuthCode s)

Defined in Network.Google.Internal.Auth

Methods

showsPrec :: Int -> OAuthCode s -> ShowS

show :: OAuthCode s -> String

showList :: [OAuthCode s] -> ShowS

IsString (OAuthCode s)

Defined in Network.Google.Internal.Auth

Methods

fromString :: String -> OAuthCode s

Generic (OAuthCode s)

Defined in Network.Google.Internal.Auth

Associated Types

type Rep (OAuthCode s) :: Type -> Type

Methods

from :: OAuthCode s -> Rep (OAuthCode s) x

to :: Rep (OAuthCode s) x -> OAuthCode s

ToJSON (OAuthCode s)

Defined in Network.Google.Internal.Auth

Methods

toJSON :: OAuthCode s -> Value

toEncoding :: OAuthCode s -> Encoding

toJSONList :: [OAuthCode s] -> Value

toEncodingList :: [OAuthCode s] -> Encoding

FromJSON (OAuthCode s)

Defined in Network.Google.Internal.Auth

Methods

parseJSON :: Value -> Parser (OAuthCode s)

parseJSONList :: Value -> Parser [OAuthCode s]

ToHttpApiData (OAuthCode s)

Defined in Network.Google.Internal.Auth

Methods

toUrlPiece :: OAuthCode s -> Text

toEncodedUrlPiece :: OAuthCode s -> Builder

toHeader :: OAuthCode s -> ByteString

toQueryParam :: OAuthCode s -> Text

type Rep (OAuthCode s)

Defined in Network.Google.Internal.Auth

type Rep (OAuthCode s) = D1 (MetaData "OAuthCode" "Network.Google.Internal.Auth" "gogol-0.4.0-CWdievQQFAX4gtqt1NM1hC" True) (C1 (MetaCons "OAuthCode" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))

newtype OAuthScope

An OAuth2 scope.

Constructors

OAuthScope Text

Instances

Eq OAuthScope

Defined in Network.Google.Types

Methods

(==) :: OAuthScope -> OAuthScope -> Bool

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

Ord OAuthScope

Defined in Network.Google.Types

Methods

compare :: OAuthScope -> OAuthScope -> Ordering

(<) :: OAuthScope -> OAuthScope -> Bool

(<=) :: OAuthScope -> OAuthScope -> Bool

(>) :: OAuthScope -> OAuthScope -> Bool

(>=) :: OAuthScope -> OAuthScope -> Bool

max :: OAuthScope -> OAuthScope -> OAuthScope

min :: OAuthScope -> OAuthScope -> OAuthScope

Read OAuthScope

Defined in Network.Google.Types

Methods

readsPrec :: Int -> ReadS OAuthScope

readList :: ReadS [OAuthScope]

readPrec :: ReadPrec OAuthScope

readListPrec :: ReadPrec [OAuthScope]

Show OAuthScope

Defined in Network.Google.Types

Methods

showsPrec :: Int -> OAuthScope -> ShowS

show :: OAuthScope -> String

showList :: [OAuthScope] -> ShowS

IsString OAuthScope

Defined in Network.Google.Types

Methods

fromString :: String -> OAuthScope

Generic OAuthScope

Defined in Network.Google.Types

Associated Types

type Rep OAuthScope :: Type -> Type

Methods

from :: OAuthScope -> Rep OAuthScope x

to :: Rep OAuthScope x -> OAuthScope

ToJSON OAuthScope

Defined in Network.Google.Types

Methods

toJSON :: OAuthScope -> Value

toEncoding :: OAuthScope -> Encoding

toJSONList :: [OAuthScope] -> Value

toEncodingList :: [OAuthScope] -> Encoding

FromJSON OAuthScope

Defined in Network.Google.Types

Methods

parseJSON :: Value -> Parser OAuthScope

parseJSONList :: Value -> Parser [OAuthScope]

FromHttpApiData OAuthScope

Defined in Network.Google.Types

Methods

parseUrlPiece :: Text -> Either Text OAuthScope

parseHeader :: ByteString -> Either Text OAuthScope

parseQueryParam :: Text -> Either Text OAuthScope

ToHttpApiData OAuthScope

Defined in Network.Google.Types

Methods

toUrlPiece :: OAuthScope -> Text

toEncodedUrlPiece :: OAuthScope -> Builder

toHeader :: OAuthScope -> ByteString

toQueryParam :: OAuthScope -> Text

type Rep OAuthScope

Defined in Network.Google.Types

type Rep OAuthScope = D1 (MetaData "OAuthScope" "Network.Google.Types" "gogol-core-0.4.0-LbKJUcnPxNi5xGRGqOu4OX" True) (C1 (MetaCons "OAuthScope" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))

Re-exported Types

newtype AccessToken

An OAuth2 access token.

Constructors

AccessToken Text

Instances

Eq AccessToken

Defined in Network.Google.Types

Methods

(==) :: AccessToken -> AccessToken -> Bool

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

Ord AccessToken

Defined in Network.Google.Types

Methods

compare :: AccessToken -> AccessToken -> Ordering

(<) :: AccessToken -> AccessToken -> Bool

(<=) :: AccessToken -> AccessToken -> Bool

(>) :: AccessToken -> AccessToken -> Bool

(>=) :: AccessToken -> AccessToken -> Bool

max :: AccessToken -> AccessToken -> AccessToken

min :: AccessToken -> AccessToken -> AccessToken

Read AccessToken

Defined in Network.Google.Types

Methods

readsPrec :: Int -> ReadS AccessToken

readList :: ReadS [AccessToken]

readPrec :: ReadPrec AccessToken

readListPrec :: ReadPrec [AccessToken]

Show AccessToken

Defined in Network.Google.Types

Methods

showsPrec :: Int -> AccessToken -> ShowS

show :: AccessToken -> String

showList :: [AccessToken] -> ShowS

IsString AccessToken

Defined in Network.Google.Types

Methods

fromString :: String -> AccessToken

Generic AccessToken

Defined in Network.Google.Types

Associated Types

type Rep AccessToken :: Type -> Type

Methods

from :: AccessToken -> Rep AccessToken x

to :: Rep AccessToken x -> AccessToken

ToJSON AccessToken

Defined in Network.Google.Types

Methods

toJSON :: AccessToken -> Value

toEncoding :: AccessToken -> Encoding

toJSONList :: [AccessToken] -> Value

toEncodingList :: [AccessToken] -> Encoding

FromJSON AccessToken

Defined in Network.Google.Types

Methods

parseJSON :: Value -> Parser AccessToken

parseJSONList :: Value -> Parser [AccessToken]

FromHttpApiData AccessToken

Defined in Network.Google.Types

Methods

parseUrlPiece :: Text -> Either Text AccessToken

parseHeader :: ByteString -> Either Text AccessToken

parseQueryParam :: Text -> Either Text AccessToken

ToHttpApiData AccessToken

Defined in Network.Google.Types

Methods

toUrlPiece :: AccessToken -> Text

toEncodedUrlPiece :: AccessToken -> Builder

toHeader :: AccessToken -> ByteString

toQueryParam :: AccessToken -> Text

type Rep AccessToken

Defined in Network.Google.Types

type Rep AccessToken = D1 (MetaData "AccessToken" "Network.Google.Types" "gogol-core-0.4.0-LbKJUcnPxNi5xGRGqOu4OX" True) (C1 (MetaCons "AccessToken" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))

newtype RefreshToken

An OAuth2 refresh token.

Constructors

RefreshToken Text

Instances

Eq RefreshToken

Defined in Network.Google.Types

Methods

(==) :: RefreshToken -> RefreshToken -> Bool

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

Ord RefreshToken

Defined in Network.Google.Types

Methods

compare :: RefreshToken -> RefreshToken -> Ordering

(<) :: RefreshToken -> RefreshToken -> Bool

(<=) :: RefreshToken -> RefreshToken -> Bool

(>) :: RefreshToken -> RefreshToken -> Bool

(>=) :: RefreshToken -> RefreshToken -> Bool

max :: RefreshToken -> RefreshToken -> RefreshToken

min :: RefreshToken -> RefreshToken -> RefreshToken

Read RefreshToken

Defined in Network.Google.Types

Methods

readsPrec :: Int -> ReadS RefreshToken

readList :: ReadS [RefreshToken]

readPrec :: ReadPrec RefreshToken

readListPrec :: ReadPrec [RefreshToken]

Show RefreshToken

Defined in Network.Google.Types

Methods

showsPrec :: Int -> RefreshToken -> ShowS

show :: RefreshToken -> String

showList :: [RefreshToken] -> ShowS

IsString RefreshToken

Defined in Network.Google.Types

Methods

fromString :: String -> RefreshToken

Generic RefreshToken

Defined in Network.Google.Types

Associated Types

type Rep RefreshToken :: Type -> Type

Methods

from :: RefreshToken -> Rep RefreshToken x

to :: Rep RefreshToken x -> RefreshToken

ToJSON RefreshToken

Defined in Network.Google.Types

Methods

toJSON :: RefreshToken -> Value

toEncoding :: RefreshToken -> Encoding

toJSONList :: [RefreshToken] -> Value

toEncodingList :: [RefreshToken] -> Encoding

FromJSON RefreshToken

Defined in Network.Google.Types

Methods

parseJSON :: Value -> Parser RefreshToken

parseJSONList :: Value -> Parser [RefreshToken]

FromHttpApiData RefreshToken

Defined in Network.Google.Types

Methods

parseUrlPiece :: Text -> Either Text RefreshToken

parseHeader :: ByteString -> Either Text RefreshToken

parseQueryParam :: Text -> Either Text RefreshToken

ToHttpApiData RefreshToken

Defined in Network.Google.Types

Methods

toUrlPiece :: RefreshToken -> Text

toEncodedUrlPiece :: RefreshToken -> Builder

toHeader :: RefreshToken -> ByteString

toQueryParam :: RefreshToken -> Text

type Rep RefreshToken

Defined in Network.Google.Types

type Rep RefreshToken = D1 (MetaData "RefreshToken" "Network.Google.Types" "gogol-core-0.4.0-LbKJUcnPxNi5xGRGqOu4OX" True) (C1 (MetaCons "RefreshToken" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))

newtype GSecret

An opaque client secret.

Constructors

GSecret Text

Instances

Eq GSecret

Defined in Network.Google.Types

Methods

(==) :: GSecret -> GSecret -> Bool

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

Ord GSecret

Defined in Network.Google.Types

Methods

compare :: GSecret -> GSecret -> Ordering

(<) :: GSecret -> GSecret -> Bool

(<=) :: GSecret -> GSecret -> Bool

(>) :: GSecret -> GSecret -> Bool

(>=) :: GSecret -> GSecret -> Bool

max :: GSecret -> GSecret -> GSecret

min :: GSecret -> GSecret -> GSecret

Read GSecret

Defined in Network.Google.Types

Methods

readsPrec :: Int -> ReadS GSecret

readList :: ReadS [GSecret]

readPrec :: ReadPrec GSecret

readListPrec :: ReadPrec [GSecret]

Show GSecret

Defined in Network.Google.Types

Methods

showsPrec :: Int -> GSecret -> ShowS

show :: GSecret -> String

showList :: [GSecret] -> ShowS

IsString GSecret

Defined in Network.Google.Types

Methods

fromString :: String -> GSecret

Generic GSecret

Defined in Network.Google.Types

Associated Types

type Rep GSecret :: Type -> Type

Methods

from :: GSecret -> Rep GSecret x

to :: Rep GSecret x -> GSecret

ToJSON GSecret

Defined in Network.Google.Types

Methods

toJSON :: GSecret -> Value

toEncoding :: GSecret -> Encoding

toJSONList :: [GSecret] -> Value

toEncodingList :: [GSecret] -> Encoding

FromJSON GSecret

Defined in Network.Google.Types

Methods

parseJSON :: Value -> Parser GSecret

parseJSONList :: Value -> Parser [GSecret]

FromHttpApiData GSecret

Defined in Network.Google.Types

Methods

parseUrlPiece :: Text -> Either Text GSecret

parseHeader :: ByteString -> Either Text GSecret

parseQueryParam :: Text -> Either Text GSecret

ToHttpApiData GSecret

Defined in Network.Google.Types

Methods

toUrlPiece :: GSecret -> Text

toEncodedUrlPiece :: GSecret -> Builder

toHeader :: GSecret -> ByteString

toQueryParam :: GSecret -> Text

type Rep GSecret

Defined in Network.Google.Types

type Rep GSecret = D1 (MetaData "GSecret" "Network.Google.Types" "gogol-core-0.4.0-LbKJUcnPxNi5xGRGqOu4OX" True) (C1 (MetaCons "GSecret" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))

newtype ServiceId

A service identifier.

Constructors

ServiceId Text

Instances

Eq ServiceId

Defined in Network.Google.Types

Methods

(==) :: ServiceId -> ServiceId -> Bool

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

Ord ServiceId

Defined in Network.Google.Types

Methods

compare :: ServiceId -> ServiceId -> Ordering

(<) :: ServiceId -> ServiceId -> Bool

(<=) :: ServiceId -> ServiceId -> Bool

(>) :: ServiceId -> ServiceId -> Bool

(>=) :: ServiceId -> ServiceId -> Bool

max :: ServiceId -> ServiceId -> ServiceId

min :: ServiceId -> ServiceId -> ServiceId

Read ServiceId

Defined in Network.Google.Types

Methods

readsPrec :: Int -> ReadS ServiceId

readList :: ReadS [ServiceId]

readPrec :: ReadPrec ServiceId

readListPrec :: ReadPrec [ServiceId]

Show ServiceId

Defined in Network.Google.Types

Methods

showsPrec :: Int -> ServiceId -> ShowS

show :: ServiceId -> String

showList :: [ServiceId] -> ShowS

IsString ServiceId

Defined in Network.Google.Types

Methods

fromString :: String -> ServiceId

Generic ServiceId

Defined in Network.Google.Types

Associated Types

type Rep ServiceId :: Type -> Type

Methods

from :: ServiceId -> Rep ServiceId x

to :: Rep ServiceId x -> ServiceId

ToJSON ServiceId

Defined in Network.Google.Types

Methods

toJSON :: ServiceId -> Value

toEncoding :: ServiceId -> Encoding

toJSONList :: [ServiceId] -> Value

toEncodingList :: [ServiceId] -> Encoding

FromJSON ServiceId

Defined in Network.Google.Types

Methods

parseJSON :: Value -> Parser ServiceId

parseJSONList :: Value -> Parser [ServiceId]

FromHttpApiData ServiceId

Defined in Network.Google.Types

Methods

parseUrlPiece :: Text -> Either Text ServiceId

parseHeader :: ByteString -> Either Text ServiceId

parseQueryParam :: Text -> Either Text ServiceId

ToHttpApiData ServiceId

Defined in Network.Google.Types

Methods

toUrlPiece :: ServiceId -> Text

toEncodedUrlPiece :: ServiceId -> Builder

toHeader :: ServiceId -> ByteString

toQueryParam :: ServiceId -> Text

type Rep ServiceId

Defined in Network.Google.Types

type Rep ServiceId = D1 (MetaData "ServiceId" "Network.Google.Types" "gogol-core-0.4.0-LbKJUcnPxNi5xGRGqOu4OX" True) (C1 (MetaCons "ServiceId" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))

newtype ClientId

A client identifier.

Constructors

ClientId Text

Instances

Eq ClientId

Defined in Network.Google.Types

Methods

(==) :: ClientId -> ClientId -> Bool

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

Ord ClientId

Defined in Network.Google.Types

Methods

compare :: ClientId -> ClientId -> Ordering

(<) :: ClientId -> ClientId -> Bool

(<=) :: ClientId -> ClientId -> Bool

(>) :: ClientId -> ClientId -> Bool

(>=) :: ClientId -> ClientId -> Bool

max :: ClientId -> ClientId -> ClientId

min :: ClientId -> ClientId -> ClientId

Read ClientId

Defined in Network.Google.Types

Methods

readsPrec :: Int -> ReadS ClientId

readList :: ReadS [ClientId]

readPrec :: ReadPrec ClientId

readListPrec :: ReadPrec [ClientId]

Show ClientId

Defined in Network.Google.Types

Methods

showsPrec :: Int -> ClientId -> ShowS

show :: ClientId -> String

showList :: [ClientId] -> ShowS

IsString ClientId

Defined in Network.Google.Types

Methods

fromString :: String -> ClientId

Generic ClientId

Defined in Network.Google.Types

Associated Types

type Rep ClientId :: Type -> Type

Methods

from :: ClientId -> Rep ClientId x

to :: Rep ClientId x -> ClientId

ToJSON ClientId

Defined in Network.Google.Types

Methods

toJSON :: ClientId -> Value

toEncoding :: ClientId -> Encoding

toJSONList :: [ClientId] -> Value

toEncodingList :: [ClientId] -> Encoding

FromJSON ClientId

Defined in Network.Google.Types

Methods

parseJSON :: Value -> Parser ClientId

parseJSONList :: Value -> Parser [ClientId]

FromHttpApiData ClientId

Defined in Network.Google.Types

Methods

parseUrlPiece :: Text -> Either Text ClientId

parseHeader :: ByteString -> Either Text ClientId

parseQueryParam :: Text -> Either Text ClientId

ToHttpApiData ClientId

Defined in Network.Google.Types

Methods

toUrlPiece :: ClientId -> Text

toEncodedUrlPiece :: ClientId -> Builder

toHeader :: ClientId -> ByteString

toQueryParam :: ClientId -> Text

type Rep ClientId

Defined in Network.Google.Types

type Rep ClientId = D1 (MetaData "ClientId" "Network.Google.Types" "gogol-core-0.4.0-LbKJUcnPxNi5xGRGqOu4OX" True) (C1 (MetaCons "ClientId" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))

Re-exported Modules

module Network.Google.Auth.Scope