Stirling PDF icon

Stirling PDF

Merged API: Stirling PDF - Processing API + Stirling PDF - Management API + Stirling PDF - System API

Actions260

File Storage → Share With User

AI-generated

Summary

Grant a specified user access to a file stored in the Stirling PDF service by sharing the file with them and assigning an access role.

Inputs

  • File Id (required) — The numerical ID of the file in the storage system to be shared.
  • Username (required) — The username of the user to share the file with.
  • Access Role (required) — The access role to assign to the user for this file, defining their permissions.

Output shape

a single record representing the sharing action result

Returns the response from the Stirling PDF API confirming the share operation. No pagination or batching applies directly to the output, but batching input options exist to throttle multiple share requests.

Examples

Example 1: Share file ID 123 with user 'alice' granting viewer role.

Set File Id to 123, Username to 'alice', Access Role to 'viewer'.

Links

Discussion