Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

IAM: update quickstart comments #4716

Merged
merged 5 commits into from
Sep 22, 2020
Merged

IAM: update quickstart comments #4716

merged 5 commits into from
Sep 22, 2020

Conversation

anguillanneuf
Copy link
Member

@anguillanneuf anguillanneuf commented Sep 21, 2020

  1. Project IDs usually use dashes.
  2. IAM members should not be limited to one form.

Reference: https://cloud.google.com/sdk/gcloud/reference/iam/service-accounts/add-iam-policy-binding#--member

@anguillanneuf anguillanneuf requested a review from a team as a code owner September 21, 2020 23:15
@google-cla google-cla bot added the cla: yes This human has signed the Contributor License Agreement. label Sep 21, 2020
@product-auto-label product-auto-label bot added api: iam Issues related to the Identity and Access Management API. samples Issues that are directly related to samples. labels Sep 22, 2020
member = "your_member"
project_id = "your-project-id"
# TODO: Replace with the ID of your member in the form
# 'user|group|serviceAccount:email' or 'domain:domain'
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we add a link to the IAM reference documentation for this format?

Copy link
Member Author

@anguillanneuf anguillanneuf Sep 22, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added. The link has some good examples of what member should look like.

@melaniedejong
Copy link
Collaborator

Since this is a quickstart and we want to be as directive as possible, I would prefer not to give the user multiple options for the member type. We're assuming at this point that they will be testing out IAM by adding a user.

The goal of the quickstart is just to give users a first-touch experience with IAM. If we need to instruct users about how to modify policy, including modifying policy for different member types, we should use the Granting, changing, and revoking access page, and/or the access sample.

@anguillanneuf anguillanneuf changed the title IAM: do not limit member form to user:email in comments IAM: update quickstart comments Sep 22, 2020
@anguillanneuf anguillanneuf merged commit 4b56b2c into master Sep 22, 2020
@anguillanneuf anguillanneuf deleted the anguillanneuf-patch-1 branch September 22, 2020 17:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
api: iam Issues related to the Identity and Access Management API. cla: yes This human has signed the Contributor License Agreement. samples Issues that are directly related to samples.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants