エラー

APIは、すべての操作に対して標準のHTTP成功またはエラーステータスコードを返します。エラーの場合、応答には対応するエラーコード、エラーの原因を説明する短いメッセージ、およびオプションでそのエラーに固有の情報を伝える追加のフィールドが含まれます。

ステータスコード

コード	名	説明
200	OK	要求は正常に処理されました。
201	作成した	要求は正常に処理され、新しいリソースインスタンスが作成されました。
400	要求の形式が正しくありません	何らかの理由で不正な形式のため、APIは要求を処理できませんでした。
401	無許可	APIは要求内に有効な資格情報を見つけることができませんでした。
403	禁じられている	提供された資格情報には、要求を実行するための十分な権限がありません。
404	見つかりません	要求されたリソースが見つかりません。
429	リクエストが多すぎる	レート制限に達したため、要求は処理されていません。
5xx	サーバーエラー	イベントの処理中に予期しないエラーが発生しました。

エラーコード

invalid-body

APIはリクエストの本文を処理できませんでした。リクエストボディが有効なJSONであることを確認してください。

invalid-parameter

リクエストボディの1つ以上のパラメータが検証チェックに合格しませんでした。この応答には、問題のパラメータに関する詳細を含むparams属性が含まれます。

unconfigured

あなたの組織は、APIがこのリクエストを完了するのに必要な設定を持っていません。メッセージには、どの構成が欠落しているかに関する詳細が含まれます。

missing-scope

組織、キー、または現在のユーザーには、この要求を実行するために必要な権限の範囲がありません。

session-expired

このリクエストに使用しようとしているセッションは、APIによって期限切れとしてマークされています。先に進む前に、新しい有効なセッションを作成する必要があります。

invalid-credentials

提供された資格情報が外部サービスによって拒否されました。ソースが存在しない（つまり無効なユーザー名）か、資格情報のペイロードが間違っている（パスワードが間違っているなど）。

source-locked

ソースは外部サービスによってロックされており、ユーザーによってロック解除されるまでAPIからアクセスすることはできません。 APIメッセージは、関連サービスに対してこれを行う方法についての指示を提供します。

code-required

セッションを作成しようとしているソースは、多要素認証（MFA）が有効になっています。 APIによってMFAプロセスが起動されます。次回のセッション作成では、このプロセス中に表示されたコードを提供する必要があります。

セッション作成フローの詳細については、アクセスしようとしているサービスのサービスリファレンスを参照してください。

choice-required

アクセスしようとしているソースは、2段階認証（2SV）が有効になっている、多要素認証（MFA）のサブセットです。このレスポンスの一環として、APIは2SVプロセスをトリガーできるデバイスのリストを提供します。このデバイスは、プロセスの次のステップに必要となる2SVコードを受け取ります。

セッション作成フローの詳細については、アクセスしようとしているサービスのサービスリファレンスを参照してください。

task-error

これは一般的なタスクエラーです。より多くのエラーを特定のカテゴリに入れるための作業はまだ進行中です。