> ## 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/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。                                         |