跳到主要内容

参数​

请参阅 插件通用配置 了解所有插件可用的配置选项。

  • app_id

    string

    必填

    飞书应用 ID（client ID）。

  • app_secret

    string

    必填

    飞书应用密钥（client secret）。

    该密钥在存入数据库之前会通过 AES 加密。你也可以将其保存在环境变量中并通过 env:// 前缀引用，或保存在 HashiCorp Vault 的 KV secrets engine 等密钥管理服务中，通过 secret:// 前缀引用。更多信息请参阅 密钥。

  • auth_redirect_uri

    string

    必填

    在飞书注册的 OAuth 回调重定向 URI，需与你在飞书应用设置中配置的重定向 URI 一致。飞书完成认证后会携带授权码重定向到该地址。

  • redirect_uri

    string

    必填

    用户被重定向进行身份认证的 URI。请勿在 URI 中预设 state；插件会生成随机 state，保存到会话并自动追加到该 URI。使用查询参数返回授权码时，回调必须携带相同的 state，否则插件返回 401 Invalid state；通过 code_header 提供授权码时不校验 state。详见 构造授权链接。

  • secret

    string

    必填

    有效值：

    8 到 32 个字符

    用于会话密钥派生和 Cookie 加密的密钥。该密钥应为强随机字符串以保障安全。

    该值在存入数据库之前会通过 AES 加密。

  • secret_fallbacks

    array[string]

    用于密钥轮换期间会话校验的备用密钥列表，使主密钥更新后由旧密钥创建的现有会话仍然有效。

  • code_header

    string

    默认值：X-Feishu-Code

    用于提取授权码的请求头名称。若请求头与查询参数同时提供，请求头优先。

  • code_query

    string

    默认值：code

    用于提取授权码的查询参数名称。当飞书在查询字符串中通过授权码回跳时使用。

  • access_token_url

    string

    默认值：https://open.feishu.cn/open-apis/authen/v2/oauth/token

    用于使用授权码换取访问 Token 的飞书 OAuth Token 端点 URL。

  • userinfo_url

    string

    默认值：https://open.feishu.cn/open-apis/authen/v1/user_info

    用于使用访问 Token 获取用户信息的飞书用户信息端点 URL。

  • set_userinfo_header

    boolean

    默认值：true

    如果为 true，则在转发到上游服务的请求中设置 X-Userinfo 请求头，其中包含 Base64 编码的飞书用户信息。

  • timeout

    integer

    默认值：6000

    调用飞书 API 时 HTTP 请求的超时时间（毫秒），同时适用于 Token 交换和用户信息获取请求。

  • ssl_verify

    boolean

    默认值：true

    如果为 true，则在调用飞书 API 时验证 SSL 证书。

  • cookie_expires_in

    integer

    默认值：86400

    会话 Cookie 的过期时间（秒）。Cookie 在该时长内保持有效。