Kafka OAuth2 Account

In this article:

Overview

You can use this account type to connect Kafka Snaps with data sources that use the Kafka OAuth2 account.

Prerequisites

A registered OAuth application in the Confluent portal with appropriate permissions:

  • Client ID

  • Client secret

  • OAuth2 token endpoint

  • Scope

Limitations and Known Issues

None.

Account Settings

kafka-oauth2-overview.png
  • Asterisk ( * ): Indicates a mandatory field.

  • Suggestion icon ( ): Indicates a list that is dynamically populated based on the configuration.

  • Expression icon ( ): Indicates the value is an expression (if enabled) or a static value (if disabled). Learn more about Using Expressions in SnapLogic.

  • Add icon ( ): Indicates that you can add fields in the field set.

  • Remove icon ( ): Indicates that you can remove fields from the field set.

Field Name

Field Type

Field Dependency

Description

Field Name

Field Type

Field Dependency

Description

Label*

 

Default Value: Kafka OAuth2 Account
Example: Kafka OAuth2Account

String

None

Specify a unique label for the account.

 

Bootstrap servers*

Use this field to specify the initial list of Kafka broker addresses for a Kafka client to connect to during its initial bootstrap process.

Bootstrap server

 

Default Value: N/A
Example: localhost:9092

String/Expression

None

Specify the host:port pairs to establish the initial connection to the Kafka cluster.

Schema registry URL

 

Default Value: N/A
Example: http://ec2-55-334-44-58.compute-1.amazonaws.com:8000

String/Expression

None

Specify the schema registry server URL.

Advanced Kafka properties

Use this field set to specify any additional Kafka properties for connecting to the Kafka server that are not specifically provided in the Confluent Kafka Snaps. 

Key 

 

Default Value: N/A
Example: max.message.size

String/Expression

None

Specify the key for any Kafka parameters that are not specifically supported by the Snaps.

Value

 

Default Value: N/A
Example: 5 MB

String/Expression/Integer

None

Specify the value for the corresponding key that is not specifically supported by the Snaps.

Security protocol

 

Default Value: SASL_PLAINTEXT
Example: SASL_SSL

String/Expression/Suggestion

None

Select the security protocol from the dropdown list. The available options are:

  • SASL_SSL

  • SASL_PLAINTEXT

Keystore filepath

 

Default Value: N/A
Example: server.keystore.jks

String/Expression

Appears when the Security protocol is SASL_SSL

Specify the keystore file location of the client.

Keystore file password

 

Default Value: N/A
Example: KsP@ssw0rd123!

String/Expression

Appears when the Security protocol is SASL_SSL

Specify the keystore password to access the keystore file of the client.

SSL key password

 

Default Value: N/A
Example: SslK3yP@ssw0rd!

String/Expression

Appears when the Security protocol is SASL_SSL

Specify the SSL key password.

Truststore filepath

 

Default Value: N/A
Example: server.truststore.jks

String/Expression

Appears when the Security protocol is SASL_SSL

Specify the truststore file location of the client.

Truststore password

 

Default Value: N/A
Example: Value is encrypted

String/Expression

Appears when the Security protocol is SASL_SSL

Specify the password to access the truststore file, if used.

Client ID*

 

Default Value: N/A
Example: 8231b8a-jbc8-128-73ce-d021j2b279c8

String

None

Specify the client ID created during the application registration process. This ID enables the application to log in to an identity provisioning program, such as Azure Active Directory. The application ID, also known as the client ID, uniquely identifies your application. Learn more about the application configuration process in the Azure portal.

Client secret*

 

Default value: N/A
Example: value is encrypted

String

None

Specify the client secret, which your application uses to securely acquire the tokens. The client secret can be created by following the steps of the application provider.

Scope

 

Default Value: N/A
Example: api://e0af525c-c373-44bc-ac99-5f5a-2782268d/default

String/Expression

None

Specify the scope to provide a way to manage permissions to protected resources, such as your web API. Learn more about how to set up OAuth2 credentials in the Azure portal.

OAuth2 token endpoint*

 

Default value: N/A

Example: https://login.microsoftonline.com/2060acfg-89d9-423d-9514-eac46338ec05/oauth2/v2.0/token

String/Expression

 

None

Specify the token endpoint to get the access token.

 

Related Content

Add label