Documentation Index

Fetch the complete documentation index at: https://docs.eshare.com/llms.txt

Use this file to discover all available pages before exploring further.

Create a New Sharing Policy

Prev Next
Post
/api/3.1/organizations/{org_id}/sharing-policies

This request creates a new Sharing Policy for the organization.

Security
API Key: NCC_Token
Header parameter nameAuthorization

NCC token authentication. Format: NCC token=<auth_token>

Path parameters
org_id
stringRequired
Body parameters
object
name
string Required
tags
string
modules
string
pin_security_options
string
terms_of_use_group_id
string

Identifier of the terms of use group associated with the policy

tou_file_group_id
string

Identifier of the terms of use group associated with the policy for file access

authenticate_with_id
integer (int64)
smg_templates_id
string

Identifier of the template set

email_filter
string
sensitivity_label
string
guid
string
description
string

A description for this group of share options

can_read
boolean

Recipient can view

can_read_auo
boolean

Allow user override for can_view

can_create
boolean

Recipient can create

can_create_auo
boolean

Allow user override for can_create

can_create_folders
boolean

Recipient can create folders

can_create_folders_auo
boolean

Allow user override for can_create_folders

can_edit
boolean

Recipient can edit

can_edit_auo
boolean

Allow user override for can_edit

can_delete
boolean

Recipient can delete

can_delete_auo
boolean

Allow user override for can_delete

can_download
boolean

Recipient can download

can_download_auo
boolean

Allow user override for can_download

can_download_with_approval
boolean

Recipient can download files with owner approval

branded_watermark
integer (int64)
branded_watermark_auo
boolean

Allow user override for branded watermark

watermark
boolean

Watermark contents

watermark_auo
boolean

Allow user override for watermark

export_secure_conversation
string

Export Secure Conversation

export_secure_conversation_auo
boolean

Allow user override for export_secure_conversation

login_required
boolean

Login required

login_required_auo
boolean

Allow user override for login_required

require_terms_of_use
boolean

Require terms of use

require_terms_of_use_auo
boolean

Allow user override for require_terms_of_use

show_terms_once
boolean

Show terms only once

show_terms_once_auo
boolean

Allow user override for show_terms_once

show_terms_always
boolean

Show always no matter if accepted

show_terms_always_auo
boolean

Allow user override for show_terms_once_always

one_time_link
boolean

Is an one time link?

one_time_link_auo
boolean

Allow user override for one_time_link

send_pin_on_email
boolean

Send pin with email

send_pin_on_email_auo
boolean

Allow user override for send_pin_on_email

pin_required
boolean

Whether to require a PIN to be set

pin_required_auo
boolean

Allow user override for pin

otp_required
boolean

Whether to require an OTP pin to access share

otp_required_auo
boolean

Allow user override for OTP pin

secure_conversation_enabled
boolean

Whether secure conversation will be enabled

secure_conversation_enabled_auo
boolean

Allow user override for secure conversation

only_message_owner_auo
boolean

Allow user override for only direct messages to owner

secure_conversation_style_auo
boolean

Allow user override for specifying secure conversation style

generate_email_for_each_secure_conversation_message
boolean

Flag. If set to True every secure message is sent as an email including any attachments

generate_email_for_each_secure_conversation_message_auo
boolean

Allow user override for generate email for each secure conversation message

disable_email_notifications
boolean

Disable informational email notifications

disable_email_notifications_auo
boolean

Allow user override for disable informational email notifications

disable_all_notifications
boolean

Disable all notifications

disable_all_notifications_auo
boolean

Allow user override for disable all notifications

enable_action_notifications
boolean

Enable Requests & Actions type notifications

enable_action_notifications_auo
boolean

Allow user override for enabling Requests & Actions type notifications

enable_activity_notifications
boolean

Enable Activity type notifications

enable_activity_notifications_auo
boolean

Allow user override for enabling Activity type notifications

enable_message_notifications
boolean

Enable Message type notifications

enable_message_notifications_auo
boolean

Allow user override for enabling Message type notifications

enforce_openid
boolean

Use OpenID to login

enforce_openid_auo
boolean

Allow user override for openid login

expiration_seconds
integer (int64)

Expiration of this share in seconds

expiration_seconds_auo
boolean

Allow user override for expiration_seconds

max_expiration_seconds
integer (int64)

Maximum allowed expiration of this share in seconds

max_recipients
integer (int64)

Maximum allowed amount of recipients

apply_branding
boolean

Whether organization branding should be applied to the sent e-mails

apply_branding_auo
boolean

Whether organization branding can be overridden

secure_message_body
boolean

Whether to secure the body of secure emails

secure_message_body_auo
boolean

Whether to allow overriding the secure_message_body

secure_mail_body_preview
boolean

Whether to preview the body of secure email

