servicePrincipal リソースの種類

名前空間: microsoft.graph

ディレクトリ内のアプリケーションのインスタンスを表します。 directoryObject から継承します。

agentIdentityBlueprintPrincipal リソースは、このオブジェクトから継承されます。

このリソースは、デルタ関数を提供することによって、増分の追加、削除、および更新を追跡するためのデルタ クエリの使用をサポートしています。 このリソースは、ここに記載されているもの以外の追加のプロパティを許可するオープン型です。

メソッド

メソッド 戻り値の型 説明
List servicePrincipal コレクション servicePrincipal オブジェクトの一覧を取得します。
Create servicePrincipal 新しい servicePrincipal オブジェクトを作成します。
Get servicePrincipal servicePrincipal オブジェクトのプロパティとリレーションシップを読み取ります。
更新する servicePrincipal servicePrincipal オブジェクトを更新します。
Upsert servicePrincipal 存在しない場合は新しい servicePrincipal を作成するか、既存の servicePrincipal のプロパティを更新します。
Delete なし servicePrincipal オブジェクトを削除します。
Deltaを取得する servicePrincipal コレクション サービス プリンシパルに対する増分の変更を取得します。
作成されたオブジェクトを一覧表示する directoryObject コレクション createdObject オブジェクト コレクションを取得します。
所有されているオブジェクトを一覧表示する directoryObject コレクション ownedObject オブジェクト コレクションを取得します。
削除済みアイテム
List directoryObject コレクション servicePrincipal オブジェクトの一覧を取得します。
Get directoryObject servicePrincipal オブジェクトのプロパティとリレーションシップを取得します。
復元 directoryObject 最近削除した servicePrincipal オブジェクトを復元します。
完全に削除 なし servicePrincipal オブジェクトを完全に削除します。
App role assignments
List appRoleAssignments appRoleAssignment コレクション このサービス プリンシパルに割り当てられているアプリ ロールを取得します。
Add appRoleAssignment appRoleAssignment このサービスプリンシパルにアプリの役割を割り当てます。
appRoleAssignment を削除する なし このサービスプリンシパルからアプリの役割の割り当てを削除します。
appRoleAssignedTo をリストする appRoleAssignment コレクション このサービスプリンシパルのアプリ役割が割り当てられているユーザー、グループ、サービスプリンシパルを取得します。
appRoleAssignedTo を追加する appRoleAssignment このサービスプリンシパルのアプリ役割をユーザー、グループ、またはサービスプリンシパルに割り当てます。
appRoleAssignedTo を削除する なし ユーザー、グループ、またはサービスプリンシパルからこのサービスプリンシパルへのアプリ役割の割り当てを削除します。
証明書とシークレット
パスワードを追加する passwordCredential 強力なパスワードまたはシークレットを servicePrincipal に追加します。
パスワードを削除する passwordCredential servicePrincipal からパスワードまたはシークレットを削除します。
キーの追加 keyCredential 鍵資格情報を servicePrincipal に追加します。
キーの削除 なし servicePrincipal からキー資格情報を削除します。
トークン署名証明書を追加する selfSignedCertificate 自己署名証明書をサービス プリンシパルに追加します。 主に、Microsoft Entra ギャラリーから SAML ベースの SSO アプリケーションを構成するために使用されます。
代理アクセス許可の分類
List delegatedPermissionClassification コレクション このサービスプリンシパルによって公開される代理アクセス許可のアクセス許可の分類を取得します。
追加する delegatedPermissionClassification このサービスプリンシパルによって公開された、代理アクセス許可のアクセス許可の分類を追加します。
Remove なし このサービスプリンシパルによって公開された代理アクセス許可のアクセス許可の分類を削除します。
委任された (OAuth2) アクセス許可の付与
List oAuth2PermissionGrant コレクション サインインしているユーザーに代わってこのサービスプリンシパルが API にアクセスすることを承認する、委任されたアクセス許可を取得します。
メンバーシップ
memberOf を一覧表示する directoryObject コレクション memberOf ナビゲーション プロパティからこのサービス プリンシパルが直接のメンバーであるグループを取得します。
推移的な所属を一覧表示する directoryObject コレクション このサービス プリンシパルがメンバーになっているグループを一覧表示します。 この操作は推移的で、このサービス プリンシパルが入れ子のメンバーになっているグループが含まれます。
メンバー グループをチェックする String collection 指定したグループ一覧内のメンバーシップを確認します。
メンバー オブジェクトを確認する String collection 指定したグループ、ディレクトリ役割、または管理ユニット オブジェクト一覧内のメンバーシップを確認します。
メンバー グループを取得する String collection このサービス プリンシパルがメンバーになっているグループ一覧を取得します。
メンバー オブジェクトを取得する String collection このサービス プリンシパルがメンバーになっているグループ、管理単位、およびディレクトリ ロールの一覧を取得します。
所有者
List directoryObject コレクション サービス プリンシパルの所有者を取得します。
追加する directoryObject サービス プリンシパルに所有者を割り当てます。 サービス プリンシパルの所有者は、ユーザーまたはその他のサービス プリンシパルにすることができます。
Remove なし サービス プリンシパルから所有者を削除します。 推奨されるベスト プラクティスとして、サービス プリンシパルには少なくとも 2 人の所有者が必要です。

