Box Developerドキュメント
 
    最新バージョン

    アクセストークンをリクエスト

    post
    https://api.box.com
    /oauth2/token

    このエンドポイントはバージョン2024.0です。引き続き使用するために 変更は必要ありません。詳細については、 **Box APIのバージョン管理**を参照してください。

    クライアント側で取得したOAuth 2.0認証コードまたはサーバー側のJWTアサーションを使用してアクセストークンをリクエストします。

    アクセストークンとは、リクエストが認証済みセッションに属していることをBoxで検証するための文字列です。通常の手順では、最初にユーザーが承認エンドポイントに対して認証をリクエストした後で、Boxが認証コードを送信します。

    ユーザーはこのエンドポイントに認証コードを送信してアクセストークンと交換します。返されたアクセストークンは、Box APIコールを行うときに使用できます。

    リクエスト

    application/x-www-form-urlencoded

    リクエスト本文

    string (token)本文内省略可能
    "c3FIOG9vSGV4VHo4QzAyg5T1JvNnJoZ3ExaVNyQWw6WjRsanRKZG5lQk9qUE1BVQ"

    注釈トークンを作成するためのトークン。これはJWTアサーションです。

    urn:ietf:params:oauth:grant-type:token-exchangeとの組み合わせでgrant_typeとして使用されます。

    string (urn)本文内省略可能
    "urn:ietf:params:oauth:token-type:id_token"

    渡されるactor_tokenのタイプ。

    urn:ietf:params:oauth:grant-type:token-exchangeとの組み合わせでgrant_typeとして使用されます。

    次の値に固定: urn:ietf:params:oauth:token-type:id_token

    string (jwt)本文内省略可能
    "xxxxx.yyyyy.zzzzz"

    新しいアクセストークンをリクエストするJWTアサーション。

    urn:ietf:params:oauth:grant-type:jwt-bearerとの組み合わせでgrant_typeとして使用されます。

    string本文内省略可能
    "123456789"

    grant_typeclient_credentialsが指定されている場合に組み合わせて使用されます。値はbox_subject_typeによって決まります。userの場合はユーザーIDを使用し、enterpriseの場合はEnterprise IDを使用します。

    string本文内省略可能
    "enterprise"

    client_credentialsとの組み合わせでgrant_typeとして使用されます。

    次の値のいずれか1つ: enterprise,user

    string本文内省略可能
    "ly1nj6n11vionaie65emwzk575hnnmrk"

    アクセストークンをリクエストしているアプリケーションのクライアントID。

    grant_typeauthorization_codeclient_credentials、またはurn:ietf:params:oauth:grant-type:jwt-bearerが指定されている場合に組み合わせて使用されます。

    string本文内省略可能
    "hOzsTeFlT6ko0dme22uGbQal04SBPYc1"

    アクセストークンをリクエストしているアプリケーションのクライアントシークレット。

    grant_typeauthorization_codeclient_credentials、またはurn:ietf:params:oauth:grant-type:jwt-bearerが指定されている場合に組み合わせて使用されます。

    string (token)本文内省略可能
    "n22JPxrh18m4Y0wIZPIqYZK7VRrsMTWW"

    ユーザーが自身の代わりにAPIコールを行う権限をアプリケーションに付与した後、ブラウザリダイレクト時にBoxからアプリケーションに渡されるクライアント側承認コード。

    authorization_codeとの組み合わせでgrant_typeとして使用されます。

    string (urn)本文内必須
    "authorization_code"

    クライアント側で取得される承認コード、更新トークン、JWTアサーション、クライアント資格情報許可、またはトークンのダウンスコープを目的とするその他のアクセストークンを使用して行われているリクエストのタイプ。

    次の値のいずれか1つ: authorization_code,refresh_token,client_credentials,urn:ietf:params:oauth:grant-type:jwt-bearer,urn:ietf:params:oauth:grant-type:token-exchange

    string (token)本文内省略可能
    "c3FIOG9vSGV4VHo4QzAyg5T1JvNnJoZ3ExaVNyQWw6WjRsanRKZG5lQk9qUE1BVQ"

    新しいアクセストークンを入手するために使用される更新トークン。

    refresh_tokenとの組み合わせでgrant_typeとして使用されます。

    string (url)本文内省略可能
    "https://api.box.com/2.0/files/123456"

    トークンを生成するファイルの完全なURL。

    string (space_delimited_list)本文内省略可能
    "item_upload item_preview base_explorer"

    新しいアクセストークンに割り当てるスコープのスペース区切りリスト。

    subject_tokenは、これらすべてのスコープを持っている必要があります。そうでない場合、この呼び出しを行うと、401 Unauthorizedエラーになります。

    string (token)本文内省略可能
    "c3FIOG9vSGV4VHo4QzAyg5T1JvNnJoZ3ExaVNyQWw6WjRsanRKZG5lQk9qUE1BVQ"

    ダウンスコープされたトークンと交換するためのトークン。通常のアクセストークン、JWTアサーション、アプリトークンのいずれかを使用できます。

    urn:ietf:params:oauth:grant-type:token-exchangeとの組み合わせでgrant_typeとして使用されます。

    string本文内省略可能
    "urn:ietf:params:oauth:token-type:access_token"

    渡されるsubject_tokenのタイプ。

    urn:ietf:params:oauth:grant-type:token-exchangeとの組み合わせでgrant_typeとして使用されます。

    次の値に固定: urn:ietf:params:oauth:token-type:access_token

    レスポンス

    Authorization: Bearer <Token>のように承認ヘッダー内でトークンを渡すことによって認証済みのAPIコールを行うために使用できる新しいアクセストークンを返します。

    application/jsonOAuth 2.0エラー

    認証エラー。

    認証エラー。

    post
    アクセストークンをリクエスト
    このドキュメント内で一部のAPIを試せるようになりました。
    ログイン

    リクエストの例

    cURL
    curl -i -X POST "https://api.box.com/oauth2/token" \
         -H "content-type: application/x-www-form-urlencoded" \
         -d "client_id=[CLIENT_ID]" \
         -d "client_secret=[CLIENT_SECRET]" \
         -d "code=[CODE]" \
         -d "grant_type=authorization_code"

    レスポンスの例

    {
      "access_token": "c3FIOG9vSGV4VHo4QzAyg5T1JvNnJoZ3ExaVNyQWw6WjRsanRKZG5lQk9qUE1BVQ",
      "expires_in": 3600,
      "issued_token_type": "urn:ietf:params:oauth:token-type:access_token",
      "refresh_token": "c3FIOG9vSGV4VHo4QzAyg5T1JvNnJoZ3ExaVNyQWw6WjRsanRKZG5lQk9qUE1BVQ",
      "restricted_to": [
        {
          "object": {
            "etag": "1",
            "id": "12345",
            "type": "folder",
            "name": "Contracts",
            "sequence_id": "3"
          },
          "scope": "item_download"
        }
      ],
      "token_type": "bearer"
    }