コンテンツにスキップ

Identities GraphQL API🔗

クエリ🔗

説明: 公開クエリ

フィールド🔗

フィールド 説明 引数
identity Identity 指定されたIDプロバイダー上の外部IDを持つIDを返します。providerがnullの場合、お客様のすべてのプロバイダーが検索されます。複数の一致がある場合、非決定的に1つが選択されます。曖昧さを避けるため、providerを指定することを強く推奨します。 id: ID, provider: ID
identities IdentitiesQueryResponse テナントコンテキストのすべてのIDを返します。 input: IdentitiesQuery
identityFacets IdentityFacetsResponse クエリパラメータに基づいてIDごとのファセットごとの集計数を取得します。 query: IdentitiesQuery
identityDevice IdentityDevice 指定されたIDプロバイダー上の外部IDを持つデバイスを返します。providerがnullの場合、お客様のすべてのプロバイダーが検索されます。複数の一致がある場合、非決定的に1つが選択されます。曖昧さを避けるため、providerを指定することを強く推奨します。 id: ID, provider: ID
identityDevices IdentityDevicesQueryResponse クエリに一致するテナントコンテキストのすべてのIDデバイスを返します。 input: IdentityDevicesQuery
identityDeviceFacets IdentityDeviceFacetsResponse クエリパラメータに基づいてIDデバイスごとのファセットごとの集計数を取得します。 query: IdentityDevicesQuery
identityGroup IdentityGroup 指定されたプロバイダー上の外部IDを持つグループを返します。providerがnullの場合、お客様のすべてのプロバイダーが検索されます。複数の一致がある場合、非決定的に1つが選択されます。曖昧さを避けるため、providerを指定することを強く推奨します。 id: ID, provider: ID
identityGroups IdentityGroupsQueryResponse クエリに一致するテナントコンテキストのすべてのグループを返します。 query: IdentityGroupsQuery
identityGroupFacets IdentityGroupFacetsResponse クエリパラメータに基づいてIDグループごとのファセットごとの集計数を取得します。 query: IdentityGroupsQuery
identityProviders IdentityProvider テナントコンテキストのすべてのIDプロバイダーを返します。
primaryIdentityProvider IdentityProvider テナントコンテキストのプライマリIDプロバイダーを返します。プライマリIDプロバイダーがない場合、結果はnullです。
identityHierarchy IdentityHierarchy childLimitまでの直属の部下、parentLimitまでのマネージャー、および自身のIDを含むリストを返します。ID間の関係を判断するには、identityのmanagerフィールドを使用してください。providerがnullの場合、お客様のすべてのIDプロバイダーが検索され、1つだけの場合はそれが使用されます。複数ある場合は非決定的に1つが選択されます。曖昧さを避けるため、providerを指定することを強く推奨します。 id: ID, provider: ID, childLimit: Int, parentLimit: Int
identityForLegacyEntities Identity 指定されたエンティティに対する潜在的なIDを返します。1つのエンティティに複数のIDが一致する場合や、まったく一致しない場合もあります。IDがどのエンティティに関連付けられているかを判断するには、identityのlegacyEntitiesフィールドを使用してください。providerがnullの場合、お客様のすべてのIDプロバイダーが検索されます。 entities: String, provider: ID
identityForLegacyEntitiesLookup Map 指定されたエンティティのIDを高速に検索します。各入力エンティティのキーと、IDとprovider IDのみを持つNullableなIdentityReferenceのマップを返します。IDが見つからない場合、値はnullになります。これはアラート詳細で、アラートエンティティのいずれかにIDコンテキストがあるかを迅速に確認するために使用されます。providerがnullの場合、お客様のすべてのIDプロバイダーが検索されます。 entities: String, provider: ID
identityGenericProfiles IdentityGenericProfiles 指定された期間におけるIDの記録された汎用プロファイルを取得します。時間が指定されていない場合、デフォルトで直近7日間となります。providerが指定されていない場合、お客様のすべてのプロバイダーが一致するIDを検索します。複数のIDが一致する場合、非決定的に1つが選択されます。providerの指定を強く推奨します。 id: ID, provider: ID, startTime: Time, endTime: Time, feature: IdentityGenericProfileFeature
identitiesOverview IdentitiesOverview テナント内のIDおよびID取り込みの概要を取得します。 input: IdentitiesOverviewQuery
identityServicePrincipal IdentityServicePrincipal 指定されたIDプロバイダー上のIDを持つサービスプリンシパルを返します。providerがnullの場合、お客様のすべてのプロバイダーが検索され、1つだけの場合はそれが使用されます。複数ある場合は非決定的に1つが選択されます。曖昧さを避けるため、providerを指定することを強く推奨します。 id: ID, provider: ID
identityServicePrincipals IdentityServicePrincipalsQueryResponse クエリに一致するテナントコンテキストのすべてのIDサービスプリンシパルを返します。 input: IdentityServicePrincipalsQuery
identityServicePrincipalFacets IdentityServicePrincipalsFacetsResponse クエリパラメータに基づいてサービスプリンシパルごとのファセットごとの集計数を取得します。 input: IdentityServicePrincipalsQuery
identitiesByOpenAlerts IdentityOpenAlerts 指定された期間で最も多くのオープンアラートを持つIDを返します。期間が指定されていない場合、直近3日間が使用されます。IDのすべてのオープンアラートが保証されるわけではなく、パフォーマンス向上のため特定のアラートのみが考慮されます。providerがnullの場合、お客様のすべてのIDプロバイダーが検索されます。 provider: ID, limit: Int, earliest: Time, latest: Time
identitiesByAlerts IdentityOpenAlerts 指定された期間で最も多くのアラートを持つIDを返します。期間が指定されていない場合、直近3日間が使用されます。IDのすべてのアラートが保証されるわけではなく、パフォーマンス向上のため特定のアラートのみが考慮されます。providerがnullの場合、お客様のすべてのIDプロバイダーが検索されます。 provider: ID, limit: Int, earliest: Time, latest: Time
identityProviderHealth IdentityProviderHealth IDプロバイダーの全般的な正常性ステータスを返します provider: ID
identitiesByReferences Identity 指定された参照のいずれかに一致するIDを返します。 references: IdentityReferenceInput

