JDBC Driver for Box

Build 22.0.8462

GetOAuthAccessToken

Gets an authentication token from Box.

Input

Name Type Description
AuthMode String The type of authentication mode to use. Select App for getting authentication tokens via a desktop app. Select Web for getting authentication tokens via a Web app.

The allowed values are APP, WEB.

The default value is WEB.

CallbackUrl String The URL the user will be redirected to after authorizing your application. This value must match the Redirect URL you have specified in the Box app settings. Only needed when the AuthMode parameter is Web.
Scope String The scope or permissions you are requesting.
Verifier String The verifier returned from Box after the user has authorized your app to have access to their data. This value will be returned as a parameter to the callback URL in GetOAuthAuthorizationURL.
State String This field indicates any state that may be useful to your application upon receipt of the response. Your application receives the same value it sent, as this parameter makes a round-trip to Box authorization server and back. Uses include redirecting the user to the correct resource in your site, using nonces, and mitigating cross-site request forgery.

Result Set Columns

Name Type Description
OAuthAccessToken String The access token used for communication with Box.
OAuthRefreshToken String The OAuth refresh token. This is the same as the access token in case of Box.
ExpiresIn String The remaining lifetime on the access token. A -1 denotes that it will not expire.

Copyright (c) 2023 CData Software, Inc. - All rights reserved.
Build 22.0.8462