secure_mail_body_preview_auo
boolean

Whether to allow overriding the secure_mail_body_preview

can_invite_others
boolean

Whether recipients can invite other users to the share

can_invite_others_auo
boolean

Whether to allow overriding can_invite_others

auto_approve_invitations
string

The auto approve invitations policy

auto_approve_invitations_auo
boolean

Whether to allow overriding auto_approve_invitations

auto_approve_self_service_invitations
string

The auto approve invitations policy for Access Link

auto_approve_self_service_invitations_auo
boolean

Whether to allow overriding auto_approve_self_service_invitations

active
boolean

Is sharing policy active

deleted
boolean

Whether this sharing policy has been deleted

terms_of_use_group_auo
boolean

Allow overriding terms_of_use_group

allow_deny_file_type
boolean

True for allowing file types to upload, False for denying them

allow_deny_file_type_auo
boolean

Allow user override for allow_deny_file_type

upload_allowed_file_type
string

File types that an organization is allowed to upload on a TS

upload_allowed_file_type_auo
boolean

Whether to allow overriding upload_allowed_file_type

upload_allowed_max_file_size
integer (int64)

File size limitation upload for a file type on a TS

upload_allowed_max_file_size_auo
boolean

Whether to allow overriding upload_allowed_max_file_size

can_view_recipients_list
boolean

Whether a recipient can view the list of TS recipients

can_view_recipients_list_auo
boolean

Whether to allow overriding can_view_recipients_list

hide_labels_from_externals
boolean

Hide sensitivity labels from external recipients

hide_labels_from_externals_auo
boolean

Allow user override for hide_labels_from_externals

sensitivity_label_temporary_override
boolean

Sensitivity Label Temporary Override

sensitivity_label_temporary_override_auo
boolean

Allow user override for sensitivity_label_temporary_override

filtering_recipients_domain_list
string
filtering_recipients_domain_list_auo
boolean

Whether to allow overriding filtering_recipients_domain_list

allow_deny_list_switch
boolean

True for allowing domains in filtering_recipients_domain_list, False for denying them

allow_deny_list_switch_auo
boolean

Whether to allow overriding allow_deny_list_switch

allow_deny_users_exceptions
string
allow_deny_users_exceptions_auo
boolean

Allow user override for allow_deny_users_exceptions

upgrade_internal_users_to_co_owners
boolean

Make internal users co-owners

upgrade_internal_users_to_co_owners_auo
boolean

Allow user override for upgrade_internal_users_to_co_owners

include_spo_members
boolean

Include all Share Point site members to the share and make them co-owners

include_spo_members_auo
boolean

Allow user override for include_spo_members

include_spo_owners
boolean

Include all Share Point site owners to the share and make them co-owners

include_spo_owners_auo
boolean

Allow user override for include_spo_owners

allow_sms_mentions
boolean

Allow SMS mentions

allow_sms_mentions_auo
boolean

Allow user override for allow_sms_mentions

require_authentication
boolean

Require available authentication, login or one-time password

require_authentication_auo
boolean

Whether to allow overriding require_authentication

secure_messages_for_internals_same_as_externals
boolean

Handle secure messages for internals the same way as internals

secure_messages_for_internals_same_as_externals_auo
boolean

Handle secure messages for internals the same way as internals

convert_files_to_pdf
boolean

Convert files to PDF before download

convert_files_to_pdf_auo
boolean

Allow overriding convert_files_to_pdf

force_zip_tou
boolean

Zip TOU with original file

force_zip_tou_auo
boolean

Allow overriding force_zip_tou

secure_ms_links
boolean

Support conversion of MS native links

secure_ms_links_auo
boolean

Allow overriding secure_ms_links

pdf_conversion_fallback
string

Action if conversion not possible

pdf_conversion_fallback_auo
boolean

Allow overriding pdf_conversion_fallback

tou_file_access_mode
integer (int32)

Frequency for showing TOU on file access

tou_file_access_mode_auo
boolean

Allow overriding tou_file_access_mode

tou_share_access_mode
integer (int32)

Frequency for showing TOU on share access

tou_share_access_mode_auo
boolean

Allow overriding tou_share_access_mode

tou_file_group_auo
boolean

Allow overriding tou_file_group

expiration_enabled
boolean

Default expiration for all shares

expiration_enabled_auo
boolean

Allow overriding expiration_enabled

abac_controlled_access
boolean

Use ABAC to control file access

Responses
200

Successful operation

Expand All
object
id
string
name
string
tags
Array of string
string
modules
Array of string
string
pin_security_options
object (PinSecurityOptionsSerializer)
minimum_pin_length
integer (int64)
requires_capital_letter
boolean

Pin requires at least one capital letter

requires_special_character
boolean

Pin requires at least one special character

requires_number
boolean

Pin requires at least one number

