> For the complete documentation index, see [llms.txt](https://manual.dxable.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://manual.dxable.com/1password/audit-events.md). # 1Password イベント 監査イベントの報告 1Password イベント API を使うと、監査イベント、アイテムの使用状況、サインイン試行など、1Password アカウントのアクティビティに関する情報を取得し、セキュリティ情報およびイベント管理 (SIEM) システムに送信できます。 ヒント [1password-events-api.yaml](https://i.1password.com/media/1password-events-reporting/1password-events-api.yaml)別のツールで API を表示するには、ファイルをダウンロードしてください。 ### 必要条件 1Password イベント API を使う前に、次のことを行う必要があります。 * [1Password Business にサインアップしてください](https://1password.com/business-security)。 * アカウントで[イベント レポート統合を設定します。](https://support.1password.com/events-reporting) * [ベアラー トークンをCreateし](https://support.1password.com/events-reporting/#appendix-issue-or-revoke-bearer-tokens)、アクセスできるイベント機能を選択します。 ### **APIについて** 1Password イベント API は、[ OpenAPI 3.0 仕様](https://spec.openapis.org/oas/latest.html)に準拠した REST スタイルの API です。クライアントとサーバー間の全ての通信は HTTPS 経由で行われます。 イベント API のテストと実装には、お好みの言語とツールを使用できます。このリファレンスでは、コマンド ラインで[curl を](https://curl.se/)使用してサンプル リクエストを示します。リクエスト内の値を独自の値に置き換えて、1Password アカウントのイベントに関する情報を受け取ることができます。 API は過去 120 日間のデータにアクセスできます。120 日以上前のデータにアクセスする必要がある場合は、[1Password アカウントのアクティビティ ログを使用](https://support.1password.com/activity-log/)できます。 #### **Request methods** イベント API は、次の標準 HTTP リクエスト メソッドを受け入れます。 * エンドポイントへの GET リクエストは、[introspect](https://developer.1password.com/docs/events-api/reference/#get-apiv2authintrospect)ベアラー トークンがアクセスできるイベントに関する情報を返します。 * [auditevents](https://developer.1password.com/docs/events-api/reference/#post-apiv1auditevents)、[itemusages](https://developer.1password.com/docs/events-api/reference/#post-apiv1itemusages)、[signinattempts](https://developer.1password.com/docs/events-api/reference/#post-apiv1signinattempts)エンドポイントへの POST リクエストは1Password アカウントのさまざまなアクティビティに関する情報を返します。どのエンドポイントが呼び出されるかに応じて、リクエストは次のいずれかを返します。 * 1Password アカウントへのサインインのCreate功と失敗 * アカウント内の共有金庫にSaveされているアイテムの使用に関する全ての情報 * アカウント内のチームメンバーが実行したアクションの監査イベント #### **Servers** API 呼び出しに使うベース URL は、1Password アカウントをホストするサーバーによって決まります。 | **アカウントがオンの場合:** | **ベース URL は次のとおりです:** | | ---------------- | ------------------------------------------------------------------------------------------------------- | | 1Password.com | (1Password ビジネス) (1Password エンタープライズ) | | 1Password.ca | | | 1Password.eu | | サービス ID ( events) とホスト サーバーがベース URL を形Createし、その後に呼び出すエンドポイントのパスが続きます。例えば、1Password.com のビジネス アカウントの監査イベントのリストを取得するには、次の URL を使用してエンドポイントを呼び出しますauditevents。 #### **Authorization** 1Password Events API への全ての呼び出しは、[ベアラー トークン](https://support.1password.com/events-reporting/#appendix-issue-or-revoke-bearer-tokens)を使用して承認される必要があります。認証のリクエストの[ヘッダー](https://developer.1password.com/docs/events-api/reference/#request-headers)にベアラー トークンを含める必要があります。 トークンは、トークンのCreate時にスコープされたイベントに応じて、1 つ以上のイベントのデータにアクセスすることを許可されます。使うベアラー トークンが、要求するイベントにアクセスできることを確認してください。これは、1Password アカウントの[統合](https://start.1password.com/integrations/active)セクションにあるイベント レポート統合の詳細から、または[イントロスペクション エンドポイントへの GET リクエスト](https://developer.1password.com/docs/events-api/reference/#get-apiv2authintrospect)を通じて確認できます。 #### **リクエストヘッダー** イベント API へのリクエストには正しいヘッダーが含まれている必要があります。 * Authorization: イベント API への各 GET および POST リクエストは、その機能のイベント データにアクセスするためのスコープが設定された[ベアラー トークンで承認される](https://developer.1password.com/docs/events-api/reference/#authorization)必要があります。承認ヘッダーにトークンを含めます。 * Content-Type: 各 POST リクエストにContent-Typeは、リクエスト本文で送信されるリソースのメディア タイプを示すヘッダーが必要です。Events API の全てのデータは JSON として送受信されるため、application/jsonコンテンツ タイプとして指定する必要があります。GET リクエストにはリクエスト本文が含まれていないため、このヘッダーは必要ありません。 リクエスト ヘッダーの例: Authorization: Bearer YOUR\_BEARER\_TOKEN Content-type: application/json #### **Pagination** イベント API はカーソルベースのページネーションを使用します。これは、大規模なデータセットの操Createに便利です。各リクエストに応答して、API はデータの取得を中断した場所を示す一意の ID (カーソル) を返します。次の呼び出しでは、そのカーソルを指定してデータセットの次のポイントからイベントの取得を続行できるため、レコードが失われることはありません。 API 呼び出しで使用されるカーソルには、[リセット カーソル](https://developer.1password.com/docs/events-api/reference/#reset-cursor)と[カーソル](https://developer.1password.com/docs/events-api/reference/#cursor)(継続カーソルとも呼ばれます) の 2 種類があります。 **Reset cursor** リセット カーソルは、API への最初のリクエストで使用され、データの取得を開始する新しいポイントをCreateします。また、カーソルのパラメータ (各リクエストで返すレコードの数など) をリセットする必要がある場合や、レコード内の前のポイントに戻る必要がある場合はいつでも、リセット カーソルを使用できます。 API に対して行う最初の POST リクエストでは、ResetCursorリクエスト本文に、オプションの開始時刻、終了時刻、制限パラメータを含むオブジェクトを含める必要があります。返される値にcursorは、API への次の呼び出しで使用できるレスポンス本文が含まれます。パラメータが指定されていない場合、API はスキーマに示されているデフォルト値を使用します。 例えば： **Example reset cursor request** { "limit": 100, "start\_time": "2023-03-15T16:32:50-03:00", "end\_time": "2023-03-15T17:32:50-03:00" } **ResetCursor object schema** | **名前** | **タイプ** | **説明** | | ---------------------------- | ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **limit*****（オプション）*** | **number** | **1 回のリクエストで返されるイベントの数。1 ～ 1000 の制限を指定します。指定しない場合は、limitデフォルトで 100 になります。追加のイベントを返すには、後続のリクエストのカーソル位置を使用します。** | | **start\_time*****（オプション）*** | **string** | **イベントの取得を開始する日時。RFC** [**3339 標準**](https://datatracker.ietf.org/doc/html/rfc3339)**を使用します。指定しない場合は、start\_time指定された時間の 1 時間前がデフォルトになりますend\_time。指定しない場合はend\_time、start\_time1 時間前がデフォルトになります。** | | **end\_time*****（オプション）*** | **string** | **イベントの取得を停止する日時。RFC** [**3339 標準**](https://datatracker.ietf.org/doc/html/rfc3339)**を使用します。** | **Cursor** API の呼び出しを継続するには、オブジェクトcursorの代わりに、前回の応答の を次の API 呼び出しのリクエスト本文に含めますResetCursor。これにより、データの欠落を回避するために、最後に指定された位置からデータの取得が開始されます。 **Example cursor** { "cursor": "aGVsbG8hIGlzIGl0IG1lIHlvdSBhcmUgbG9va2luZyBmb3IK" } **Cursor object schema** | **名前** | **タイプ** | **説明** | | ---------- | ---------- | --------------------------------------------------------------------------------------------------------------------------------------- | | **cursor** | **string** | **カーソルを使用して、利用可能な場合はさらにデータを取得するか、ポーリング プロセスを続行します。エンドポイントへの前の応答本文で返されたカーソルを使用します。例: aGVsbG8hIGlzIGl0IG1lIHlvdSBhcmUgbG9va2luZyBmb3IK。** | [Splunk](http://support.1password.com/events-reporting-splunk/)および[Elastic](http://support.1password.com/events-reporting-elastic/)用の 1Password イベント API アプリは、将来のリクエストのために位置をSaveしますcursor。 #### **レート制限** イベント API では、リクエストが 1 分あたり 600 件、1 時間あたり最大 30,000 件に制限されています。これらの制限を超えると、エラーが返されます。 429　Too many requests ### **GET /api/v2/auth/introspect** https\://\/api/v2/auth/introspect このエンドポイントへの GET 呼び出しは、監査イベント、アイテムの使用状況、サインイン試行など 1 つ以上を含む、ベアラー トークンがアクセスを許可されているイベント (機能) のリストを返します。 #### [**パラメータ**](https://developer.1password.com/docs/events-api/reference/#parameters) パラメータはありません。 #### [**リクエスト**](https://developer.1password.com/docs/events-api/reference/#requests) [ベアラー トークン](https://developer.1password.com/docs/events-api/reference/#authorization)と必要な[リクエスト ヘッダーを](https://developer.1password.com/docs/events-api/reference/#request-headers)introspect含むエンドポイントの完全な URL を使用します。GET リクエストには本文が含まれていないため、コンテンツ タイプ ヘッダーは必要ありません。 例えば： curl --request GET \\ \--url https\://\/api/v2/auth/introspect \\ \--header 'Authorization: Bearer YOUR\_BEARER\_TOKEN' #### **Responses** 200 Returns an Introspection object 400 Bad request 401 Unauthorized access 500 Internal server error Create功した200応答は、トークンに関する情報を含むIntrospectionオブジェクトを返します。 **Example introspection response** { "uuid": "OK41XEGLRTH4YKO5YRTCPNX3IU", "issued\_at": "2023-03-05T16:32:50-03:00", "features": \[ "auditevents", "itemusages", "signinattempts" ] } **Introspection object schema** | **名前** | **タイプ** | **説明** | | ---------- | ------- | -------------------------------------------------------------------------------------------------------------------- | | uuid | string | イベント レポート統合の UUID。 | | issued\_at | string | トークンが発行された日時。RFC [3339 標準](https://datatracker.ietf.org/doc/html/rfc3339)を使用します。 | | features | 文字列の配列 |

統合がアクセスできるイベント機能のリスト。可能な値は、次の 1 つ以上です。

  • auditevents
  • itemusages
  • signinattempts
| ### **POST /api/v1/auditevents** https\://\/api/v1/auditevents このエンドポイントへの POST 呼び出しは、1Password アカウント内のチーム メンバーによって実行されたアクションに関する情報を返します。イベントには、アクションがいつ、だれによって実行されたか、アクションの種類とオブジェクトに関する詳細、およびアクティビティに関するその他の情報が含まれます。[監査イベントの](https://developer.1password.com/docs/events-api/audit-events/)詳細については、こちらをご覧ください。 このエンドポイントには、機能を備えた[ベアラー トークンが](https://developer.1password.com/docs/events-api/reference/#authorization)auditevents必要です。APIへの[イントロスペクション呼び出しを](https://developer.1password.com/docs/events-api/reference/#get-apiv2authintrospect)実行して、トークンが監査イベントにアクセスする権限を持っているかどうかを確認できます。 #### **Parameters** パラメータはありません。 #### **Requests** [ベアラー トークン](https://developer.1password.com/docs/events-api/reference/#authorization)と必要な[リクエスト ヘッダー](https://developer.1password.com/docs/events-api/reference/#request-headers)auditeventsを含むエンドポイントの完全な URL を使用します。リクエスト本文には、 [ResetCursor](https://developer.1password.com/docs/events-api/reference/#reset-cursor)オブジェクトまたは以前の応答からの[カーソル](https://developer.1password.com/docs/events-api/reference/#cursor)を含める必要があります。 **Example audit events request with a reset cursor** $ curl --request POST \\ \--url \\ \--header 'Authorization: Bearer YOUR\_BEARER\_TOKEN' \\ \--header 'Content-Type: application/json' \\ \--data '{ "limit": 100, "start\_time": "2023-03-15T16:32:50-03:00" $}' **Example audit events request with a continuing cursor** $ curl --request POST \\ \--url \\ \--header 'Authorization: Bearer YOUR\_BEARER\_TOKEN' \\ \--header 'Content-Type: application/json' \\ \--data '{ "cursor":"aGVsbG8hIGlzIGl0IG1lIHlvdSBhcmUgbG9va2luZyBmb3IK" $}' #### **Responses** **Create**功した200応答は、カーソルのAuditEventItemsオブジェクトラッププロパティとAuditEventオブジェクトの配列を返します。含まれているカーソルを使用して、さらにデータを取得したり、ポーリング プロセスを続行したりできます。 200 Returns an AuditEventItems object 400 Bad request 401 Unauthorized access 500 Internal server error **Example audit event response** { "cursor": "aGVsbG8hIGlzIGl0IG1lIHlvdSBhcmUgbG9va2luZyBmb3IK", "has\_more": true "items": \[ { "uuid": "56YE2TYN2VFYRLNSHKPW5NVT5E", "timestamp": "2023-03-15T16:33:50-03:00", "actor\_uuid": "4HCGRGYCTRQFBMGVEGTABYDU2V", "actor\_details": { "uuid:": "4HCGRGYCTRQFBMGVEGTABYDU2V", "name": "Jeff Shiner", "email": "" }, "action": "join", "object\_type": "gm", "object\_uuid": "pf8soyakgngrphytsyjed4ae3u", "aux\_id": 9277034, "aux\_uuid": "K6VFYDCJKHGGDI7QFAXX65LCDY", "aux\_details": { "uuid": "K6VFYDCJKHGGDI7QFAXX65LCDY", "name": "Wendy Appleseed", "email": "" }, "aux\_info": "R", "session": { "uuid": "A5K6COGVRVEJXJW3XQZGS7VAMM", "login\_time": "2023-03-15T16:33:50-03:00", "device\_uuid": "lc5fqgbrcm4plajd8mwncv2b3u", "ip": "192.0.2.254" }, "location": { "country": "Canada", "region": "Ontario", "city": "Toronto", "latitude": 43.5991, "longitude": -79.4988 } } ] } **AuditEvent object schemas** **AuditEventItems オブジェクト**[**スキーマ**](https://developer.1password.com/docs/events-api/reference/#auditeventitems-object-schema) | **名前** | **タイプ** | **説明** | | ------------- | ---------- | -------------------------------------------------------------------------------------------------------------------- | | **cursor** | **string** | **より多くのイベント データを返すか、ポーリングを続行するためのカーソル。** | | **has\_more** | **ブール値** | **カーソルを使用して返されるデータがさらにあるかどうか。値が の場合true、さらにイベントがある可能性があります。値が の場合false、これ以上イベントはありません。** | | **items** | **配列** | [**AuditEvent オブジェクト**](https://developer.1password.com/docs/events-api/reference/#auditevent-object-schema)**の配列。** | **AuditEvent オブジェクト**[**スキーマ**](https://developer.1password.com/docs/events-api/reference/#auditevent-object-schema) | **名前** | **タイプ** | **説明** | | ------------------- | ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | **uuid** | **string** | **アクション イベントの UUID。** | | **timestamp** | **string** | **アクションが実行された日時。RFC** [**3339 標準**](https://datatracker.ietf.org/doc/html/rfc3339)**を使用します。** | | **actor\_uuid** | **string** | **アクションを実行したユーザーの UUID。** | | **actor\_details** | **object** | **アクター**[**の詳細オブジェクト**](https://developer.1password.com/docs/events-api/reference/#actor-details-object-schema)**。** | | **action** | **string** |

実行されたアクションの種類。可能な値は次のとおりです。

  • "activate"
  • "addgsso"
  • "begin"
  • "beginr"
  • "cancel"
  • "cancelr"
  • "changeks"
  • "changeks"
  • "changela"
  • "changemp"
  • "changenm"
  • "changesk"
  • "chngasso"
  • "chngdsso"
  • "chngpsso"
  • "complete"
  • "completr"
  • "convert"
  • "create"
  • "dealldev"
  • "delete"
  • "delgsso"
  • "delshare"
  • "deolddev"
  • "detchild"
  • "disblduo"
  • "disblmfa"
  • "disblsso"
  • "dlgsess"
  • "dvrfydmn"
  • "enblduo"
  • "enblmfa"
  • "enblsso"
  • "export"
  • "grant"
  • "hide"
  • "join"
  • "leave"
  • "musercom"
  • "muserdec"
  • "patch"
  • "propose"
  • "provsn"
  • "prsndall"
  • "purge"
  • "rdmchild"
  • "reactive"
  • "reauth"
  • "replace"
  • "replace"
  • "resendts"
  • "revoke"
  • "role"
  • "sdvcsso"
  • "sendpkg"
  • "sendts"
  • "share"
  • "ssotknv"
  • "suspend"
  • "tdvcsso"
  • "trename"
  • "trevoke"
  • "trvlaway"
  • "trvlback"
  • "tverify"
  • "uisas"
  • "unhide"
  • "unknown"
  • "updatduo"
  • "update"
  • "updatea"
  • "updatfw"
  • "updatmfa"
  • "upguest"
  • "uvrfydmn"
  • "verify"
  • "view"
  • "vrfydmn"

監査イベントのアクションについて学習します。

| | **object\_type** | **弦** |

アクションが実行されたオブジェクトのタイプ。可能な値は次のとおりです。

  • "account"
  • "card"
  • "device"
  • "dlgdsess"
  • "ec"
  • "famchild"
  • "file"
  • "gm"
  • "group"
  • "gva"
  • "invite"
  • "item"
  • "itemhist"
  • "items"
  • "miguser"
  • "pm"
  • "report"
  • "sa"
  • "satoken"
  • "slackapp"
  • "sso"
  • "ssotkn"
  • "sub"
  • "template"
  • "user"
  • "uva"
  • "vault"
  • "vaultkey"

監査イベント オブジェクトについて学習します。

| | **object\_uuid** | **string** | **アクションが実行されたオブジェクトの一意の識別子。** | | **object\_details** | **object** | **オブジェクト**[**の詳細オブジェクト**](https://developer.1password.com/docs/events-api/reference/#object-details-object-schema)**。オブジェクトがユーザーの場合に返されます。** | | **aux\_id** | **integer** | **アクティビティに関する追加情報を提供する人物または物の識別子。例えば、ユーザーがアカウントに追加またはアカウントから削除するデバイスの ID などです。** | | **aux\_uuid** | **string** | **アクティビティに関する追加情報を提供する、人物または物の一意の識別子。例えば、アカウント内のグループに参加または脱退するチーム メンバーの UUID などです。** | | **aux\_details** | **object** | [**補助詳細オブジェクト**](https://developer.1password.com/docs/events-api/reference/#aux-details-object-schema)**。補助詳細がユーザーに関連している場合に返されます。** | | **aux\_info** | **string** | **アクティビティに関する追加情報。** | | **session** | **object** | [**セッション**](https://developer.1password.com/docs/events-api/reference/#session-object-schema)**オブジェクト。** | | **location** | **object** | **イベントが実行された時点のクライアントの IP アドレスに基づいて、クライアントの地理的位置に関する詳細を含む場所**[**オブジェクト。**](https://developer.1password.com/docs/events-api/reference/#location-object-schema) | **アクター詳細オブジェクトスキーマ** | **名前** | **タイプ** | **説明** | | --------- | ---------- | ---------------------------- | | **uuid** | **string** | **アクションを実行したユーザーの UUID。** | | **name** | **string** | **アクションを実行したユーザーの名前。** | | **email** | **string** | **アクションを実行したユーザーのメール アドレス。** | **オブジェクトの詳細オブジェクトスキーマ** | **名前** | **タイプ** | **説明** | | --------- | ---------- | ----------------------------- | | **uuid** | **string** | **アクションの対象となるユーザーの UUID。** | | **name** | **string** | **アクションの対象となるユーザーの名前。** | | **email** | **string** | **アクションの対象となるユーザーのメール アドレス。** | **補助詳細オブジェクト**[**スキーマ**](https://developer.1password.com/docs/events-api/reference/#aux-details-object-schema) | **名前** | **タイプ** | **説明** | | --------- | ---------- | ----------------------------------------------------------------------------------------------------------------- | | **uuid** | **string** | **アクティビティに関する追加情報に関連するユーザーの UUID。例えば、アカウントまたは保管庫に追加された、またはアカウントまたは保管庫から削除されたユーザー、またはデバイスをCreateまたは削除したユーザーなどです。** | | **name** | **string** | **アクティビティに関する追加情報に関連するユーザーの名前。** | | **email** | **string** | **アクティビティに関する追加情報に関連するユーザーの電子メール アドレス。** | **セッション オブジェクトスキーマ** | **名前** | **タイプ** | **説明** | | ---------------- | ---------- | ---------------------------------------------------------------------------------------------------------- | | **uuid** | **string** | **セッションの UUID。** | | **login\_time** | **string** | **クライアントがサインインしてセッションを開始した日時。RFC** [**3339 標準**](https://datatracker.ietf.org/doc/html/rfc3339)**を使用します。** | | **device\_uuid** | **string** | **セッションにサインインしたデバイスの UUID。** | | **ip** | **string** | **セッションに使用される IP アドレス。** | **ロケーションオブジェクト**[**スキーマ**](https://developer.1password.com/docs/events-api/reference/#location-object-schema) | **名前** | **タイプ** | **説明** | | ------------- | ---------- | ------------------------------ | | **country** | **string** | **アクションが実行された国。** | | **region** | **string** | **アクションが実行された地域。** | | **city** | **string** | **アクションが実行された都市。** | | **longitude** | **number** | **アクションが実行された経度方向の位置を指定する座標。** | | **latitude** | **number** | **アクションが実行された場所の緯度位置を指定する座標。** | ### **POST /api/v1/itemusages** https\://\/api/v1/itemusages このエンドポイントへの POST 呼び出しは、共有保管庫内の変更、アクセス、または使用されたアイテムに関する情報を返します。イベントには、アイテムにアクセスしたユーザーの名前と IP アドレス、アイテムがアクセスされた日時、アイテムがSaveされている保管庫が含まれます。[アイテムの使用アクション](https://developer.1password.com/docs/events-api/item-usage-actions/)の詳細については、こちらをご覧ください。 このエンドポイントには、機能を備えた[ベアラー トークンが](https://developer.1password.com/docs/events-api/reference/#authorization)itemusages必要です。APIへの[イントロスペクション呼び出しを](https://developer.1password.com/docs/events-api/reference/#get-apiv2authintrospect)実行して、トークンがサインイン イベントへのアクセスを許可されているかどうかを確認できます。 #### **Parameters** パラメータはありません。 #### **Requests** [ベアラー トークン](https://developer.1password.com/docs/events-api/reference/#authorization)と必要な[リクエスト ヘッダー](https://developer.1password.com/docs/events-api/reference/#request-headers)itemusagesを含むエンドポイントの完全な URL を使用します。リクエスト本文には、 [ResetCursor](https://developer.1password.com/docs/events-api/reference/#reset-cursor)オブジェクトまたは以前の応答からの[カーソル](https://developer.1password.com/docs/events-api/reference/#cursor)を含める必要があります。 **Example item usage request with a reset cursor** $ curl --request POST \\ \--url \\ \--header 'Authorization: Bearer YOUR\_BEARER\_TOKEN' \\ \--header 'Content-Type: application/json' \\ \--data '{ "limit": 100, "start\_time": "2023-03-15T16:32:50-03:00" $ }' **Example item usage request with a continuing cursor** $ curl --request POST \\ \--url \\ \--header 'Authorization: Bearer YOUR\_BEARER\_TOKEN' \\ \--header 'Content-Type: application/json' \\ \--data '{ "cursor": "aGVsbG8hIGlzIGl0IG1lIHlvdSBhcmUgbG9va2luZyBmb3IK" $ }' #### **Responses**[**​**](https://developer.1password.com/docs/events-api/reference/#responses-2) 200 Returns an ItemUsage response object 400 Bad request 401 Unauthorized access 500 Internal server error Create功した200応答は、ItemUsageItemsオブジェクトラップカーソルプロパティとItemUsageオブジェクト配列を返します。含まれているカーソルを使用して、さらにデータを取得したり、ポーリング プロセスを続行したりできます。 応答には、さらにデータを取得し続けるか、次回リクエストを行うときに使うためのカーソルも含まれます。 **Example item usage response** { "cursor": "aGVsbG8hIGlzIGl0IG1lIHlvdSBhcmUgbG9va2luZyBmb3IK", "has\_more": true "items": \[ { "uuid": "56YE2TYN2VFYRLNSHKPW5NVT5E", "timestamp": "2023-03-15T16:33:50-03:00", "used\_version": 0, "vault\_uuid": "VZSYVT2LGHTBWBQGUJAIZVRABM", "item\_uuid": "SDGD3I4AJYO6RMHRK8DYVNFIDZ", "user": { "uuid": "4HCGRGYCTRQFBMGVEGTABYDU2V", "name": "Wendy Appleseed", "email": "" }, "client": { "app\_name": "1Password Browser", "app\_version": "20240", "platform\_name": "Chrome", "platform\_version": "string", "os\_name": "MacOSX", "os\_version": "13.2", "ip\_address": "192.0.2.254" }, "location": { "country": "Canada", "region": "Ontario", "city": "Toronto", "latitude": 43.5991, "longitude": -79.4988 }, "action": "secure-copy" } ] } **ItemUsage object schemas** **ItemUsageItems オブジェクト**[**スキーマ**](https://developer.1password.com/docs/events-api/reference/#itemusageitems-object-schema) | **名前** | **タイプ** | **説明** | | ------------- | ---------- | ------------------------------------------------------------------------------------------------------------------ | | **items** | **array** | [**ItemUsage オブジェクト**](https://developer.1password.com/docs/events-api/reference/#itemusage-object-schema)**の配列。** | | **cursor** | **string** | **より多くのイベント データを返すか、ポーリングを続行するためのカーソル。** | | **has\_more** | **ブール値** | **カーソルを使用して返されるデータがさらにあるかどうか。値が の場合true、さらにイベントがある可能性があります。値が の場合false、これ以上イベントはありません。** | **ItemUsage オブジェクト**[**スキーマ**](https://developer.1password.com/docs/events-api/reference/#itemusage-object-schema) | **名前** | **タイプ** | **説明** | | ----------------- | ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **uuid** | **string** | **イベントの UUID。** | | **timestamp** | **string** | **イベントの日時。RFC** [**3339 標準**](https://datatracker.ietf.org/doc/html/rfc3339)**。** | | **used\_version** | **integer** | **アクセスされたアイテムのバージョン。** | | **vault\_uuid** | **string** | **アイテムが格納されている保管庫の UUID。** | | **item\_uuid** | **string** | **アクセスされたアイテムの UUID。** | | **action** | **string** |

アイテムの使用方法に関する詳細。アクションは、1Password 8.4.0 以降を使用しているクライアント アプリからのみキャプチャされます。可能な値は次のとおりです。

  • "enter-item-edit-mode"
  • "export"
  • "fill"
  • "other"
  • "reveal"
  • "secure-copy"
  • "select-sso-provider"
  • "server-create"
  • "server-fetch"
  • "server-update"
  • "share"

アイテムの使用アクションについて学習します。

| | **user** | **object** | **ユーザー**[**オブジェクト**](https://developer.1password.com/docs/events-api/reference/#user-object-schema)**。** | | **client** | **object** | **クライアント**[**オブジェクト**](https://developer.1password.com/docs/events-api/reference/#client-object-schema)**。** | | **location** | **object** | **イベントが実行された時点のクライアントの IP アドレスに基づいて、クライアントの地理的位置に関する詳細を含む場所**[**オブジェクト。**](https://developer.1password.com/docs/events-api/reference/#location-object-schema-1) | **ユーザー オブジェクトスキーマ** | **名前** | **タイプ** | **説明** | | --------- | ---------- | ----------------------------------------------- | | **uuid** | **string** | **アイテムにアクセスした、またはアカウントにサインインしようとしたユーザーの UUID。** | | **name** | **string** | **イベントが生Createされた時点で取得されたユーザーの名前。** | | **email** | **string** | **イベントが生Createされた時点で取得されたユーザーの電子メール アドレス。** | **クライアント オブジェクトスキーマ** | **名前** | **タイプ** | **説明** | | --------------------- | ---------- | -------------------------------------------------------------------------------------------- | | **app\_name** | **string** | **アイテムにアクセスした 1Password アプリの名前。** | | **app\_version** | **string** | **アプリのバージョン番号。** | | **platform\_name** | **string** | **アイテムにアクセスしたプラットフォームの名前。** | | **platform\_version** | **string** | **1Password がインストールされているブラウザまたはコンピュータのバージョン、または 1Password コマンドライン ツールがインストールされているマシンの CPU。** | | **os\_name** | **string** | **アイテムにアクセスしたオペレーティング システムの名前。** | | **os\_version** | **string** | **アイテムにアクセスしたオペレーティング システムのバージョン。** | | **ip\_address** | **string** | **アイテムにアクセスした IP アドレス。** | **ロケーションオブジェクトスキーマ** | **名前** | **タイプ** | **説明** | | ------------- | ---------- | ------------------------------- | | **country** | **string** | **アイテムにアクセスした国。** | | **region** | **string** | **アイテムがアクセスされた地域。** | | **city** | **string** | **アイテムにアクセスした都市。** | | **longitude** | **number** | **アイテムがアクセスされた経度方向の位置を指定する座標。** | | **latitude** | **number** | **アイテムがアクセスされた緯度位置を指定する座標。** | ### **POST /api/v1/ signinattempts** https\://\/api/v1/signinattempts このエンドポイントへの POST 呼び出しは、サインイン試行に関する情報を返します。イベントには、アカウントへのサインインを試行したユーザーの名前と IP アドレス、試行が行われた日時、失敗した試行の場合は失敗の原因が含まれます。 このエンドポイントには、機能を備えた[ベアラー トークンが](https://developer.1password.com/docs/events-api/reference/#authorization)signinattempts必要です。APIへの[イントロスペクション呼び出しを](https://developer.1password.com/docs/events-api/reference/#get-apiv2authintrospect)実行して、トークンがサインイン イベントへのアクセスを許可されているかどうかを確認できます。 #### **Parameters**[**​**](https://developer.1password.com/docs/events-api/reference/#parameters-3) パラメータはありません。 #### **Requests** [ベアラー トークン](https://developer.1password.com/docs/events-api/reference/#authorization)と必要な[リクエスト ヘッダー](https://developer.1password.com/docs/events-api/reference/#request-headers)signinattemptsを含むエンドポイントの完全な URL を使用します。リクエスト本文には、 [ResetCursor](https://developer.1password.com/docs/events-api/reference/#reset-cursor)オブジェクトまたは以前の応答からの[カーソルを含める必要があります。](https://developer.1password.com/docs/events-api/reference/#cursor) **Example request with a reset cursor** $ curl --request POST \\ \--url \\ \--header 'Authorization: Bearer YOUR\_BEARER\_TOKEN' \\ \--header 'Content-Type: application/json' \--data '{ "limit": 100, "start\_time": "2023-03-15T16:32:50-03:00" $ }' **Example request with a continuing cursor** $ curl --request POST \\ \--url \\ \--header 'Authorization: Bearer YOUR\_BEARER\_TOKEN' \\ \--header 'Content-Type: application/json' \--data '{ "cursor": "aGVsbG8hIGlzIGl0IG1lIHlvdSBhcmUgbG9va2luZyBmb3IK" $ }' #### **Responses**[**​**](https://developer.1password.com/docs/events-api/reference/#responses-3) 200 Returns a SigninAttempts object 400 Bad request 401 Unauthorized access 500 Internal server error Create功した応答は、カーソルのプロパティとオブジェクトの配列をラップするオブジェクト200を返します。含まれているカーソルを使用して、さらにデータを取得したり、ポーリング プロセスを続行したりできます。SignInAttemptItemsSignInAttempts **Example sign-in attempt response** { "cursor": "aGVsbG8hIGlzIGl0IG1lIHlvdSBhcmUgbG9va2luZyBmb3IK", "has\_more": true, "items": \[ { "uuid": "56YE2TYN2VFYRLNSHKPW5NVT5E", "session\_uuid": "A5K6COGVRVEJXJW3XQZGS7VAMM", "timestamp": "2023-03-15T16:32:50-03:00", "category": "firewall\_failed", "type": "continent\_blocked", "country": "France", "details": { "value": "Europe" }, "target\_user": { "uuid": "IR7VJHJ36JHINBFAD7V2T5MP3E", "name": "Wendy Appleseed", "email": "" }, "client": { "app\_name": "1Password Browser", "app\_version": "20240", "platform\_name": "Chrome", "platform\_version": "string", "os\_name": "MacOSX", "os\_version": "13.2", "ip\_address": "192.0.2.254" }, "location": { "country": "Canada", "region": "Ontario", "city": "Toronto", "latitude": 43.5991, "longitude": -79.4988 } } ] } **SignInAttempts object schemas** **SignInAttemptItems オブジェクトスキーマ** | **名前** | **タイプ** | **説明** | | ------------- | ---------- | ---------------------------------------------------------------------------------------------------------------------------- | | **items** | **array** | [**SignInAttempts オブジェクト**](https://developer.1password.com/docs/events-api/reference/#signinattempts-object-schema)**の配列。** | | **cursor** | **string** | **より多くのイベント データを返すか、ポーリングを続行するためのカーソル。** | | **has\_more** | **ブール値** | **カーソルを使用して返されるデータがさらにあるかどうか。値が の場合true、さらにイベントがある可能性があります。値が の場合false、これ以上イベントはありません。** | **SignInAttempts オブジェクト**[**スキーマ**](https://developer.1password.com/docs/events-api/reference/#signinattempts-object-schema) | **名前** | **タイプ** | **説明** | | ----------------- | ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **uuid** | **string** | **イベントの UUID。** | | **session\_uuid** | **string** | **イベントをCreateしたセッションの UUID。** | | **timestamp** | **string** | **サインイン試行の日時。RFC** [**3339 標準**](https://datatracker.ietf.org/doc/html/rfc3339)**を使用します。** | | **category** | **string** |

サインイン試行のカテゴリ。可能な値は次のとおりです。

  • "success"
  • "credentials\_failed"
  • "mfa\_failed"
  • "sso\_failed"
  • "modern\_version\_failed"
  • "firewall\_failed"
  • "firewall\_reported\_success"
| | **type** | **string** |

サインイン試行に関する詳細。可能な値は次のとおりです。

  • "credentials\_ok"
  • "mfa\_ok"
  • "password\_secret\_bad"
  • "mfa\_missing"
  • "totp\_disabled"
  • "totp\_bad"
  • "totp\_timeout"
  • "u2f\_disabled"
  • "u2f\_bad"
  • "u2f\_timeout"
  • "duo\_disabled"
  • "duo\_bad"
  • "duo\_timeout"
  • "duo\_native\_bad"
  • "service\_account\_sso\_denied"
  • "non\_sso\_user"
  • "sso\_user\_mismatch"
  • "platform\_secret\_disabled"
  • "platform\_secret\_bad"
  • "platform\_secret\_proxy"
  • "code\_disabled"
  • "code\_bad"
  • "code\_timeout"
  • "ip\_blocked"
  • "continent\_blocked"
  • "country\_blocked"
  • "anonymous\_blocked"
  • "all\_blocked"
  • "modern\_version\_missing"
  • "modern\_version\_old"
| | **country** | **string** | **イベントの国コード。ISO** [**3166 標準**](https://www.iso.org/iso-3166-country-codes.html)**を使用します。** | | **details** | **object** | **サインイン試行に関する追加情報が含まれる**[**詳細オブジェクト**](https://developer.1password.com/docs/events-api/reference/#details-object-schema)**。** | | **target\_user** | **object** | **ユーザー**[**オブジェクト**](https://developer.1password.com/docs/events-api/reference/#user-object-schema-1)**。** | | **client** | **object** | **クライアント**[**オブジェクト**](https://developer.1password.com/docs/events-api/reference/#client-object-schema-1)**。** | | **location** | **object** | **イベントが実行された時点のクライアントの IP アドレスに基づいて、クライアントの地理的位置に関する詳細を含む場所**[**オブジェクト。**](https://developer.1password.com/docs/events-api/reference/#location-object-schema-2) | **詳細オブジェクトスキーマ** | **名前** | **タイプ** | **説明** | | --------- | ---------- | ------------------------------------------------------------------------------------------------------------------------- | | **value** | **string** | **サインイン試行に関する追加情報 (ユーザーのサインインを妨げるファイアウォール ルールなど)。例えば、サインイン試行がファイアウォール ルールによってブロックされた場合、値はサインイン試行の国、大陸、または IP アドレスになります。** | **ユーザー オブジェクト**[**スキーマ**](https://developer.1password.com/docs/events-api/reference/#user-object-schema-1) | **名前** | **タイプ** | **説明** | | --------- | ---------- | ----------------------------------------------- | | **uuid** | **string** | **アイテムにアクセスした、またはアカウントにサインインしようとしたユーザーの UUID。** | | **name** | **string** | **イベントが生Createされた時点で取得されたユーザーの名前。** | | **email** | **string** | **イベントが生Createされた時点で取得されたユーザーの電子メール アドレス。** | **クライアント オブジェクト**[**スキーマ**](https://developer.1password.com/docs/events-api/reference/#client-object-schema-1) | **名前** | **タイプ** | **説明** | | --------------------- | ---------- | -------------------------------------------------------------------------------------------- | | **app\_name** | **string** | **アイテムにアクセスした 1Password アプリの名前。** | | **app\_version** | **string** | **アプリのバージョン番号。** | | **platform\_name** | **string** | **アイテムにアクセスしたプラットフォームの名前。** | | **platform\_version** | **string** | **1Password がインストールされているブラウザまたはコンピュータのバージョン、または 1Password コマンドライン ツールがインストールされているマシンの CPU。** | | **os\_name** | **string** | **アイテムにアクセスしたオペレーティング システムの名前。** | | **os\_version** | **string** | **アイテムにアクセスしたオペレーティング システムのバージョン。** | | **ip\_address** | **string** | **アイテムにアクセスした IP アドレス。** | **ロケーションオブジェクト**[**スキーマ**](https://developer.1password.com/docs/events-api/reference/#location-object-schema-2) | **名前** | **タイプ** | **説明** | | ------------- | ---------- | ------------------------------- | | **country** | **string** | **サインインが試行された国。** | | **region** | **string** | **サインインが試行された地域。** | | **city** | **string** | **サインインが試行された都市。** | | **longitude** | **number** | **サインイン試行が行われた経度方向の位置を指定する座標。** | | **latitude** | **number** | **サインインが試行された緯度の場所を指定する座標。** | ### **ErrorResponseオブジェクト** **Example error response** { status: 401, message: "Unauthorized access" } **ErrorResponse object schema** | **名前** | **タイプ** | **説明** | | ------- | ------- | ----------------- | | status | integer | THTTP ステータス コード。. | | message | string | エラーの詳細を示すメッセージ。 |