servicePrincipal リソースの種類

名前空間: microsoft.graph

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

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

メソッド

メソッド 戻り値の型 説明
servicePrincipals を一覧表示する servicePrincipal コレクション servicePrincipal オブジェクトの一覧を取得します。
servicePrincipal を作成する servicePrincipal 新しい servicePrincipal オブジェクトを作成します。
servicePrincipal を取得する servicePrincipal servicePrincipal オブジェクトのプロパティとリレーションシップを読み取ります。
servicePrincipalを更新する servicePrincipal servicePrincipal オブジェクトを更新します。
servicePrincipalを削除する なし servicePrincipal オブジェクトを削除します。
createdObjects を一覧表示する directoryObject コレクション createdObject オブジェクト コレクションを取得します。
List ownedObjects directoryObject コレクション ownedObject オブジェクト コレクションを取得します。
Deltaを取得する servicePrincipal コレクション サービス プリンシパルに対する増分の変更を取得します。
アプリの役割の割り当て
appRoleAssignments を一覧表示する appRoleAssignment コレクション このサービスプリンシパルが割り当てられているアプリの役割を取得します。
appRoleAssignment を追加する appRoleAssignment このサービスプリンシパルにアプリの役割を割り当てます。
appRoleAssignment を削除する なし このサービスプリンシパルからアプリの役割の割り当てを削除します。
appRoleAssignedTo をリストする appRoleAssignment コレクション このサービスプリンシパルのアプリ役割が割り当てられているユーザー、グループ、サービスプリンシパルを取得します。
appRoleAssignedTo を追加する appRoleAssignment このサービスプリンシパルのアプリ役割をユーザー、グループ、またはサービスプリンシパルに割り当てます。
appRoleAssignedTo を削除する なし ユーザー、グループ、またはサービスプリンシパルからこのサービスプリンシパルへのアプリ役割の割り当てを削除します。
証明書とシークレット
パスワードを追加する passwordCredential 強力なパスワードを servicePrincipal に追加します。
パスワードを削除する passwordCredential servicePrincipal からパスワードを削除します。
キーの追加 keyCredential 鍵資格情報を servicePrincipal に追加します。
キーの削除 なし servicePrincipal からキー資格情報を削除します。
代理アクセス許可の分類
代理アクセス権の分類を列挙する delegatedPermissionClassification コレクション このサービスプリンシパルによって公開される代理アクセス許可のアクセス許可の分類を取得します。
代理アクセス権の分類を追加する delegatedPermissionClassification このサービスプリンシパルによって公開された、代理アクセス許可のアクセス許可の分類を追加します。
代理アクセス権の分類を削除する なし このサービスプリンシパルによって公開された代理アクセス許可のアクセス許可の分類を削除します。
委任された権限の付与
oauth2PermissionGrants を一覧表示する oAuth2PermissionGrant コレクション サインインしているユーザーに代わってこのサービスプリンシパルが API にアクセスすることを承認する、委任されたアクセス許可を取得します。
メンバーシップ
memberOf を一覧表示する directoryObject コレクション memberOf ナビゲーション プロパティからこのサービス プリンシパルが直接のメンバーであるグループを取得します。
推移的な memberOf を一覧表示する directoryObject コレクション このサービス プリンシパルがメンバーになっているグループを一覧表示します。 この操作は推移的で、このサービス プリンシパルが入れ子のメンバーになっているグループが含まれます。
checkMemberGroups String collection 指定したグループ一覧内のメンバーシップを確認します。
checkMemberObjects String collection 指定したグループ、ディレクトリ役割、または管理ユニット オブジェクト一覧内のメンバーシップを確認します。
getMemberGroups String collection このサービス プリンシパルがメンバーになっているグループ一覧を取得します。
getMemberObjects String コレクション このサービス プリンシパルがメンバーになっているグループ、管理単位、およびディレクトリ ロールの一覧を取得します。
所有者
所有者を一覧表示する directoryObject コレクション 所有者オブジェクトのコレクションを取得します。
Add owner directoryObject 所有者のコレクションに投稿して、新しい所有者を作成します。
所有者を削除する なし サービスプリンシパルから所有者を削除します。
ポリシー
claimsMappingPolicy を割り当てる claimsMappingPolicy コレクション claimsMappingPolicy をこのオブジェクトに割り当てます。
claimsMappingPolicies を一覧表示する claimsMappingPolicy コレクション このオブジェクトに割り当てられているすべての claimsMappingPolicies を取得します。
claimsMappingPolicy を削除する claimsMappingPolicy コレクション このオブジェクトから ClaimsMappingPolicy を削除します。
homeRealmDiscoveryPolicy を割り当てる homeRealmDiscoveryPolicy コレクション このオブジェクトに homeRealmDiscoveryPolicy を割り当てます。
homeRealmDiscoveryPolicies を一覧表示する homeRealmDiscoveryPolicy コレクション このオブジェクトに割り当てられているすべての homeRealmDiscoveryPolicies を取得します。
homeRealmDiscoveryPolicy を削除する homeRealmDiscoveryPolicy コレクション このオブジェクトから homeRealmDiscoveryPolicy を削除します。
tokenIssuancePolicy を割り当てる tokenIssuancePolicy コレクション このオブジェクトに tokenIssuancePolicy を割り当てます。
tokenIssuancePolicy を一覧表示する tokenIssuancePolicy コレクション このオブジェクトに割り当てられているすべての tokenIssuancePolicy を取得します。
tokenIssuancePolicy を削除する tokenIssuancePolicy コレクション このオブジェクトから tokenIssuancePolicy を削除します。
tokenLifetimePolicy を割り当てる tokenLifetimePolicy コレクション このオブジェクトに tokenLifetimePolicy を割り当てます。
tokenLifetimePolicy を一覧表示する tokenLifetimePolicy コレクション このオブジェクトに割り当てられているすべての tokenLifetimePolicy を取得します。
tokenLifetimePolicy を削除する tokenLifetimePolicy コレクション このオブジェクトから tokenLifetimePolicy を削除します。

