servicePrincipal リソースの種類

[アーティクル]
07/16/2024

名前空間: microsoft.graph

重要

Microsoft Graph の /beta バージョンの API は変更される可能性があります。実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。

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

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

メソッド

メソッド	戻り値の型	説明
List	servicePrincipal コレクション	servicePrincipal オブジェクトの一覧を取得します。
Create	servicePrincipal	新しい servicePrincipal オブジェクトを作成します。
Get	servicePrincipal	servicePrincipal オブジェクトのプロパティとリレーションシップを読み取ります。
Update	なし	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 人の所有者が必要です。
パスワードベースのシングルサインオン資格情報
Create	passwordSingleSignOnCredentialSet	本文で指定されたユーザーまたはグループの資格情報セットを作成します。
Get	passwordSingleSignOnCredentialSet	本文で指定されたユーザーまたはグループの資格情報セットを取得します。
Update	なし	本文で指定されたユーザーまたはグループの資格情報セットを更新します。
Delete	なし	本文で指定されたユーザーまたはグループの資格情報セットを削除します。

プロパティ

重要

$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	関連付けられているアプリケーションによって公開される表示名。
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 許容ではありません。
customSecurityAttributes	customSecurityAttributeValue	ディレクトリオブジェクトに割り当てられたカスタムセキュリティ属性の値を保持するオープン複合型。 Null 許容型です。でのみ返されます。`$select` `$filter` (`eq`、`ne`、`not`、`startsWith`) をサポートします。フィルター値では大文字と小文字が区別されます。このプロパティを読み取るために、呼び出し元のアプリに CustomSecAttributeAssignment.Read.All アクセス許可を割り当てる必要があります。このプロパティを記述するには、呼び出し元のアプリに CustomSecAttributeAssignment.ReadWrite.All アクセス許可を割り当てる必要があります。委任されたシナリオでこのプロパティを読み書きするには、管理者に属性割り当て管理者ロールを割り当てる必要があります。
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` をサポートします。
errorUrl	String	非推奨。使用しないでください。
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が通知を送信する電子メールアドレスの一覧を指定します。これは、ギャラリーアプリケーションに対して発行された SAML トークンの署名に使用Microsoft Entra証明書に対してのみ行われます。
passwordCredentials	passwordCredential コレクション	サービスプリンシパルに関連付けられているパスワード資格情報のコレクションです。null 許容型ではありません。 null 許容ではありません。
passwordSingleSignOnSettings	passwordSingleSignOnSettings	パスワードシングルサインオンに関連する設定のコレクションです。 `$select=passwordSingleSignOnSettings` を使用してプロパティを読み取ります。カスタムアプリケーションテンプレートを除き applicationTemplates では読み取り専用です。
preferredSingleSignOnMode	string	このアプリケーションに構成されているシングルサインオンモードを指定します。 Microsoft Entra IDは、優先シングルサインオンモードを使用して、Microsoft 365 またはMicrosoft Entra マイアプリからアプリケーションを起動します。サポートされている値は `password`、`saml`、`notSupported`、および `oidc` です。手記：このフィールドは、古い SAML アプリと、自動的に設定されない OIDC アプリケーションの場合に `null` される場合があります。
permissionGrantPreApprovalPolicies	permissionGrantPreApprovalPolicy コレクション	サービスプリンシパルに割り当てられている事前適用ポリシーの一覧。
preferredTokenSigningKeyEndDateTime	DateTimeOffset	preferredTokenSigningKeyThumbprintによってマークされたトークンの署名に使用される keyCredential の有効期限を指定します。この属性の更新は現在サポートされていません。詳細については、「 ServicePrincipal プロパティの違い」を参照してください。
preferredTokenSigningKeyThumbprint	String	このプロパティは、SAML アプリケーション ( preferredSingleSignOnMode が `saml` に設定されているアプリ) で使用して、SAML 応答の署名に使用される証明書を制御できます。 SAML ではないアプリケーションの場合は、このプロパティを書き込んだり、このプロパティに依存したりしないでください。
publishedPermissionScopes	permissionScope コレクション	アプリケーションによって公開された委任された権限。詳細については、アプリケーションエンティティの api プロパティの oauth2PermissionScopes プロパティを参照してください。 null 許容ではありません。注意: このプロパティは、v1.0 では oauth2PermissionScopes という名前が付いています。
publisherName	String	アプリケーションを発行したMicrosoft Entra テナントの名前。
replyUrls	String コレクション	関連付けられたアプリケーションにサインインするためにユーザートークンが送信される URL、または関連付けられたアプリケーションに対して OAuth 2.0 認証コードとアクセストークンが送信されるリダイレクト URI。 null 許容型ではありません。
samlMetadataUrl	String	サービスがフェデレーション用の SAML メタデータを公開する URL。
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によって設定されます。アプリケーションを表すサービスプリンシパルの場合、これはアプリケーションとして設定されます。マネージド ID を表すサービスプリンシパルの場合、これは ManagedIdentity として設定されます。 SocialIdp型は内部使用用です。
signInAudience	String	現在のアプリケーションでサポートされている Microsoft アカウントを指定します。読み取り専用です。サポートされている値は次のとおりです。 `AzureADMyOrg`: organizationのMicrosoft Entra テナント (シングルテナント) に Microsoft の職場または学校アカウントを持つユーザー。 `AzureADMultipleOrgs`: organizationのMicrosoft Entra テナント (マルチテナント) に Microsoft の職場または学校アカウントを持つユーザー。 `AzureADandPersonalMicrosoftAccount`: 個人の Microsoft アカウントを持つユーザー、またはorganizationのMicrosoft Entra テナント内の職場または学校アカウントを持つユーザー。 `PersonalMicrosoftAccount`: 個人の Microsoft アカウントを持つユーザーのみ。
tags	String コレクション	サービスプリンシパルの分類と識別に使用できるカスタム文字列。 null 許容ではありません。値は、ここで、関連付けられているアプリケーションエンティティの tags プロパティに設定された文字列の和集合です。 `$filter` (`eq`、`not`、`ge`、`le`、`startsWith`) をサポートします。
tokenEncryptionKeyId	String	keyCredentials コレクションにある公開キーの keyId を指定します。構成すると、Microsoft Entra IDは、このプロパティで指定されたキーを使用して暗号化されたこのアプリケーションのトークンを発行します。暗号化されたトークンを受け取るアプリケーションコードでは、一致する秘密キーを使用してトークンを複合化してから、サインインしているユーザーのトークンとして使用する必要があります。
verifiedPublisher	verifiedPublisher	このサービスプリンシパルにリンクされているアプリケーションの検証済み発行元を指定します。

リレーションシップ

重要

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

リレーションシップ	型	説明
appManagementPolicies	appManagementPolicy コレクション	このサービスプリンシパルに適用される appManagementPolicy。
appRoleAssignedTo	appRoleAssignment	ユーザー、グループ、その他のサービスプリンシパルに付与されるアプリの役割の割り当て。`$expand`をサポートします。
appRoleAssignments	appRoleAssignment コレクション	このサービスプリンシパルに付与される、別のアプリまたはサービスのアプリの役割の割り当て。 `$expand` をサポートします。
claimsMappingPolicies	claimsMappingPolicy コレクション	このサービスプリンシパルに割り当てられている claimsMappingPolicies。 `$expand` をサポートします。
claimsPolicy	customClaimsPolicy	アプリケーション管理者がこのポリシーの影響を受けるトークンで生成される要求をカスタマイズできるようにする要求ポリシー。
createdObjects	directoryObject コレクション	このサービスプリンシパルで作成したディレクトリオブジェクト。読み取り専用です。 Null 許容型。
delegatedPermissionClassifications	delegatedPermissionClassification コレクション	このサービスプリンシパルが表すアプリによって公開される代理アクセス許可のアクセス許可の分類。 `$expand` をサポートします。
endpoints	endpoint コレクション	Discovery に使用できるエンドポイント。 Sharepoint などのサービスは、他のアプリケーションで検出して使用できるテナント固有のSharePoint エンドポイントをこのプロパティに入力します。
homeRealmDiscoveryPolicies	homeRealmDiscoveryPolicy コレクション	このサービスプリンシパルに割り当てられている homeRealmDiscoveryPolicies。 `$expand` をサポートします。
memberOf	directoryObject コレクション	このサービスプリンシパルがメンバーになっている役割。 HTTP メソッド: GET 読み取り専用。 Null 許容型です。 `$expand` をサポートします。
oauth2PermissionGrants	oAuth2PermissionGrant コレクション	委任されたアクセス許可は、サインインしたユーザーに代わってこのサービスプリンシパルが API にアクセスすることを許可します。読み取り専用です。 Null 許容型。
ownedObjects	directoryObject コレクション	このサービスプリンシパルで所有しているディレクトリオブジェクト。読み取り専用です。 Null 許容型。 `$expand` および `$filter` (`/$count eq 0`、`/$count ne 0`、`/$count eq 1`、`/$count ne 1`) をサポートします。
owners	directoryObject コレクション	この servicePrincipal の所有者であるディレクトリオブジェクト。所有者は、このオブジェクトの変更を許可されている管理者以外のユーザーまたは servicePrincipals のセットです。読み取り専用です。 Null 許容型。 `$expand` および `$filter` (`/$count eq 0`、`/$count ne 0`、`/$count eq 1`、`/$count ne 1`) をサポートします。
remoteDesktopSecurityConfiguration	remoteDesktopSecurityConfiguration	このサービスプリンシパルに適用される remoteDesktopSecurityConfiguration オブジェクト。 isRemoteDesktopProtocolEnabled プロパティの`$filter` (`eq`) をサポートします。
同期	同期	Microsoft Graph APIを介した ID 同期Microsoft Entra機能を表します。
tokenIssuancePolicies	tokenIssuancePolicy コレクション	このサービスプリンシパルに割り当てられたtokenIssuancePolicies。 `$expand` をサポートします。
tokenLifetimePolicy	tokenLifetimePolicy コレクション	このサービスプリンシパルに割り当てられている tokenLifetimePolicies。 `$expand` をサポートします。

JSON 表記

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

{
  "accountEnabled": true,
  "addIns": [{"@odata.type": "microsoft.graph.addIn"}],
  "alternativeNames": "String",
  "appDisplayName": "String",
  "appId": "String",
  "appOwnerOrganizationId": "Guid",
  "applicationTemplateId": "String",
  "appRoleAssignmentRequired": true,
  "appRoles": [{"@odata.type": "microsoft.graph.appRole"}],
  "customSecurityAttributes": {
    "@odata.type": "microsoft.graph.customSecurityAttributeValue"
  },
  "disabledByMicrosoftStatus": "String",
  "displayName": "String",
  "errorUrl": "String",
  "homepage": "String",
  "id": "String (identifier)",
  "info": {"@odata.type": "microsoft.graph.informationalUrl"},
  "keyCredentials": [{"@odata.type": "microsoft.graph.keyCredential"}],
  "loginUrl": "String",
  "logoutUrl": "String",
  "notes": "String",
  "notificationEmailAddresses": ["String"],
  "publishedPermissionScopes": [{"@odata.type": "microsoft.graph.permissionScope"}],
  "passwordCredentials": [{"@odata.type": "microsoft.graph.passwordCredential"}],
  "passwordSingleSignOnSettings": {"@odata.type": "microsoft.graph.passwordSingleSignOnSettings"},
  "preferredSingleSignOnMode": "String",
  "preferredTokenSigningKeyEndDateTime": "DateTime",
  "preferredTokenSigningKeyThumbprint": "String",
  "publisherName": "String",
  "replyUrls": ["String"],
  "samlMetadataUrl": "String",
  "samlSingleSignOnSettings": "microsoft.DirectoryServices.SamlSingleSignOnSettings",
  "servicePrincipalNames": ["String"],
  "servicePrincipalType": "String",
  "signInAudience": "String",
  "tags": ["String"],
  "tokenEncryptionKeyId": "String",
  "verifiedPublisher": {"@odata.type": "microsoft.graph.verifiedPublisher"}
}

次の方法で共有

servicePrincipal リソースの種類

メソッド

プロパティ

リレーションシップ

JSON 表記

フィードバック

その他のリソース