PostOAuth2Token (Box Java SDK)

Object
- NullableFieldTracker
- - SerializableObject
  - - PostOAuth2Token

All Implemented Interfaces:

Serializable
```
public class PostOAuth2Token
extends SerializableObject
```
A request for a new OAuth 2.0 token.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class PostOAuth2Token.Builder

Nested Classes
Modifier and Type	Class and Description
`static class`	`PostOAuth2Token.Builder`

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`actorToken` The token used to create an annotator token.
`protected EnumWrapper<PostOAuth2TokenActorTokenTypeField>`	`actorTokenType` The type of `actor_token` passed in.
`protected String`	`assertion` A JWT assertion for which to request a new access token.
`protected String`	`boxSharedLink` Full URL of the shared link on the file or folder that the token should be generated for.
`protected String`	`boxSubjectId` Used in combination with `client_credentials` as the `grant_type`.
`protected EnumWrapper<PostOAuth2TokenBoxSubjectTypeField>`	`boxSubjectType` Used in combination with `client_credentials` as the `grant_type`.
`protected String`	`clientId` The Client ID of the application requesting an access token.
`protected String`	`clientSecret` The client secret of the application requesting an access token.
`protected String`	`code` The client-side authorization code passed to your application by Box in the browser redirect after the user has successfully granted your application permission to make API calls on their behalf.
`protected EnumWrapper<PostOAuth2TokenGrantTypeField>`	`grantType` The type of request being made, either using a client-side obtained authorization code, a refresh token, a JWT assertion, client credentials grant or another access token for the purpose of downscoping a token.
`protected String`	`refreshToken` A refresh token used to get a new access token with.
`protected String`	`resource` Full URL for the file that the token should be generated for.
`protected String`	`scope` The space-delimited list of scopes that you want apply to the new access token.
`protected String`	`subjectToken` The token to exchange for a downscoped token.
`protected EnumWrapper<PostOAuth2TokenSubjectTokenTypeField>`	`subjectTokenType` The type of `subject_token` passed in.

Fields inherited from class NullableFieldTracker
explicitlySetNullableFields

Constructor Summary

Constructors
Modifier	Constructor and Description
	`PostOAuth2Token(EnumWrapper<PostOAuth2TokenGrantTypeField> grantType)`
`protected`	`PostOAuth2Token(PostOAuth2Token.Builder builder)`
	`PostOAuth2Token(PostOAuth2TokenGrantTypeField grantType)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object o)`
`String`	`getActorToken()`
`EnumWrapper<PostOAuth2TokenActorTokenTypeField>`	`getActorTokenType()`
`String`	`getAssertion()`
`String`	`getBoxSharedLink()`
`String`	`getBoxSubjectId()`
`EnumWrapper<PostOAuth2TokenBoxSubjectTypeField>`	`getBoxSubjectType()`
`String`	`getClientId()`
`String`	`getClientSecret()`
`String`	`getCode()`
`EnumWrapper<PostOAuth2TokenGrantTypeField>`	`getGrantType()`
`String`	`getRefreshToken()`
`String`	`getResource()`
`String`	`getScope()`
`String`	`getSubjectToken()`
`EnumWrapper<PostOAuth2TokenSubjectTokenTypeField>`	`getSubjectTokenType()`
`int`	`hashCode()`
`String`	`toString()`

Methods inherited from class SerializableObject
getRawData, setRawData

Methods inherited from class NullableFieldTracker
getExplicitlySetNullableFields, isFieldExplicitlySet, markNullableFieldAsSet, markNullableFieldsAsSet

Methods inherited from class Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - grantType
```
protected final EnumWrapper<PostOAuth2TokenGrantTypeField> grantType
```
    The type of request being made, either using a client-side obtained authorization code, a refresh token, a JWT assertion, client credentials grant or another access token for the purpose of downscoping a token.
  - clientId
```
protected String clientId
```
    The Client ID of the application requesting an access token.
    Used in combination with `authorization_code`, `client_credentials`, or `urn:ietf:params:oauth:grant-type:jwt-bearer` as the `grant_type`.
  - clientSecret
```
protected String clientSecret
```
    The client secret of the application requesting an access token.
    Used in combination with `authorization_code`, `client_credentials`, or `urn:ietf:params:oauth:grant-type:jwt-bearer` as the `grant_type`.
  - code
```
protected String code
```
    The client-side authorization code passed to your application by Box in the browser redirect after the user has successfully granted your application permission to make API calls on their behalf.
    Used in combination with `authorization_code` as the `grant_type`.
  - refreshToken