is_default
string
is_swm_link_policy
string
is_sws_policy
string
is_blob_sharing_policy
string
is_access_link_policy
boolean

Whether this is the organization's Access Link policy. Read-only

terms_of_use_group_id
string

Identifier of the terms of use group associated with the policy

tou_file_group_id
string

Identifier of the terms of use group associated with the policy for file access

authenticate_with_id
integer (int64)
only_message_owner
string
integrations
string
secure_conversation_style
string
smg_templates_id
string

Identifier of the template set

email_filter
object (EmailFilterSerializer)
root_ruleset
object (RootRulesetSerializer)
id
string
operand
string
rules
Array of object (NestedRuleSerializer)
object
id
integer (int64)
field_type
string
field_name
string
operand
string
value
string
rulesets
Array of object (NestedRulesetSerializer)
object
id
integer (int64)
operand
string
rules
Array of object (NestedRuleSerializer)
object
id
integer (int64)
field_type
string
field_name
string
operand
string
value
string
name
string
description
string

A description for this ruleset

active
boolean
sensitivity_label
object (SensitivityLabelDataSerializer)
id
integer (int64)
label_id
string
display_name
string
last_modified
string (date-time)
created
string (date-time)
guid
string
description
string

A description for this group of share options

can_read
boolean

Recipient can view

can_read_auo
boolean

Allow user override for can_view

can_create
boolean

Recipient can create

can_create_auo
boolean

Allow user override for can_create

can_create_folders
boolean

Recipient can create folders

can_create_folders_auo
boolean

Allow user override for can_create_folders

can_edit
boolean

Recipient can edit

can_edit_auo
boolean

Allow user override for can_edit

can_delete
boolean

Recipient can delete

can_delete_auo
boolean

Allow user override for can_delete

can_download
boolean

Recipient can download

can_download_auo
boolean

Allow user override for can_download

can_download_with_approval
boolean

Recipient can download files with owner approval

branded_watermark
integer (int64)
branded_watermark_auo
boolean

Allow user override for branded watermark

watermark
boolean

Watermark contents

watermark_auo
boolean

Allow user override for watermark

export_secure_conversation
string

Export Secure Conversation

export_secure_conversation_auo
boolean

Allow user override for export_secure_conversation

login_required
boolean

Login required

login_required_auo
boolean

Allow user override for login_required

require_terms_of_use
boolean

Require terms of use

require_terms_of_use_auo
boolean

Allow user override for require_terms_of_use

show_terms_once
boolean

Show terms only once

show_terms_once_auo
boolean

Allow user override for show_terms_once

show_terms_always
boolean

Show always no matter if accepted

show_terms_always_auo
boolean

Allow user override for show_terms_once_always

one_time_link
boolean

Is an one time link?

one_time_link_auo
boolean

Allow user override for one_time_link

send_pin_on_email
boolean

Send pin with email

send_pin_on_email_auo
boolean

Allow user override for send_pin_on_email

pin_required
boolean

Whether to require a PIN to be set

pin_required_auo
boolean

Allow user override for pin

otp_required
boolean

Whether to require an OTP pin to access share

otp_required_auo
boolean

Allow user override for OTP pin

secure_conversation_enabled
boolean

Whether secure conversation will be enabled

secure_conversation_enabled_auo
boolean

Allow user override for secure conversation

only_message_owner_auo
boolean

Allow user override for only direct messages to owner

secure_conversation_style_auo
boolean

Allow user override for specifying secure conversation style

generate_email_for_each_secure_conversation_message
boolean

Flag. If set to True every secure message is sent as an email including any attachments

generate_email_for_each_secure_conversation_message_auo
boolean

Allow user override for generate email for each secure conversation message

disable_email_notifications
boolean

Disable informational email notifications

disable_email_notifications_auo
boolean

Allow user override for disable informational email notifications

disable_all_notifications
boolean

Disable all notifications

disable_all_notifications_auo
boolean

Allow user override for disable all notifications

enable_action_notifications
boolean

Enable Requests & Actions type notifications

enable_action_notifications_auo
boolean

Allow user override for enabling Requests & Actions type notifications

enable_activity_notifications
boolean

Enable Activity type notifications

enable_activity_notifications_auo
boolean

Allow user override for enabling Activity type notifications

enable_message_notifications
boolean

Enable Message type notifications

enable_message_notifications_auo
boolean

Allow user override for enabling Message type notifications

enforce_openid
boolean

Use OpenID to login

enforce_openid_auo
boolean

Allow user override for openid login

expiration_seconds
integer (int64)

Expiration of this share in seconds

expiration_seconds_auo
boolean

Allow user override for expiration_seconds

max_expiration_seconds
integer (int64)

Maximum allowed expiration of this share in seconds

max_recipients
integer (int64)

Maximum allowed amount of recipients