ID🔗

説明: IDスカラ型は一意の識別子を表し、オブジェクトの再取得やキャッシュのキーとしてよく使用されます。ID型はJSONレスポンスではStringとして現れますが、人間が読めることを意図していません。入力型として期待される場合、任意の文字列(例: "4")や整数(例: 4)がIDとして受け入れられます。

Int🔗

説明: Intスカラ型は小数点を含まない符号付き整数値を表します。Intは-(2^31)から2^31 - 1までの値を表現できます。

String🔗

説明: Stringスカラ型はテキストデータを表し、UTF-8文字列として表現されます。String型はGraphQLで自由形式の人間が読めるテキストを表現する際によく使用されます。

ミューテーション🔗

説明: 公開ミューテーション

フィールド🔗

フィールド 説明 引数
setupIdentityProvider SetupIdentityProviderResponse IDプロバイダーをセットアップします。これによりIDと体制の取り込みが開始されます。認証情報は指定されたプロバイダータイプの既知の構造と一致している必要があります。同じ認証情報を使用するプロバイダーが既に存在する場合、エラーが返されます。呼び出し元テナントはIDサービスが有効である必要があります。認証情報に"keyId"というフィールドが含まれている場合、generateIdentityCertificateミューテーションで生成されたキーと一致する秘密鍵が検索されます。 type: IdentityProviderType, credentials: Map, options: IdentityProviderCreationOptions
startIdentityProviderSetup StartIdentityProviderSetupResponse Sophosまたは新規Taegisのお客様向けです。既存のTRIPインテグレーションやプレイブックの接続がないことを前提としています。これにより、Sophos Masterアプリを使用してMicrosoft Graph IngestorおよびIdentity Azureアプリが自動的にインストールされます。 type: IdentityProviderType, options: StartIdentityProviderSetupOptions
setupIdentityProviderResponseActions SetupIdentityProviderResponseActionsResponse 事前構成済みのレスポンスアクションを実行するために必要なオーケストレーション接続とプレイブックをセットアップします。 provider: ID
setPrimaryIdentityProvider Boolean 指定したIDプロバイダーをテナントのデフォルトプロバイダーとして設定します。以前のプライマリプロバイダーは非プライマリに設定されます。プロバイダーが正常にプライマリとして設定された場合はtrue、存在しない場合はfalseを返します。 id: ID
renameIdentityProvider Boolean IDプロバイダーの名前を変更します。プロバイダーが正常にリネームされた場合はtrue、存在しない場合はfalseを返します。 id: ID, name: String
disableIdentityProvider Boolean IDプロバイダーを無効化します。これによりIDや体制の取り込みが停止します。プロバイダーが正常に無効化された場合はtrue、存在しない場合はfalseを返します。 id: ID
enableIdentityProvider Boolean 以前に無効化されたIDプロバイダーを有効化します。これによりIDの取り込みが再開されます。呼び出し元テナントはIDサービスが有効である必要があります。プロバイダーが正常に有効化された場合はtrue、存在しない場合はfalseを返します。 id: ID
deleteIdentityProvider Boolean IDプロバイダーおよびそのすべてのIDを削除します。プロバイダーが正常に削除された場合はtrue、無効化されていないか存在しない場合はfalseを返します。これは元に戻せませんのでご注意ください。 id: ID
generateIdentityCertificate IdentityCertificate テナントコンテキスト用の公開鍵/秘密鍵ペアを生成します。private key idが指定されていない場合、新しいキーペアが生成され、IDが割り当てられます。出力証明書のprivateKeyIdは、setupIdentityProviderミューテーションでIDプロバイダーに秘密鍵を関連付けるために使用できます。expirationが指定されていない場合、証明書は365日間有効です。 privateKeyID: ID, expiration: Time
updateIdentityProviderCredentials Boolean IDプロバイダーの認証情報を更新します。認証情報は指定されたプロバイダータイプの既知の構造と一致している必要があります。認証情報に"keyId"というフィールドが含まれている場合、generateIdentityCertificateミューテーションで生成されたキーと一致する秘密鍵が検索されます。プロバイダーが正常に更新された場合はtrue、そうでない場合はfalseを返します。 id: ID, credentials: Map

Boolean🔗

説明: Booleanスカラ型はtrueまたはfalseを表します。

Time🔗

説明: タイムスタンプ型。

Map🔗

説明: マップ型。

IdentityProviderType🔗

説明: IDプロバイダーのタイプ。

IdentityReference🔗

説明: IDへの参照/キー。

フィールド🔗

フィールド 説明 引数
providerId ID このIDが関連付けられているIDプロバイダーID
externalId String IDの外部ID

IdentityReferenceInput🔗

説明: IDを参照/キー指定するための入力。

フィールド🔗

フィールド 説明 引数
providerId ID このIDが関連付けられているIDプロバイダーID
externalId String IDの外部ID

IdentitiesQuery🔗

説明: IDのクエリオプション。

フィールド🔗

