com.amazonaws.appflow.custom.connector.model.connectorconfiguration.auth

Interface OAuth2Defaults

All Known Implementing Classes:

ImmutableOAuth2Defaults

@Value.Immutable
public interface OAuth2Defaults

Default OAuth2 Params values defined by Connector.

Method Summary

Modifier and Type	Method and Description
default boolean	addBasicAuthHeader() Specifies if clientId and clientSecret should be added to basic auth header
List<String>	authURL() Auth URLs.
default OAuth2ContentType	oAuth2ContentType() OAuth2 Content type to use in the token request header.
List<OAuth2CustomParameter>	oauth2CustomProperties() OAuth2 custom parameters needed by the connector.
List<OAuth2GrantType>	oAuth2GrantTypesSupported() OAuth2 Grant types supported by connector.
default OAuth2MethodType	oAuth2MethodType() OAuth2 Http method to use for the token request.
List<String>	oAuthScopes() OAuth Scopes.
List<String>	tokenURL() Token URLs.

Method Detail

oAuthScopes

@Nullable
List<String> oAuthScopes()

OAuth Scopes. Required for OAuth2GrantType - AUTHORIZATION_CODE.

tokenURL

List<String> tokenURL()

Token URLs. Required for both OAuth2GrantType - AUTHORIZATION_CODE and CLIENT_CREDENTIALS. This URL can be in two format - Static and Template based where we need the input from the Customer to build the complete URL. For Static URLs you can add the URL directly to this list like - https://login.salesforce.com/services/oauth2/token And for template based URLs, you can use this format - https://{{SALESFORCE_SUBDOMAIN}}.auth.marketingcloudapis.com/v2/token where the SALESFORCE_SUBDOMAIN will be the user input and AppFlow will ask the customers to provide its value while configuring the connector profile.

authURL

@Nullable
List<String> authURL()

Auth URLs. Required for OAuth2GrantType - AUTHORIZATION_CODE. This URL can be in two format - Static and Template based where we need the input from the Customer to build the complete URL. For Static URLs you can add the URL directly to this list like - https://login.salesforce.com/services/oauth2/token. And for template based URLs, you can use this format - https://{{SALESFORCE_SUBDOMAIN}}.auth.marketingcloudapis.com/v2/token where the SALESFORCE_SUBDOMAIN will be the user input and AppFlow will ask the customers to provide its value while configuring the connector profile.

oAuth2GrantTypesSupported

List<OAuth2GrantType> oAuth2GrantTypesSupported()

OAuth2 Grant types supported by connector.

oAuth2ContentType

@Value.Default
default OAuth2ContentType oAuth2ContentType()

OAuth2 Content type to use in the token request header. Default: "application/x-www-form-urlencoded"

oAuth2MethodType

@Value.Default
default OAuth2MethodType oAuth2MethodType()

OAuth2 Http method to use for the token request. Default: "POST"

oauth2CustomProperties

@Nullable
List<OAuth2CustomParameter> oauth2CustomProperties()

OAuth2 custom parameters needed by the connector. In case of 3 legged OAuth2 AppFlow have clientId and scope defined as the default parameter for AUTH_URL to generate the Authorization code. Connector developer doesn't have to define clientId and scope as OAuth2Custom Parameter for AUTH_URL.

addBasicAuthHeader

@Value.Default
default boolean addBasicAuthHeader()

Specifies if clientId and clientSecret should be added to basic auth header