Amazonka.AppFlow.Types.OAuthCredentials

Documentation

data OAuthCredentials

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.

• oAuthRequest :: Maybe ConnectorOAuthRequest

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

• refreshToken :: Maybe Text

  The refresh token used to refresh expired access token.

• 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

ToJSON OAuthCredentials

Defined in Amazonka.AppFlow.Types.OAuthCredentials

Methods

toJSON :: OAuthCredentials -> Value

toEncoding :: OAuthCredentials -> Encoding

toJSONList :: [OAuthCredentials] -> Value

toEncodingList :: [OAuthCredentials] -> Encoding

Generic OAuthCredentials

Defined in Amazonka.AppFlow.Types.OAuthCredentials

Associated Types

type Rep OAuthCredentials :: Type -> Type

Methods

from :: OAuthCredentials -> Rep OAuthCredentials x

to :: Rep OAuthCredentials x -> OAuthCredentials

Show OAuthCredentials

Defined in Amazonka.AppFlow.Types.OAuthCredentials

Methods

showsPrec :: Int -> OAuthCredentials -> ShowS

show :: OAuthCredentials -> String

showList :: [OAuthCredentials] -> ShowS

NFData OAuthCredentials

Defined in Amazonka.AppFlow.Types.OAuthCredentials

Methods

rnf :: OAuthCredentials -> ()

Eq OAuthCredentials

Defined in Amazonka.AppFlow.Types.OAuthCredentials

Methods

(==) :: OAuthCredentials -> OAuthCredentials -> Bool

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

Hashable OAuthCredentials

Defined in Amazonka.AppFlow.Types.OAuthCredentials

Methods

hashWithSalt :: Int -> OAuthCredentials -> Int

hash :: OAuthCredentials -> Int

type Rep OAuthCredentials

Defined in Amazonka.AppFlow.Types.OAuthCredentials

type Rep OAuthCredentials = D1 ('MetaData "OAuthCredentials" "Amazonka.AppFlow.Types.OAuthCredentials" "amazonka-appflow-2.0-3aJWKTszi6ZKDtrkFSqVAB" 'False) (C1 ('MetaCons "OAuthCredentials'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "accessToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :*: S1 ('MetaSel ('Just "oAuthRequest") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ConnectorOAuthRequest))) :*: (S1 ('MetaSel ('Just "refreshToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "clientId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "clientSecret") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Text))))))

newOAuthCredentials

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:oAuthRequest:OAuthCredentials', oAuthCredentials_oAuthRequest - The OAuth requirement needed to request security tokens from the connector endpoint.

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

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

The access token used to access protected SAPOData resources.

oAuthCredentials_oAuthRequest :: Lens' OAuthCredentials (Maybe ConnectorOAuthRequest)

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

oAuthCredentials_refreshToken :: Lens' OAuthCredentials (Maybe Text)

The refresh token used to refresh expired access token.

oAuthCredentials_clientId :: Lens' OAuthCredentials Text

The identifier for the desired client.

oAuthCredentials_clientSecret :: Lens' OAuthCredentials Text

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