フィールド 説明 引数
idpId ID クエリを特定のIDプロバイダーに制限するためのオプションフィルター。他のすべてのIDプロバイダーも含まれます。非推奨、代わりにprovidersを使用してください。
providers ID クエリを特定のIDプロバイダーに制限するためのオプションフィルター。他のすべてのIDプロバイダーも含まれます。
offset IdentityOffsetInput ページングオフセット。
sortBy IdentitySortBy ソートするフィールド。
sortOrder IdentitySortOrder ソート順。
displayNameContains String 指定された部分文字列を含む表示名のIDにクエリを制限するためのオプションフィルター。他のすべての表示名も含まれます。
fuzzySearch String 指定された部分文字列を含む表示名、givenName、surName、email、またはusernameのIDにクエリを制限するためのオプションフィルター。他のすべてのIDも含まれます。
allowedStatus IdentityStatus 非推奨。代わりにstatusを使用してください。
status IdentityStatus 特定のステータスのIDにクエリを制限するためのオプションフィルター。他のすべてのステータスも含まれます。
department String 特定の部署のIDにクエリを制限するためのオプションフィルター。他のすべての部署も含まれます。空文字列はnullおよび空の部署の両方を検索します。
employeeType String 特定の従業員タイプのIDにクエリを制限するためのオプションフィルター。他のすべての従業員タイプも含まれます。空文字列はnullおよび空の従業員タイプの両方を検索します。
isAdmin Boolean 管理者である/ないIDにクエリを制限するためのオプションフィルター。他のすべてのIDも含まれます。
hasMfa Boolean MFAが有効/無効なIDにクエリを制限するためのオプションフィルター。他のすべてのMFAステータスも含まれます。
hasPasswordlessMfa Boolean パスワードレスMFAが有効/無効なIDにクエリを制限するためのオプションフィルター。他のすべてのパスワードレスMFAステータスも含まれます。
primaryMfaMethod String 特定のプライマリMFA方式のIDにクエリを制限するためのオプションフィルター。他のすべてのプライマリMFA方式も含まれます。null値はプライマリMFA方式がないIDを検索します。
stale Boolean 古いと見なされる/見なされないIDにクエリを制限するためのオプションフィルター。他のすべてのIDも含まれます。
country String 特定の国コードのIDにクエリを制限するためのオプションフィルター。他のすべての国コードも含まれます。空文字列はnullおよび空の国コードの両方を検索します。
region String 特定のリージョンのIDにクエリを制限するためのオプションフィルター。他のすべてのリージョンも含まれます。空文字列はnullおよび空のリージョンの両方を検索します。
isGuest Boolean ゲストである/ないIDにクエリを制限するためのオプションフィルター。他のすべてのIDも含まれます。
mfaMethod String 特定のMFA方式のIDにクエリを制限するためのオプションフィルター。他のすべてのMFA方式も含まれます。null値はMFA方式がないIDを検索します。
hasLoggedIn Boolean 少なくとも1回ログインしたIDにクエリを制限するためのオプションフィルター。他のすべてのIDも含まれます。
isCompromised Boolean 侵害された/されていないと見なされるIDにクエリを制限するためのオプションフィルター。他のすべてのIDも含まれます。
isCloudOnly Boolean クラウド専用/そうでないと見なされるIDにクエリを制限するためのオプションフィルター。他のすべてのIDも含まれます。
isVip Boolean VIPと見なされる/されないIDにクエリを制限するためのオプションフィルター。他のすべてのIDも含まれます。

IdentityStringFacet🔗

説明: ファセットの値のカウント。

フィールド🔗

フィールド 説明 引数
value String 文字列値
count Int この値を持つ発見事項の数

IdentityStatusFacet🔗

説明: ファセットの値のカウント。

フィールド🔗

フィールド 説明 引数
value IdentityStatus ステータス
count Int このステータスを持つIDの数

IdentityServicePrincipalStatusFacet🔗

説明: ファセットの値のカウント。

フィールド🔗

フィールド 説明 引数
value IdentityServicePrincipalStatus ステータス
count Int このステータスを持つIDの数

IdentityBoolFacet🔗

説明: ファセットの値のカウント。

フィールド🔗

フィールド 説明 引数
value Boolean ブール値
count Int この値を持つ発見事項の数

IdentityDeviceStateFacet🔗

説明: ファセットの値のカウント。

フィールド🔗

フィールド 説明 引数
value IdentityDeviceState 状態
count Int この状態を持つデバイスの数

IdentityDeviceBYODStatusFacet🔗

説明: ファセットの値のカウント。

フィールド🔗

フィールド 説明 引数
value IdentityDeviceBYODStatus BYODステータス
count Int このBYODステータスを持つデバイスの数

IdentityDeviceOSFacet🔗

説明: ファセットの値のカウント。

フィールド🔗

フィールド 説明 引数
value IdentityDeviceOS OS
count Int このOSを持つデバイスの数

IdentityDeviceArchFacet🔗

説明: ファセットの値のカウント。

フィールド🔗

フィールド 説明 引数
value IdentityDeviceArch アーキテクチャ
count Int このアーキテクチャを持つデバイスの数

IdentityProviderFacet🔗

説明: ファセットの値のカウント。

フィールド🔗

フィールド 説明 引数
value IdentityProvider プロバイダー
count Int このプロバイダーを持つ要素の数

IdentityDeviceFacetsResponse🔗

説明: IDデバイスのファセットに対するレスポンス。

フィールド🔗

