Amazonka.AppFlow.Types.OAuth2Credentials

Documentation

data OAuth2Credentials

The OAuth 2.0 credentials required for OAuth 2.0 authentication.

See: newOAuth2Credentials smart constructor.

Constructors

OAuth2Credentials'

Fields

• accessToken :: Maybe (Sensitive Text)

  The access token used to access the connector on your behalf.

• clientId :: Maybe Text

  The identifier for the desired client.

• clientSecret :: Maybe (Sensitive Text)

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

• oAuthRequest :: Maybe ConnectorOAuthRequest
• refreshToken :: Maybe Text

  The refresh token used to refresh an expired access token.

Instances

ToJSON OAuth2Credentials

Defined in Amazonka.AppFlow.Types.OAuth2Credentials

Methods

toJSON :: OAuth2Credentials -> Value

toEncoding :: OAuth2Credentials -> Encoding

toJSONList :: [OAuth2Credentials] -> Value

toEncodingList :: [OAuth2Credentials] -> Encoding

Generic OAuth2Credentials

Defined in Amazonka.AppFlow.Types.OAuth2Credentials

Associated Types

type Rep OAuth2Credentials :: Type -> Type

Methods

from :: OAuth2Credentials -> Rep OAuth2Credentials x

to :: Rep OAuth2Credentials x -> OAuth2Credentials

Show OAuth2Credentials

Defined in Amazonka.AppFlow.Types.OAuth2Credentials

Methods

showsPrec :: Int -> OAuth2Credentials -> ShowS

show :: OAuth2Credentials -> String

showList :: [OAuth2Credentials] -> ShowS

NFData OAuth2Credentials

Defined in Amazonka.AppFlow.Types.OAuth2Credentials

Methods

rnf :: OAuth2Credentials -> ()

Eq OAuth2Credentials

Defined in Amazonka.AppFlow.Types.OAuth2Credentials

Methods

(==) :: OAuth2Credentials -> OAuth2Credentials -> Bool

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

Hashable OAuth2Credentials

Defined in Amazonka.AppFlow.Types.OAuth2Credentials

Methods

hashWithSalt :: Int -> OAuth2Credentials -> Int

hash :: OAuth2Credentials -> Int

type Rep OAuth2Credentials

Defined in Amazonka.AppFlow.Types.OAuth2Credentials

type Rep OAuth2Credentials = D1 ('MetaData "OAuth2Credentials" "Amazonka.AppFlow.Types.OAuth2Credentials" "amazonka-appflow-2.0-3aJWKTszi6ZKDtrkFSqVAB" 'False) (C1 ('MetaCons "OAuth2Credentials'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "accessToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :*: S1 ('MetaSel ('Just "clientId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "clientSecret") '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))))))

newOAuth2Credentials :: OAuth2Credentials

Create a value of OAuth2Credentials 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:OAuth2Credentials', oAuth2Credentials_accessToken - The access token used to access the connector on your behalf.

$sel:clientId:OAuth2Credentials', oAuth2Credentials_clientId - The identifier for the desired client.

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

$sel:oAuthRequest:OAuth2Credentials', oAuth2Credentials_oAuthRequest - Undocumented member.

$sel:refreshToken:OAuth2Credentials', oAuth2Credentials_refreshToken - The refresh token used to refresh an expired access token.

oAuth2Credentials_accessToken :: Lens' OAuth2Credentials (Maybe Text)

The access token used to access the connector on your behalf.

oAuth2Credentials_clientId :: Lens' OAuth2Credentials (Maybe Text)

The identifier for the desired client.

oAuth2Credentials_clientSecret :: Lens' OAuth2Credentials (Maybe Text)

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

oAuth2Credentials_oAuthRequest :: Lens' OAuth2Credentials (Maybe ConnectorOAuthRequest)

Undocumented member.

oAuth2Credentials_refreshToken :: Lens' OAuth2Credentials (Maybe Text)

The refresh token used to refresh an expired access token.