ユーザーを承認

get

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

/authorize

ユーザーをBoxウェブサイトにリダイレクトして承認し、ユーザーに代わって操作を実行する権限をリクエストします。

これは、OAuth 2.0を使用してユーザーを承認する際の最初の手順です。Box APIをユーザーに代わって使用することについて、ユーザーに承認してもらうよう依頼するには、この形式を使用してユーザーを所定のURLにリダイレクトする必要があります。

関連するガイド

リクエスト

Content-Typeapplication/json

クエリパラメータ

client_id stringクエリ内必須

例ly1nj6n11vionaie65emwzk575hnnmrk

ユーザーの認証をリクエストしているアプリケーションのクライアントID。アプリケーションのクライアントIDを取得するには、Box開発者コンソールにログインして、該当するアプリケーションの[アプリケーションの編集]リンクをクリックします。設定ページの[OAuth 2.0パラメータ]セクションで、client_idというラベルの付いた項目を探します。その項目のテキストが、アプリケーションのクライアントIDです。

redirect_uri string / urlクエリ内必須

例http://example.com/auth/callback

ユーザーがアプリケーション権限を許可または拒否した後にブラウザがリダイレクトされるURL。このURLは、アプリケーションの設定に含まれるダイレクトURLと一致している必要があります。このURLは有効なHTTPS URLでなければならず、OAuth 2.0フローの次の手順を完了するには、このリダイレクトを処理できる状態になっている必要があります。

response_type string / tokenクエリ内必須

例code

次の値に固定: code

scope stringクエリ内省略可能

例admin_readwrite

ユーザーを認証するアプリケーションスコープのカンマ区切りリスト。デフォルトでは、アプリケーションの設定ページで指定されたすべてのスコープになります。

state stringクエリ内省略可能

例my_state

任意のカスタム文字列。認証が完了すると、同じ文字列がBoxからリダイレクトURLに渡されます。このパラメータを使用するとリダイレクト時にユーザーを識別できるだけでなく、ハイジャックされたセッションやその他の悪用を防止できます。

レスポンス

200text/html

何もデータを返しませんが、ブラウザで使用するようにしてください。

defaulttext/html

何もデータを返しませんが、ブラウザで使用するようにしてください。

get

ユーザーを承認

このドキュメント内で一部のAPIを試せるようになりました。

ログイン

リクエストの例

cURL

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

Python

from boxsdk import OAuth2

oauth = OAuth2(
    client_id='YOUR_CLIENT_ID',
    client_secret='YOUR_CLIENT_SECRET',
    store_tokens=your_store_tokens_callback_method,
)

auth_url, csrf_token = oauth.get_authorization_url('http://YOUR_REDIRECT_URL')

# Redirect user to auth_url, where they will enter their Box credentials

Node

var BoxSDK = require('box-node-sdk');
var sdk = new BoxSDK({
	clientID: 'YOUR-CLIENT-ID',
	clientSecret: 'YOUR-CLIENT_SECRET'
});

// the URL to redirect the user to
var authorize_url = sdk.getAuthorizeURL({
	response_type: 'code'
});

iOS

import BoxSDK

let sdk = BoxSDK(clientId: "YOUR CLIENT ID HERE", clientSecret: "YOUR CLIENT SECRET HERE")
sdk.getOAuth2Client() { result in
    switch result {
    case let .success(client):
        // Use client to make API calls
    case let .failure(error):
        // Handle error creating client
    }
}