フィールド 説明 引数
providers IdentityProviderFacet クエリ内のデバイスのプロバイダー
state IdentityDeviceStateFacet クエリ内のデバイスの状態
byodStatus IdentityDeviceBYODStatusFacet クエリ内のデバイスのBYODステータス
os IdentityDeviceOSFacet クエリ内のデバイスのOS
architecture IdentityDeviceArchFacet クエリ内のデバイスのアーキテクチャ
manufacturer IdentityStringFacet クエリ内のデバイスの製造元
model IdentityStringFacet クエリ内のデバイスのモデル
isCompliant IdentityBoolFacet クエリ内のデバイスのコンプライアンスごとのファセットカウント
isManaged IdentityBoolFacet クエリ内のデバイスの管理ごとのファセットカウント
isRooted IdentityBoolFacet クエリ内のデバイスのrootedステータスごとのファセットカウント
isStale IdentityBoolFacet クエリ内のデバイスの古いステータスごとのファセットカウント

IdentityFacetsResponse🔗

説明: IDクエリのファセットカウント。

フィールド🔗

フィールド 説明 引数
providers IdentityProviderFacet クエリ内のIDのプロバイダー
status IdentityStatusFacet クエリ内のIDのステータス
department IdentityStringFacet クエリ内のIDの部署
employeeType IdentityStringFacet クエリ内のIDの従業員タイプ
isAdmin IdentityBoolFacet クエリ内のIDの国
stale IdentityBoolFacet 古いと見なされる/見なされないIDのカウント
hasMfa IdentityBoolFacet MFAが有効/無効なIDのカウント
hasPasswordlessMfa IdentityBoolFacet パスワードレスMFAが有効/無効なIDのカウント
primaryMfaMethod IdentityStringFacet 各プライマリMFA方式のIDのカウント
country IdentityStringFacet 国ごとのクエリ内のID
region IdentityStringFacet リージョンごとのクエリ内のID
isGuest IdentityBoolFacet ゲストである/ないIDのカウント
mfaMethod IdentityStringFacet MFA方式ごとのIDのカウント
isCompromised IdentityBoolFacet 侵害された/されていないIDのカウント
isCloudOnly IdentityBoolFacet クラウド専用またはfalseの場合はハイブリッドのIDのカウント

IdentitySortBy🔗

説明: クエリでIDをソートするための入力。

IdentitySortOrder🔗

説明: クエリでIDをソートする際の方向。

IdentityOffsetInput🔗

説明: IDのページネーション用入力。

フィールド🔗

フィールド 説明 引数
offset Int クエリの開始インデックス(0から開始、含む)
limit Int クエリの終了インデックス(含まない)

IdentityStatus🔗

説明: 外部IDプロバイダー上のIDのステータス。

IdentityIcon🔗

説明: IDを表すアイコン。

IdentityEntityReference🔗

説明: IDのエンティティへの参照。

フィールド🔗

フィールド 説明 引数
label String エンティティのタイプ
id ID エンティティのID

IdentitiesQueryResponse🔗

説明: クエリに一致するIDと、すべてのページにわたるIDの合計数。

フィールド🔗

フィールド 説明 引数
identities Identity クエリに一致するID
total Int クエリに一致するIDの合計数

Identity🔗

説明: 外部IDプロバイダー上のID。

フィールド🔗

フィールド 説明 引数
provider IdentityProvider このIDが関連付けられているIDプロバイダー
manager ID このIDのマネージャーの外部ID。IDプロバイダーから取得できない場合やマネージャーがいない場合はnullになることがあります。
externalId String このIDのIdP ID
displayName String IdPから取得した表示名、または利用できない場合は推測されます。
givenName String
surname String
status IdentityStatus このIDの現在のステータス。IDプロバイダーから取得できない場合は不明になることがあります。
title String このIDに関連付けられた職位。利用できない場合は空になることがあります。
department String このIDに関連付けられた部署。利用できない場合は空になることがあります。
emails String このIDに関連付けられたメールアドレス。利用できない場合は空になることがあります。
phoneNumbers String このIDに関連付けられた電話番号。利用できない場合は空になることがあります。
userNames String このIDに関連付けられたユーザー名。利用できない場合は空になることがあります。
primaryEntity IdentityEntityReference このIDを表す主要なエンティティ。このエンティティはグラフ内に必ず存在し、レスポンスアクションで使用する必要があります。
entities IdentityEntityReference このIDに関連付けられている可能性のあるエンティティ。
legacyEntities String このIDに関連付けられている可能性のあるレガシーエンティティ。例: targetUserName:john.doe
createdAt Time このIDが外部IDプロバイダー上で作成された時刻。IDプロバイダーから取得できない場合はnullになることがあります。
ingestedAt Time TaegisがこのIDの追跡を開始した時刻。
lastUpdated Time このIDが外部IDプロバイダーから最後に更新された時刻。IDが外部IDプロバイダーで更新された場合のみ増加します。
employeeType String ユーザーの従業員タイプ(正社員、パートタイム、契約社員など)。利用できない場合は空になることがあります。
hireDate Time ユーザーが雇用された日付。利用できない場合は空になることがあります。
leaveDate Time ユーザーが退職予定の日付。利用できない場合は空になることがあります。
lastPasswordChangeAt Time ユーザーが最後にパスワードを変更した時刻。利用できない場合は空になることがあります。
isAdmin Boolean ユーザーが環境内で管理者かどうか。取得できない場合はfalseになることがあります。
isGuest Boolean ユーザーが環境内でゲストかどうか
hasMfa Boolean ユーザーがMFAを有効にしているかどうか。取得できない場合はfalseになることがあります。
hasPasswordlessMfa Boolean ユーザーがパスワードレスMFAを有効にしているかどうか。取得できない場合はfalseになることがあります。
primaryMfaMethod String このIDのプライマリMFA方式(存在する場合)
mfaMethods String このIDで有効なすべてのMFA方式
lastActiveAt Time ログインイベントに基づくこのIDの最終アクティブ時刻。正確でない場合があります。
properties Map このIDに関連付けられたIdPまたはテナント固有のカスタムプロパティ
country String IDの国。利用できない場合は空になることがあります。
region String IDの州または都道府県。利用できない場合は空になることがあります。
city String IDの市区町村。利用できない場合は空になることがあります。
zipCode String IDの郵便番号。利用できない場合は空になることがあります。
officeLocation String IDの主なオフィス所在地の住所全体。利用できない場合は空になることがあります。
officeZipCode String IDの主なオフィス所在地の郵便番号。利用できない場合は空になることがあります。
usageLocation String IDの主な利用国コード。利用できない場合は空になることがあります。
icon IdentityIcon IDを表す主要なアイコン/タグ
tags IdentityIcon IDを表すその他のタグ/アイコン
groups IdentityGroupsQueryResponse このユーザーが所属するグループのリスト search: String, offset: IdentityOffsetInput
ownedServicePrincipals IdentityServicePrincipalsQueryResponse このユーザーが所有するサービスプリンシパルのリスト search: String, offset: IdentityOffsetInput
devices IdentityDevicesQueryResponse このユーザーに関連付けられているデバイスのリスト query: IdentityDevicesQuery
isCompromised Boolean ユーザーの認証情報が侵害されているかどうか
isVip Boolean ユーザーが侵害設定でVIPとしてタグ付けされているVIP IDかどうか