プロパティ

重要

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

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

$filter (eqneNOT) をサポートします。
appRoles appRole コレクション このサービスプリンシパルが表すアプリケーションによって公開される役割。 さらに詳しい情報については、アプリケーション エンティティの appRoles プロパティの定義を参照してください。 null 許容ではありません。
deletedDateTime DateTimeOffset サービス プリンシパルが削除された日時。読み取り専用です。
説明 String サービス プリンシパルの内部エンド ユーザー向けの説明を提供するフリー テキスト フィールド。 MyApps などのエンドユーザー ポータルでは、このフィールドにアプリケーションの説明が表示されます。 最大許容サイズは 1024 文字です。 $filter (eqnenotgelestartsWith$search) をサポートします。
disabledByMicrosoftStatus String Microsoft で登録済みアプリケーションを無効にしたかどうかを指定します。使用可能な値は、null (既定値)、NotDisabledDisabledDueToViolationOfServicesAgreement です (疑わしいアクティビティ、悪用されたアクティビティ、悪意のあるアクティビティ、またはMicrosoft サービス規約の違反が理由になります)。

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

$filter (eqnenotgele、および< eqnull値)をサポートします。
keyCredentials keyCredential コレクション サービス プリンシパルに関連付けられているキー資格情報のコレクションです。null 許容型ではありません。 null 許容ではありません。 $filter (eqnotgele) をサポートします。
loginUrl String サービスプロバイダーが認証のためにユーザーを Azure AD にリダイレクトする URL を指定します。 Azure AD は、URL を使用してMicrosoft 365 または Azure AD My Apps からアプリケーションを起動します。 空白の場合、Azure AD は SAML ベースのシングルサインオンで構成されたアプリケーションに対して IdP によって開始されるサインオンを実行します。 ユーザーは、Microsoft 365、Azure AD My Apps、または Azure AD SSO URL からアプリケーションを起動します。
logoutUrl String Microsoft の承認サービスが OpenId Connect フロントチャネルバックチャネル、または SAML ログアウトプロトコルを使用してユーザーをログアウトするために使用する URL を指定します。
notes String 通常は運用目的で使用される、サービス プリンシパルに関する情報を取得するためのフリー テキスト フィールド。最大許容サイズは 1024 文字です。
notificationEmailAddresses String コレクション アクティブな証明書が有効期限に近づいたときに Azure AD が通知を送信する電子メールアドレスのリストを指定します。 これは、Azure AD Gallery アプリケーション用に発行された SAML トークンに署名するために使用される証明書専用です。
oauth2PermissionScopes permissionScope コレクション アプリケーションによって公開された委任された権限。 詳細については、applicationエンティティの api プロパティの oauth2PermissionScopes プロパティを参照してください。 null 許容ではありません。
passwordCredentials passwordCredential コレクション アプリケーションに関連付けられているキー資格情報のコレクションです。null 許容型ではありません。
preferredSingleSignOnMode string このアプリケーションに構成されているシングルサインオンモードを指定します。 Azure AD は、優先されるシングルサインオンモードを使用して、Microsoft 365 または Azure AD My Apps からアプリケーションを起動します。 サポートされている値は passwordsamlnotSupported、および oidc です。
replyUrls String コレクション 関連付けられたアプリケーションにサインインするためにユーザー トークンが送信される URL、または関連付けられたアプリケーションに対して OAuth 2.0 認証コードとアクセス トークンが送信されるリダイレクト URI。null 許容型ではありません。
samlSingleSignOnSettings samlSingleSignOnSettings saml シングルサインオンに関連する設定のコレクション。
servicePrincipalNames String コレクション 関連する アプリケーションからコピーされた identifiersUris のリストが含まれています。 ハイブリッドアプリケーションに追加の値を追加できます。 これらの値を使用して、Azure AD 内でこのアプリによって公開されるアクセス許可を識別できます。 例えば、
  • クライアントアプリは、このプロパティの値に基づくリソース URI を指定して、「aud」クレームで返される URI であるアクセストークンを取得できます。

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

