> ## Documentation Index
> Fetch the complete documentation index at: https://docs.kasoftware.com/llms.txt
> Use this file to discover all available pages before exploring further.

# 認證

> 使用 authtoken 或 OAuth 2.0 對知行之橋系統 API 進行認證。

export const CommonApiAuthentication = () => <>
    <p>此範例使用認證權杖訊息頭 (<strong>x-cdata-authtoken</strong>) 作為身分驗證方法。要使用該方法：</p>
    <ol>
      <li>單擊知行之橋導覽列上的 <strong>系統設定</strong> 圖示。</li>
      <li>單擊 <strong>新增使用者</strong> 新增新使用者，或單擊現有使用者名稱稱的連結來編輯使用者。</li>
      <li>單擊 <strong>API 存取</strong> 索引標籤，然後勾選 <strong>API 存取</strong> 核取方塊以顯示認證權杖。將此權杖複製到安全位置，因為該對話方塊將不會再次顯示。如果您丟失或刪除了認證權杖，則必須建立一個新權杖。</li>
      <li>單擊 <strong>儲存</strong>。</li>
    </ol>
  </>;

export const siteName = "知行之橋";

每個已配置的 {siteName} 使用者都可以選擇使用 authtoken 或 OAuth 2.0 對系統 API 進行認證。有關配置使用者和使用者角色的更多資訊，請參閱[使用者](../getting-started/administration/settings/users)和[使用者角色](../getting-started/administration/settings/user-roles)。

## 使用身分驗證權杖

authtoken 可以透過多種方式在 API 請求中使用：

* 在 HTTP 請求中包含 **x-cdata-authtoken** 標頭，並將值設定為相應使用者的 authtoken
* 將使用者和 authtoken 作為 HTTP 基本認證的使用者名稱/密碼組合
* 在請求 URL 中將 authtoken 作為查詢參數

<CommonApiAuthentication />

要在請求 URL 中包含 authtoken，請按照以下步驟操作：

1. 開啟**設定**頁面。

2. 選擇**系統 API** 索引標籤。

3. 在**其他設定**部分，選擇**允許在 URL 中使用 Authtoken**。

authtoken 查詢參數的語法為 `@authtoken=myAuthTokenValue`。

## 使用 OAuth 2.0

OAuth 2.0 為需要管理權杖生命週期或與外部應用程式整合的用戶端提供結構化認證流程。

要啟用 OAuth 2.0，請按照以下步驟操作：

1. 點選導覽列上的**設定**圖示。

2. 點選**新增使用者**以新增新使用者，或點選現有使用者名稱稱上的連結來編輯使用者。

3. 點選 **API 存取**索引標籤，然後勾選**啟用 OAuth 存取**。填寫以下欄位：

   | 欄位                | 描述                                                                   |
   | ----------------- | -------------------------------------------------------------------- |
   | **Grant Type**    | 用於確定用戶端應用程式如何取得存取權杖的 OAuth 2.0 授權型別。目前唯一的選項是 **Client Credentials**。 |
   | **Client Id**     | 系統生成的用戶端 Id 權杖。                                                      |
   | **Client Secret** | 系統生成的用戶端金鑰。請確保在儲存使用者之前將其複製到安全位置，因為之後將不再顯示。                           |
   | **Access URL**    | 用戶端應用程式使用配置的憑據請求存取權杖的端點 URL。                                         |