IdentityProvider🔗

説明: 同期対象となる構成済みIDプロバイダー。

フィールド🔗

フィールド 説明 引数
id ID Taegis内でこのIDプロバイダーの一意の識別子
name String このIDプロバイダーの表示名
primary Boolean このIdPがこのテナントのプライマリプロバイダーかどうか。プライマリは1つのみ。
type IdentityProviderType IDプロバイダーのタイプ
tenant String このIDプロバイダーに関連付けられているテナント
createdAt Time このIDプロバイダーが作成された時刻
updatedAt Time このIDプロバイダーが最後に更新された時刻
disabledAt Time このIDプロバイダーが無効化された時刻(無効化されている場合)
status IdentityProviderStatus このIDプロバイダーのステータス
playbookConnector ID このIDプロバイダーに関連付けられているプレイブックコネクター
tripIntegration ID このIDプロバイダーに関連付けられているTRIPインテグレーション
publicHash String このidpの環境詳細のハッシュ
expiration Time このIdPが有効期限付きの認証情報を使用している場合、その有効期限
license IdentityProviderLicense IDプロバイダーライセンス情報
integrations Int テレメトリー取り込みTRIPインテグレーション

SetupIdentityProviderResponse🔗

説明: IDプロバイダーのセットアップ試行に対するレスポンス。

フィールド🔗

フィールド 説明 引数
provider IdentityProvider 作成されたプロバイダー。エラーが発生した場合はnull

IdentityProviderStatus🔗

説明: IDプロバイダーのステータス。

IdentityProviderCreationOptions🔗

説明: IDプロバイダー作成時のオプション設定。

フィールド🔗

フィールド 説明 引数
name String IDプロバイダーの表示名。指定しない場合は生成されたIDが使用されます。
tripIngestionName String trip取り込みの表示名(オプション)。指定しない場合はプロバイダーIDがデフォルト。

IdentityApplicationType🔗

説明: お客様環境にインストールされたアプリケーションタイプ。

StartIdentityProviderSetupOptions🔗

説明: IDプロバイダーの作成およびプロビジョニング用設定。

フィールド🔗

フィールド 説明 引数
providerTenantId ID アプリやリソースをプロビジョニングするプロバイダーのテナントID。MS Entraの場合はAzureテナントID。
name String IDプロバイダーの表示名
provisionTelemetryIngest Boolean テレメトリー取り込みのプロビジョニングオプション
provisionResponseActions Boolean レスポンスアクションプレイブックおよび関連接続のプロビジョニングオプション

IdentityApplication🔗

説明: お客様プロバイダー環境にインストールされたアプリケーション。

フィールド🔗

フィールド 説明 引数
application IdentityApplicationType アプリケーションのタイプ
applicationId ID アプリケーションのID
authorizationUrl String お客様プロバイダー環境でインストールされたアプリケーションを認可するためにクライアントが遷移できるURL

StartIdentityProviderSetupResponse🔗

説明: 作成されたIDプロバイダーとお客様環境にインストールされたアプリケーションのリストを返します。

フィールド🔗

フィールド 説明 引数
provider IdentityProvider 作成されたIDプロバイダーモデル
applications IdentityApplication お客様プロバイダー環境にインストールされたアプリケーションのリスト

SetupIdentityProviderResponseActionsResponse🔗

説明: 作成されたオーケストレーション接続IDとお客様環境にインストールされた関連アプリケーションを返します。

フィールド🔗

フィールド 説明 引数
connectionId String 作成されたオーケストレーション接続のID
application IdentityApplication お客様環境で作成・インストールされたアプリケーション

IdentityHierarchy🔗

説明: IDの組織階層。

フィールド🔗

フィールド 説明 引数
identity Identity ID
managers Identity IDのマネージャーおよびその上位マネージャー(parentLimitまで)。IDのマネージャーから階層の最上位まで順に並びます。
directReports Identity IDの直属の部下
numDirectReports Int 直属の部下の合計数(directReportsフィールドに返されないものも含む)

IdentityGenericProfileFeature🔗

説明: 汎用プロファイルシステムで取得されるプロファイルのタイプ。

IdentityGenericProfiles🔗

