Authentication
Authentication module will be used by Connection. This module allows authenticating with the Kintone app by password authenticator or API token authenticator. This module is also supported the basic authenticator.
Warning
- If both the Token and Password Authentication are specified, the Token Authentication will be ignored and the Password authentication will be used.
Constructor
Parameter
(none)
Sample code
Init authentication module
Javascript
var kintoneAuth = new kintoneJSSDK.Auth();
Nodejs
const kintone = require('@kintone/kintone-js-sdk'); let kintoneAuth = new kintone.Auth();
Methods
setPasswordAuth(params)
Set password authentication for Authentication module.
Parameter
Name | Type | Required | Description |
---|---|---|---|
params | Object | yes | The parameters that include username, password properties |
params.username | String | yes | The username that is able to authenticate on kintone app |
params.password | String | yes | The password that is able to authenticate on kintone app |
Return
Sample code
Set password authentication
Javascript
var basicAuth = { username: '{your_user_name}', password: '{your_password}' }; kintoneAuth.setPasswordAuth(basicAuth);
Nodejs
let basicAuth = { username: '{your_user_name}', password: '{your_password}' }; kintoneAuth.setPasswordAuth(basicAuth);
setApiToken(params)
Set Api Token for Authentication module.
Parameter
Name | Type | Required | Description |
---|---|---|---|
params | Object | yes | The parameters that includes apiToken property |
params.apiToken | String | yes | The apiToken that is able to authenticate on kintone app |
Return
Set APIToken authentication
Javascript
var params = { apiToken: '{your_token}' }; kintoneAuth.setApiToken(params);
Nodejs
let params = { apiToken: '{your_token}' }; kintoneAuth.setApiToken(params);
setBasicAuth(params)
Set Basic authentication for Authentication module.
Parameter
Name | Type | Required | Description |
---|---|---|---|
params | Object | yes | The parameters that includes username, password properties |
params.username | String | yes | The username that is able to authenticate on kintone app |
params.password | String | yes | The password that is able to authenticate on kintone app |
Return
Sample code
Set basic authentication
Javascript
var basicAuth = { username: '{your_user_name}', password: '{your_password}' }; kintoneAuth.setBasicAuth(basicAuth);
Nodejs
let basicAuth = { username: '{your_user_name}', password: '{your_password}' }; kintoneAuth.setBasicAuth(basicAuth);
setClientCert(params)
Setting Authentication with the client certificate & password set.
Parameter
Name | Type | Required | Description |
---|---|---|---|
params | Object | yes | The parameters that includes cert, password properties |
params.cert | BinaryData | yes | Binary data of client certificate |
params.password | String | yes | Password of client certificate |
Return
Sample code
Set client certificate by binary data
Nodejs
const filePath = "your_cert_path_file"; const params = { fileContent: fs.readFileSync(filePath), certPassword: "your_cert_file_password" }; //set client cert by file content and password kintoneAuth.setClientCert(params);
setClientCertByPath(params)
Setting Authentication with the client certificate & password set by file path
Parameter
Name | Type | Required | Description |
---|---|---|---|
params | Object | yes | The parameters that includes filePath, password properties |
params.filePath | String | yes | File path to client certificate |
params.password | String | yes | Password of client certificate |
Return
Sample code
Set client certificate by path
Nodejs
const params = { filePath: "your_cert_path_file", certPassword: "your_cert_file_password" }; //set client cert by file path and password kintoneAuth.setClientCertByPath(params);