Kintone Connection

See the Connector Marketplace topic. Please request your administrator to start a trial or subscribe to the Premium Kintone connector.

Kintone is a versatile no-code/low-code platform empowering businesses to build customized applications for streamlined collaboration and workflow.

This topic describes how to authenticate to Kintone and configure any necessary connection properties in the Kintone connection connector.

Prerequisites #

Connecting to Kintone

In addition to the authentication values, set the following parameters to connect to and retrieve data from Kintone:

• Url: The URL of your account.

• GuestSpaceId: Optional. Set this when using a guest space.

Authenticating to Kintone #

Kintone supports the following authentication methods.

Password Authentication #

You must set the following to authenticate to Kintone:

• User: The username of your account.

• Password: The password of your account.

• AuthScheme: Set AuthScheme to Password.

API Token #

You must set the following to authenticate to Kintone:

• APIToken: The API Token.

  To generate an API token access the specific app and click on the cog wheel.

  Proceed to App Settings tab > API Token.

  Click on the Generate button, an API token will be generated. You can also specify multiple comma-seperated APITokens.

• AppId: The Application Ids.

  The AppId is the number of that specific app in the sequence under Apps in Kintone UI dashboard. You can also specify multiple comma-seperated AppIds.

• AuthScheme: Set AuthScheme to APIToken.

Additional Security #

In addition to the mentioned authentication schemese, Kintone offers additional security in the form of both an additional Basic Auth header, and an SSL Certificate.

Using Client SSL #

In addition to your authentication information, Kintone may be configured to require an SSL certificate to accept requests. To do so, set the following:

• SSLClientCert: The file containing the certificate of the SSL Cert. Or alternatively, the name of the certificate store for the client certificate.

• SSLClientCertType: The type of certificate.

• SSLClientCertSubject: (Optional) If searching for a certificate in the certificate store, the store is searched for subjects containing the value of the property.

• SSLClientCertPassword: If the certificate store is of a type that requires a password, this property is used to specify that password to open the certificate store.

Basic #

Kintone environments using basic authentication will need to pass additional basic credentials. To do so, specify the following:

• BasicAuthUser: The basic login name.

• BasicAuthPassword: The basic password.

Connection Configuration #

Each connection property available in the Kintone connector is explained below.

Connection Name #

The name of the connection to be created should be provided. This is the name that will display on the list of available connections.

Auth Scheme #

Whether to connect to Kintone with User/Password or APIToken.

• Password: Set this to perform Password authentication.

• APIToken: Set this to perform APIToken authentication.

URL #

The Kintone URL.

Example: https://SUBDOMAIN_NAME.cybozu.com.

User #

The Kintone user account used to authenticate.

Password #

The password used to authenticate the user.

Basic Auth User #

The additional username required for domains using basic authentication.

The basic authentication username, used to connect to basic-authentication-enabled domains.

Basic authentication provides a double authentication: if you are connecting to a domain using basic authentication, set BasicAuthUser and BasicAuthPassword in addition to User and Password.

Basic Auth Password #

The additional password required for domains using basic authentication.

The basic authentication password, used to connect to basic-authentication-enabled domains.

Basic authentication provides a double authentication: if you are connecting to a domain using basic authentication, set BasicAuthUser and BasicAuthPassword in addition to User and Password.

App Id #

The AppId used along with the APIToken for authentication.

The AppId is the number of that specific app in the sequence under Apps in Kintone UI dashboard.

You can also specify multiple comma-seperated AppIds.

API Token #

The APIToken used for authentication.

Access the specific app to create the API tokens for and click on the cog wheel.

Proceed to App Settings tab > API Token > click on the Generate button, an API token will be generated.

You can also specify multiple comma-seperated API Tokens in case of operations involving Lookup fields or Related Record fields.

Enable SSL #

Option for creating the connection with SSL enabled.

Upload Keystore File #

Option to upload keystore file.

Add Configuration: Additional properties can be added using this option as key-value pairs.

After entering all the details, click on the TEST button.

If the connection service identification and authentication details are provided correctly, a success message stating “connection available” is generated.

Click on the CREATE button to save the changes.

If the details are incorrect or the server is down, you will get a message “Connection unavailable”.