Box Developer Documentation
 
    Latest version

    Authorize user

    get
    https://account.box.com/api/oauth2
    /authorize

    This endpoint is in the version 2024.0. No changes are required to continue using it. For more details, see Box API versioning.

    Authorize a user by sending them through the Box 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.

    Request

    application/json

    Query Parameters

    stringin queryrequired
    ly1nj6n11vionaie65emwzk575hnnmrk

    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.

    string (url)in queryoptional
    http://example.com/auth/callback

    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.

    string (token)in queryrequired
    code

    The type of response we'd like to receive.

    Value is always code

    stringin queryoptional
    admin_readwrite

    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.

    stringin queryoptional
    my_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.

    Response

    text/html

    Does not return any data, but rather should be used in the browser.

    text/html

    Does not return any data, but rather should be used in the browser.

    get
    Authorize user
    You can now try out some of our APIs live, right here in the documentation.
    Log in

    Request Example

    cURL
    curl -i -X GET "https://account.box.com/api/oauth2/authorize?response_type=code&client_id=ly1nj6n11vionaie65emwzk575hnnmrk&redirect_uri=http://example.com/auth/callback"