com.box.sdkgen.managers.authorization

Class AuthorizationManager

Object

AuthorizationManager

public class AuthorizationManager
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AuthorizationManager.Builder

Field Summary

Fields

Modifier and Type	Field and Description
Authentication	auth
NetworkSession	networkSession

Constructor Summary

Constructors

Modifier	Constructor and Description
	AuthorizationManager()
protected	AuthorizationManager(AuthorizationManager.Builder builder)

Method Summary

Modifier and Type	Method and Description
void	authorizeUser(AuthorizeUserQueryParams queryParams) Authorize a user by sending them through the [Box](https://box.com) website and request their permission to act on their behalf.
void	authorizeUser(AuthorizeUserQueryParams queryParams, AuthorizeUserHeaders headers) Authorize a user by sending them through the [Box](https://box.com) website and request their permission to act on their behalf.
Authentication	getAuth()
NetworkSession	getNetworkSession()
AccessToken	refreshAccessToken(PostOAuth2TokenRefreshAccessToken requestBody) Refresh an Access Token using its client ID, secret, and refresh token.
AccessToken	refreshAccessToken(PostOAuth2TokenRefreshAccessToken requestBody, RefreshAccessTokenHeaders headers) Refresh an Access Token using its client ID, secret, and refresh token.
AccessToken	requestAccessToken(PostOAuth2Token requestBody) Request an Access Token using either a client-side obtained OAuth 2.0 authorization code or a server-side JWT assertion.
AccessToken	requestAccessToken(PostOAuth2Token requestBody, RequestAccessTokenHeaders headers) Request an Access Token using either a client-side obtained OAuth 2.0 authorization code or a server-side JWT assertion.
void	revokeAccessToken(PostOAuth2Revoke requestBody) Revoke an active Access Token, effectively logging a user out that has been previously authenticated.
void	revokeAccessToken(PostOAuth2Revoke requestBody, RevokeAccessTokenHeaders headers) Revoke an active Access Token, effectively logging a user out that has been previously authenticated.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

auth

public Authentication auth

networkSession

public NetworkSession networkSession

Constructor Detail

AuthorizationManager

public AuthorizationManager()

AuthorizationManager

protected AuthorizationManager(AuthorizationManager.Builder builder)

Method Detail

authorizeUser

public void authorizeUser(AuthorizeUserQueryParams queryParams)

Authorize a user by sending them through the [Box](https://box.com) website and request their permission to act on their behalf.

This is the first step when authenticating a user using OAuth 2.0. To request a user's authorization to use the Box APIs on their behalf you will need to send a user to the URL with this format.

Parameters:

queryParams - Query parameters of authorizeUser method

authorizeUser

public void authorizeUser(AuthorizeUserQueryParams queryParams,
                          AuthorizeUserHeaders headers)

Authorize a user by sending them through the [Box](https://box.com) website and request their permission to act on their behalf.

This is the first step when authenticating a user using OAuth 2.0. To request a user's authorization to use the Box APIs on their behalf you will need to send a user to the URL with this format.

Parameters:

queryParams - Query parameters of authorizeUser method

headers - Headers of authorizeUser method

requestAccessToken

public AccessToken requestAccessToken(PostOAuth2Token requestBody)

Request an Access Token using either a client-side obtained OAuth 2.0 authorization code or a server-side JWT assertion.

An Access Token is a string that enables Box to verify that a request belongs to an authorized session. In the normal order of operations you will begin by requesting authentication from the [authorize](https://developer.box.com/reference/get-authorize) endpoint and Box will send you an authorization code.

You will then send this code to this endpoint to exchange it for an Access Token. The returned Access Token can then be used to to make Box API calls.

Parameters:

requestBody - Request body of requestAccessToken method

requestAccessToken

public AccessToken requestAccessToken(PostOAuth2Token requestBody,
                                      RequestAccessTokenHeaders headers)

Request an Access Token using either a client-side obtained OAuth 2.0 authorization code or a server-side JWT assertion.

An Access Token is a string that enables Box to verify that a request belongs to an authorized session. In the normal order of operations you will begin by requesting authentication from the [authorize](https://developer.box.com/reference/get-authorize) endpoint and Box will send you an authorization code.

You will then send this code to this endpoint to exchange it for an Access Token. The returned Access Token can then be used to to make Box API calls.

Parameters:

requestBody - Request body of requestAccessToken method

headers - Headers of requestAccessToken method

refreshAccessToken

public AccessToken refreshAccessToken(PostOAuth2TokenRefreshAccessToken requestBody)

Refresh an Access Token using its client ID, secret, and refresh token.

Parameters:

requestBody - Request body of refreshAccessToken method

refreshAccessToken

public AccessToken refreshAccessToken(PostOAuth2TokenRefreshAccessToken requestBody,
                                      RefreshAccessTokenHeaders headers)

Refresh an Access Token using its client ID, secret, and refresh token.

Parameters:

requestBody - Request body of refreshAccessToken method

headers - Headers of refreshAccessToken method

revokeAccessToken

public void revokeAccessToken(PostOAuth2Revoke requestBody)

Revoke an active Access Token, effectively logging a user out that has been previously authenticated.

Parameters:

requestBody - Request body of revokeAccessToken method

revokeAccessToken

public void revokeAccessToken(PostOAuth2Revoke requestBody,
                              RevokeAccessTokenHeaders headers)

Revoke an active Access Token, effectively logging a user out that has been previously authenticated.

Parameters:

requestBody - Request body of revokeAccessToken method

headers - Headers of revokeAccessToken method

getAuth

public Authentication getAuth()

getNetworkSession

public NetworkSession getNetworkSession()