IDクレデンシャル侵害 GraphQL API🔗
Query🔗
説明: 公開クエリ
フィールド🔗
| フィールド | 型 | 説明 | 引数 |
|---|---|---|---|
| breaches | BreachesResponse | 指定されたクエリオプションに基づき、侵害されたIDを返します。 | query: BreachesQuery, sorting: BreachesSorting, paging: BreachesPaging |
| breachesFacets | BreachesFacets | 侵害されたIDのクエリパラメータごとのファセットごとの集計数を返します。現在のテナントコンテキストに制限されます。 | query: BreachesQuery |
| identityCompromiseMetrics | IdentityCompromiseMetrics | 指定されたクエリオプションに基づき、ID侵害のメトリクスを取得します。 | input: IdentityCompromiseMetricsQuery |
| identityCompromiseMonitoredDomains | String | ID侵害のために現在監視されているドメインを返します。 | |
| availableIdentityCompromiseDomains | PotentialCompromiseDomain | 監視可能な潜在的な侵害ドメインを返します。 | limit: Int |
| numAllowedIdentityCompromiseDomains | Int64 | 現在のテナントがID侵害のために監視できるドメイン数を返します。 | |
| vipInfo | VIP | 特定のIDに対するVIP（Very Important Person）監視情報を返します。IDがVIPとして設定されていない場合はnullを返します。 | externalId: String |
| vipInfos | VIPsQueryResponse | 複数のIDに対するVIP（Very Important Person）監視情報を返します。 | query: VIPsQuery |
String🔗
説明: Stringスカラ型は、UTF-8文字列として表現されるテキストデータを表します。String型は、GraphQLで自由形式の人間が読めるテキストを表現するために最もよく使用されます。
Int🔗
説明: Intスカラ型は、小数点を含まない符号付き整数値を表します。Intは-(2^31)から2^31 - 1までの値を表現できます。
Mutation🔗
説明: 公開ミューテーション
フィールド🔗
| フィールド | 型 | 説明 | 引数 |
|---|---|---|---|
| setIdentityCompromiseMonitoredDomains | Boolean | 現在監視されているドメインを指定されたドメインリストで置き換えます。numAllowedIdentityCompromiseDomainsまでのみ設定可能です。 | domains: String |
| upsertVIP | Boolean | IDに対するVIP（Very Important Person）監視情報を作成または更新します。これにより、重要なIDに対する強化されたクレデンシャル漏洩監視が有効になります。VIP情報が正常に作成または更新された場合はtrueを返します。 | vip: VIPInput |
| deleteVIP | Boolean | IDからVIP（Very Important Person）ステータスを削除します。これにより、指定したIDの強化監視が停止されます。VIPステータスが正常に削除された場合はtrue、IDがVIPでなかった場合はfalseを返します。 | externalId: String |
Boolean🔗
説明: Booleanスカラ型は、trueまたはfalseを表します。
Time🔗
説明: タイムスタンプ型。
Duration🔗
説明: 期間型。
Int64🔗
説明: 64ビット整数用のスカラ型。
IdentityCompromiseMetricsQuery🔗
説明: IdentityCompromiseMetricsのクエリオプション。
フィールド🔗
| フィールド | 型 | 説明 | 引数 |
|---|---|---|---|
| startTime | Time | メトリクスの開始時刻（含む）。指定しない場合は30日前がデフォルトです。 | |
| endTime | Time | メトリクスの終了時刻（含まない）。指定しない場合は現在時刻がデフォルトです。 | |
| interval | Duration | メトリクスの間隔。指定しない場合は1日がデフォルトです。 |
IdentityCompromiseMetrics🔗
説明: IdentityCompromiseMetrics型は、監視対象ドメインのID侵害イベントに関する集計メトリクスを表します。
フィールド🔗
| フィールド | 型 | 説明 | 引数 |
|---|---|---|---|
| activeBreaches | CompromiseMetric | アクティブな侵害の数 | |
| plaintextPasswords | CompromiseMetric | 侵害されたアカウントの数 | |
| hashedPasswords | CompromiseMetric | ハッシュ化されたパスワードの数 | |
| uniquePasswords | CompromiseMetric | 一意のパスワードの数 | |
| breachSources | CompromiseMetric | 侵害ソースの数 | |
| breachedAccounts | CompromiseMetric | 侵害されたアカウントの数 | |
| breachedAdminAccounts | CompromiseMetric | 侵害された管理者アカウントの数 | |
| avgBreachesPerDomain | CompromiseMetric | ドメインごとの平均侵害数 |
CompromiseMetricUnit🔗
説明: CompromiseMetricUnitは、メトリクスが計算された単位を定義します。
CompromiseMetric🔗
説明: CompromiseMetric UIコンポーネントを表す型。
フィールド🔗
| フィールド | 型 | 説明 | 引数 |
|---|---|---|---|
| value | Float | コンポーネントの最新値 | |
| percentChange | Float | 指定期間における変化率 | |
| sparklineData | Float | コンポーネントのスパークラインデータ（間隔ごとに1つの数値） | |
| unit | CompromiseMetricUnit | メトリクスの単位 |
Float🔗
説明: Floatスカラ型は、IEEE 754で指定された符号付き倍精度浮動小数点値を表します。
PotentialCompromiseDomain🔗
説明: ID侵害監視に使用できるメールドメイン。
フィールド🔗
| フィールド | 型 | 説明 | 引数 |
|---|---|---|---|
| domain | String | ドメイン | |
| userCount | Int64 | このドメインを持つユーザー数 |
BreachesSort🔗
説明: 侵害レコードのソートに利用可能なフィールド。
BreachesSortOrder🔗
説明: 侵害レコードのソート順。
BreachesSorting🔗
説明: 侵害レコード取得時のソートパラメータ設定用。
フィールド🔗
| フィールド | 型 | 説明 | 引数 |
|---|---|---|---|
| sortBy | BreachesSort | 侵害のソート対象フィールド | |
| sortOrder | BreachesSortOrder | 侵害のソート順 |
BreachesPaging🔗
説明: 侵害レコード取得時のページングパラメータ設定用。
フィールド🔗
| フィールド | 型 | 説明 | 引数 |
|---|---|---|---|
| limit | Int64 | ページングの上限値。デフォルトは100。最大値は500。500を超える場合は500、0以下の場合は100がデフォルトとなります。 | |
| offset | Int64 | ページングのオフセット。デフォルトは0。 |
BreachesStringFacet🔗
説明: 文字列型ファセットの返却用。
フィールド🔗
| フィールド | 型 | 説明 | 引数 |
|---|---|---|---|
| value | String | ファセットの一意の値 | |
| label | String | 値の人間が読めるラベル | |
| count | Int64 | 一意の値の件数 |
BreachesBooleanFacet🔗
説明: ブール型ファセットの返却用。
フィールド🔗
| フィールド | 型 | 説明 | 引数 |
|---|---|---|---|
| value | Boolean | ファセットの一意の値 | |
| count | Int64 | 一意の値の件数 |
BreachStatus🔗
説明: 侵害のステータスを表します。
BreachesBreachStatusFacet🔗
説明: BreachStatus型ファセットの返却用。
フィールド🔗
| フィールド | 型 | 説明 | 引数 |
|---|---|---|---|
| value | BreachStatus | ファセットの一意の値 | |
| count | Int64 | 一意の値の件数 |
BreachPasswordType🔗
説明: 侵害のパスワードタイプを表します。
BreachesPasswordTypeFacet🔗
説明: BreachPasswordTypeファセットの返却用。
フィールド🔗
| フィールド | 型 | 説明 | 引数 |
|---|---|---|---|
| value | BreachPasswordType | ファセットの一意の値 | |
| count | Int64 | 一意の値の件数 |
BreachesFacets🔗
説明: 一意のファセット値とその関連件数の返却用。
フィールド🔗
| フィールド | 型 | 説明 | 引数 |
|---|---|---|---|
| breachSource | BreachesStringFacet | 侵害ソースごとの一意値と件数 | |
| breachStatus | BreachesBreachStatusFacet | 侵害ステータスごとの一意値と件数 | |
| username | BreachesStringFacet | ユーザー名ごとの一意値と件数 | |
| passwordType | BreachesPasswordTypeFacet | パスワードタイプごとの一意値と件数 | |
| domain | BreachesStringFacet | ドメインごとの一意値と件数 | |
| status | BreachesStringFacet | IDステータスごとの一意値と件数 | |
| department | BreachesStringFacet | ID部門ごとの一意値と件数 | |
| employeeType | BreachesStringFacet | 従業員タイプごとの一意値と件数 | |
| isAdmin | BreachesBooleanFacet | isAdminごとの一意値と件数 | |
| isStale | BreachesBooleanFacet | isStaleごとの一意値と件数 | |
| hasMfa | BreachesBooleanFacet | hasMfaごとの一意値と件数 | |
| hasPasswordLessMfa | BreachesBooleanFacet | hasPasswordLessMfaごとの一意値と件数 | |
| primaryMfaMethod | BreachesStringFacet | プライマリMFA方式ごとの一意値と件数 | |
| country | BreachesStringFacet | 国ごとの一意値と件数 |
BreachSource🔗
説明: 侵害レコードのソースを表します。
フィールド🔗
| フィールド | 型 | 説明 | 引数 |
|---|---|---|---|
| id | String | 侵害ソースのID | |
| source | String | 侵害ソースのデータソース | |
| title | String | 侵害ソースのタイトル | |
| description | String | 侵害ソースの説明 | |
| breachDate | Time | 侵害が発生した日付 | |
| leakedDate | Time | 侵害でクレデンシャルが漏洩した日付 | |
| relatedUrls | String | 侵害ソースの関連URL | |
| createdAt | Time | BreachSourceレコードが作成された日付 | |
| updatedAt | Time | BreachSourceレコードが最終更新された日付 |
BreachesQuery🔗
説明: 侵害レコードのクエリ用。
フィールド🔗
| フィールド | 型 | 説明 | 引数 |
|---|---|---|---|
| breachSourceIDs | ID | 侵害ソースで侵害レコードをクエリするために使用 | |
| identityIDs | ID | IDで侵害レコードをクエリするために使用 | |
| breachStatus | BreachStatus | 侵害ステータスで侵害レコードをクエリするために使用 | |
| usernames | String | 侵害されたユーザー名で侵害レコードをクエリするために使用 | |
| passwordTypes | BreachPasswordType | 侵害されたパスワードタイプで侵害レコードをクエリするために使用 | |
| domains | String | クレデンシャルが漏洩したドメインで侵害レコードをクエリするために使用 | |
| status | String | 関連IDのステータスで侵害レコードをクエリするために使用（利用可能な場合） | |
| departments | String | 関連IDの部門で侵害レコードをクエリするために使用（利用可能な場合） | |
| isAdmin | Boolean | 関連IDが管理者またはゲストかどうかで侵害レコードをクエリするために使用 | |
| isStale | Boolean | 関連IDが古いかどうかで侵害レコードをクエリするために使用 | |
| hasMfa | Boolean | 関連IDがMFAを持つかどうかで侵害レコードをクエリするために使用 | |
| hasPasswordlessMfa | Boolean | 関連IDがパスワードレスMFAを持つかどうかで侵害レコードをクエリするために使用 | |
| primaryMfaMethods | String | 関連IDのプライマリMFA方式で侵害レコードをクエリするために使用 | |
| employeeTypes | String | 関連IDの従業員タイプで侵害レコードをクエリするために使用 | |
| countries | String | 関連IDの国で侵害レコードをクエリするために使用 | |
| publishDateRange | IdentityCompromiseTimeRange | publishDateフィールドで侵害レコードをクエリするために使用 | |
| breachDateRange | IdentityCompromiseTimeRange | breachDateフィールドで侵害レコードをクエリするために使用 | |
| fuzzy | String | 侵害ユーザー名、ドメイン、侵害ソースに対してあいまい検索を実行するために使用 |
ID🔗
説明: IDスカラ型は一意の識別子を表し、オブジェクトの再取得やキャッシュのキーとしてよく使用されます。ID型はJSONレスポンスではStringとして現れますが、人間が読めることを意図していません。入力型として期待される場合、任意の文字列（例: "4"）や整数（例: 4）がIDとして受け入れられます。
IdentityCompromiseTimeRange🔗
説明: 時間範囲を記述するためのコンテナ。
フィールド🔗
| フィールド | 型 | 説明 | 引数 |
|---|---|---|---|
| start | Time | 時間範囲の開始時刻（含む） | |
| end | Time | 時間範囲の終了時刻（含む） |
BreachesResponse🔗
説明: 侵害レコードのリスト返却用コンテナ。
フィールド🔗
| フィールド | 型 | 説明 | 引数 |
|---|---|---|---|
| total | Int64 | 利用可能なレコードの総数 | |
| breaches | Breach | 指定されたクエリ・ページング・ソートパラメータで返された侵害レコードのリスト |
Breach🔗
説明: IDの侵害を記述するために使用。
フィールド🔗
| フィールド | 型 | 説明 | 引数 |
|---|---|---|---|
| thirdpartyId | String | 侵害のサードパーティID。この値は侵害が現れた行番号と一致します。 | |
| date | Time | 侵害の日付。 | |
| source | BreachSource | 侵害のソース。 | |
| domain | String | 侵害が発生したドメイン。 | |
| username | String | 侵害されたユーザー名。 | |
| isActive | Boolean | 侵害が現在アクティブかどうかを示します。 | |
| plaintextPassword | Boolean | 侵害でクレデンシャルパスワードが平文で漏洩したかどうかを示します。 | |
| hashPassword | Boolean | 侵害でクレデンシャルパスワードのハッシュが漏洩したかどうかを示します。 | |
| publishDate | Time | 侵害が公開された日付。 | |
| identity | Identity | 侵害に関連付けられた侵害ID。 | |
| tenant | TenantV4 | 侵害レコードのテナント。 | |
| createdAt | Time | 侵害レコードが作成された日付。 | |
| updatedAt | Time | 侵害レコードが最終更新された日付。 | |
| inactiveAt | Time | nullでない場合、侵害が非アクティブになった日付。 | |
| maskedPassword | String | マスクされたパスワード。UIでパスワードを安全に表示するための文字列。 |
IdentityProvider🔗
説明: 外部IDを管理するIDプロバイダーを表します。この型はフェデレーテッドであり、他のサービスで管理されるIDプロバイダーデータへの参照として機能します。
フィールド🔗
| フィールド | 型 | 説明 | 引数 |
|---|---|---|---|
| id | ID | IDプロバイダーの一意識別子 |
Identity🔗
説明: 侵害される可能性のある外部IDを表します。この型はフェデレーテッドであり、identitiesサービスのIdentity型を拡張してアイコンおよびタグ情報を含みます。
フィールド🔗
| フィールド | 型 | 説明 | 引数 |
|---|---|---|---|
| externalId | String | IDの一意の外部識別子 | |
| provider | IdentityProvider | このIDを管理するプロバイダー |
TenantV4🔗
説明: APIバージョン4のテナントエンティティを表します。この型は外部参照として使用され、このサービス内では解決できません。テナントは一意のIDで識別され、フェデレーテッドエンティティキーとして機能します。
フィールド🔗
| フィールド | 型 | 説明 | 引数 |
|---|---|---|---|
| id | ID | テナントの一意識別子 |
VIP🔗
説明: IDに対するVIP（Very Important Person）監視情報を表します。
フィールド🔗
| フィールド | 型 | 説明 | 引数 |
|---|---|---|---|
| identity | Identity | このVIP情報が関連付けられているID（リクエスト時のみ設定） | |
| emails | String | このVIPに関連付けられたメールアドレスの配列 | |
| phoneNumbers | String | このVIPに関連付けられた電話番号の配列 | |
| socialMedia | String | このVIPに関連付けられたソーシャルメディアハンドルの配列 | |
| zipCode | String | このVIPに関連付けられた郵便番号 |
VIPsQuery🔗
説明: VIP情報のクエリ用入力。デフォルトでは、テナントのすべてのVIPを返します。
フィールド🔗
| フィールド | 型 | 説明 | 引数 |
|---|---|---|---|
| externalIds | String | VIP情報をクエリするIDの外部ID。空の場合はテナントのすべてのVIPを返します。 |
VIPsQueryResponse🔗
説明: VIP情報クエリのレスポンス。
フィールド🔗
| フィールド | 型 | 説明 | 引数 |
|---|---|---|---|
| vips | VIP | クエリに一致するVIPレコード | |
| total | Int64 | クエリに一致するVIPレコードの総数 |
VIPInput🔗
説明: VIP情報の作成または更新用入力。
フィールド🔗
| フィールド | 型 | 説明 | 引数 |
|---|---|---|---|
| providerId | ID | このVIPが関連付けられているIDプロバイダー | |
| externalId | String | IDの外部ID | |
| emails | String | このVIPに関連付けられたメールアドレスの配列 | |
| phoneNumbers | String | このVIPに関連付けられた電話番号の配列 | |
| socialMedia | String | このVIPに関連付けられたソーシャルメディアハンドルの配列 | |
| zipCode | String | このVIPに関連付けられた郵便番号（null可） |