$filter (eqnotgelestartsWith) をサポートします。
servicePrincipalType String サービス プリンシパルがアプリケーションや管理された ID またはレガシ アプリケーションを表すかどうかを識別します。 これは Azure AD によって内部的に設定されます。 servicePrincipalType プロパティは、3 つの値に設定できます。
  • アプリケーション - アプリケーションまたはサービスを表現するサービス プリンシパル。 appId プロパティは、関連付けられたアプリの登録を識別し、アプリケーションappId (場合によっては別のテナントから) と一致させます。 関連付けられたアプリの登録が存在しない場合、サービス プリンシパルにトークンは発行されません。
  • ManagedIdentity -サービス プリンシパルは、 管理されたIDを表現します。 管理 ID を表すサービス プリンシパルは、アクセスとアクセス許可を付与されることがありますが、直接更新または変更することはできません。
  • レガシ - アプリの登録前または従来の経験で作成されたアプリを表すサービス プリンシパル。 レガシ サービス プリンシパルは、資格情報、サービス プリンシパル名、返信 URL、および承認されたユーザーが編集できる他のプロパティを持っていますが、関連付けられたアプリの登録を持つ必要があります。 appId 値は、サービス プリンシパルとアプリの登録の関連付けをします。 サービス プリンシパルは、作成されたテナントでのみ使用できます。
  • SocialIdp - 内部使用用。
signInAudience String 現在のアプリケーションでサポートされている Microsoft アカウントを指定します。読み取り専用です。

サポートされている値は次のとおりです。
  • AzureADMyOrg: 組織の Azure AD テナント (シングル テナント) で Microsoft の職場または学校アカウントを持つユーザー。
  • AzureADMultipleOrgs: いずれかの組織の Azure AD テナント (マルチテナント) で Microsoft の職場または学校アカウントを持つユーザー
  • AzureADandPersonalMicrosoftAccount: 個人の Microsoft アカウントを持つユーザー、またはいずれかの組織の Azure AD テナントで職場または学校のアカウントを持つユーザー。
  • PersonalMicrosoftAccount: 個人の Microsoft アカウントを持つユーザーのみ。
tags String collection サービス プリンシパルの分類と識別に使用できるカスタム文字列。null 許容型ではありません。

$filter (eqnotgelestartsWith) をサポートします。
tokenEncryptionKeyId String keyCredentials コレクションにある公開キーの keyId を指定します。 構成すると、Azure AD は、このプロパティで指定されたキーを使用して暗号化されたこのアプリケーションのトークンを発行します。 暗号化されたトークンを受け取るアプリケーション コードでは、一致する秘密キーを使用してトークンを複合化してから、サインインしているユーザーのトークンとして使用する必要があります。
verifiedPublisher verifiedPublisher このサービスプリンシパルが表すアプリケーションの認証された発行元を示します。

リレーションシップ

リレーションシップ 説明
appRoleAssignedTo appRoleAssignment ユーザー、グループ、その他のサービス プリンシパルに付与される、このアプリまたはサービスのアプリの役割の割り当て。 $expand をサポートします。
appRoleAssignments appRoleAssignment コレクション このサービス プリンシパルに付与される、別のアプリまたはサービスのアプリの役割の割り当て。 $expand をサポートします。
claimsMappingPolicies claimsMappingPolicy コレクション このサービス プリンシパルに割り当てられている claimsMappingPolicies。 $expand をサポートします。
createdObjects directoryObject collection このサービス プリンシパルで作成したディレクトリ オブジェクト。読み取り専用です。null 許容型です。
homeRealmDiscoveryPolicies homeRealmDiscoveryPolicy コレクション このサービス プリンシパルに割り当てられている homeRealmDiscoveryPolicies。 $expand をサポートします。
memberOf directoryObject コレクション このサービス プリンシパルがメンバーになっている役割。 HTTP メソッド: GET 読み取り専用。 Null 許容型です。 $expand をサポートします。
oauth2PermissionGrants oAuth2PermissionGrant コレクション 委任されたアクセス許可は、サインインしたユーザーに代わってこのサービス プリンシパルが API にアクセスすることを許可します。読み取り専用です。null 許容型です。
ownedObjects directoryObject コレクション このサービス プリンシパルで所有しているディレクトリ オブジェクト。 読み取り専用です。 Null 許容型。 $expand をサポートします。
owners directoryObject コレクション この servicePrincipal の所有者であるディレクトリオブジェクト。 所有者は、このオブジェクトの変更が許可されている管理者以外のユーザーまたは servicePrincipals です。 読み取り専用です。 Null 許容型。 $expand をサポートします。
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"}],
  "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"}],
  "replyUrls": ["string"],
  "servicePrincipalNames": ["string"],
  "servicePrincipalType": "string",
  "tags": ["string"],
  "tokenEncryptionKeyId": "String",
  "verifiedPublisher": {"@odata.type": "microsoft.graph.verifiedPublisher"}
}