This article is for developers with a full understanding of how to work with our API.
Important note about the API explorer:
When you follow the link we provide to the API explorer, you'll see a red warning.
The API itself is not deprecated. It's the Google API explorer that is deprecated. All the processes described in our API articles function correctly and safely if you use this Google API explorer.
You can:
- prevent documents in Document Management libraries from being shared publicly on your domain – if you activate this feature, the public visibility options in Document Management libraries are not available
Note: This feature isn't applicable in Team Folders or Secured Folders because these libraries don't have public visibility options.
- restrict sharing options in the workflow permissions in Document Management libraries or Secured Folders so documents are not shared publicly on your domain – if you activate this feature, the public visibility options in the workflow permissions are not available
Important:
– To activate these features at the domain level, you must be super administrator; to activate these features at the library level, you must be library administrator or super administrator.
– These features are activated by API only. They aren't available in the administration interface.
In this article:
Automatically generated table of contents
Access the API
Restrict sharing publicly at the domain level
As super administrator, follow one of these links to the AODocs API:
- US instance:
- EU instance:
Note: Dedicated instances have their own URLs. Learn more: What are AODocs instances?
Learn more: What are AODocs instances?
Restrict sharing publicly at the library level
As library administrator or super administrator, follow one of these links to the AODocs API:
- US instance:
- EU instance:
Note: Dedicated instances have their own URLs. Learn more: What are AODocs instances?
Restrict sharing publicly in Document Management libraries
At the domain level
1. As a super administrator, access the API.
2. Enter the flag name maxDomainPermissionRole.
3. Enter the name of your domain.
4. In the Request body field, enter one of the following values next to configurationFlagValue:
-
NONE: it isn't possible to share publicly at all – the options to give public read-access or contributor-access are not available (grayed out) -
READER: it's possible to give public read-access on your domain -
CONTRIBUTOR(default): it's possible to give public read-access and contributor-access on your domain
Note: The values are case sensitive.
5. Click Authorize and execute. The response is displayed in the lower part of the screen.
At the library level
1. As a library administrator, access the API.
2. Enter the library ID. Learn how to identify the library ID.
Follow the procedure Restrict public sharing in Document Management libraries at the domain level from step 2.
Restrict publicly sharing documents in workflow permissions
At the domain level
1. As a super administrator, access the API.
2. Enter the flag name enableOnlySpecificWorkflowStatePermissions.
3. Enter the name of your domain.
4. In the Request body field, enter one of the following values next to configurationFlagValue:
-
TRUE: the options to give public read-access or contributor-access in workflow state permissions are not available (grayed out) -
FALSE (default): you can give public read-access or contributor-access in workflow state permissions (grayed out)
5. Click Authorize and execute. The response is displayed in the lower part of the screen.
At the library level
1. As a library administrator, access the API.
2. Enter the library ID. Learn how to identify the library ID.
Follow the procedure Restrict publicly sharing documents in workflow permissions at the domain level from step 2.