Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.AppFlow.Types.OAuthCredentials

Description

Documentation

data OAuthCredentials Source #

The OAuth credentials required for OAuth type authentication.

See: newOAuthCredentials smart constructor.

Constructors

OAuthCredentials'

Fields

accessToken :: Maybe (Sensitive Text)
The access token used to access protected SAPOData resources.
refreshToken :: Maybe Text
The refresh token used to refresh expired access token.
oAuthRequest :: Maybe ConnectorOAuthRequest
The OAuth requirement needed to request security tokens from the connector endpoint.
clientId :: Text
The identifier for the desired client.
clientSecret :: Sensitive Text
The client secret used by the OAuth client to authenticate to the authorization server.

Instances

Instances details

Eq OAuthCredentials Source #
Instance details Defined in Amazonka.AppFlow.Types.OAuthCredentials Methods (==) :: OAuthCredentials -> OAuthCredentials -> Bool # (/=) :: OAuthCredentials -> OAuthCredentials -> Bool #
Show OAuthCredentials Source #
Instance details Defined in Amazonka.AppFlow.Types.OAuthCredentials Methods showsPrec :: Int -> OAuthCredentials -> ShowS # show :: OAuthCredentials -> String # showList :: [OAuthCredentials] -> ShowS #
Generic OAuthCredentials Source #
Instance details Defined in Amazonka.AppFlow.Types.OAuthCredentials Associated Types type Rep OAuthCredentials :: Type -> Type # Methods from :: OAuthCredentials -> Rep OAuthCredentials x # to :: Rep OAuthCredentials x -> OAuthCredentials #
NFData OAuthCredentials Source #
Instance details Defined in Amazonka.AppFlow.Types.OAuthCredentials Methods rnf :: OAuthCredentials -> () #
Hashable OAuthCredentials Source #
Instance details Defined in Amazonka.AppFlow.Types.OAuthCredentials Methods hashWithSalt :: Int -> OAuthCredentials -> Int # hash :: OAuthCredentials -> Int #
ToJSON OAuthCredentials Source #
Instance details Defined in Amazonka.AppFlow.Types.OAuthCredentials Methods toJSON :: OAuthCredentials -> Value # toEncoding :: OAuthCredentials -> Encoding # toJSONList :: [OAuthCredentials] -> Value # toEncodingList :: [OAuthCredentials] -> Encoding #
type Rep OAuthCredentials Source #
Instance details Defined in Amazonka.AppFlow.Types.OAuthCredentials type Rep OAuthCredentials = D1 ('MetaData "OAuthCredentials" "Amazonka.AppFlow.Types.OAuthCredentials" "libZSservicesZSamazonka-appflowZSamazonka-appflow" 'False) (C1 ('MetaCons "OAuthCredentials'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "accessToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :: S1 ('MetaSel ('Just "refreshToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "oAuthRequest") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ConnectorOAuthRequest)) :: (S1 ('MetaSel ('Just "clientId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "clientSecret") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Text))))))

newOAuthCredentials Source #

Arguments

:: Text	`$sel:clientId:OAuthCredentials'`
-> Text	`$sel:clientSecret:OAuthCredentials'`
-> OAuthCredentials

Create a value of OAuthCredentials with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:accessToken:OAuthCredentials', oAuthCredentials_accessToken - The access token used to access protected SAPOData resources.

$sel:refreshToken:OAuthCredentials', oAuthCredentials_refreshToken - The refresh token used to refresh expired access token.

$sel:oAuthRequest:OAuthCredentials', oAuthCredentials_oAuthRequest - The OAuth requirement needed to request security tokens from the connector endpoint.

$sel:clientId:OAuthCredentials', oAuthCredentials_clientId - The identifier for the desired client.

$sel:clientSecret:OAuthCredentials', oAuthCredentials_clientSecret - The client secret used by the OAuth client to authenticate to the authorization server.

oAuthCredentials_accessToken :: Lens' OAuthCredentials (Maybe Text) Source #

The access token used to access protected SAPOData resources.

oAuthCredentials_refreshToken :: Lens' OAuthCredentials (Maybe Text) Source #

The refresh token used to refresh expired access token.

oAuthCredentials_oAuthRequest :: Lens' OAuthCredentials (Maybe ConnectorOAuthRequest) Source #

The OAuth requirement needed to request security tokens from the connector endpoint.

oAuthCredentials_clientId :: Lens' OAuthCredentials Text Source #

The identifier for the desired client.

oAuthCredentials_clientSecret :: Lens' OAuthCredentials Text Source #

The client secret used by the OAuth client to authenticate to the authorization server.