Connecting to Box

Use the OAuth authentication standard to connect to Box. You can authenticate with a user account or with a service account. A service account is required to grant organization-wide access scopes to the add-in. The add-in facilitates these authentication flows as described below.

User Accounts (OAuth)

AuthScheme must be set to OAuth in all user account flows.

Desktop Applications

CData provides an embedded OAuth application that simplifies OAuth desktop Authentication. Alternatively, you can create a custom OAuth application. See Create a Custom OAuth App for information about creating custom applications and reasons for doing so.

Get and Refresh the OAuth Access Token

After setting the following, you are ready to connect:

• OAuthClientId (custom applications only): Set this to the client Id assigned when you registered your app.
• OAuthClientSecret (custom applications only): Set this to the client secret assigned when you registered your app.
• CallbackURL (custom application only): Set this to the redirect URI defined when you registered your app. For example: http://localhost:33333

When you connect, the add-in opens Box's OAuth endpoint in your default browser. Log in and grant permissions to the application. The add-in refreshes the access token automatically when it expires.

Authenticate with a Service Account

Set the AuthScheme to OAuthJWT to authenticate with this method.

Service accounts have silent authentication, without user authentication in the browser. You can also use a service account to delegate enterprise-wide access scopes to the add-in.

You need to create an OAuth application in this flow. See Create a Custom OAuth App to create and authorize an app. You can then connect to Box data that the service account has permission to access.

After setting the following connection properties, you are ready to connect:

• OAuthClientId: Set to the Client Id in your app settings.
• OAuthClientSecret: Set to the Client Secret in your app settings.
• OAuthJWTCertType: Set to "PEMKEY_FILE".
• OAuthJWTCert: Set to the path to the .pem file you generated.
• OAuthJWTCertPassword: Set to the password of the .pem file.
• OAuthJWTCertSubject: Set to "*" to pick the first certificate in the certificate store.
• OAuthJWTSubjectType: Set to "enterprise" or "user" depending on the Application Access Value you selected in your app settings. The default value of this connection property is "enterprise".
• OAuthJWTSubject: Set to your enterprise Id if your subject type is set to "enterprise" or your app user Id if your subject type is set to "user".
• OAuthJWTPublicKeyId: Set to the Id of your public key in your app settings.

When you connect the add-in completes the OAuth flow for a service account.