クライアントエラー
HTTP 4XX形式の大半のクライアントエラーとHTTP 5XX形式の一部のサーバーエラーでは、標準のクライアントエラーJSONオブジェクトが返されます。{
"type": "error",
"status": 400,
"code": "bad_digest",
"help_url": "/guides/api-calls/permissions-and-errors/common-errors/",
"message": "The specified content-md5 did not match what we received",
"request_id": "abcdef123456"
}
共通エラーコード
Box APIの使用時に発生した一般的なエラーの解決策については、開発者向けトラブルシューティングの記事を確認してください。400 Bad Request
| エラー | bad_digest |
| メッセージ | The specified content-md5 did not match what we received. (指定のcontent-md5は受信したものと一致しませんでした。) |
| 解決策 | ファイルのアップロード中に、ファイルのSHA-1ハッシュとcontent-md5ヘッダーを指定して、ファイルが転送中に破損していないかどうかを確認できます。リクエストで指定されたSHA-1ハッシュは、アップロードで受信したものと一致していません。アップロードしたファイルの有効なSHA-1ハッシュを指定してください。 |
| エラー | bad_request |
| メッセージ | |
| 解決策 | APIリクエストで指定された必須パラメータが見つからないか無効です。詳細については、レスポンス本文の拡張エラーメッセージを確認してください。 |
| エラー | cannot_make_collaborated_subfolder_private |
| メッセージ | Cannot move a collaborated folder to a private folder unless the new owner is explicitly specified. (新しい所有者が明示的に指定されない限り、コラボレーションサブフォルダを非公開フォルダに移動することはできません。) |
| 解決策 | リクエストのowned_by.idフィールドを設定して、コンテンツの転送先となるユーザーのIDを指定してください。 |
| エラー | collaborations_not_available_on_root_folder |
| メッセージ | Root folder cannot be collaborated (ルートフォルダのコラボレーションができません) |
| 解決策 | ユーザーのルートフォルダ (フォルダID 0) にコラボレータを設定できません。ルートフォルダとは異なるフォルダIDを使用してください。 |
| エラー | cyclical_folder_structure |
| メッセージ | Folder move creates cyclical folder structure (フォルダの移動により循環フォルダ構造が作成されます) |
| 解決策 | フォルダの移動で指定したフォルダIDによって、循環フォルダ構造 (たとえば、フォルダがそのフォルダ内のサブフォルダに移動される構造) が作成されます。フォルダ移動リクエストで指定するフォルダを変更してください。 |
| エラー | folder_not_empty |
| メッセージ | Cannot delete – folder not empty (削除できません – フォルダにファイルが存在しません) |
| 解決策 | 削除する前に、フォルダからすべてのコンテンツを削除してください。 |
| エラー | invalid_collaboration_item |
| メッセージ | Item type must be specified and set to ‘folder’ (項目タイプは指定されていなければならず、「folder」に設定されていることが必要です) |
| 解決策 | コラボレーション項目のitem.typeフィールドをフォルダに設定してください。 |
| エラー | invalid_client |
| メッセージ | The client credentials are invalid. (クライアント資格情報が無効です。) |
| 解決策 | トークンリクエスト内のclient_idおよびclient_secretが、開発者コンソールの値と一致していることを確認してください。 |
| エラー | invalid_grant |
| メッセージ | Verify the authorization code is set correctly in your request, or your application likely needs to get a new authorization code. (リクエストに承認コードが正しく設定されていることを確認してください。そうしないと、アプリケーションで新しい承認コードが必要になる可能性があります。) |
| 解決策 | APIリクエストで指定された承認コードが見つからないか、無効になりました。考えられる解決策として、リクエストにアクセストークンが正しく追加されているかどうかを確認してください。正しく設定されている場合は、アクセストークンが期限切れになっている可能性があります。アクセストークンを更新するか、新しいアクセストークンを取得してください。 |
| エラー | invalid_grant |
| メッセージ | Current date time must be before the expiration date time listed in the exp claim. (現在の日時はexpクレームに記載されている有効期限の日時よりも前である必要があります。) |
| 解決策 | このエラーは、ローカルマシンとBoxサーバーのUnix時間が同期されていない場合に発生します。このエラーを修正するには、ローカルマシンのUnix時間を、同期対象の時刻サーバーと一致するよう更新し、再度リクエストしてみてください。 |
| エラー | invalid_grant |
| メッセージ | Invalid refresh token. (無効な更新トークンです。) |
| 解決策 | 更新トークンが無効、取り消し済み、または有効期限切れの可能性があります。アプリケーションの更新トークンの処理を修正し、必要に応じてOAuth 2.0認証フローを通じて新しいトークンペアを取得してください。 |
| エラー | invalid_grant |
| メッセージ | The authorization code has expired. (承認コードの有効期限が切れています。) |
| 解決策 | 承認コードは発行後すぐに (数十秒程度で) 失効します。ユーザーがアプリケーションにリダイレクトされたら、直ちにそのコードをトークンと交換してください。 |
| エラー | invalid_grant |
| メッセージ | Please check the sub claim. (subクレームを確認してください。) |
| 解決策 | JWT認証を行う際は、box_sub_typeに応じて、sub (サブジェクト) クレームを正しいユーザーIDまたはEnterprise IDに設定します。詳細については、Boxのサポートサイトを参照してください。 |
| エラー | invalid_grant |
| メッセージ | Please check the jti claim. A unique jti value is required. (jtiクレームを確認してください。一意のjti値が必要です。) |
| 解決策 | アサーションごとに、JWT ID (jti) が有効かつ一意の値に設定されていることを確認してください。同じjtiを再利用することはできません。 |
| エラー | invalid_grant |
| メッセージ | Please check the iss claim. (issクレームを確認してください。) |
| 解決策 | JWT認証を使用する場合、発行者 (iss) クレームは、アプリケーションのOAuthクライアントIDと一致している必要があります。 |
| エラー | invalid_grant |
| メッセージ | Signature verification error. The public key identified by kid must correspond to the private key used for signing. (署名の検証エラー。kidで識別される公開キーは、署名に使用された秘密キーと一致している必要があります。) |
| 解決策 | 開発者コンソールでは、アプリに関連付けられている公開/秘密キーのペアを使用します。キーをローテーションする場合は、新しいキーを追加し、古いキーを削除した後、構成ファイルを新しいキーペアとkidで更新し、新しいアクセストークンをリクエストしてください。 |
| エラー | invalid_grant |
| メッセージ | kid invalid, unable to lookup correct key. (kidが無効です。正しいキーが見つかりません。) |
| 解決策 | JWTヘッダー内のキーID (kid) は、アプリケーションに登録されている公開キー (例: 構成内のpublicKeyID) と一致している必要があります。正しい構成ファイルを使用していることを確認するか、開発者コンソールで新しいRSAキーペアを生成し、これを使用するようアプリを更新してください。 |
| エラー | invalid_limit |
| メッセージ | Limit is not a valid number (制限値が有効な数値ではありません) |
| 解決策 | 指定された制限値に有効な数値を追加してください。 |
| エラー | invalid_offset |
| メッセージ | Offset is not a valid number (オフセットが有効な数値ではありません) |
| 解決策 | 指定されたオフセット値に有効な数値を追加してください。 |
| エラー | invalid_request |
| メッセージ | The grant type is unauthorized for this client_id. (この許可タイプはこのclient_idに対して許可されていません。) |
| 解決策 | アプリがサーバー認証 (JWT) 用に構成されているにもかかわらず、標準のOAuth 2.0を使用してトークンをリクエストしている (あるいはその逆の) 可能性があります。アプリの認証方法に合ったトークンリクエストタイプを使用してください。The grant type is unauthorized for this client_id. (この許可タイプはこのclient_idに対して許可されていません。)を参照してください。 |
| エラー | invalid_request |
| メッセージ | Invalid grant_type parameter or parameter missing. (無効なgrant_typeパラメータか、パラメータが指定されていません。) |
| 解決策 | トークンリクエストを誤ったドメイン (app.box.comやwww.box.comなど) に送信している可能性があります。トークンリクエストはhttps://api.box.comに送信してください。また、grant_type、およびフローに必要なその他のパラメータ (authorization_code、refresh_token、JWTアサーションなど) を使用してください。 |
| エラー | invalid_request |
| メッセージ | Cannot obtain user token based on the enterprise configuration for your app. (アプリのEnterprise構成に基づいて、ユーザートークンを取得できません。) |
| 解決策 | ユーザートークンのリクエストに必要なスコープや構成が、アプリに指定されていない可能性があります。アプリに対するEnterpriseの構成に基づいてトークンを取得できないを参照してください。 |
| エラー | invalid_request_parameters |
| メッセージ | Invalid input parameters in request (リクエスト内に無効な入力パラメータがあります) |
| 解決策 | APIリクエストで無効なパラメータが送信されました。APIリファレンスドキュメントで、このAPI操作に指定すべき正しいリクエストパラメータを確認してください。 |
| エラー | invalid_status |
| メッセージ | You can change the status only if the collaboration is pending (ステータスを変更できるのは、コラボレーションが保留中の場合のみです) |
| 解決策 | コラボレーションのステータスは、現在のステータスが保留中に設定されている場合に、accessible_byフィールドで指定されたユーザーのみが承認済みまたは拒否済みに更新できます。 |
| エラー | invalid_upload_session_id |
| メッセージ | The upload session ID provided in the URL is not of a valid format. (URLに指定されているアップロードセッションIDが有効な形式ではありません。) |
| 解決策 | 分割アップロードAPIリクエストの送信時に指定されたセッションIDが無効です。作成されたセッションと同じセッションIDを使用してください。 |
| エラー | item_name_invalid | |
| メッセージ | Item name invalid (項目名が無効です) | |
| 解決策 | ファイルの名前が有効であることを確認してください。Boxでは、255文字以下のファイル名またはフォルダ名のみがサポートされています。印刷不可能な文字を含むファイル名、/、\、<、>、:、` | , ?, *, -`という文字を含む名前、先頭または末尾にスペースを含む名前のほか、「.」と「..」という特殊な名前も使用できません。 |
| エラー | item_name_too_long |
| メッセージ | Item name too long (項目名が長すぎます) |
| 解決策 | 項目に指定されている名前の長さを短くしてください。Boxのファイル名またはフォルダ名に使用できる文字数は255文字以下です。 |
| エラー | metadata_after_file_contents |
| メッセージ | Metadata is included after file contents in a file upload request. (メタデータは、ファイルアップロードリクエストでファイルのコンテンツの後に含まれています。) |
| 解決策 | ファイルのコンテンツの前にファイルメタデータを含めてください。 |
| エラー | password_reset_required |
| メッセージ | User needs to reset password (ユーザーはパスワードをリセットする必要があります) |
| 解決策 | ユーザーは、アカウントの設定手順を完了していません。 |
| エラー | requested_page_out_of_range |
| メッセージ | Requested representation page out of range (リクエストされたレプリゼンテーションページが範囲外です) |
| 解決策 | 指定された範囲ヘッダーは、指定した項目のサイズに収まりません。項目のサイズに収まるよう範囲を調整し、もう一度やり直してください。 |
| エラー | requested_preview_unavailable |
| メッセージ | Requested preview unavailable (リクエストされたプレビューは利用できません) |
| 解決策 | ファイルに対してリクエストされたサムネイルサイズが有効ではありません。API操作のリファレンスドキュメントで、利用可能な形式サイズを確認してください。 |
| エラー | sync_item_move_failure |
| メッセージ | Cannot move a synced item (同期した項目を移動できません) |
| 解決策 | 項目は、Box Syncクライアントによって同期が設定されているため移動できません。項目のsync_stateをnot_syncedに設定することで、解決できる場合があります。 |
| エラー | task_assignee_not_allowed |
| メッセージ | Assigner does not have sufficient privileges to assign task to assignee (依頼者には、担当者にタスクを割り当てるのに十分な権限がありません) |
| 解決策 | タスクを割り当てようとしているユーザーに、そのための適切な権限がありません。タスクの割り当てを許可するようユーザー権限を調整してください。 |
| エラー | terms_of_service_required |
| メッセージ | User must accept custom terms of service before action can be taken (ユーザーは操作を実行する前にカスタムサービス利用規約に同意する必要があります) |
| 解決策 | APIリクエストのコンテキスト上のユーザーが、企業のカスタムサービス利用規約に同意していません。ログイン可能な管理対象ユーザーは、ほとんどのAPIコール、ユーザーアクセストークンの発行、またはOAuth認可を行う前に同意が必要です。サービスアカウントとApp Userは対象外です。サーバー認証でAs-Userヘッダーまたはユーザーアクセストークンを使用している場合、As-Userで指定したユーザー、またはアクセストークンの対象ユーザーが同意している必要があります。ユーザーはBoxウェブアプリケーションから同意することも、アプリケーションがに従ってプログラムで同意することもできます。詳細については、こちらで確認してください。 |
| エラー | unauthorized_client |
| メッセージ | This app is not authorized by the enterprise admin. (このアプリは、Enterprise管理者の承認を受けていません。) |
| 解決策 | JWTまたはクライアント資格情報許可を使用するサーバー認証アプリケーションは、使用前にBox管理者による承認が必要です。の手順に従ってください。 |
| エラー | user_already_collaborator |
| メッセージ | ユーザーはすでにコラボレータです |
| 解決策 | ある項目のコラボレータに設定しようとしているユーザーは、すでにその項目のコラボレータです。このリクエストは必要ありません。 |
401 Unauthorized
| エラー | unauthorized |
| メッセージ | 許可なし |
| 解決策 | 承認トークンは承認されていません。詳細については、本文の拡張エラーメッセージを確認してください。 |
| エラー | invalid_token |
| メッセージ | The access token provided is invalid. (指定されたアクセストークンは無効です。) |
| 解決策 | アクセストークンが正しくない、破損している、または有効期限が切れている可能性があります。例えば、誤入力した、別の環境のトークンを使用している、トークンが失効または削除されている、などの原因が考えられます。トークンエンドポイントから新しいアクセストークンを取得してください。OAuth 2.0認証の場合、有効期限が切れたアクセストークンを更新することができます。を参照してください。 |
403 Forbidden
| エラー | access_denied_insufficient_permissions |
| メッセージ | Access denied – insufficient permission (アクセスが拒否されました – 権限が不足しています) |
| 解決策 | アクセストークンに適切なユーザー権限またはスコープが設定されていません。解決策の情報については、こちらを参照してください。 |
| エラー | insufficient_scope |
| メッセージ | The request requires higher privileges than provided by the access token. (リクエストには、アクセストークンによって提供される権限よりも高い権限が必要です。) |
| 解決策 | 通常、このエラーは、API操作に必要なスコープが有効になっていない場合に発生します。構成済みのアプリケーションスコープを確認し、該当する場合はアプリケーションを再承認してください。 |
| エラー | access_denied_item_locked |
| メッセージ | Access denied – item locked (アクセスが拒否されました – 項目がロックされています) |
| 解決策 | ロックされた項目にアクセスしようとしていますが、アクセスするための適切な権限がありません。項目のロックを解除してから、再度アクセスしてみてください。 |
| エラー | access_from_location_blocked |
| メッセージ | |
| 解決策 | 管理者によって承認されていない場所からBoxにログインしようとしています。この問題を解決するには、管理者にお問い合わせください。 |
| エラー | file_size_limit_exceeded |
| メッセージ | ファイルサイズがフォルダ所有者のファイルサイズ上限を超えています |
| 解決策 | アカウントの種類に基づいたファイルサイズの上限については、こちらを参照してください。 |
| エラー | forbidden |
| メッセージ | |
| 解決策 | クライアントには、このセッションにアップロードするための権限がありません。アップロードできるのは、アップロードセッションを開始したユーザーのみです。 |
| エラー | forbidden_by_policy |
| メッセージ | Access denied – Blocked by Shield Access Policy (アクセスが拒否されました – Shieldアクセスポリシーによってブロックされています) |
| 解決策 | 会社に適用されているShieldアクセスポリシーによってこの操作が妨げられています。Enterprise管理者に連絡して、適用されているShieldアクセスポリシーを調整してください。 |
| エラー | forbidden_by_policy |
| メッセージ | Access denied – Blocked by Shield Malware Detection Rule (アクセスが拒否されました – Shieldマルウェア検出ルールによってブロックされています) |
| 解決策 | Shieldマルウェア検出ルールを有効化すると、悪意のある可能性のあるコンテンツをダウンロードしたり、ローカルで編集したりできなくなりますが、引き続きプレビューとオンライン編集は可能です。適用されているShieldポリシーを調整するには、会社の管理者にお問い合わせください。 |
| エラー | incorrect_shared_item_password |
| メッセージ | |
| 解決策 | 共有項目にはパスワードが必要ですが、パスワードが誤っているか指定されていません。 |
| エラー | storage_limit_exceeded |
| メッセージ | アカウントのストレージサイズの上限に達しました |
| 解決策 | アカウントのストレージサイズの上限に達しました。続行するには、アカウントをアップグレードするか、コンテンツを完全に削除してください。単にごみ箱に移動したコンテンツも、完全に削除されるまでアカウントの合計サイズにカウントされます。 |
| エラー | user_email_confirmation_required |
| メッセージ | User needs to complete email confirmation (ユーザーはメール確認を完了する必要があります) |
| 解決策 | ユーザーは、メール確認の手順をまだ完了していません。 |
| エラー | cors_origin_not_whitelisted |
| メッセージ | Access denied - Did you forget to safelist your origin in the CORS configuration of your app? (アクセスが拒否されました – アプリのCORS構成のオリジンをセーフリストに追加し忘れていませんか。) |
| 解決策 | アプリケーションはウェブサイトからBox APIにアクセスしようとしました。このアプリケーションでは、サイトがホストされているドメインに対して必要があります。 |
404 Not Found
| エラー | not_found |
| メッセージ | |
| 解決策 | リソースが見つかりませんでした。詳細については、レスポンス本文の拡張エラーメッセージを確認してください。 |
| エラー | not_trashed |
| メッセージ | Item is not trashed (項目はごみ箱に移動されていません) |
| 解決策 | ごみ箱には、完全に削除する項目がありません。最初に、項目をごみ箱に移動してください。 |
| エラー | preview_cannot_be_generated |
| メッセージ | Preview cannot be generated (プレビューを生成できません) |
| 解決策 | 指定されたファイルのプレビューのサムネイルを生成できません。 |
| エラー | trashed |
| メッセージ | Item is trashed (項目はごみ箱に移動されました) |
| 解決策 | アクセス対象の項目がごみ箱にあり、変更できません。項目をごみ箱から移動してやり直してください。 |
405 Method Not Allowed
| エラー | method_not_allowed |
| メッセージ | Method Not Allowed (メソッドが許可されていません) |
| 解決策 | API操作に使用されるHTTPメソッドは許可されていません。APIリファレンスドキュメントで、API操作に必要なHTTP動詞を確認してください。 |
409 Conflict
| エラー | conflict |
| メッセージ | A resource with this value already exists (この値のリソースはすでに存在します) |
| 解決策 | このエラーは、作成するリソースがすでに存在する場合に発生する可能性があります。詳細については、レスポンス本文の拡張エラーメッセージを確認してください。 |
| エラー | item_name_in_use |
| メッセージ | Item with the same name already exists (同じ名前の項目はすでに存在します) |
| 解決策 | このエラーは、同じ名前のリソースがすでに存在している場合に発生する可能性があります。追加/変更するリソース名には一意の名前を指定してください。 |
| エラー | name_temporarily_reserved |
| メッセージ | The item name is reserved by another processing item. Wait and then retry the request, or wait and check the parent folder to see if the name is in use. (項目名は別の処理項目によって予約されています。しばらく待ってからリクエストを再試行するか、しばらく待ってから名前が使用中であるかどうか親フォルダを確認してください。) |
| 解決策 | 重複する2つのリクエストが同時に送信されました。Boxは最初のリクエストを確認して名前を予約しますが、最初のリクエストの処理が完了する前に2つ目の重複するリクエストを受信しています。最初のリクエストが完了してから2番目のリクエストを送信してください。 |
| エラー | operation_blocked_temporary |
| メッセージ | The operation is blocked by another ongoing operation (他の進行中の操作によって操作がブロックされました) |
| 解決策 | このエラーは、移動やコピーなど、他のフォルダ操作によってブロックされたフォルダにアクセスしようとしたときに返されます。後でもう一度やり直してください。 |
| エラー | recent_similar_comment |
| メッセージ | A similar comment has been made recently (同様のコメントが最近作成されました) |
| 解決策 | 同様のコメントが最近作成されており、重複する可能性があるためAPIがフラグを設定しています。コメントが実際に作成済みか確認するか、コメントの内容を変更してやり直してください。 |
| エラー | user_login_already_used |
| メッセージ | User with the specified login already exists (指定のログインを持つユーザーがすでに存在します) |
| 解決策 | 同じメールアドレスのユーザーがすでに存在します。既存ユーザーを参照するか、別のメールアドレスを指定してください。 |
410 Gone
| エラー | session_expired |
| メッセージ | |
| 解決策 | 指定されたアップロードセッションIDに関連付けられたアップロードセッションは、有効期限が切れているためアクセスできません。 |
| エラー | upload_failed |
| メッセージ | |
| 解決策 | アップロードセッションで回復不能な状態になり、続行できません。このリクエストまたはその他のリクエストのアップロードセッションは、結果として、不適切な状態 (パーツ重複など) になりました。この状態の原因として、パーツの上限を超過しているか、重複するパーツがアップロード済みであることが考えられます。 |
411 Length Required
| エラー | length_required |
| メッセージ | content-length header was required, but not provided. (content-lengthヘッダーが要求されましたが、指定されていません。) |
| 解決策 | APIリクエストでContent-Lengthヘッダーを指定してください。 |
412 Precondition Failed
| エラー | precondition_failed |
| メッセージ | The resource has been modified. Retrieve the resource again and retry (このリソースは変更されています。リソースをもう一度取得してから再試行してください) |
| 解決策 | 詳細については、レスポンス本文の拡張エラーメッセージを確認してください。 |
| エラー | sync_state_precondition_failed |
| メッセージ | The resource has been modified. Retrieve the resource again and retry (このリソースは変更されています。リソースをもう一度取得してから再試行してください) |
| 解決策 | 詳細については、レスポンス本文の拡張エラーメッセージを確認してください。 |
413 Request Entity Too Large
| エラー | request_entity_too_large |
| メッセージ | Request Entity too Large (リクエストのエンティティが大きすぎます) |
| 解決策 | アップロードのサイズが許容された上限を超えると、このエラーが発生します。レスポンス本文の拡張エラーメッセージを確認してください。 |
415 Unsupported Media Type
| エラー | unsupported_media_type |
| メッセージ | Previews for boxnote files are not yet supported. (boxnoteファイルのプレビューはサポートされていません。) |
| 解決策 | このエラーは、Box Noteの埋め込みプレビューをリクエストしたときに発生します。現時点では、埋め込みプレビューがBox Notesでサポートされていません。 |
429 Too Many requests
| エラー | rate_limit_exceeded |
| メッセージ | Request rate limit exceeded, try again later. (リクエストのレート制限を超えました。後でもう一度やり直してください。) |
| 解決策 | クライアントの処理が速すぎて、レート制限を受けました。クライアントでは、retry-afterヘッダーで指定された時間が経過してからリクエストをやり直すことが推奨されます。に注意する必要があります。 |
500 Internal Service Error
| エラー | internal_server_error |
| メッセージ | Internal Server Error (内部サーバーエラー) |
| 解決策 | クライアントは指数バックオフ戦略を使用してやり直す必要があります |
502 Bad Gateway
| エラー | bad_gateway |
| メッセージ | |
| 解決策 | クライアントは指数バックオフ戦略を使用してやり直す必要があります |
503 Unavailable
| エラー | unavailable |
| メッセージ | 利用できません |
| 解決策 | Retry-Afterヘッダーがレスポンスで返された場合、クライアントは、そのヘッダーの値に従ってリクエストを再試行する必要があります。稀に、クライアントが503のレスポンスを受け取った後も、書き込み操作が最終的にその変更を保持する可能性があるため、クライアントは、再試行時にこのケースを処理する必要があります。問題が引き続き発生する場合は、BoxのStatusサイトで、機能停止に関する既知の情報を確認してください。 |