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

密碼認證時，請在請求頭中指定"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 令牌，則具有查找欄位的應用可以通過複製進行查找的應用的值來註冊記錄。
有關可以使用多個 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配合使用，以處理記錄和應用。

記錄

• 獲取單條記錄
• 檢索多條記錄
• 註冊單條記錄
• 註冊多條記錄
• 更新單個記錄
• 更新多條記錄
• 刪除多條記錄
• 從游標中檢索記錄
• 建立游標（批量檢索紀錄）
• 移除游標（批量抓取紀錄 ）
• 發表記錄評論
• 刪除記錄註釋
• 更新記錄上的工作人員
• 更新單個記錄的狀態
• 更新多條記錄的狀態
• 批量多應用記錄操作

檔案

• 上傳檔案
• 下載檔

應用程式

• 表單
  • 獲取欄位清單
  • 選擇欄位
  • 更改欄位的設置
  • 選擇欄位
  • 更改表單的佈局
  • 獲取表單的佈局
• 清單
  • 獲取清單設置
  • 變更應用程式的設定（僅適用於顯示格式不包含「自訂格式」清單的應用）
• 設定
  • 獲取常規設置
  • 更改常規設置
  • 獲取進程管理設置
  • 更改流程管理設置
  • 獲取應用的條件通知設置
  • 更改應用的狀況通知設置
  • 獲取記錄狀態通知的設置
  • 更改記錄狀態通知的設置
  • 獲取提醒條件通知的設置
  • 更改提醒條件通知的設置
  • 獲取應用訪問許可權設置
  • 更改應用訪問許可權設置
  • 獲取記錄的訪問設置
  • 更改記錄的許可權設置
  • 獲取欄位的許可權設置
  • 更改欄位的許可權設置
  • 獲取應用的操作設置
  • 更改應用的操作設置
• 圖表
  • 獲取應用的圖表設置
  • 變更應用程式的設定
• 整個
  • 獲取單個應用的資訊
  • 檢查應用設置在生產環境中的反映方式
  • 將應用設置傳播到生產環境

言論

• 每個應用最多可以生成 20 個代幣。
• 使用 API 令牌的操作由管理員記錄為操作。
• 在跨組織訪問許可權設置 中啟用「禁止跨組織訪問」後，只有kintone系統管理員可以生成和查看API令牌。

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

如果要使用瀏覽器的 XMLHttpRequest 或 Fetch API 來執行 POST/PUT/DELETE 方法 API，請 授予 CSRF 令牌 。
如果要從Garoon的JavaScript文件中執行POST/PUT/DELETE方法的kintone REST API， 則需要為kintone集成提供Token。

請參閱 OAuth 用戶端 。

來賓使用者執行kintone REST API時，僅支援會話認證。

身份驗證方法的優先順序順序如下：

1. 密碼
2. API 令牌身份驗證
3. 使用 OAuth 用戶端進行身份驗證
4. 會話身份驗證

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

• IP 位址限制設置允許運行 REST API 的環境的 IP 位址。
  有關如何允許它的資訊， 請參閱幫助頁面 。
• 如果配置了基本身份驗證，請在請求標頭中添加"Authorization"標頭。
  有關詳細資訊， 請參閱基本身份驗證 。
• 授予尚未過期的客戶端證書。
  有關詳細資訊， 請參閱客戶端證書 。

Basic身分驗證

如果已設置基本身份驗證 ，請在請求標頭中指定"授權"標頭。
標頭的值是"基本"和"Basic身分驗證使用者名稱:Basic身分驗證密碼 Base64 編碼值"的組合。
例如，使用者名為「cybozu」，密碼為「password」，請在請求頭中指定以下值：

1
2
3

{
  "Authorization": "Basic Y3lib3p1OnBhc3N3b3Jk"
}

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

用戶端憑證

可以通過允許使用安全訪問來頒發客戶端證書。 有關如何允許使用安全訪問和頒發用戶端證書的詳細資訊， 請參閱配置 安全訪問。

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

如果要使用其他使用者的用戶端憑證進行密碼身份驗證，可以使用 . 在 COM Common Administration 中登錄的安全設置中，啟用"使用 API 時的身份驗證"。
有關詳細資訊， 請參閱登錄安全性 。

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

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

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

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