apply_branding
boolean

Whether organization branding should be applied to the sent e-mails

apply_branding_auo
boolean

Whether organization branding can be overridden

secure_message_body
boolean

Whether to secure the body of secure emails

secure_message_body_auo
boolean

Whether to allow overriding the secure_message_body

secure_mail_body_preview
boolean

Whether to preview the body of secure email

secure_mail_body_preview_auo
boolean

Whether to allow overriding the secure_mail_body_preview

can_invite_others
boolean

Whether recipients can invite other users to the share

can_invite_others_auo
boolean

Whether to allow overriding can_invite_others

auto_approve_invitations
string

The auto approve invitations policy

auto_approve_invitations_auo
boolean

Whether to allow overriding auto_approve_invitations

auto_approve_self_service_invitations
string

The auto approve invitations policy for Access Link

auto_approve_self_service_invitations_auo
boolean

Whether to allow overriding auto_approve_self_service_invitations

active
boolean

Is sharing policy active

deleted
boolean

Whether this sharing policy has been deleted

terms_of_use_group_auo
boolean

Allow overriding terms_of_use_group

allow_deny_file_type
boolean

True for allowing file types to upload, False for denying them

allow_deny_file_type_auo
boolean

Allow user override for allow_deny_file_type

upload_allowed_file_type
string

File types that an organization is allowed to upload on a TS

upload_allowed_file_type_auo
boolean

Whether to allow overriding upload_allowed_file_type

upload_allowed_max_file_size
integer (int64)

File size limitation upload for a file type on a TS

upload_allowed_max_file_size_auo
boolean

Whether to allow overriding upload_allowed_max_file_size

can_view_recipients_list
boolean

Whether a recipient can view the list of TS recipients

can_view_recipients_list_auo
boolean

Whether to allow overriding can_view_recipients_list

hide_labels_from_externals
boolean

Hide sensitivity labels from external recipients

hide_labels_from_externals_auo
boolean

Allow user override for hide_labels_from_externals

sensitivity_label_temporary_override
boolean

Sensitivity Label Temporary Override

sensitivity_label_temporary_override_auo
boolean

Allow user override for sensitivity_label_temporary_override

filtering_recipients_domain_list
string
filtering_recipients_domain_list_auo
boolean

Whether to allow overriding filtering_recipients_domain_list

allow_deny_list_switch
boolean

True for allowing domains in filtering_recipients_domain_list, False for denying them

allow_deny_list_switch_auo
boolean

Whether to allow overriding allow_deny_list_switch

allow_deny_users_exceptions
string
allow_deny_users_exceptions_auo
boolean

Allow user override for allow_deny_users_exceptions

upgrade_internal_users_to_co_owners
boolean

Make internal users co-owners

upgrade_internal_users_to_co_owners_auo
boolean

Allow user override for upgrade_internal_users_to_co_owners

include_spo_members
boolean

Include all Share Point site members to the share and make them co-owners

include_spo_members_auo
boolean

Allow user override for include_spo_members

include_spo_owners
boolean

Include all Share Point site owners to the share and make them co-owners

include_spo_owners_auo
boolean

Allow user override for include_spo_owners

allow_sms_mentions
boolean

Allow SMS mentions

allow_sms_mentions_auo
boolean

Allow user override for allow_sms_mentions

require_authentication
boolean

Require available authentication, login or one-time password

require_authentication_auo
boolean

Whether to allow overriding require_authentication

secure_messages_for_internals_same_as_externals
boolean

Handle secure messages for internals the same way as internals

secure_messages_for_internals_same_as_externals_auo
boolean

Handle secure messages for internals the same way as internals

convert_files_to_pdf
boolean

Convert files to PDF before download

convert_files_to_pdf_auo
boolean

Allow overriding convert_files_to_pdf

force_zip_tou
boolean

Zip TOU with original file

force_zip_tou_auo
boolean

Allow overriding force_zip_tou

secure_ms_links
boolean

Support conversion of MS native links

secure_ms_links_auo
boolean

Allow overriding secure_ms_links

pdf_conversion_fallback
string

Action if conversion not possible

pdf_conversion_fallback_auo
boolean

Allow overriding pdf_conversion_fallback

tou_file_access_mode
integer (int32)

Frequency for showing TOU on file access

tou_file_access_mode_auo
boolean

Allow overriding tou_file_access_mode

tou_share_access_mode
integer (int32)

Frequency for showing TOU on share access

tou_share_access_mode_auo
boolean

Allow overriding tou_share_access_mode

tou_file_group_auo
boolean

Allow overriding tou_file_group

expiration_enabled
boolean

Default expiration for all shares

expiration_enabled_auo
boolean

Allow overriding expiration_enabled

abac_controlled_access
boolean

Use ABAC to control file access

organization_id
string