驗證

information

本頁面使用機器翻譯而成。
機器翻譯免責聲明 (External link)

目錄

驗證方式

密碼認證

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

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

例如,登入名稱為“Administrator“,密碼為“cybozu“,請在請求標頭中指定以下值:

1
2
3
{
  "X-Cybozu-Authorization": "QWRtaW5pc3RyYXRvcjpjeWJvenU="
}

API 權杖認證

API 權杖認證是一種使用您為每個應用生成的 API 權杖進行認證的方法。
關於如何生成API權杖,請參見 生成API 權杖 (External link)

對於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 權杖的操作由管理員記錄為操作。
  • 在跨 組織間相互存取設置 (External link) 中啟用“禁止組織間相互存取“後,只有kintone系統管理員可以生成和查看API權杖。

工作階段認證

工作階段認證是一種使用您使用 Web 瀏覽器登錄 cybozu.com 時使用的工作階段進行認證的方法。
從kintone或Garoon的JavaScript文件執行kintone REST API時,可以使用工作階段認證。

如果要使用瀏覽器的 XMLHttpRequest (External link) Fetch API (External link) 來執行 POST/PUT/DELETE 方法 API,請 授予 CSRF 權杖
如果要從Garoon的JavaScript文件中執行POST/PUT/DELETE方法的kintone REST API,則需要為 kintone集成提供權杖

使用 OAuth 用戶端進行認證

請參閱 OAuth 用戶端

訪客可用的認證方法

訪客執行kintone REST API時,僅支援工作階段認證。

認證優先順序

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

  1. 密碼認證
  2. API 權杖認證
  3. 使用 OAuth 用戶端認證
  4. 工作階段認證

在安全配置的環境中使用 API

如果您設定了IP位址限制

如果您有 IP位址限制 (External link) ,請通過以下方式之一執行此操作:

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

如果已設置 Basic身分驗證 (External link) ,請在請求標頭中指定“Authorization”標頭。
標頭的值是“Basic ”和“Basic身分驗證使用者名稱:Basic身分驗證密碼 Base64 編碼值”的組合。
例如,登入名稱為”cybozu”,密碼為”password”,請在請求標頭中指定以下值:

1
2
3
{
  "Authorization": "Basic Y3lib3p1OnBhc3N3b3Jk"
}

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

用戶端憑證

可以通過允許使用安全訪問來頒發用戶端憑證。 有關如何允許使用安全訪問和頒發用戶端證書的詳細資訊,請參閱 配置SecureAccess (External link)

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

如果要使用其他使用者的用戶端憑證進行密碼身份驗證,在cybozu.com共通管理中登錄的安全設置中,啟用“使用API時的認證”。
有關詳細資訊,請參閱 登入的安全性設定 (External link)

如果您要設定SAML身分驗證

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

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

如果您設置了雙重驗證

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

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