驗證
本頁面使用機器翻譯而成。
機器翻譯免責聲明
驗證方式
密碼認證
密碼認證是一種使用用戶登入名稱和密碼進行身份驗證的方法。
密碼認證時,請在請求標頭中指定「X-Cybozu-Authorization」標頭。
標頭的值是 登入名稱:密碼
Base64編碼的。
例如,登入名稱為「Administrator」,密碼為「cybozu」,請在請求標頭中指定以下值:
|
|
會話身份驗證
會話認證是一種使用您使用網路瀏覽器登錄 cybozu.com 時使用的會話進行認證的方法。
如果希望從kintone或Garoon的JavaScript文件中執行User 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聯動令牌的獲取
身份驗證方法的優先順序
同時使用密碼認證和會話認證時,優先順序順序如下:
- 密碼認證
- 會話認證
在安全配置的環境中使用 API
如果您設定了IP位址限制
如果您有IP位址限制,請通過以下方式之一執行此操作:
- IP 位址限制設置允許運行 REST API 的環境的 IP 位址。
有關如何允許它的資訊,請參閱幫助頁面。
幫助頁面 - 如果配置了基本身份驗證,請授予「Authorization」請求標頭。
有關說明,請參閱以下頁面。
Basic身分驗證 - 授予尚未過期的客戶端證書。
有關說明,請參閱以下頁面。
用戶端憑證 - 有關IP位址限制的更多資訊,請參閱以下頁面:
IP地址限制
Basic身分驗證
如果已設置Basic身分驗證,請在請求標頭中指定「Authorization」標頭。
標頭的值是「Basic 」和「Basic身分驗證的登入名稱:Basic身分驗證的密碼
Base64 編碼值」的組合。
Basic身分驗證
例如,登入名稱為「cybozu」,密碼為「password」,請在請求標頭中指定以下值:
|
|
用戶端憑證
可以通過允許使用SecureAccess來頒發用戶端憑證。
有關如何允許使用SecureAccess和頒發用戶端證書的詳細資訊,請參閱以下頁面。
設置SecureAccess
使用用戶端證書運行時,子域必須在URL中後跟 .s
。
例如,對於「sample.cybozu.com」,URL 為「https://sample.s.cybozu.com」。
如果您要設定SAML身分驗證
如果配置了SAML 身份驗證 ,則仍可以通過本文中所述的身份驗證方法使用User API。
但是,如果使用密碼身份驗證,則必須指定 cybozu.com 登入名稱和密碼。
.com 共通管理在「必須使用SAML身分驗證」設置,則只有 cybozu.com 通用管理員才能執行密碼身份驗證。
其他身份驗證方法不受此限制。
如果您設置了雙重驗證
啟用了雙重驗證的使用者無法運行具有密碼身份驗證的 REST API。
使用密碼身份驗證以外的身份驗證方法,或在禁用雙重驗證的情況下為使用者準備協作。