プロパティ

重要

$filter および $search クエリ パラメーターの具体的な使用方法は、ConsistencyLevel ヘッダーの設定を eventual と $count に使用する場合にのみサポートされます。 詳細については、「ディレクトリ オブジェクトの詳細クエリ機能」を参照してください。

プロパティ 型 説明
accountEnabled Boolean trueサービス プリンシパルのアカウントが有効な場合。それ以外の場合は false。 false に設定すると、ユーザーが割り当てられている場合でも、このアプリにサインインできるユーザーはいません。 $filter (eq、ne、not、in) をサポートします。
addIns addIn コレクション 特定のコンテキストで利用者サービスがアプリを呼び出すために使用できるカスタムの動作を定義します。 たとえば、ファイル ストリームのレダリングが可能なアプリケーションは、そのアプリケーションの "FileHandler" 機能のために addIns プロパティを設定することがあります。 これにより、Microsoft 365 などのサービスは、ユーザーが作業しているドキュメントのコンテキストでアプリケーションを呼び出すことができます。
alternativeNames String コレクション サブスクリプションによってサービス プリンシパルを取得し、 マネージド ID のリソース グループと完全なリソース ID を識別するために使用されます。 $filter (eq、not、ge、le、startsWith) をサポートします。
appDescription String 関連付けられているアプリケーションによって公開される説明。
appDisplayName String 関連付けられているアプリケーションによって公開される表示名。 最大文字数は 256 文字です。
appId String 関連付けられたアプリケーションの一意の識別子 (その appId プロパティ)。 代替キー。 $filter (eq、ne、not、in、startsWith) をサポートします。
applicationTemplateId String applicationTemplate の一意の識別子。 $filter (eq、not、ne) をサポートします。 読み取り専用です。 null サービス プリンシパルがアプリケーション テンプレートから作成されていない場合。
appOwnerOrganizationId Guid アプリケーションが登録されているテナント ID が含まれます。 これは、アプリケーションによってサポートされるサービスプリンシパルにのみ適用されます。 $filter (eq、ne、NOT、ge、le) をサポートします。
appRoleAssignmentRequired ブール値 ユーザーがサインインしたり、アプリがトークンを取得したりする前に、ユーザーまたは他のサービスプリンシパルに、このサービスプリンシパルへのアプリの役割の割り当てを付与する必要があるかどうかを指定します。 既定値は false です。 null 許容ではありません。

$filter (eq、ne、NOT) をサポートします。
appRoles appRole コレクション このサービス プリンシパルにリンクされているアプリケーションによって公開されるロール。 詳細については、アプリケーション エンティティの appRoles プロパティ定義を参照してください。 null 許容ではありません。

