Documentation
    {{docApp.userSession.userId}}
    {{docApp.userSession.userName}}
    {{docApp.userSession.email}}
    Issuer : {{docApp.userSession.issuerInstance}}
    Expires : {{new Date(docApp.userSession.validUntil).toLocaleDateString()}}

{{docApp.title}}

{{docApp.description}}

INDEX

Documentation Library

Search for information on Hornbill Documentation.

{{docApp.searchError}}

{{docApp.searchResultFilteredItems.length}} results for "{{docApp.currentResultsSearchText}}" in {{docApp.searchFilterBySpecificBookTitle}}

Have questions about this site?

What is this site?

  • This website is Hornbill's new product documentation website and is currently under development.
  • It is intended that all existing and future public-facing documentation we produce will be available to search, browse and share.
  • Hornbill's current documentation is available at Hornbill Wiki but over time this content will be migrated to this documentation site.
  • Please feel free to have a look around at any time.

Why has Hornbill created this site?

  • Hornbill's products have moved on considerably since we introduced it almost 10 years ago. At the time, the MediaWiki tool was sufficient, but we have outgrown it.
  • Our customers are more enterprise focused and more self-sufficient than ever before, so for 2023 and beyond we have established a new documentation platform and team to drive our documentation initiative forwards.
  • We are aiming to deprecate the use of Hornbill Wiki for most Hornbill related documentation.
  • We want to enable our growing partner network with product resources and information, documentation beyond our Wiki approach is required.
  • We could definitely do with some help, and may even pay for some! If you have domain knowledge and would like to help, please check out our Hornbill Docs Contributor Guide and contact the Hornbill docs team at docs@hornbill.com.

What will this site be good for?

  • Community contribution will be facilitated, encouraged, and most welcome.
  • High quality documentation, will be kept up to date as rapidly as our products evolve.
  • Real-time content search and discovery.
  • Articles organized into books, books into libraries, creating a more natural and logical structure to our documentation.
  • Legacy API documentation and various other documentation sources will all be consolidated into a single unified documentation system.
  • Documentation available in browser as well as printable/viewable as PDF on demand.
  • Personalized documentation experience, allowing dark/light mode, article subscriptions, social media sharing and other useful features.
  • Almost all publicly available documentation on docs.hornbill.com will be open-source and available to fork on GitHub, allowing customers to derive their own custom documentation around Hornbill products should they wish to.

What is the timeline for this site?

  • We have taken the decision to publish and make available early, there is very little content at this time.
  • As and when we have completed/usable documentation, it will be published here.
  • We have a host of additional features we wish to add over time, so please watch this space.
  • We expect most of our existing documentation should be reviewed/migrated to docs.hornbill.com over the coming months.
  • The documentation project will be ongoing, will continue to expand, evolve and improve day-by-day.

{{docApp.libraryHomeViewProduct.title || docApp.libraryHomeViewProduct.id}}

{{docApp.libraryHomeViewProduct.description}}

  1. {{book.title}}

{{group.title || group.id}}

{{group.description}}

  1. {{book.title}}

{{group.title}}

{{book.title}}
More...

Drive / Share File

  • Article
  • 4 minutes to read

Operation Information

Creates a permission against a file in Google Drive.

API Documentation: https://developers.google.com/drive/api/v3/reference/permissions/create.

This is a Free Tier Integration.

Authentication

This operation requires authentication, the details of which can be securely stored on your instance in a KeySafe Key of type Google Drive.

To create a key of this type:

  • In the Configuration area of your Hornbill instance, navigate to Platform Configuration > Security > KeySafe;
  • Click on the + Create New Key button;
  • On the resulting Create New Key form, choose Google Drive in the Type pick list;
  • Give the Google Drive KeySafe key a Title (this is the name / identifier for the Google Drive account as you will see it when using the cloud automation node in your workflows);
  • Optionally populate the Description field;
  • Click the Create Key button to create your new key;
  • Once the Key is created, you will need to connect to the target service, and your account, in order to authorize the connector app access to the listed operations. Click the Connect button and you will be redirected to the service provider in a popup window;
  • Log in to your account, and then you will be prompted to review the options you are authorizing the Hornbill connector to be allowed to perform using the chosen account;
  • Accept the review and you will be returned to your KeySafe key.

Tip

If you have revoked your Google KeySafe Token with the Revoke Access button, before you can reconnect Hornbill to your Google account you will need to log in to your Google account and remove Hornbill from the list of third-party apps with account access.

If this is not performed prior to reconnecting your account, then Hornbill will only be able to access the account for up to 1 hour before the access token is expired.

Revoking Access

If at any point you wish to revoke access to any of the above accounts from your Hornbill instance, just hit the Revoke button in the relevant KeySafe key(s).

Warning

This will revoke the rights of any existing Cloud Automation Node in your Hornbill Workflows that are using the revoked Google Drive account, so you will need to manage these workflows accordingly.

Input Parameters

Display Name ID Type Description Required Supported Values
File ID fileId string The ID of the file to create the permission against Yes None provided
Email Message emailMessage string A plain text custom message to include in the notification email. No None provided
Send Notification Email sendNotificationEmail boolean Whether to send a notification email when sharing to users or groups. This defaults to true for users and groups, and is not allowed for other requests. It must not be disabled for ownership transfers. No None provided
Supports Team Drives supportsTeamDrives boolean Whether the requesting application supports Team Drives. (Default: false) No None provided
Transfer Ownership transferOwnership boolean Whether to transfer ownership to the specified user and downgrade the current owner to a writer. This parameter is required as an acknowledgement of the side effect. (Default: false) No None provided
Use Domain Admin Access useDomainAdminAccess boolean Issue the request as a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the item belongs. (Default: false) No None provided
Role role string The role granted by this permission. Yes owner, organizer, fileOrganizer, writer, commenter, reader
Type type string The type of the grantee. Yes user, group, domain, anyone
Allow File Discovery allowFileDiscovery boolean Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type domain or anyone. No None provided
Domain domain string The domain to which this permission refers. No None provided
Email Address emailAddress string The email address of the user or group to which this permission refers. No None provided

Output Parameters

Display Name ID Type Description
Success? success boolean Boolean value, is only set when the share permission is set successfully.
Id id string The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as permissionId.
Type type string The type of the grantee
Email Address emailAddress string The email address of the user or group to which this permission refers.
Domain domain string The domain to which this permission refers.
Role role string The role granted by this permission.
Allow File Discovery allowFileDiscovery boolean Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type domain or anyone.
Display Name displayName string A displayable name for users, groups or domains.
Photo Link photoLink string A link to the user’s profile photo, if available.
Expiration Time expirationTime string The time at which this permission will expire (RFC 3339 date-time).
Team Drive Permission Type teamDrivePermissionType string The Team Drive permission type for this user.
Inherited From inheritedFrom string The ID of the item from which this permission is inherited. This is an output-only field and is only populated for members of the Team Drive.
Inherited inherited boolean Whether this permission is inherited.
Deleted deleted boolean Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document