com.box.sdkgen.managers.authorization

Class AuthorizeUserQueryParams

Object

AuthorizeUserQueryParams

public class AuthorizeUserQueryParams
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AuthorizeUserQueryParams.Builder

Field Summary

Fields

Modifier and Type	Field and Description
String	clientId The Client ID of the application that is requesting to authenticate the user.
String	redirectUri The URI to which Box redirects the browser after the user has granted or denied the application permission.
EnumWrapper<AuthorizeUserQueryParamsResponseTypeField>	responseType The type of response we'd like to receive.
String	scope A space-separated list of application scopes you'd like to authenticate the user for.
String	state A custom string of your choice.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AuthorizeUserQueryParams(AuthorizeUserQueryParams.Builder builder)
	AuthorizeUserQueryParams(AuthorizeUserQueryParamsResponseTypeField responseType, String clientId)
	AuthorizeUserQueryParams(EnumWrapper<AuthorizeUserQueryParamsResponseTypeField> responseType, String clientId)

Method Summary

Modifier and Type	Method and Description
String	getClientId()
String	getRedirectUri()
EnumWrapper<AuthorizeUserQueryParamsResponseTypeField>	getResponseType()
String	getScope()
String	getState()

Methods inherited from class Object

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

Field Detail

responseType

public final EnumWrapper<AuthorizeUserQueryParamsResponseTypeField> responseType

The type of response we'd like to receive.

clientId

public final String clientId

The Client ID of the application that is requesting to authenticate the user. To get the Client ID for your application, log in to your Box developer console and click the **Edit Application** link for the application you're working with. In the OAuth 2.0 Parameters section of the configuration page, find the item labelled `client_id`. The text of that item is your application's Client ID.

redirectUri

public String redirectUri

The URI to which Box redirects the browser after the user has granted or denied the application permission. This URI match one of the redirect URIs in the configuration of your application. It must be a valid HTTPS URI and it needs to be able to handle the redirection to complete the next step in the OAuth 2.0 flow. Although this parameter is optional, it must be a part of the authorization URL if you configured multiple redirect URIs for the application in the developer console. A missing parameter causes a `redirect_uri_missing` error after the user grants application access.

state

public String state

A custom string of your choice. Box will pass the same string to the redirect URL when authentication is complete. This parameter can be used to identify a user on redirect, as well as protect against hijacked sessions and other exploits.

scope

public String scope

A space-separated list of application scopes you'd like to authenticate the user for. This defaults to all the scopes configured for the application in its configuration page.

Constructor Detail

AuthorizeUserQueryParams

public AuthorizeUserQueryParams(AuthorizeUserQueryParamsResponseTypeField responseType,
                                String clientId)

AuthorizeUserQueryParams

public AuthorizeUserQueryParams(EnumWrapper<AuthorizeUserQueryParamsResponseTypeField> responseType,
                                String clientId)

AuthorizeUserQueryParams

protected AuthorizeUserQueryParams(AuthorizeUserQueryParams.Builder builder)

Method Detail

getResponseType

public EnumWrapper<AuthorizeUserQueryParamsResponseTypeField> getResponseType()

getClientId

public String getClientId()

getRedirectUri

public String getRedirectUri()

getState

public String getState()

getScope

public String getScope()