Lark Files icon

Lark Files

Lark Files Management

Overview

The node "Lark Files" provides functionality to manage files and their permissions within the Lark (Feishu) ecosystem. Specifically, the "Add Permissions" operation under the "Permission Member" resource allows users to grant access rights to a file for specific members. This is useful in scenarios where you want to share documents or files with colleagues or external collaborators by assigning them appropriate permission levels.

Practical examples include:

  • Adding a team member as an editor or viewer to a shared document.
  • Granting read-only access to a client on a project file.
  • Managing permissions programmatically to automate sharing workflows based on user roles.

Properties

Name Meaning
Authentication Method of authentication to use: either "Tenant Token" or "OAuth2".
Type The type of the file (e.g., document, spreadsheet). This is sent as a query string parameter named type.
Token The unique token identifier of the file to which permissions are being added.
Member Id Identifier of the member (user or group) to whom the permission will be granted.
Member Type The type/category of the member (e.g., user, group).
Perm The permission level to assign to the member (e.g., read, write, comment).
Custom Body A JSON object allowing the user to specify a custom request body instead of using the standard fields (member_id, etc.).
Use Custom Body Boolean option to toggle whether to send the custom JSON body or the standard structured body.

Output

The node outputs JSON data representing the response from the Lark API after attempting to add the permission. This typically includes confirmation of the permission addition, details about the member, and the assigned permission level.

If the node supports binary data output (not indicated here), it would represent any file or media content returned by the API, but this operation primarily deals with JSON responses related to permissions.

Dependencies

  • Requires valid authentication credentials, either a Tenant Token or OAuth2 token configured in n8n.
  • Depends on the Lark Suite Open API endpoint at https://open.larksuite.com/open-apis.
  • Proper configuration of authentication credentials in n8n is necessary to authorize API requests.

Troubleshooting

  • Common Issues:

    • Invalid or expired authentication tokens leading to authorization errors.
    • Incorrect or missing file token causing the API to fail locating the target file.
    • Improper member ID or member type resulting in failure to assign permissions.
    • Using an unsupported permission value may cause the API to reject the request.
  • Error Messages:

    • Authorization errors: Check that the correct authentication method is selected and credentials are valid.
    • "File not found" or similar: Verify the file token is correct and the file exists.
    • Validation errors on request body: Ensure required fields (member_id, member_type, perm) are correctly set.
    • If using custom body, ensure JSON syntax is valid and matches expected API schema.

Links and References


This summary is based on static analysis of the provided properties and bundled source code for the "Add Permissions" operation on the "Permission Member" resource of the Lark Files node.

Discussion