説明: 指定された期間内のIDのすべての汎用プロファイル。

フィールド🔗

フィールド 説明 引数
feature IdentityGenericProfileFeature 汎用プロファイルの機能
profiles IdentityGenericProfile 期間内の機能ごとのプロファイル

IdentityGenericProfile🔗

説明: IDの単一ウィンドウ汎用プロファイル。

フィールド🔗

フィールド 説明 引数
value String プロファイルの値
startTime Time プロファイルの開始時刻ウィンドウ
endTime Time プロファイルの終了時刻ウィンドウ
count Int この期間内にプロファイルが観測された回数

IdentitiesOverviewQuery🔗

説明: ID概要クエリのパラメータ。

フィールド🔗

フィールド 説明 引数
changedSince Time 直近X日間のデータ変更統計。デフォルトは7日前。

IdentitiesOverview🔗

説明: IDおよびID取り込みに関する一般的な統計。

フィールド🔗

フィールド 説明 引数
totalIdentities Int IDの総数
totalIdentitiesAdded Int 入力で指定された期間に追加されたIDの総数
totalDevices Int デバイスの総数
totalDevicesAdded Int 入力で指定された期間に追加(登録)されたデバイスの総数
totalServicePrincipals Int サービスプリンシパルの総数
totalServicePrincipalsAdded Int 入力で指定された期間に追加されたサービスプリンシパルの総数
domainList String ドメインの総数
totalGroups Int グループの総数
totalGroupsAdded Int 入力で指定された期間に追加されたグループの総数

IdentityCertificate🔗

説明: 証明書とそれに関連付けられたキー。

フィールド🔗

フィールド 説明 引数
certificate String PEM形式の証明書
keyId ID 証明書に関連付けられたキーの参照

IdentityDeviceBYODStatus🔗

説明: デバイス所有権の分類。

IdentityDeviceState🔗

説明: デバイス状態の分類。

IdentityDeviceProperty🔗

説明: デバイスプロパティ/フラグの分類。

IdentityDeviceOS🔗

説明: デバイスOSの分類。

IdentityDeviceArch🔗

説明: デバイスアーキテクチャの分類。

IdentityDeviceSortBy🔗

説明: デバイスクエリのソートオプション。

IdentityDevicesQuery🔗

説明: デバイスクエリ用の入力オプション。

フィールド🔗

フィールド 説明 引数
idpId ID クエリを特定のIDプロバイダーに制限するためのオプションフィルター。他のすべてのIDプロバイダーも含まれます。非推奨、代わりにprovidersを使用してください。
providers ID クエリを特定のIDプロバイダーに制限するためのオプションフィルター。他のすべてのIDプロバイダーも含まれます。
offset IdentityOffsetInput ページングオフセット
sortBy IdentityDeviceSortBy ソートするフィールド
sortOrder IdentitySortOrder ソート順
displayNameContains String 指定された部分文字列を含む表示名のデバイスにクエリを制限するためのオプションフィルター。他のすべての表示名も含まれます。
allowedState IdentityDeviceState 特定の状態のデバイスにクエリを制限するためのオプションフィルター。他のすべての状態も含まれます。
allowedBYODStatus IdentityDeviceBYODStatus 特定のBYODステータスのデバイスにクエリを制限するためのオプションフィルター。他のすべてのBYODステータスも含まれます。
allowedOS IdentityDeviceOS 特定のOSのデバイスにクエリを制限するためのオプションフィルター。他のすべてのOSも含まれます。
allowedArchitecture IdentityDeviceArch 特定のアーキテクチャのデバイスにクエリを制限するためのオプションフィルター。他のすべてのアーキテクチャも含まれます。
allowedManufacturer String 特定の製造元のデバイスにクエリを制限するためのオプションフィルター。他のすべての製造元も含まれます。
allowedModel String 特定のモデルのデバイスにクエリを制限するためのオプションフィルター。他のすべてのモデルも含まれます。
identities ID 指定されたIDのいずれかに関連付けられているデバイスにクエリを制限するためのオプションフィルター。
isRooted Boolean rooted/jailbrokenである/ないデバイスにクエリを制限するためのオプションフィルター。他のすべてのデバイスも含まれます。
isManaged Boolean 管理されている/いないデバイスにクエリを制限するためのオプションフィルター。他のすべてのデバイスも含まれます。
isCompliant Boolean コンプライアンス準拠/非準拠のデバイスにクエリを制限するためのオプションフィルター。他のすべてのデバイスも含まれます。
externalIds String 特定の外部IDのデバイスにクエリを制限するためのオプションフィルター。他のすべての外部IDも含まれます。
isStale Boolean 古いと見なされる/見なされないIDにクエリを制限するためのオプションフィルター。他のすべてのIDも含まれます。90日間アクティブでない場合は古いと見なされます。

IdentityDevicesQueryResponse🔗

説明: デバイスのクエリレスポンス。

フィールド🔗

フィールド 説明 引数
devices IdentityDevice クエリに一致するデバイス
total Int クエリに一致するデバイスの合計数

IdentityDevice🔗

説明: デバイスを管理するIDプロバイダーからのデバイス。

フィールド🔗

