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

Documentation does not explain how to create service account files #946

Closed
pcolmer opened this issue Jun 23, 2020 · 3 comments · Fixed by #1120
Closed

Documentation does not explain how to create service account files #946

pcolmer opened this issue Jun 23, 2020 · 3 comments · Fixed by #1120
Assignees
Labels
type: docs Improvement to the documentation for an API.

Comments

@pcolmer
Copy link

pcolmer commented Jun 23, 2020

https://github.com/googleapis/google-api-python-client/blob/master/docs/oauth-server.md makes reference to SERVICE_ACCOUNT_FILE but doesn't explain where it comes from or what it contains.

Digging deeper leads me to https://google-auth.readthedocs.io/en/latest/reference/google.oauth2.service_account.html#google.oauth2.service_account.Credentials which says:

"To create credentials using a Google service account private key JSON file"

but that doesn't explain how or where to get the file from either.

I did end up discovering https://stackoverflow.com/questions/46287267/how-can-i-get-the-file-service-account-json-for-google-translate-api which also confirms that if I haven't got the JSON file, I've got to create a new service account :(.

It would help if the documentation made the steps to setting up the service account clearer ...

@busunkim96 busunkim96 changed the title Documentation bug report Documentation does not explain how to create service account files Jun 23, 2020
@busunkim96
Copy link
Contributor

https://cloud.google.com/iam/docs/creating-managing-service-account-keys is the best source for general information on obtaining service accounts. The auth documentation also touches on it briefly https://google-auth.readthedocs.io/en/latest/user-guide.html#service-account-private-key-files.

There's definitely lots of room to make this clearer though, thank you for taking the time to file a bug!

@busunkim96 busunkim96 added the type: docs Improvement to the documentation for an API. label Jun 23, 2020
@FirePing32
Copy link

@busunkim96 Can I add this in docs ?

@mik-laj
Copy link
Contributor

mik-laj commented Dec 3, 2020

@busunkim96 Any response?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: docs Improvement to the documentation for an API.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants