Skip to content

Commit

Permalink
Merge pull request #321 from stephenplusplus/spp--storage-acl-docs
Browse files Browse the repository at this point in the history
storage: docs - explain scope values - fixes #319
  • Loading branch information
ryanseys committed Dec 4, 2014
2 parents d36802f + 43a850c commit f272ea2
Showing 1 changed file with 24 additions and 0 deletions.
24 changes: 24 additions & 0 deletions lib/storage/acl.js
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,30 @@ var util = require('../common/util.js');
* object or bucket (for example, `READ` or `WRITE`); the scope defines who the
* permission applies to (for example, a specific user or group of users).
*
* Where a `scope` value is accepted, we follow the format the Cloud Storage API
* expects.
*
* Refer to
* https://cloud.google.com/storage/docs/json_api/v1/defaultObjectAccessControls
* for the most up-to-date values.
*
* - `user-userId`
* - `user-email`
* - `group-groupId`
* - `group-email`
* - `domain-domain`
* - `project-team-projectId`
* - `allUsers`
* - `allAuthenticatedUsers`
*
* Examples:
*
* - The user "liz@example.com" would be `user-liz@example.com`.
* - The group "example@googlegroups.com" would be
* `group-example@googlegroups.com`.
* - To refer to all members of the Google Apps for Business domain
* "example.com", the entity would be `domain-example.com`.
*
* For more detailed information, see
* [About Access Control Lists](http://goo.gl/6qBBPO).
*
Expand Down

0 comments on commit f272ea2

Please sign in to comment.