アプリ ロールと公開されている委任されたアクセス許可スコープ (oauth2PermissionScopes) では、アプリケーションから継承された定義やサービス プリンシパルに直接追加された定義を含め、サービス プリンシパルごとに 700 個のアクセス許可定義という既定の制限を共有します。 有効な定義と無効な定義の両方がカウントされます。 この制限は、定義数ですが、アプリ ロールの割り当て数ではありません。 カウント ルール、制限を超える既存のオブジェクトの動作、および設計ガイダンスについては、「 アプリ ロールの制限」を参照してください。
createdByAppId String このサービス プリンシパルを作成したアプリケーションの appId 。 Microsoft Entra ID によって内部的に設定されます。 読み取り専用です。
customSecurityAttributes customSecurityAttributeValue ディレクトリ オブジェクトに割り当てられたカスタム セキュリティ属性の値を保持するオープン複合型。 Null 許容型。

取得に $select が必要です。 $filter (eq、ne、not、startsWith) をサポートします。 フィルター値は大文字と小文字を区別します。
  • このプロパティを読み取るには、呼び出し元のアプリに "CustomSecAttributeAssignment.Read.All" のアクセス許可が割り当てられている必要があります。 このプロパティを記述するには、呼び出し元のアプリに "CustomSecAttributeAssignment.ReadWrite.All" のアクセス許可が割り当てられている必要があります。
  • 代理シナリオでこのプロパティを読み取りまたは書き込みするには、管理者に Attribute Assignment Administrator (属性割り当て管理者) ロールが割り当てられている必要があります。
    		•
    deletedDateTime DateTimeOffset サービスプリンシパルが削除された日時。 読み取り専用です。
    説明 String サービス プリンシパルの内部エンド ユーザー向けの説明を提供するフリー テキスト フィールド。 MyApps などのエンドユーザー ポータルでは、このフィールドにアプリケーションの説明が表示されます。 最大許容サイズは 1,024 文字です。 $filter (eq、ne、not、ge、le、startsWith、$search) をサポートします。
    disabledByMicrosoftStatus String Microsoft で登録済みアプリケーションを無効にしたかどうかを指定します。 可能な値は、 null (既定値)、 NotDisabled、および DisabledDueToViolationOfServicesAgreement です (理由として、疑わしい、虐待的、悪意のあるアクティビティ、あるいは Microsoft サービス規約の違反が含まれます)。

    $filter (eq、ne、not) をサポートします。
    displayName String サービス プリンシパルの表示名。 $filter (eq、ne、not、ge、le、in、startsWith、および eq の null値)、$search、および $orderby をサポートします。
    HomePage String アプリケーションのホームページまたはランディングページ。
    id String サービス プリンシパルの一意識別子。 directoryObject から継承されます。 キー。 null 許容ではありません。 読み取り専用です。 $filter (eq、ne、not、in) をサポートします。
    info informationalUrl アプリのマーケティング、サポート、利用規約、プライバシーに関する声明のURLなど、取得したアプリケーションの基本的なプロファイル情報。 サービス利用規約とプライバシーに関する声明は、ユーザーの同意エクスペリエンスからユーザーに提示されます。 詳細については、「方法: 登録済みの Microsoft Entra アプリのサービス利用規約とプライバシーに関する声明を追加する」を参照してください。

    $filter (eq、ne、not、ge、le、および< eqの null値)をサポートします。
    keyCredentials keyCredential コレクション サービス プリンシパルに関連付けられているキー資格情報のコレクションです。null 許容型ではありません。 null 許容ではありません。 $filter (eq、not、ge、le) をサポートします。
    loginUrl String サービス プロバイダーがユーザーを Microsoft Entra ID にリダイレクトして認証する URL を指定します。 Microsoft Entra ID はこの URL を使用して、Microsoft 365 または Microsoft Entra マイ アプリ からアプリケーションを起動します。 空白の場合、Microsoft Entra ID は SAML ベースのシングル サインオンで構成されたアプリケーションに対して IdP が開始するサインオンを実行します。 ユーザーは、Microsoft 365、Microsoft Entra マイ アプリ、または Microsoft Entra SSO URL からアプリケーションを起動します。
    logoutUrl String OpenID Connect のフロント チャネル、 バック チャネル、または SAML サインアウト プロトコルを使用してユーザーをサインアウトするために Microsoft の承認サービスが使用する URL を指定します。
    notes String 通常は運用目的で使用される、サービス プリンシパルに関する情報を取得するためのフリー テキスト フィールド。 最大許容サイズは 1,024 文字です。
    notificationEmailAddresses String コレクション アクティブな証明書の有効期限が近づいたときに Microsoft Entra ID が通知を送信するメール アドレスの一覧を指定します。 これは、Microsoft Entra Gallery アプリケーション用に発行された SAML トークンに署名するために使用される証明書専用です。
    oauth2PermissionScopes permissionScope コレクション アプリケーションによって公開された委任された権限。 詳細については、アプリケーション エンティティの API プロパティの oauth2PermissionScopes プロパティを参照してください。 null 許容ではありません。

    これらのスコープと appRoles では、サービス プリンシパルあたり 700 アクセス許可定義の既定の制限を共有しています。 有効な定義と無効な定義の両方がカウントされます。 カウント ルール、制限を超える既存のオブジェクトの動作、および設計ガイダンスについては、「 アプリ ロールの制限」を参照してください。
    passwordCredentials passwordCredential コレクション アプリケーションに関連付けられているパスワード資格情報のコレクションです。 null 許容ではありません。
    preferredSingleSignOnMode string このアプリケーションに構成されているシングルサインオンモードを指定します。 Microsoft Entra ID では、優先シングル サインオン モードを使用して、Microsoft 365 または マイ アプリ ポータルからアプリケーションを起動します。 サポートされている値は password、saml、notSupported、および oidc です。 メモ: このフィールドは、古い SAML アプリや、自動的に設定されない OIDC アプリケーションで null 場合があります。
    preferredTokenSigningKeyThumbprint String このプロパティを SAML アプリケーション ( preferredSingleSignOnMode が saml に設定されているアプリ) で使用して、SAML 応答の署名に使用する証明書を制御できます。 SAML ではないアプリケーションの場合、このプロパティを書き込んだり、それ以外の方法で依存したりしないでください。
    replyUrls String コレクション 関連付けられたアプリケーションにサインインするためにユーザー トークンが送信される URL、または関連付けられたアプリケーションに対して OAuth 2.0 認証コードとアクセス トークンが送信されるリダイレクト URI。 null 許容ではありません。
    resourceSpecificApplicationPermissions resourceSpecificPermission コレクション このアプリケーションによって公開されるリソース固有のアプリケーションのアクセス許可。 現在、リソース固有のアクセス許可は、Microsoft Graph を使用して特定のチャットやチームにアクセスする Teams アプリでのみサポートされています。 読み取り専用です。
    samlSingleSignOnSettings samlSingleSignOnSettings saml シングルサインオンに関連する設定のコレクション。
    servicePrincipalNames String コレクション 関連するアプリケーションからコピーされた identifiersUris のリストが含まれています。 ハイブリッドアプリケーションに追加の値を追加できます。 これらの値を使用して、Microsoft Entra ID 内でこのアプリによって公開されるアクセス許可を識別できます。 例えば、
    • クライアント アプリは、このプロパティの値に基づくリソース URI を指定して、アクセス トークンを取得できます。これは、"aud" クレームで返される URI です。

    多値プロパティのフィルター式には、any 演算子が必要です。 null 許容ではありません。

    $filter (eq、not、ge、le、startsWith) をサポートします。
    servicePrincipalType String サービス プリンシパルがアプリケーションや管理された ID またはレガシ アプリケーションを表すかどうかを識別します。 このプロパティは、Microsoft Entra ID によって内部的に設定されます。 servicePrincipalType プロパティは、3 つの値に設定できます。
    • Application - アプリケーションまたはサービスを表すサービス プリンシパル。 appId プロパティは、関連付けられたアプリの登録を識別し、アプリケーションの appId (場合によっては別のテナントから) と一致させます。 関連付けられているアプリの登録がない場合、サービス プリンシパルに対してトークンは発行されません。
    • ManagedIdentity - マネージド ID を表すサービス プリンシパル。 マネージド ID を表すサービス プリンシパルにはアクセス許可を付与できますが、直接更新または変更することはできません。
    • Legacy - アプリの登録前、またはレガシ エクスペリエンスを通じて作成されたアプリを表すサービス プリンシパル。 従来のサービス プリンシパルには、資格情報、サービス プリンシパル名、応答 URL、および承認されたユーザーが編集できるその他のプロパティを含めることができますが、関連するアプリ登録はありません。 appId 値は、サービス プリンシパルをアプリの登録に関連付けません。 サービス プリンシパルは、作成されたテナントでのみ使用できます。
    • ServiceIdentity - エージェント ID を表すサービス プリンシパル。
  • SocialIdp - 内部使用用。
    • signInAudience String 現在のアプリケーションでサポートされている Microsoft アカウントを指定します。 読み取り専用です。

    サポートされている値は次のとおりです。
    • AzureADMyOrg: organization のMicrosoft Entraテナント (シングルテナント) に Microsoft の職場または学校アカウントを持つユーザー。
    • AzureADMultipleOrgs: 任意の organization's Microsoft Entra テナント (マルチテナント) に Microsoft の職場または学校アカウントを持つユーザー。
    • AzureADandPersonalMicrosoftAccount: 個人の Microsoft アカウントを持つユーザーか、任意のorganizationの Microsoft Entra テナント内に職場または学校のアカウントを持つユーザー。
    • PersonalMicrosoftAccount: 個人の Microsoft アカウントを持つユーザーのみ。
    tags String コレクション サービスプリンシパルの分類と識別に使用できるカスタム文字列。 null 許容ではありません。 値は、ここおよび関連する アプリケーション エンティティの tags プロパティに設定された文字列の和集合です。

    $filter (eq、not、ge、le、startsWith) をサポートします。
    tokenEncryptionKeyId 文字列 keyCredentials コレクションにある公開キーの keyId を指定します。 構成されている場合、Microsoft Entra ID は、このプロパティで指定されたキーを使用して暗号化されたこのアプリケーションのトークンを発行します。 暗号化されたトークンを受け取るアプリケーション コードでは、一致する秘密キーを使用してトークンを複合化してから、サインインしているユーザーのトークンとして使用する必要があります。
    verifiedPublisher verifiedPublisher このサービス プリンシパルにリンクされているアプリケーションの検証済み発行元を指定します。

    リレーションシップ

    重要

    $filter クエリ パラメーターの特定の使用は、ConsistencyLevel ヘッダーを eventual および $count に設定した場合にのみサポートされます。 詳細については、「ディレクトリ オブジェクトの詳細クエリ機能」を参照してください。

    リレーションシップ 型 説明
    appManagementPolicies appManagementPolicy コレクション このアプリケーションに適用される appManagementPolicy。
    appRoleAssignedTo appRoleAssignment ユーザー、グループ、その他のサービス プリンシパルに付与される、このアプリまたはサービスのアプリの役割の割り当て。 $expand をサポートします。
    appRoleAssignments appRoleAssignment コレクション このサービス プリンシパルに付与される、別のアプリまたはサービスのアプリの役割の割り当て。 $expand をサポートします。
    claimsMappingPolicies claimsMappingPolicy コレクション このサービス プリンシパルに割り当てられている claimsMappingPolicies。 $expand をサポートします。
    createdObjects directoryObject コレクション このサービス プリンシパルで作成したディレクトリ オブジェクト。 読み取り専用です。 Null 許容型。
    federatedIdentityCredentials federatedIdentityCredential のコレクション 特定の種類のサービス プリンシパルのフェデレーション ID - マネージド ID。 $expand と$filter (/$count eq 0、/$count ne 0) をサポートします。
    homeRealmDiscoveryPolicies homeRealmDiscoveryPolicy コレクション このサービス プリンシパルに割り当てられている homeRealmDiscoveryPolicies。 $expand をサポートします。
    memberOf directoryObject コレクション このサービス プリンシパルがメンバーになっている役割。 HTTP メソッド: GET 読み取り専用。 Null 許容型です。 $expand をサポートします。
    oauth2PermissionGrants oAuth2PermissionGrant コレクション 委任されたアクセス許可は、サインインしたユーザーに代わってこのサービスプリンシパルが API にアクセスすることを許可します。 読み取り専用です。 Null 許容型。
    ownedObjects directoryObject コレクション このサービス プリンシパルが所有するディレクトリ オブジェクト。 読み取り専用です。 Null 許容型。 $expand、$expand で入れ子になっている $select、および $filter (/$count eq 0、/$count ne 0、/$count eq 1、/$count ne 1) をサポートします。
    owners directoryObject コレクション この servicePrincipal の所有者であるディレクトリオブジェクト。 所有者は、このオブジェクトの変更が許可されている管理者以外のユーザーまたは servicePrincipal のセットです。 $expand、$filter (/$count eq 0、/$count ne 0、/$count eq 1、/$count ne 1)、$select を $expand にネストしてサポートします。
    remoteDesktopSecurityConfiguration remoteDesktopSecurityConfiguration このサービス プリンシパルに適用されている remoteDesktopSecurityConfiguration オブジェクト。 isRemoteDesktopProtocolEnabled プロパティの$filter (eq) をサポートします。
    同期 同期 Microsoft Graph API を使用した Microsoft Entra ID 同期の機能を表します。
    tokenIssuancePolicies tokenIssuancePolicy コレクション このサービスプリンシパルに割り当てられ たtokenIssuancePolicies。
    tokenLifetimePolicy tokenLifetimePolicy コレクション このサービス プリンシパルに割り当てられている tokenLifetimePolicies。

    JSON 表記

    次の JSON 表現は、リソースの種類を示しています。

    {
  "accountEnabled": true,
  "addIns": [{"@odata.type": "microsoft.graph.addIn"}],
  "alternativeNames": ["String"] ,
  "appDisplayName": "String",
  "appId": "String",
  "appOwnerOrganizationId": "Guid",
  "appRoleAssignmentRequired": true,
  "appRoles": [{"@odata.type": "microsoft.graph.appRole"}],
  "createdByAppId": "String",
  "customSecurityAttributes": {
    "@odata.type": "microsoft.graph.customSecurityAttributeValue"
  },
  "disabledByMicrosoftStatus": "String",
  "displayName": "String",
  "homepage": "String",
  "id": "String (identifier)",
  "info": {"@odata.type": "microsoft.graph.informationalUrl"},
  "keyCredentials": [{"@odata.type": "microsoft.graph.keyCredential"}],
  "logoutUrl": "String",
  "notes": "String",
  "oauth2PermissionScopes": [{"@odata.type": "microsoft.graph.permissionScope"}],
  "passwordCredentials": [{"@odata.type": "microsoft.graph.passwordCredential"}],
  "preferredTokenSigningKeyThumbprint": "String",
  "replyUrls": ["String"],
  "resourceSpecificApplicationPermissions": [{"@odata.type": "microsoft.graph.resourceSpecificPermission"}],
  "servicePrincipalNames": ["String"],
  "servicePrincipalType": "String",
  "tags": ["String"],
  "tokenEncryptionKeyId": "String",
  "verifiedPublisher": {"@odata.type": "microsoft.graph.verifiedPublisher"}
}
    • 最終更新: