Google-api-nodejs-client: pass state parameters with the oauth redirect URI

[uriva]

How does one achieve what is described here: http://stackoverflow.com/questions/7722062/google-oauth2-redirect-uri-with-several-parameters# using this package?

[jmdobry]

Add a state property to the options passed to OAuth2Client#generateAuthUrl. For example, here you could add state: { 'foo': 'bar' } and I believe the stringified state object will be passed through to the final destination.

[uriva]

doc doc doc

[carrotcomputer]

+1 - Please add this to the docs, was searching for hours on a way to pass some form of parameter from my App to the redirect URI and then receive it back again to map the request to the original user.

[fabienjuif]

Because I came here thanks to google search.
Here what I did, at the end:

const oAuth2 = new google.auth.OAuth2(
  process.env.GOOGLE_AUTH_CLIENT_ID,
  process.env.GOOGLE_AUTH_CLIENT_SECRET,
  process.env.GOOGLE_AUTH_REDIRECT,
)

const url = oAuth2.generateAuthUrl({
  access_type: 'offline',
  scope: [
    // all your scopes
  ],
  prompt: 'consent', // ask for a refresh token everytime you need, you can comment it if you don't need it
  state: JSON.stringify({ your: 'informations' }), // needs to be a string

})

[HelloJunWei]

Please add this to the docs. Thank you

[NielsDom]

doc!!!

[pittersnider]

We really need doc. for this.

[JustinBeckwith]

Here you go!
https://googleapis.dev/nodejs/google-auth-library/latest/interfaces/GenerateAuthUrlOpts.html#state

TL;DR: you can pass a state property in the options to generateAuthUrl that contains a string which is passed back to your redirect URI after generating a new code :)

[aeneasr]

Please don't do this:

state: JSON.stringify({ your: 'informations' }), // needs to be a string

The state param needs to be a random string and not predictable or you will be vulnerable to several OAuth2 attack vectors.