Skip to content

Commit

Permalink
chore(docs): update authorization section
Browse files Browse the repository at this point in the history
make Authorization section more verbose and use proper repo name
  • Loading branch information
minherz committed Jul 27, 2021
1 parent 69580ac commit 018a08f
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion synthtool/gcp/templates/java_library/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,8 @@ See the [Authentication][authentication] section in the base directory's README.

## Authorization

A GCP account credentials that are used in API calls should be granted [Authorization Scopes](https://developers.google.com/identity/protocols/oauth2/scopes) to call these APIs. You can also review existing [predefined IAM roles](https://cloud.google.com/iam/docs/understanding-roles#predefined_roles) that can be granted to GCP account which is used for authentication.
To authorize you calls grant [authorization scopes][auth-scopes] required by {{metadata['repo']['name_pretty']}} APIs to the identity you are using for authentication.
You can do that by defining [IAM policy][iam-policy] to bind the identity with [predefined IAM roles][predefined-iam-roles] for particular GCP project.

## Getting Started

Expand Down Expand Up @@ -233,6 +234,9 @@ Java is a registered trademark of Oracle and/or its affiliates.
[maven-version-image]: https://img.shields.io/maven-central/v/{{ group_id }}/{{ artifact_id }}.svg
[maven-version-link]: https://search.maven.org/search?q=g:{{ group_id }}%20AND%20a:{{ artifact_id }}&core=gav
[authentication]: https://github.com/googleapis/google-cloud-java#authentication
[auth-scopes]: https://developers.google.com/identity/protocols/oauth2/scopes
[predefined-iam-roles]: https://cloud.google.com/iam/docs/understanding-roles#predefined_roles
[iam-policy]: https://cloud.google.com/iam/docs/overview#cloud-iam-policy
[developer-console]: https://console.developers.google.com/
[create-project]: https://cloud.google.com/resource-manager/docs/creating-managing-projects
[cloud-sdk]: https://cloud.google.com/sdk/
Expand Down

0 comments on commit 018a08f

Please sign in to comment.