フィールド 説明 引数
externalId String IDプロバイダー上でこのデバイスの一意の識別子
provider IdentityProvider このデバイスが関連付けられているIDプロバイダー
associatedIdentities ID このデバイスに関連付けられているID
displayName String デバイスの表示名。IDプロバイダーから取得できない場合は推測されることがあります。
state IdentityDeviceState デバイスの状態
properties IdentityDeviceProperty デバイスの管理プロパティ
isRooted Boolean デバイスがrooted/jailbrokenかどうか
isManaged Boolean デバイスがInTuneで管理されているかどうか
isCompliant Boolean デバイスがInTuneのコンプライアンスに準拠しているかどうか
byodStatus IdentityDeviceBYODStatus デバイスのBYODステータス
customLabels Map このデバイスに関連付けられたIdPまたはテナント固有のカスタムラベル
os IdentityDeviceOS デバイスのOS
osVersion String デバイスのOSバージョン
architecture IdentityDeviceArch デバイスのアーキテクチャ
manufacturer String デバイスの製造元
model String デバイスのモデル
lastUsedAt Time このデバイスが最後に使用された時刻(実際の最終使用から遅れる場合あり)
createdAt Time このデバイスが外部IDプロバイダーで登録された時刻。IDプロバイダーから取得できない場合はnullになることがあります。
updatedAt Time このデバイスが外部IDプロバイダーから最後に更新された時刻。デバイスが外部IDプロバイダーで更新された場合のみ増加します。
aliases String デバイスの他の識別子
entities IdentityEntityReference このデバイスに関連付けられている可能性のあるエンティティ
legacyEntities String このデバイスに関連付けられている可能性のあるレガシーエンティティ。例: hostName:JohnDoes-Macbook-Pro

IdentityServicePrincipalsQuery🔗

説明: サービスプリンシパルのクエリオプション。

フィールド🔗

フィールド 説明 引数
idpId ID クエリを特定のIDプロバイダーに制限するためのオプションフィルター。他のすべてのIDプロバイダーも含まれます。非推奨、代わりにprovidersを使用してください。
providers ID クエリを特定のIDプロバイダーに制限するためのオプションフィルター。他のすべてのIDプロバイダーも含まれます。
offset IdentityOffsetInput ページングオフセット
sortBy IdentityServicePrincipalSortBy ソートするフィールド
sortOrder IdentitySortOrder ソート順
displayNameContains String 指定された部分文字列を含む表示名のサービスプリンシパルにクエリを制限するためのオプションフィルター。他のすべての表示名も含まれます。
status IdentityServicePrincipalStatus 特定のステータスのサービスプリンシパルにクエリを制限するためのオプションフィルター。他のすべてのステータスも含まれます。
hasPasswordCredentials Boolean パスワード認証情報を持つサービスプリンシパルにクエリを制限するためのオプションフィルター。他のすべてのサービスプリンシパルも含まれます。
hasKeyCredentials Boolean キー認証情報を持つサービスプリンシパルにクエリを制限するためのオプションフィルター。他のすべてのサービスプリンシパルも含まれます。
applicationId String 特定のapplicationIdを持つサービスプリンシパルにクエリを制限するためのオプションフィルター。他のすべてのサービスプリンシパルも含まれます。

IdentityServicePrincipalsQueryResponse🔗

説明: サービスプリンシパルのクエリレスポンス。

フィールド🔗

フィールド 説明 引数
servicePrincipals IdentityServicePrincipal クエリに一致するサービスプリンシパル
total Int クエリに一致するサービスプリンシパルの合計数

IdentityServicePrincipalSortBy🔗

説明: サービスプリンシパルのソートオプション。

IdentityServicePrincipalStatus🔗

説明: 外部IDプロバイダー上のサービスプリンシパルのステータス。

IdentityServicePrincipal🔗

説明: IDプロバイダーからのインストール済みEntraアプリケーション(サービスプリンシパル)。

フィールド🔗

フィールド 説明 引数
id String IDプロバイダー上でこのデバイスの一意の識別子
provider IdentityProvider このデバイスが関連付けられているIDプロバイダー
displayName String サービスプリンシパルの表示名
applicationId String サービスプリンシパルのapplicationId。サービスプリンシパルにない場合はNull。
status IdentityServicePrincipalStatus サービスプリンシパルのステータス。IDプロバイダーから取得できない場合は不明になることがあります。
createdAt Time サービスプリンシパルがIDプロバイダーで作成された時刻。IDプロバイダーから取得できない場合はnullになることがあります。
updatedAt Time サービスプリンシパルが外部IDプロバイダーから最後に更新された時刻
deletedAt Time サービスプリンシパルが外部IDプロバイダーで削除された時刻。削除されていない場合はNull
ingestedAt Time このサービスプリンシパルの追跡を開始した時刻
userOwners IdentitiesQueryResponse このグループに所属するユーザーを取得します。searchはユーザーの表示名に対する大文字小文字を区別しないテキスト一致のオプション検索です。 search: String, offset: IdentityOffsetInput
servicePrincipalOwners IdentityServicePrincipalsQueryResponse このグループを所有するサービスプリンシパルを取得します。searchはサービスプリンシパルの表示名に対する大文字小文字を区別しないテキスト一致のオプション検索です。 search: String, offset: IdentityOffsetInput

IdentityServicePrincipalsFacetsResponse🔗

説明: サービスプリンシパルクエリのファセットカウント。

フィールド🔗

フィールド 説明 引数
providers IdentityProviderFacet クエリ内のアプリケーションのプロバイダー
status IdentityServicePrincipalStatusFacet クエリ内のアプリケーションのステータス
hasPasswordCredentials IdentityBoolFacet パスワード認証情報の有無ごとのアプリケーションのカウント
hasKeyCredentials IdentityBoolFacet キー認証情報の有無ごとのアプリケーションのカウント

IdentityOpenAlerts🔗

説明: IDとそのアラート数。OpenAlertsと記載されていますが、実際にはオープンアラートだけでなくクエリに依存します。

フィールド🔗

フィールド 説明 引数
identity Identity アラートを持つID
critical Int IDの重大アラート数
high Int IDの高アラート数
medium Int IDの中アラート数
low Int IDの低アラート数
info Int IDの情報アラート数

IdentityGroup🔗

説明: IDプロバイダーからのグループ。

フィールド🔗

フィールド 説明 引数
id String IDプロバイダー上でこのグループの一意の識別子
provider IdentityProvider このグループが関連付けられているIDプロバイダー
displayName String サービスプリンシパルの表示名
description String グループの説明(利用可能な場合)
isAssignableToRoles Boolean このグループがMicrosoft Entraロールに割り当て可能かどうか
isMailEnabled Boolean グループがメール有効かどうか
isSecurityEnabled Boolean グループがセキュリティグループかどうか
isDeleted Boolean グループが削除されているかどうか
onPremiseSID String オンプレAD用のグループのセキュリティ識別子
securityIdentifier String グループのセキュリティ識別子
expirationTime Time グループの有効期限。設定されていない場合はNull。
deletedAt Time グループがIDプロバイダーで削除された時刻。IDプロバイダーから取得できない場合や削除されていない場合はnull。
createdAt Time グループがIDプロバイダーで作成された時刻。IDプロバイダーから取得できない場合はnull。
updatedAt Time グループが外部IDプロバイダーから最後に更新された時刻
ingestedAt Time このグループの追跡を開始した時刻
userMembers IdentitiesQueryResponse このグループに所属するユーザーを取得します。searchはユーザーの表示名に対する大文字小文字を区別しないテキスト一致のオプション検索です。 search: String, offset: IdentityOffsetInput
servicePrincipalMembers IdentityServicePrincipalsQueryResponse このグループに所属するサービスプリンシパルを取得します。searchはサービスプリンシパルの表示名に対する大文字小文字を区別しないテキスト一致のオプション検索です。 search: String, offset: IdentityOffsetInput
groupMembers IdentityGroupsQueryResponse このグループに所属するグループを取得します。searchはグループの表示名に対する大文字小文字を区別しないテキスト一致のオプション検索です。 search: String, offset: IdentityOffsetInput

IdentityGroupFacetsResponse🔗

説明: グループクエリのファセットカウント。

フィールド🔗

フィールド 説明 引数
providers IdentityProviderFacet クエリ内のグループのIDプロバイダー
isAssignableToRoles IdentityBoolFacet ロールに割り当て可能なグループ数
isMailEnabled IdentityBoolFacet メール有効なグループ数
isSecurityEnabled IdentityBoolFacet セキュリティ有効なグループ数
isDeleted IdentityBoolFacet 削除されたグループ数

IdentityGroupSortBy🔗

説明: グループのソートオプション。

IdentityGroupsQuery🔗

説明: サービスプリンシパルのクエリオプション。

フィールド🔗

フィールド 説明 引数
idpId ID クエリを特定のIDプロバイダーに制限するためのオプションフィルター。他のすべてのIDプロバイダーも含まれます。非推奨、代わりにprovidersを使用してください。
providers ID クエリを特定のIDプロバイダーに制限するためのオプションフィルター。他のすべてのIDプロバイダーも含まれます。
offset IdentityOffsetInput ページングオフセット
sortBy IdentityGroupSortBy ソートするフィールド
sortOrder IdentitySortOrder ソート順
fuzzySearch String 指定された部分文字列またはSIDを含む表示名のサービスプリンシパルにクエリを制限するためのオプションフィルター
isAssignableToRoles Boolean 指定した場合、ロールに割り当て可能/不可能なグループのみ返します。
isMailEnabled Boolean 指定した場合、メール有効/無効なグループのみ返します。
isSecurityEnabled Boolean 指定した場合、セキュリティ有効/無効なグループのみ返します。
isDeleted Boolean 指定した場合、削除済み/未削除のグループのみ返します。

IdentityGroupsQueryResponse🔗

説明: クエリに一致するグループと、すべてのページにわたるグループの合計数。

フィールド🔗

フィールド 説明 引数
groups IdentityGroup クエリに一致するグループ
total Int クエリに一致するグループの合計数

IdentityProviderHealth🔗

説明: IDプロバイダーセットアップの全般的な正常性ステータス。取り込みや体制の正常性は報告しません。

フィールド🔗

フィールド 説明 引数
health IdentityProviderHealthStatus 全体的な正常性サマリー
credentialExpiration Time 提供された認証情報が有効期限付きの場合、その有効期限
integrations IdentityProviderIntegrationHealth 取り込みインテグレーション
missingPermissions IdentityProviderPermission 期待されるが不足している権限。これは比較的高コストです。
extraPermissions IdentityProviderPermission 期待されていないが認証情報に存在する権限。

IdentityProviderHealthStatus🔗

説明: IDプロバイダーの正常性ステータス。

IdentityProviderIntegrationHealth🔗

説明: IDプロバイダーに関連するTRIPインテグレーションの正常性プロキシ。

フィールド🔗

フィールド 説明 引数
integrationId Int TRIP内のインテグレーションID
status IdentityProviderHealthStatus インテグレーションのステータス
name String インテグレーションの名前

IdentityProviderPermission🔗

説明: サービスプリンシパルで使用されるアプリケーションまたはインテグレーションの権限。

フィールド🔗

フィールド 説明 引数
id ID 権限のID
displayName String 権限の表示名

IdentityProviderLicense🔗

説明: IDプロバイダーのライセンス情報。

フィールド🔗

フィールド 説明 引数
name String ライセンス名
status String ライセンスステータス
isTrial Boolean ライセンスがトライアルかどうか
totalLicenses Int ライセンスの総数
createdAt Time ライセンス作成時刻
expiration Time ライセンス有効期限