GOOGLE-AUTH-OAUTHLIB(1)

πŸ’– GOOGLE-AUTH-OAUTHLIB πŸ’–

okay bestie, this is the manual page for google-oauthlib-tool from the GOOGLE-AUTH-OAUTHLIB(1) manual, living in the User Commands section. it's short, it's sweet, it gets you credentials, and it will NOT be doing your production auth for you (more on that drama below). πŸŽ€


✨ NAME ✨

google-oauthlib-tool β€” it's giving oauthlib integration with google-auth, fr fr πŸ¦‹


✨ SYNOPSIS ✨

google-oauthlib-tool [OPTIONS]

that's it. that's the whole vibe. flags only, no positional args, no main character arguments. πŸ‘‘


✨ DESCRIPTION ✨

so basically it's a command-line tool for obtaining authorization and credentials from a user. you run it, it goes and gets you a token. slay. πŸ’…

it uses the OAuth 2.0 Authorization Code grant, exactly as described in section 1.3.1 of RFC6749, which you can go read yourself at:

https://tools.ietf.org/html/rfc6749#section-1.3.1

(this is the part where i say "the way that RFC ate" and you nod. 😌)

now here's the intended use case, and it's important so don't skip it: this tool is intended for assisting developers in obtaining credentials for testing applications. specifically the situations where it may not be possible or easy to run a complete OAuth 2.0 authorization flow β€” think code samples, or embedded devices that have no input / display capabilities. like, how is a tiny little device with no screen supposed to do a browser dance? it can't. that's where this tool comes in. 🧚

but bestie. listen. this is not intended for production use. in production, a combination of companion and on-device applications should complete the OAuth 2.0 authorization flow to get authorization from the users. this tool is a testing-side-quest, not the main plot. do not put it in prod. i am begging. 😭

✨ OPTIONS ✨

  • --client-secrets <client_secret_json_file> β€” path to the OAuth2 client secret JSON file. required, no skipping, no cap. πŸ”₯
  • --scope <oauth2 scope> β€” the API scopes to authorize access for. also required. you gotta tell it what you want access to, it's not a mind reader. ✨
  • --save β€” save the credentials to file. default is False, so if you want them written down you gotta ask nicely. πŸ’Ύ
  • --credentials <oauth2_credentials> β€” path to store the OAuth2 credentials. default: /root/.config/google-oauthlibtool/credentials.json. yes, that's the actual default, yes it's a whole path, yes it's iconic. πŸ“
  • --headless β€” run a console based flow. default is False. perfect for when there's no browser to pop up (hello again, embedded devices πŸ‘‹). πŸ™ˆ
  • --help β€” show this message and exit. the classic. the goat. always there for you. 🫢

🌈 SIGN-OFF 🌈

and that's the whole page, bestie! this one's from google-oauthlib-tool, dated July 2020, hanging out in the GOOGLE-AUTH-OAUTHLIB(1) manual. go get those test credentials, stay out of production, and remember: --save or it didn't happen. πŸ’œβœ¨πŸŽ€