Actions10
- Api Access Token Actions
- Store App Actions
- Custom App Actions
- User ID Actions
Overview
This node is designed to obtain user information from the Lark platform using its authentication mechanisms. It supports two types of authentication: a tenant token or OAuth2, allowing flexible integration depending on the user's setup. This node is beneficial when you need to retrieve details about a specific user within your organization's Lark environment, such as fetching profile data for automation workflows, syncing user info with other systems, or validating user identities.
Practical examples include:
- Automatically retrieving user details after a new user signs up.
- Enriching customer records in a CRM by pulling updated user information from Lark.
- Verifying user permissions or roles before executing further workflow steps.
Properties
| Name | Meaning |
|---|---|
| Authentication | Method used to authenticate requests. Options: "Tenant Token" or "OAuth2". |
| Options | Additional optional settings: |
| - Use Custom Body | Boolean flag indicating whether to send a custom request body instead of default format. |
Output
The node outputs JSON data containing the user information retrieved from Lark. The structure typically includes user profile details such as user ID, name, email, and other metadata provided by the Lark API. If binary data were involved (not indicated here), it would represent files or media associated with the user, but this node focuses on JSON user data only.
Dependencies
- Requires valid authentication credentials: either a tenant token or an OAuth2 access token configured in n8n.
- Connects to the Lark Open Platform API at
https://open.larksuite.com. - Proper configuration of these credentials in n8n is necessary for successful API calls.
Troubleshooting
- Authentication errors: Ensure that the selected authentication method is correctly set up with valid tokens. Expired or incorrect tokens will cause authorization failures.
- API request failures: Network issues or incorrect API endpoint usage can lead to errors. Verify connectivity and that the base URL has not changed.
- Invalid custom body: If "Use Custom Body" is enabled, ensure the custom payload matches the expected API schema; otherwise, the request may be rejected.
- Missing required parameters: Confirm all mandatory fields are provided; missing inputs can cause the API to return errors.