Package com.smartsheet.api.oauth
OAuth 2.0 authentication support for the Smartsheet Java SDK.
This package provides classes and interfaces for implementing OAuth 2.0 authentication flows with the Smartsheet API. OAuth 2.0 is the recommended authentication method for applications that need to access Smartsheet on behalf of users.
Key components include:
OAuthFlow- Interface for OAuth flow operationsToken- Represents an OAuth access tokenAccessScope- Defines OAuth access scopes- Various exception classes for OAuth-specific errors
Use these classes to implement the OAuth authorization code flow to obtain access tokens for API requests.
-
Interface Summary Interface Description OAuthFlow OAuthFlow interface provides methods to do the OAuth2 authorization. -
Class Summary Class Description AuthorizationResult Represents an OAuth authorization result.OAuthFlowBuilder This is the builder that is used to buildOAuthFlowinstances.Token Represents OAuth token. -
Enum Summary Enum Description AccessScope Represents the access scope. -
Exception Summary Exception Description AccessDeniedException This is the exception thrown byOAuthFlowto indicate "access_denied" error when obtaining an authorization code.InvalidOAuthClientException This is the exception thrown byOAuthFlowto indicate an "invalid_client" error occurred when obtaining OAuth tokens.InvalidOAuthGrantException This is the exception thrown byOAuthFlowto indicate an "invalid_grant" error occurred when obtaining OAuth tokens.InvalidScopeException This is the exception thrown byOAuthFlowto indicate an "invalid_scope" error occurred when obtaining an authorization code.InvalidTokenRequestException This is the exception thrown byOAuthFlowto indicate an "invalid_request" error occurred when obtaining OAuth tokens.OAuthAuthorizationCodeException This is the exception thrown byOAuthFlowto indicate errors occurred when obtaining authorization code.OAuthTokenException This is the exception thrown byOAuthFlowto indicate errors occurred during obtaining OAuth tokens.UnsupportedOAuthGrantTypeException This is the exception thrown byOAuthFlowto indicate "unsupported_grant_type" error occurred during obtaining OAuth tokens.UnsupportedResponseTypeException This is the exception thrown byOAuthFlowto indicate "unsupported_response_type" error occurred when obtaining an authorization code.