Parameters
See plugin common configurations for configuration options available to all plugins.
app_id
string
required
Feishu app ID (client ID).
app_secret
string
required
Feishu app secret (client secret).
The secret is encrypted with AES before being stored in the database. You can also store it in an environment variable and reference it using the
env://prefix, or in a secret manager such as HashiCorp Vault's KV secrets engine, and reference it using thesecret://prefix. For more information, see secrets.auth_redirect_uri
string
required
The redirect URI registered with Feishu for OAuth callback. The value should match the redirect URI configured in your Feishu app settings. Feishu will redirect users to this URI after authentication with the authorization code.
redirect_uri
string
required
The URI where users are redirected for authentication. See construct the authorization link for more information.
secret
string
required
vaild vaule:
8 to 32 characters
Secret used for session key derivation and cookie encryption. The secret should be a strong, random string for security.
The value is encrypted with AES before being stored in the database.
secret_fallbacks
array[string]
List of fallback secrets for session validation during secret rotation. This allows existing sessions created with older secrets to remain valid when the primary secret is updated.
code_header
string
default:
X-Feishu-CodeHeader name to extract the authorization code from. If both header and query parameter are provided, the header takes precedence.
code_query
string
default:
codeQuery parameter name to extract the authorization code from. Used when Feishu redirects back with the authorization code in the query string.
access_token_url
string
default:
https://open.feishu.cn/open-apis/authen/v2/oauth/tokenFeishu OAuth token endpoint URL for exchanging the authorization code for an access token.
userinfo_url
string
default:
https://open.feishu.cn/open-apis/authen/v1/user_infoFeishu user info endpoint URL for retrieving user information with the access token.
set_userinfo_header
boolean
default:
trueIf true, set the
X-Userinfoheader containing base64-encoded Feishu user information in the request to upstream services.timeout
integer
default:
6000Timeout in milliseconds for HTTP requests to Feishu APIs. This includes both token exchange and user info retrieval requests.
ssl_verify
boolean
default:
trueIf true, verify SSL certificates when making requests to Feishu APIs.
cookie_expires_in
integer
default:
86400Session cookie expiration time in seconds. The cookie remains valid for this duration of inactivity.