Share access: distinguish group/restricted sharing from the public/secure pair

Share.access is limited to public and secure. Frame.io’s own web UI communicates more than two sharing modes, and our design mirrors that with three states: public link, password-locked, and group/restricted. With only two values on the API, the third indicator can’t be driven from the data - we have no field to detect “restricted to a group” versus a plain secure link.

Requested: either additional access values, or a companion field describing who the share is restricted to.

Hi @krlrzv!

public and secure map directly to the two Link Visibility settings on the UI:

which is why the values of share.access will always come back with one of those two values.

You are still able to get the other information you mentioned either directly through the share object, or through a subsequent API call.

For public link, all shares are links, so share.access can be used to determine this. If the value there is public, that can confirm that it was created as a public link.

For password-locked, share.passphrase returns the share passphrase if one has been set, and null if it hasn’t

As for group/restricted, if I am understanding this correctly, this would be used to determine who has been granted access to a share. If so, you can use the List share reviewers endpoint to verify this. That will return a response with an object for each reviewer added to that share.

If group/restricted is referring to something else, let me know and I’ll be happy to dig into that for you.

Hope this helps!

1 Like