Skip to content

Commit 462d78c

Browse files
committed
Add general resources access docs section scaffold
1 parent d4071ff commit 462d78c

File tree

2 files changed

+30
-7
lines changed

2 files changed

+30
-7
lines changed
Lines changed: 26 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,30 @@
11
# General Resources Access
22

3-
## Hello
3+
Some resources, like storages, actor runs or actor builds, support `unrestricted access`. You can share them simply by sending their unique resource ID or Console link and the recipient can then view the data in Console or fetch it via API without needing an API token. This is very useful for ad-hoc collaboration, integrating third party tools that connect to data in your Apify account or quick prototypes.
4+
5+
Thanks to the hard-to-guess, unique IDs, it’s also secure enough for most use cases. However, it doesn't offer features like access revocation or a formal audit trail and in some cases, you may want to have more direct control over data access and require users to have explicit permissions to your resources.
6+
7+
**General resource access** is an account setting that defines the default access policy at the account level. You can find general resource access in Apify Console under **Settings → Security & Privacy**. The two following options are supported:
8+
9+
- **Anyone with ID can read (default)**: Selected resources can be accessed using just with their unique resource ID. This means if you share the resource ID with someone, they would be able to view it without providing an API token or viewing the resource by visiting the console url.
10+
- **Restricted**: With this setting, only signed-in users with an explicit access to the resources can access them. To access restricted resources via API, a valid token needs to be provided.
11+
12+
This setting affects the following resources:
13+
14+
- Actor runs
15+
- Actor builds
16+
- Storages:
17+
- Datasets
18+
- Key-value stores
19+
- Request queues
20+
21+
Access to resources that require explicit access — such as Actors, tasks or schedules are not affected by this setting.
22+
423
![Setup account-level general resources access setting](./images/general-resouce-access//account-setting.png)
5-
### Per-resource access control
24+
25+
## Per-resource access control
26+
27+
The account level access control can be changed on individual resources. You can do by setting the general access level to other than Restricted in the share dialog for a given resource. This way the resource level setting takes precedence over the account setting.
628
![Setup resource level access control](./images/general-resouce-access/share-resource-dialog.png)
7-
### Sharing restricted resources with pre-signed URLs {#pre-signed-urls}
29+
30+
## Sharing restricted resources with pre-signed URLs {#pre-signed-urls}

sources/platform/collaboration/index.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,11 @@ Apify was built from the ground up as a collaborative platform. Whether you’re
1414
While most resources can be shared by assigning permissions (see [Access Rights](./access_rights.md)), some resources can also be shared simply by using their unique links or IDs. There are two types of resources in terms of sharing:
1515

1616
- **resources that require explicit access by default:**
17-
- [actors](../actors/running/index.md), [tasks](../actors/running/tasks.md)
18-
- Can be shared only by inviting collaborators using [Access Rights](./access_rights.md)) or using [Organization Accounts](./organization_account/index.md)
17+
- [actors](../actors/running/index.md), [tasks](../actors/running/tasks.md)
18+
- Can be shared only by inviting collaborators using [Access Rights](./access_rights.md)) or using [Organization Accounts](./organization_account/index.md)
1919
- **resources supporting both explicit access and link sharing:**
20-
- actor runs, actor builds and storage resources (datasets, k/v stores, request queues)
21-
- Can be shared by inviting collaborators or simply by sharing a unique direct link
20+
- actor runs, actor builds and storage resources (datasets, k/v stores, request queues)
21+
- Can be shared by inviting collaborators or simply by sharing a unique direct link
2222

2323
You can control access to your resources in four ways:
2424

0 commit comments

Comments
 (0)