@@ -54,16 +54,26 @@ const result = await appAuth.authorize(scopes);
54
54
// returns accessToken, accessTokenExpirationDate and refreshToken
55
55
```
56
56
57
- #### config
57
+ #### ` config `
58
58
59
59
This is your configuration object for the client
60
- - ** issuer** : (` string ` ) * REQUIRED* the url of the auth server
61
- - ** clientId** : (` string ` ) * REQUIRED* your client id on the auth server
62
- - ** 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.
60
+ - ** issuer** - (` string ` ) * REQUIRED* the url of the auth server
61
+ - ** clientId** - (` string ` ) * REQUIRED* your client id on the auth server
62
+ - ** 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.
64
64
Must be string values! E.g. setting ` additionalParameters: { hello: 'world', foo: 'bar' } ` would add
65
65
` hello=world&foo=bar ` to the authorization request.
66
66
67
+ ### ` result `
68
+
69
+ This is the result from the auth server
70
+ - ** accessToken** - (` string ` ) the access token
71
+ - ** tokenType** - (` string ` ) the token type, e.g. Bearer
72
+ - ** accessTokenExpirationDate** - (` string ` ) the token expiration date
73
+ - ** refreshToken** - (` string ` ) the refresh token
74
+ - ** idToken** - (` string ` ) the id token
75
+ - ** additionalParameters** - (` Object ` ) additional url parameters from the auth server
76
+
67
77
### ` refresh `
68
78
69
79
This method will refresh the accessToken using the refreshToken. Some auth providers will also give
0 commit comments