{ "opencollection": "1.0.0", "info": { "name": "Box Authorization Authorize API", "version": "1.0" }, "items": [ { "info": { "name": "Authorize", "type": "folder" }, "items": [ { "info": { "name": "Box Authorize user", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/authorize", "params": [ { "name": "response_type", "value": "code", "type": "query", "description": "The type of response we'd like to receive." }, { "name": "client_id", "value": "ly1nj6n11vionaie65emwzk575hnnmrk", "type": "query", "description": "The Client ID of the application that is requesting to authenticate\nthe user. To get the Client ID for your application, log in to your\nBox developer console and click the **Edit Application** link for\nthe application you're working with. In the OAuth 2.0 Parameters section\nof the configuration page, find the item labelled `client_id`. The\ntext of that item is your application's Client ID." }, { "name": "redirect_uri", "value": "http://example.com/auth/callback", "type": "query", "description": "The URI to which Box redirects the browser after the user has granted\nor denied the application permission. This URI match one of the redirect\nURIs in the configuration of your application. It must be a\nvalid HTTPS URI and it needs to be able to handle the redirection to\ncomplete the next step in the OAuth 2.0 flow.\nAlthough this parameter is optional, it must be a part of the\nauthorization URL if you configured multiple redirect URIs\nfor the application in the developer console. A missing parameter causes\na `redirect_uri_missing` error after the user grants application access." }, { "name": "state", "value": "my_state", "type": "query", "description": "A custom string of your choice. Box will pass the same string to\nthe redirect URL when authentication is complete. This parameter\ncan be used to identify a user on redirect, as well as protect\nagainst hijacked sessions and other exploits." }, { "name": "scope", "value": "admin_readwrite", "type": "query", "description": "A space-separated list of application scopes you'd like to\nauthenticate the user for. This defaults to all the scopes configured\nfor the application in its configuration page." } ] }, "docs": "Authorize a user by sending them through the [Box](https://box.com)\nwebsite and request their permission to act on their behalf.\n\nThis is the first step when authenticating a user using\nOAuth 2.0. To request a user's authorization to use the Box APIs\non their behalf you will need to send a user to the URL with this\nformat." } ] } ], "bundled": true }