密碼認證是一種使用用戶登入名稱和密碼進行身份驗證的方法。

密碼認證時，請在請求標頭中指定「X-Cybozu-Authorization」標頭。
標頭的值是 登入名稱:密碼 Base64編碼的。

例如，登入名稱為「Administrator」，密碼為「cybozu」，請在請求標頭中指定以下值：

1
2
3

{
  "X-Cybozu-Authorization": "QWRtaW5pc3RyYXRvcjpjeWJvenU="
}

API 權杖認證是一種使用您為每個應用生成的 API 權杖進行認證的方法。
有關產生API 權杖，請參閱以下頁面。
生成 API 令牌

對於API權杖認證，請在請求標頭中指定「X-Cybozu-API-Token」。
標頭的值是為每個應用生成的API權杖。

例如，如果 API 權杖為「BuBNIwbRRaUvr33nWXcfUZ5VhaFsJxN0xH4NPN92」，請在請求標頭中指定以下值：

1
2
3

{
  "X-Cybozu-API-Token": "BuBNIwbRRaUvr33nWXcfUZ5VhaFsJxN0xH4NPN92"
}

指定多個 API權杖

如果指定多個 API 權杖，則具有Lookup欄位的應用可以通過複製進行Lookup的應用的值來註冊記錄。
有關通過指定多個 API 令牌可以執行的操作的更多資訊，請參閱以下頁面。
您可以使用多個 API 令牌做什麼

您可以通過用逗號分隔多個 API 權杖或在單獨的標頭中指定它們來指定它們。
您可以在單個請求中指定最多 9 個 API 權杖。如果指定超過10個，則會發生錯誤。
以下為指定以逗號分隔的API權杖時的「X-Cybozu-API-Token」標頭示例。

1
2
3

{
  "X-Cybozu-API-Token": "BuBNIwbRRaUvr33nWXcfUZ5VhaFsJxN0xH4NPN92, YuLjjdiOECJjV5ZDbFwh5BZoJJGDx3LtdCE1Dl7E"
}

可使用 API 權杖操作的 API

API權杖可與以下kintone REST API配合使用，以處理記錄和應用。

記錄

• 選取單個記錄
• 獲取多條記錄
• 註冊單條記錄
• 註冊多條記錄
• 更新單個記錄
• 更新多條記錄
• 刪除多條記錄
• （批量獲取紀錄）從游標中獲取記錄
• （批量獲取紀錄）建立游標
• （批量獲取紀錄）移除游標
• 貼文記錄回覆
• 刪除記錄回覆
• 更新記錄上的執行者
• 更新單個記錄的狀態
• 更新多條記錄的狀態
• 批量多應用記錄操作

檔案

• 上傳檔案
• 下載檔案

應用程式

• 表單
  • 獲取欄位清單
  • 新增欄位
  • 變更欄位的設置
  • 刪除欄位
  • 變更表單的佈局
  • 獲取表單的佈局
• 清單
  • 獲取清單設置
  • 變更應用程式的設定變更應用程式的設定
    只有顯示格式不包含「自訂格式」清單的應用才能使用 API 令牌認證。
• 設定
  • 獲取一般設定
  • 變更一般設定
  • 獲取進程管理設置
  • 變更流程管理的設置
  • 獲取已新增到應用的外掛程式清單
  • 將外掛程式添加到您的應用程式
  • 獲取應用的條件通知設置
  • 變更應用的狀況通知設置
  • 獲取記錄狀態通知的設置
  • 變更記錄狀態通知的設置
  • 獲取提醒條件通知的設置
  • 變更提醒條件通知的設置
  • 獲取應用訪問許可權設置
  • 變更應用訪問許可權設置
  • 獲取記錄的訪問設置
  • 變更記錄的許可權設置
  • 獲取欄位的許可權設置
  • 變更欄位的許可權設置
  • 獲取應用的操作設置
  • 變更應用的操作設置
• 圖表
  • 獲取應用的圖表設置
  • 變更應用程式的設定
• 整個
  • 獲取單個應用的資訊
  • 確認應用設置在正式環境中的反映狀態
  • 將應用設置傳播到正式環境
  • 選取應用程式管理員用備註
  • 變更應用程式管理員用備註

備考

