OAuth 2.0 refresh token grant
- Last Updated: March 29, 2023
- 2 minute read
- DataDirect Connectors
- JDBC
- Microsoft Sharepoint 6.0
- Documentation
The refresh token grant is used to replace expired access tokens with active ones by exchanging the refresh token at the endpoint specified by the TokenURI property.
This string includes the properties used to connect with OAuth 2.0 authentication.
jdbc:datadirect:sharepoint:ServiceURL=serviceurl;ClientID=client_id;
ClientSecret=client_secret;TokenURI=token_uri;RefreshToken=refresh_token;
[property=value[;...]];
where:
- serviceurl
- specifies the URL of a SharePoint site (or "site collection"), for example, https://mycorp.sharepoint.com/sites/marketing/global. The URL must include the base URL (https://mycorp.sharepoint.com/), as well as the path to the site (marketing/global). The driver uses the base URL to infer an OData endpoint, and the site path is used to locate the site that will be accessed.
- client_id
- specifies the client ID key for your application.
- client_secret
- specifies the client secret for your application.
Important: The client secret is a confidential value used to authenticate the application to the server. To prevent unauthorized access, this value must be securely maintained.
- token_uri
- specifies the endpoint used to exchange authentication credentials for access tokens.
- refresh_token
- specifies the refresh token used to either request a new
access token or renew an expired access token.
Important: The refresh token is a confidential value used to authenticate to the server. To prevent unauthorized access, this value must be securely maintained.
- property=value
- specifies connection property settings. Multiple properties are separated by a semi-colon.
The following example connection string includes the properties required for connecting with the OAuth 2.0 refresh token grant.
Connection conn = DriverManager.getConnection
("jdbc:datadirect:sharepoint:
ServiceURL=https://mycorp.sharepoint.com/sites/marketing/global;
ClientID=29453d6f-6789-25gh-gd8g-44tk3c527831;
ClientSecret=12a3=bCD/EfGh4Ijk+Lm5P67qR8s=//TuV+WXy1Zabcd;
TokenURI=https://login.microsoftonline.com/common/oauth2/v2.0/token;
RefreshToken=12a3=bCD/EfGh4Ijk+Lgd8g-44tk3c527831;");