```
protected String refreshToken
```
    A refresh token used to get a new access token with.
    Used in combination with `refresh_token` as the `grant_type`.
  - assertion
```
protected String assertion
```
    A JWT assertion for which to request a new access token.
    Used in combination with `urn:ietf:params:oauth:grant-type:jwt-bearer` as the `grant_type`.
  - subjectToken
```
protected String subjectToken
```
    The token to exchange for a downscoped token. This can be a regular access token, a JWT assertion, or an app token.
    Used in combination with `urn:ietf:params:oauth:grant-type:token-exchange` as the `grant_type`.
  - subjectTokenType
```
protected EnumWrapper<PostOAuth2TokenSubjectTokenTypeField> subjectTokenType
```
    The type of `subject_token` passed in.
    Used in combination with `urn:ietf:params:oauth:grant-type:token-exchange` as the `grant_type`.
  - actorToken
```
protected String actorToken
```
    The token used to create an annotator token. This is a JWT assertion.
    Used in combination with `urn:ietf:params:oauth:grant-type:token-exchange` as the `grant_type`.
  - actorTokenType
```
protected EnumWrapper<PostOAuth2TokenActorTokenTypeField> actorTokenType
```
    The type of `actor_token` passed in.
    Used in combination with `urn:ietf:params:oauth:grant-type:token-exchange` as the `grant_type`.
  - scope
```
protected String scope
```
    The space-delimited list of scopes that you want apply to the new access token.
    The `subject_token` will need to have all of these scopes or the call will error with **401 Unauthorized**..
  - resource
```
protected String resource
```
    Full URL for the file that the token should be generated for.
  - boxSubjectType
```
protected EnumWrapper<PostOAuth2TokenBoxSubjectTypeField> boxSubjectType
```
    Used in combination with `client_credentials` as the `grant_type`.
  - boxSubjectId
```
protected String boxSubjectId
```
    Used in combination with `client_credentials` as the `grant_type`. Value is determined by `box_subject_type`. If `user` use user ID and if `enterprise` use enterprise ID.
  - boxSharedLink
```
protected String boxSharedLink
```
    Full URL of the shared link on the file or folder that the token should be generated for.
- Constructor Detail
  - PostOAuth2Token
```
public PostOAuth2Token(PostOAuth2TokenGrantTypeField grantType)
```
  - PostOAuth2Token
```
public PostOAuth2Token(EnumWrapper<PostOAuth2TokenGrantTypeField> grantType)
```
  - PostOAuth2Token
```
protected PostOAuth2Token(PostOAuth2Token.Builder builder)
```
- Method Detail
  - getGrantType
```
public EnumWrapper<PostOAuth2TokenGrantTypeField> getGrantType()
```
  - getClientId
```
public String getClientId()
```
  - getClientSecret
```
public String getClientSecret()
```
  - getCode
```
public String getCode()
```
  - getRefreshToken
```
public String getRefreshToken()
```
  - getAssertion
```
public String getAssertion()
```
  - getSubjectToken
```
public String getSubjectToken()
```
  - getSubjectTokenType
```
public EnumWrapper<PostOAuth2TokenSubjectTokenTypeField> getSubjectTokenType()
```
  - getActorToken
```
public String getActorToken()
```
  - getActorTokenType
```
public EnumWrapper<PostOAuth2TokenActorTokenTypeField> getActorTokenType()
```
  - getScope
```
public String getScope()
```
  - getResource
```
public String getResource()
```
  - getBoxSubjectType
```
public EnumWrapper<PostOAuth2TokenBoxSubjectTypeField> getBoxSubjectType()
```
  - getBoxSubjectId
```
public String getBoxSubjectId()
```
  - getBoxSharedLink
```
public String getBoxSharedLink()
```
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class PostOAuth2Token

Nested Class Summary

Field Summary

Fields inherited from class NullableFieldTracker

Constructor Summary

Method Summary

Methods inherited from class SerializableObject

Methods inherited from class NullableFieldTracker

Methods inherited from class Object

Field Detail

grantType

clientId

clientSecret

code

refreshToken

assertion

subjectToken

subjectTokenType

actorToken

actorTokenType

scope

resource

boxSubjectType

boxSubjectId

boxSharedLink

Constructor Detail

PostOAuth2Token

PostOAuth2Token

PostOAuth2Token

Method Detail

getGrantType

getClientId

getClientSecret

getCode

getRefreshToken

getAssertion

getSubjectToken

getSubjectTokenType

getActorToken

getActorTokenType

getScope

getResource

getBoxSubjectType

getBoxSubjectId

getBoxSharedLink

equals

hashCode

toString