• 每個應用最多可以生成 20 個權杖。
• 使用 API 權杖的操作由管理員記錄為操作。
• 在跨組織間相互存取設置中啟用「禁止組織間相互存取」後，只有kintone系統管理員可以生成和查看API權杖。
  組織間的存取權限

會話認證是一種使用您使用網路瀏覽器登錄 cybozu.com 時使用的會話進行認證的方法。
從kintone或Garoon的JavaScript文件執行kintone REST API時，可以使用會話認證。

從應用於kintone的JavaScript文件執行

您可以透過以下方式之一發送要求來使用會話身份驗證：

方法1：使用kintone.api()

有關詳細的kintone.api()，請參閱以下頁面。
kintone.api()：傳送kintone REST API請求API

在 API 中上傳或下載檔，您可以使用kintone.api()不可用。
使用方法 2 提交請求。

方法2：附加「X-Requested-With」標頭並使用 Web 瀏覽器的 Fetch API 或 XMLHttpRequest

有關「X-Requested-With」標頭的詳細資訊，請參閱以下頁面： 「X-Requested-With」標頭

如果 HTTP 方法為 POST/PUT/DELETE 方法，則除了「X-Requested-With」標頭外，還要在查詢參數或請求體中授予 CSRF 令牌。
有關使用 CSRF 令牌的請求範例，請參閱以下頁面。
獲取CSRF權杖

從應用於Garoon的JavaScript文件執行

附加「X-Requested-With」標頭，並使用 Web 瀏覽器的 Fetch API 或 XMLHttpRequest 發送請求。
「X-Requested-With」標頭

如果API的HTTP方法為POST/PUT/DELETE方法，則除了在查詢參數或請求體中添加"X-Requested-With”頭外，還需要添加kintone聯動的Token。
關於kintone集成使用Token的請求示例，請參考以下頁面。
kintone聯動令牌的獲取

有關說明，請參閱以下頁面。
OAuth用戶端

訪客執行kintone REST API時，僅支援會話認證。

認證方法的優先順序順序如下：

1. 密碼認證
2. API 權杖身分驗證
3. 使用 OAuth 用戶端進行驗證
4. 會話認證

如果您有IP位址限制，請通過以下方式之一執行此操作：
IP地址限制

• IP 位址限制設置允許運行 REST API 的環境的 IP 位址。
  有關如何允許此操作的詳細資訊，請參閱以下頁面。
  設置IP位址限制
• 如果配置了基本身份驗證，請在請求標頭中添加「Authorization」標頭。
  Basic身分驗證
• 授予尚未過期的客戶端證書。
  用戶端憑證

Basic身分驗證

如果已設置Basic身分驗證，請在請求標頭中指定「Authorization」標頭。
Basic身分驗證

標頭的值是「Basic 」和「Basic身分驗證的登入名稱:Basic身分驗證的密碼 Base64 編碼值」的組合。
例如，登入名稱為「cybozu」，密碼為「password」，請在請求標頭中指定以下值：

1
2
3

{
  "Authorization": "Basic Y3lib3p1OnBhc3N3b3Jk"
}

如果您要針對訪客空間或訪客空間中的應用程式執行 API，則無需包含「Authorization」標頭。

用戶端憑證

可以通過允許使用SecureAccess來頒發用戶端憑證。 有關如何允許使用SecureAccess和頒發用戶端證書的詳細資訊，請參閱以下頁面。
設置SecureAccess

使用用戶端證書運行時，子域必須在URL中後跟 .s。
例如，對於「sample.cybozu.com」，URL 為「https://sample.s.cybozu.com」。

如果要使用其他使用者的用戶端憑證進行密碼身份驗證，在cybozu.com共通管理中登錄的安全設置中，啟用「使用API時的認證」。
登錄安全性

即使設置了SAML身分驗證設置，您仍然可以使用本文所述的認證方法運行kintone REST API。
SAML身分驗證

但是，如果使用密碼身份驗證，則必須指定 cybozu.com 登入名稱和密碼。
.com 共通管理在「必須使用SAML身分驗證」設置，則只有 cybozu.com 通用管理員才能執行密碼身份驗證。
限制登入時僅能使用SAML身分驗證
其他身份驗證方法不受此限制。

啟用了雙重驗證的使用者無法運行具有密碼身份驗證的 REST API。
雙重驗證

使用密碼身份驗證以外的身份驗證方法，或在禁用雙重驗證的情況下為使用者準備協作。