Skip to content

Commit 3fe551c

Browse files
author
JAMES FUQIAN
committed
add document content for new config param to disable token refresh on expire.
1 parent 75f4577 commit 3fe551c

1 file changed

Lines changed: 16 additions & 7 deletions

File tree

README.md

Lines changed: 16 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -37,18 +37,27 @@ The configuration parameters are:
3737
- The version number of the API
3838
- The app's environment (the BB2.0 web location where the app is registered)
3939
- The FHIR call retry settings
40+
- Enable / Disable Token refresh if FHIR request processing detected the access token expired
4041

41-
| Parameter | Value | Comments |
42-
| ------------ | ----------------------- | ------------------------------- |
43-
| environment | "SANDBOX" or "PRODUCTION" | BB2 API environment (default="SANDBOX")
44-
| version | 1 or 2 | BB2 API version (default=2) |
45-
| client_id | "foo" | oauth2 client id of the app |
46-
| client_secret | "bar" | oauth2 client secret of the app |
47-
| callback_url | "https://www.fake.com/callback" | oauth2 callback URL of the app |
42+
| Parameter | Value | Comments |
43+
| ------------- | ------------------------------- | --------------------------------------- |
44+
| environment | "SANDBOX" or "PRODUCTION" | BB2 API environment (default="SANDBOX") |
45+
| version | 1 or 2 | BB2 API version (default=2) |
46+
| client_id | "foo" | oauth2 client id of the app |
47+
| client_secret | "bar" | oauth2 client secret of the app |
48+
| callback_url | "https://www.fake.com/callback" | oauth2 callback URL of the app |
4849

4950
For application registration and client id and client secret, please refer to:
5051
[Blue Button 2.0 API Docs - Try the API](https://bluebutton.cms.gov/developers/#try-the-api)
5152

53+
Auth Token Refresh on Expire:
54+
55+
SDK FHIR requests will check if the access token is expired before the data end point call, if the access token is expired, then a token refresh is performed with the refresh token in the current auth token object, this behavior can be disabled by setting configuration parameter as below:
56+
57+
"token_refresh_on_expire": false
58+
59+
By default, token_refresh_on_expire is true.
60+
5261
FHIR requests retry:
5362

5463
Retry is enabled by default for FHIR requests, retry_settings: parameters for exponential back off retry algorithm

0 commit comments

Comments
 (0)