[v4 Beta] passwordGrant docs + not possible to set auth0-forwarded-for

[BramRoets]

Checklist

• [X] I have looked into the Readme, Examples, and FAQ and have not found a suitable solution or answer.
• [X] I have looked into the API documentation and have not found a suitable solution or answer.
• [X] I have searched the issues and have not found a suitable solution or answer.
• [X] I have searched the Auth0 Community forums and have not found a suitable solution or answer.
• [X] I agree to the terms within the Auth0 Code of Conduct.

Description

The generated docs for passwordGrant are incorrect. Additionally, it's not possible to pass auth0-forwarded-for

• The example code has clientCredentialsGrant instead of passwordGrant
• The second argument does not accept an headers property

Reproduction

1. Install the latest beta
2. Try the following piece of code
3. Receive an error that headers is not accepted.

await auth0.oauth.passwordGrant({
    username: 'myusername@example.com',
    password: 'mypassword'
},
{ headers: { 'auth0-forwarded-for': 'END.USER.IP.123' } }
);

Additional context

No response

node-auth0 version

4.0.0-beta.6

Node.js version

v18.16.1

[adamjmcgrath]

Hi @BramRoets - thanks for raising this

You need to pass grantOptions.initOverrides like so:

await auth0.oauth.passwordGrant({
        username: 'myusername@example.com',
        password: 'mypassword'
    },
    { initOverrides: { headers: { 'auth0-forwarded-for': 'END.USER.IP.123' } } }
);

Will fix the docs

[BramRoets]

Hi @BramRoets - thanks for raising this

You need to pass grantOptions.initOverrides like so:

await auth0.oauth.passwordGrant({
       username: 'myusername@example.com',
       password: 'mypassword'
   },
   { initOverrides: { headers: { 'auth0-forwarded-for': 'END.USER.IP.123' } } }
);

Will fix the docs

Awesome. thanks!