GetOpenIdToken.hs

{-# LANGUAGE DataKinds                   #-}
{-# LANGUAGE DeriveGeneric               #-}
{-# LANGUAGE FlexibleInstances           #-}
{-# LANGUAGE GeneralizedNewtypeDeriving  #-}
{-# LANGUAGE LambdaCase                  #-}
{-# LANGUAGE NoImplicitPrelude           #-}
{-# LANGUAGE OverloadedStrings           #-}
{-# LANGUAGE RecordWildCards             #-}
{-# LANGUAGE TypeFamilies                #-}

{-# OPTIONS_GHC -fno-warn-unused-imports #-}

-- Module      : Network.AWS.CognitoIdentity.GetOpenIdToken
-- Copyright   : (c) 2013-2014 Brendan Hay <brendan.g.hay@gmail.com>
-- License     : This Source Code Form is subject to the terms of
--               the Mozilla Public License, v. 2.0.
--               A copy of the MPL can be found in the LICENSE file or
--               you can obtain it at http://mozilla.org/MPL/2.0/.
-- Maintainer  : Brendan Hay <brendan.g.hay@gmail.com>
-- Stability   : experimental
-- Portability : non-portable (GHC extensions)
--
-- Derived from AWS service descriptions, licensed under Apache 2.0.

-- | Gets an OpenID token, using a known Cognito ID. This known Cognito ID is
-- returned by 'GetId'. You can optionally add additional logins for the identity.
-- Supplying multiple logins creates an implicit link.
--
-- The OpenId token is valid for 15 minutes.
--
-- <http://docs.aws.amazon.com/cognitoidentity/latest/APIReference/API_GetOpenIdToken.html>
module Network.AWS.CognitoIdentity.GetOpenIdToken
    (
    -- * Request
      GetOpenIdToken
    -- ** Request constructor
    , getOpenIdToken
    -- ** Request lenses
    , goitIdentityId
    , goitLogins

    -- * Response
    , GetOpenIdTokenResponse
    -- ** Response constructor
    , getOpenIdTokenResponse
    -- ** Response lenses
    , goitrIdentityId
    , goitrToken
    ) where

import Network.AWS.Prelude
import Network.AWS.Request.JSON
import Network.AWS.CognitoIdentity.Types
import qualified GHC.Exts

data GetOpenIdToken = GetOpenIdToken
    { _goitIdentityId :: Text
    , _goitLogins     :: Map Text Text
    } deriving (Eq, Read, Show)

-- | 'GetOpenIdToken' constructor.
--
-- The fields accessible through corresponding lenses are:
--
-- * 'goitIdentityId' @::@ 'Text'
--
-- * 'goitLogins' @::@ 'HashMap' 'Text' 'Text'
--
getOpenIdToken :: Text -- ^ 'goitIdentityId'
               -> GetOpenIdToken
getOpenIdToken p1 = GetOpenIdToken
    { _goitIdentityId = p1
    , _goitLogins     = mempty
    }

-- | A unique identifier in the format REGION:GUID.
goitIdentityId :: Lens' GetOpenIdToken Text
goitIdentityId = lens _goitIdentityId (\s a -> s { _goitIdentityId = a })

-- | A set of optional name-value pairs that map provider names to provider tokens.
goitLogins :: Lens' GetOpenIdToken (HashMap Text Text)
goitLogins = lens _goitLogins (\s a -> s { _goitLogins = a }) . _Map

data GetOpenIdTokenResponse = GetOpenIdTokenResponse
    { _goitrIdentityId :: Maybe Text
    , _goitrToken      :: Maybe Text
    } deriving (Eq, Ord, Read, Show)

-- | 'GetOpenIdTokenResponse' constructor.
--
-- The fields accessible through corresponding lenses are:
--
-- * 'goitrIdentityId' @::@ 'Maybe' 'Text'
--
-- * 'goitrToken' @::@ 'Maybe' 'Text'
--
getOpenIdTokenResponse :: GetOpenIdTokenResponse
getOpenIdTokenResponse = GetOpenIdTokenResponse
    { _goitrIdentityId = Nothing
    , _goitrToken      = Nothing
    }

-- | A unique identifier in the format REGION:GUID. Note that the IdentityId
-- returned may not match the one passed on input.
goitrIdentityId :: Lens' GetOpenIdTokenResponse (Maybe Text)
goitrIdentityId = lens _goitrIdentityId (\s a -> s { _goitrIdentityId = a })

-- | An OpenID token, valid for 15 minutes.
goitrToken :: Lens' GetOpenIdTokenResponse (Maybe Text)
goitrToken = lens _goitrToken (\s a -> s { _goitrToken = a })

instance ToPath GetOpenIdToken where
    toPath = const "/"

instance ToQuery GetOpenIdToken where
    toQuery = const mempty

instance ToHeaders GetOpenIdToken

instance ToJSON GetOpenIdToken where
    toJSON GetOpenIdToken{..} = object
        [ "IdentityId" .= _goitIdentityId
        , "Logins"     .= _goitLogins
        ]

instance AWSRequest GetOpenIdToken where
    type Sv GetOpenIdToken = CognitoIdentity
    type Rs GetOpenIdToken = GetOpenIdTokenResponse

    request  = post "GetOpenIdToken"
    response = jsonResponse

instance FromJSON GetOpenIdTokenResponse where
    parseJSON = withObject "GetOpenIdTokenResponse" $ \o -> GetOpenIdTokenResponse
        <$> o .:? "IdentityId"
        <*> o .:? "Token"