Create Recipients Sharing Link
Create and send a sharing link to recipients for a drive item in OneDrive.
Options
| Field | Definition | Type | Required |
|---|---|---|---|
| Source |
Choose a source:
|
Dropdown |
TRUE |
Input
| Field | Definition | Type | Required |
|---|---|---|---|
|
Drive |
|||
| Drive ID |
Unique ID for the drive requested. Appears when Drive ID is selected from the Source option. |
Text |
TRUE |
|
Group |
|||
| Group ID |
Unique ID for the group which owns the document library. Appears when Group ID is selected from the Source option. |
Text |
TRUE |
|
User |
|||
| User ID |
Unique ID for the user object who owns the drive item. Appears when User ID is selected from the Source option. |
Text |
TRUE |
|
Drive Item |
|||
| File or Folder ID |
Unique ID of the file or folder. |
Text |
TRUE |
|
Permissions |
|||
| Anonymous | True if anyone with the link has access, without needing to sign in; otherwise False. |
True/False |
FALSE |
| Recipients | Collection of recipients who will receive access and the sharing invitation. |
List of Text |
FALSE |
| Roles |
Type of permission for the role:
Read: Provides the ability to read the metadata and contents of the item. Write: Provides the ability to read and modify the metadata and contents of the item. |
Dropdown |
TRUE |
| Send Invitation? | True if a sharing link is sent to the recipient. When False, permission is granted directly without sending a notification. |
True/False |
FALSE |
| Message |
Plain text formatted message that is included in the sharing invitation. Maximum length 2000 characters. |
Text |
FALSE |
Output
| Field | Definition | Type |
|---|---|---|
|
Permissions |
||
| Permission ID |
Unique identifier of the permission among all permissions on the item. |
Text |
| Roles | The type of user permission. |
List of Text |
| Granted To |
For user type permissions, the details of the users and applications for this permission. |
Object |
| Granted To Identities |
For link type permissions, the details of the users to whom permission was granted. |
List of Objects |
| Inherited From |
Provides a reference to the ancestor of the current permission, if it is inherited from an ancestor. |
Object |
| Invitation |
Details of any associated sharing invitation for this permission. |
Object |
| Link |
Provides the link details of the current permission, if it is a link type permissions. |
Object |
| Shared ID |
Unique token that can be used to access this shared item via the shares API. |
Text |
| Expiration Date |
Indicates the expiration time of the permission. For example, yyyy-MM-ddTHH:mm:ssZ. |
Date & Time |
| Has Password? | True if the password is set for this permission; otherwise False. |
True/False |
| Raw Data |
Raw JSON payload returned from the Microsoft Graph API for this particular action. |
Object |
Additional information
-
Create an anonymous or organization sharing link.
- Anonymous: anyone with the link has access, without needing to sign in. This may include people outside of your organization. Anonymous link support may be disabled by an administrator.
-
Organization: anyone signed into your organization (tenant) can use the link to get access.
-
When the sharing link doesn't use anonymous settings, it can be sent to others outside the organization. Credentials may be needed to view the shared file or folder if the user is not part of the organization.
-
By default, you cannot create an anonymous type sharing link for a file or folder in a group. You can only create an anonymous type sharing link of file or folder in an organization.
Related topics
OneDrive connector