Skip to content

Commit 311c6d8

Browse files
author
Kadi Kraman
committed
Update readme to clarify how additionalParameters will be used
1 parent a32ae43 commit 311c6d8

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,9 @@ This is your configuration object for the client
6060
- **issuer**: (`string`) *REQUIRED* the url of the auth server
6161
- **clientId**: (`string`) *REQUIRED* your client id on the auth server
6262
- **redirectUrl**: (`string`) *REQUIRED* the url that links back to your app with the auth code
63-
- **additionalParameters**: (`object` | `null`) additional parameters that will be passed in the authorization request
63+
- **additionalParameters**: (`object` | `null`) additional parameters that will be passed in the authorization request.
64+
Must be string values! E.g. setting `additionalParameters: { hello: 'world', foo: 'bar' }` would add
65+
`hello=world&foo=bar` to the authorization request.
6466

6567
### `refresh`
6668

0 commit comments

Comments
 (0)