跳到主要内容

参数

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

  • app_key

    string


    必填


    有效值:

    非空字符串


    钉钉开放平台创建的应用唯一标识(AppKey),用于调用钉钉开放平台接口的身份认证。

  • app_secret

    string


    必填


    有效值:

    非空字符串


    钉钉开放平台应用的密钥(AppSecret),插件会加密存储该字段,用于获取钉钉接口的 access_token

  • code_header

    string


    默认值:X-DingTalk-Code


    有效值:

    非空字符串


    提取钉钉授权码(code)的 HTTP 请求头名称,优先级高于 code_query

  • code_query

    string


    默认值:code


    有效值:

    非空字符串


    提取钉钉授权码(code)的 URL Query 参数名称,当 code_header 未获取到 code 时使用。

  • userinfo_url

    string


    默认值:https://oapi.dingtalk.com/topapi/v2/user/getuserinfo


    有效值:

    合法的 HTTP/HTTPS URL


    钉钉开放平台用于验证授权码并获取用户信息的接口地址。

  • access_token_url

    string


    默认值:https://api.dingtalk.com/v1.0/oauth2/accessToken


    有效值:

    合法的 HTTP/HTTPS URL


    钉钉开放平台用于获取 access_token 的接口地址。

  • set_userinfo_header

    boolean


    默认值:true


    如果为 true,则将钉钉用户信息经过 Base64 编码后注入 X-Userinfo 请求头,传递给上游服务。

  • redirect_uri

    string


    必填


    有效值:

    合法的 HTTP/HTTPS URL


    当请求中未携带授权码(code)且无有效会话时,重定向到该钉钉授权页面 URI。该 URI 通常包含回调地址参数,其中的实际回调地址需在钉钉开放平台登记为可信回调地址。

  • timeout

    integer


    默认值:6000


    有效值:

    大于 0


    调用钉钉开放平台接口的超时时间(以毫秒为单位)。

  • ssl_verify

    boolean


    默认值:true


    如果为 true,则验证钉钉开放平台接口的 SSL 证书;测试环境可设置为 false 以关闭验证。

  • secret

    string


    必填


    有效值:

    8 到 32 个字符


    用于加密会话 Cookie 的密钥,确保存储的用户信息不被篡改,插件会加密存储该字段。

  • secret_fallbacks

    array[string]


    有效值:

    数组中的每个字符串包含 8 到 32 个字符


    会话密钥轮换的备用密钥列表,当主密钥(secret)更新后,仍可解密使用旧密钥加密的会话 Cookie。

  • cookie_expires_in

    integer


    默认值:86400


    有效值:

    大于 0


    会话 Cookie(dingtalk_session)的有效期(以秒为单位),默认 86400 秒(1 天),过期后需重新认证。