servicePrincipal リソースの種類servicePrincipal resource type

名前空間: microsoft.graphNamespace: microsoft.graph

Represents an instance of an application in a directory. Inherits from directoryObject.Represents an instance of an application in a directory. Inherits from directoryObject.

このリソースは、デルタ関数を提供することによって、増分の追加、削除、および更新を追跡するためのデルタ クエリの使用をサポートしています。This resource supports using delta query to track incremental additions, deletions, and updates, by providing a delta function.

メソッドMethods

メソッドMethod 戻り値の型Return Type 説明Description
servicePrincipals を一覧表示するList servicePrincipals servicePrincipal コレクションservicePrincipal collection servicePrincipal オブジェクトの一覧を取得します。Retrieve a list of servicePrincipal objects.
servicePrincipal を作成するCreate servicePrincipal servicePrincipalservicePrincipal 新しい servicePrincipal オブジェクトを作成します。Creates a new servicePrincipal object.
servicePrincipal を取得するGet servicePrincipal servicePrincipalservicePrincipal servicePrincipal オブジェクトのプロパティとリレーションシップを読み取ります。Read properties and relationships of servicePrincipal object.
servicePrincipalを更新するUpdate servicePrincipal servicePrincipalservicePrincipal servicePrincipal オブジェクトを更新します。Update servicePrincipal object.
servicePrincipalを削除するDelete servicePrincipal なしNone servicePrincipal オブジェクトを削除します。Delete servicePrincipal object.
createdObjects を一覧表示するList createdObjects directoryObject コレクションdirectoryObject collection createdObject オブジェクト コレクションを取得します。Get a createdObject object collection.
List ownedObjectsList ownedObjects directoryObject コレクションdirectoryObject collection ownedObject オブジェクト コレクションを取得します。Get a ownedObject object collection.
Deltaを取得するGet delta servicePrincipal コレクションservicePrincipal collection サービス プリンシパルに対する増分の変更を取得します。Get incremental changes for service principals.
アプリの役割の割り当てApp role assignments
appRoleAssignments を一覧表示するList appRoleAssignments appRoleAssignment コレクションappRoleAssignment collection このサービスプリンシパルが割り当てられているアプリの役割を取得します。Get the app roles which this service principal has been assigned.
appRoleAssignment を追加するAdd appRoleAssignment appRoleAssignmentappRoleAssignment このサービスプリンシパルにアプリの役割を割り当てます。Assign an app role to this service principal.
appRoleAssignment を削除するRemove appRoleAssignment なしNone このサービスプリンシパルからアプリの役割の割り当てを削除します。Remove an app role assignment from this service principal.
appRoleAssignedTo をリストするList appRoleAssignedTo appRoleAssignment コレクションappRoleAssignment collection このサービスプリンシパルのアプリ役割が割り当てられているユーザー、グループ、サービスプリンシパルを取得します。Get the users, groups, and service principals assigned app roles for this service principal.
appRoleAssignedTo を追加するAdd appRoleAssignedTo appRoleAssignmentappRoleAssignment このサービスプリンシパルのアプリ役割をユーザー、グループ、またはサービスプリンシパルに割り当てます。Assign an app role for this service principal to a user, group, or service principal.
appRoleAssignedTo を削除するRemove appRoleAssignedTo なしNone ユーザー、グループ、またはサービスプリンシパルからこのサービスプリンシパルへのアプリ役割の割り当てを削除します。Remove an app role assignment for this service principal from a user, group, or service principal.
証明書とシークレットCertificates and secrets
パスワードを追加するAdd password passwordCredentialpasswordCredential 強力なパスワードを servicePrincipal に追加します。Add a strong password to a servicePrincipal.
パスワードを削除するRemove password passwordCredentialpasswordCredential servicePrincipal からパスワードを削除します。Remove a password from a servicePrincipal.
キーの追加Add key keyCredentialkeyCredential 鍵資格情報を servicePrincipal に追加します。Add a key credential to a servicePrincipal.
キーの削除Remove key なしNone servicePrincipal からキー資格情報を削除します。Remove a key credential from a servicePrincipal.
委任された権限の付与Delegated permission grants
oauth2PermissionGrants を一覧表示するList oauth2PermissionGrants oAuth2PermissionGrant コレクションoAuth2PermissionGrant collection サインインしているユーザーに代わってこのサービスプリンシパルが API にアクセスすることを承認する、委任されたアクセス許可を取得します。Get the delegated permission grants authorizing this service principal to access an API on behalf of a signed-in user.
メンバーシップMembership
memberOf を一覧表示するList memberOf directoryObject コレクションdirectoryObject collection memberOf ナビゲーション プロパティからこのサービス プリンシパルが直接のメンバーであるグループを取得します。Get the groups that this service principal is a direct member of from the memberOf navigation property.
推移的な memberOf を一覧表示するList transitive memberOf directoryObject コレクションdirectoryObject collection このサービス プリンシパルがメンバーになっているグループを一覧表示します。List the groups that this service principal is a member of. この操作は推移的で、このサービス プリンシパルが入れ子のメンバーになっているグループが含まれます。This operation is transitive and includes the groups that this service principal is a nested member of.
checkMemberGroupscheckMemberGroups String collectionString collection 指定したグループ一覧内のメンバーシップを確認します。Check for membership in a specified list of groups.
checkMemberObjectscheckMemberObjects String collectionString collection 指定したグループ、ディレクトリ役割、または管理ユニット オブジェクト一覧内のメンバーシップを確認します。Check for membership in a specified list of group, directory role, or administrative unit objects.
getMemberGroupsgetMemberGroups String collectionString collection このサービス プリンシパルがメンバーになっているグループ一覧を取得します。Get the list of groups that this service principal is a member of.
getMemberObjectsgetMemberObjects String collectionString collection このサービス プリンシパルがメンバーになっているグループおよびディレクトリ役割一覧を取得します。Get the list of groups and directory roles that this service principal is a member of.
所有者Owners
所有者を一覧表示するList owners directoryObject コレクションdirectoryObject collection owner オブジェクトのコレクションを取得します。Get a owner object collection.
Add ownerAdd owner directoryObjectdirectoryObject 所有者のコレクションに投稿して、新しい所有者を作成します。Create a new owner by posting to the owners collection.
所有者を削除するRemove owner なしNone サービスプリンシパルから所有者を削除します。Remove an owner from a serviceprincipal.
ポリシーPolicies
claimsMappingPolicy を割り当てるAssign claimsMappingPolicy claimsMappingPolicy コレクションclaimsMappingPolicy collection claimsMappingPolicy をこのオブジェクトに割り当てます。Assign a claimsMappingPolicy to this object.
claimsMappingPolicies を一覧表示するList claimsMappingPolicies claimsMappingPolicy コレクションclaimsMappingPolicy collection このオブジェクトに割り当てられているすべての claimsMappingPolicies を取得します。Get all claimsMappingPolicies assigned to this object.
claimsMappingPolicy を削除するRemove claimsMappingPolicy claimsMappingPolicy コレクションclaimsMappingPolicy collection このオブジェクトから ClaimsMappingPolicy を削除します。Remove a claimsMappingPolicy from this object.
homeRealmDiscoveryPolicy を割り当てるAssign homeRealmDiscoveryPolicy homeRealmDiscoveryPolicy コレクションhomeRealmDiscoveryPolicy collection このオブジェクトに homeRealmDiscoveryPolicy を割り当てます。Assign a homeRealmDiscoveryPolicy to this object.
homeRealmDiscoveryPolicies を一覧表示するList homeRealmDiscoveryPolicies homeRealmDiscoveryPolicy コレクションhomeRealmDiscoveryPolicy collection このオブジェクトに割り当てられているすべての homeRealmDiscoveryPolicies を取得します。Get all homeRealmDiscoveryPolicies assigned to this object.
homeRealmDiscoveryPolicy を削除するRemove homeRealmDiscoveryPolicy homeRealmDiscoveryPolicy コレクションhomeRealmDiscoveryPolicy collection このオブジェクトから homeRealmDiscoveryPolicy を削除します。Remove a homeRealmDiscoveryPolicy from this object.
tokenIssuancePolicy を割り当てるAssign tokenIssuancePolicy tokenIssuancePolicy コレクションtokenIssuancePolicy collection このオブジェクトに tokenIssuancePolicy を割り当てます。Assign a tokenIssuancePolicy to this object.
tokenIssuancePolicy を一覧表示するList tokenIssuancePolicies tokenIssuancePolicy コレクションtokenIssuancePolicy collection このオブジェクトに割り当てられているすべての tokenIssuancePolicy を取得します。Get all tokenIssuancePolicies assigned to this object.
tokenIssuancePolicy を削除するRemove tokenIssuancePolicy tokenIssuancePolicy コレクションtokenIssuancePolicy collection このオブジェクトから tokenIssuancePolicy を削除します。Remove a tokenIssuancePolicy from this object.
tokenLifetimePolicy を割り当てるAssign tokenLifetimePolicy tokenLifetimePolicy コレクションtokenLifetimePolicy collection このオブジェクトに tokenLifetimePolicy を割り当てます。Assign a tokenLifetimePolicy to this object.
tokenLifetimePolicy を一覧表示するList tokenLifetimePolicies tokenLifetimePolicy コレクションtokenLifetimePolicy collection このオブジェクトに割り当てられているすべての tokenLifetimePolicy を取得します。Get all tokenLifetimePolicies assigned to this object.
tokenLifetimePolicy を削除するRemove tokenLifetimePolicy tokenLifetimePolicy コレクションtokenLifetimePolicy collection このオブジェクトから tokenLifetimePolicy を削除します。Remove a tokenLifetimePolicy from this object.

プロパティProperties

プロパティProperty Type 説明Description
accountEnabledaccountEnabled BooleanBoolean サービス プリンシパルのアカウントが有効な場合は true 。それ以外の場合は falsetrue if the service principal account is enabled; otherwise, false.
addInsaddIns addIn コレクションaddIn collection 特定のコンテキストで利用者サービスがアプリを呼び出すために使用できるカスタムの動作を定義します。Defines custom behavior that a consuming service can use to call an app in specific contexts. たとえば、ファイル ストリームのレダリングが可能なアプリケーションは、そのアプリケーションの "FileHandler" 機能のために addIns プロパティを設定することがありますFor example, applications that can render file streams may set the addIns property for its "FileHandler" functionality. これにより、Microsoft 365 などのサービスはユーザーが作業しているドキュメントのコンテキストでアプリケーションを呼び出せるようになります。This will let services like Microsoft 365 call the application in the context of a document the user is working on.
alternativeNamesalternativeNames String コレクションString collection サブスクリプションによってサービスプリンシパルを取得し、管理された ID のリソースグループと完全なリソース ID を識別するために使用されます。Used to retrieve service principals by subscription, identify resource group and full resource ids for managed identities.
appDisplayNameappDisplayName StringString 関連付けられているアプリケーションによって公開される表示名。The display name exposed by the associated application.
appIdappId StringString 関連付けられたアプリケーションの一意の識別子 (その appId プロパティ)。The unique identifier for the associated application (its appId property).
applicationTemplateIdapplicationTemplateId StringString servicePrincipal の作成元である applicationTemplate の一意の識別子。Unique identifier of the applicationTemplate that the servicePrincipal was created from. 読み取り専用です。Read-only.
appOwnerOrganizationIdappOwnerOrganizationId StringString アプリケーションが登録されているテナント id が含まれます。Contains the tenant id where the application is registered. これは、アプリケーションによってサポートされるサービスプリンシパルにのみ適用されます。This is applicable only to service principals backed by applications.
appRoleAssignmentRequiredappRoleAssignmentRequired ブール値Boolean ユーザーがサインインしたり、アプリがトークンを取得したりする前に、ユーザーまたは他のサービスプリンシパルに、このサービスプリンシパルへのアプリの役割の割り当てを付与する必要があるかどうかを指定します。Specifies whether users or other service principals need to be granted an app role assignment for this service principal before users can sign in or apps can get tokens. 規定値は false です。The default value is false. null 許容ではありません。Not nullable.
appRolesappRoles appRole コレクションappRole collection このサービスプリンシパルが表すアプリケーションによって公開される役割。The roles exposed by the application which this service principal represents. さらに詳しい情報については、 アプリケーション エンティティの appRoles プロパティの定義を参照してください。For more information see the appRoles property definition on the application entity. null 許容ではありません。Not nullable.
deletedDateTimedeletedDateTime DateTimeOffsetDateTimeOffset サービスプリンシパルが削除された日時。The date and time the service principal was deleted. 読み取り専用です。Read-only.
displayNamedisplayName StringString サービス プリンシパルの表示名。The display name for the service principal.
HomePagehomepage StringString アプリケーションのホームページまたはランディングページ。Home page or landing page of the application.
idid StringString サービス プリンシパルの一意識別子。The unique identifier for the service principal. directoryObject から継承されます。Inherited from directoryObject. キー。Key. null 許容ではありません。Not nullable. 読み取り専用です。Read-only.
infoinfo informationalUrlinformationalUrl アプリのマーケティング、サポート、利用規約、プライバシーに関する声明のURLなど、取得したアプリケーションの基本的なプロファイル情報。Basic profile information of the acquired application such as app's marketing, support, terms of service and privacy statement URLs. サービス利用規約とプライバシーに関する声明は、ユーザーの同意エクスペリエンスからユーザーに提示されます。The terms of service and privacy statement are surfaced to users through the user consent experience. 詳細については、「方法: アプリのサービス利用規約とプライバシーに関する声明を構成する」を参照してください。For more info, see How to: Add Terms of service and privacy statement for registered Azure AD apps.
keyCredentialskeyCredentials keyCredential コレクションkeyCredential collection サービス プリンシパルに関連付けられているキー資格情報のコレクションです。null 許容型ではありません。The collection of key credentials associated with the service principal. null 許容ではありません。Not nullable.
loginUrlloginUrl StringString サービスプロバイダーが認証のためにユーザーを Azure AD にリダイレクトする URL を指定します。Specifies the URL where the service provider redirects the user to Azure AD to authenticate. Azure AD は、URL を使用してMicrosoft 365 または Azure AD My Apps からアプリケーションを起動します。Azure AD uses the URL to launch the application from Microsoft 365 or the Azure AD My Apps. 空白の場合、Azure AD は SAML ベースのシングルサインオンで構成されたアプリケーションに対して IdP によって開始されるサインオンを実行します。When blank, Azure AD performs IdP-initiated sign-on for applications configured with SAML-based single sign-on. ユーザーは、Microsoft 365、Azure AD My Apps、または Azure AD SSO URL からアプリケーションを起動します。The user launches the application from Microsoft 365, the Azure AD My Apps, or the Azure AD SSO URL.
logoutUrllogoutUrl StringString Microsoft の承認サービスが OpenId Connect フロントチャネルバックチャネル、または SAML ログアウトプロトコルを使用してユーザーをログアウトするために使用する URL を指定します。Specifies the URL that will be used by Microsoft's authorization service to logout an user using OpenId Connect front-channel, back-channel or SAML logout protocols.
oauth2PermissionScopesoauth2PermissionScopes permissionScope コレクションpermissionScope collection アプリケーションによって公開された委任された権限。The delegated permissions exposed by the application. 詳細については、 applicationエンティティの api プロパティの oauth2PermissionScopes プロパティを参照してください。For more information see the oauth2PermissionScopes property on the application entity's api property. null 許容ではありません。Not nullable.
notificationEmailAddressesnotificationEmailAddresses String コレクションString collection アクティブな証明書が有効期限に近づいたときに Azure AD が通知を送信する電子メールアドレスのリストを指定します。Specifies the list of email addresses where Azure AD sends a notification when the active certificate is near the expiration date. これは、Azure AD Gallery アプリケーション用に発行された SAML トークンに署名するために使用される証明書専用です。This is only for the certificates used to sign the SAML token issued for Azure AD Gallery applications.
passwordCredentialspasswordCredentials passwordCredential コレクションpasswordCredential collection サービス プリンシパルに関連付けられているパスワード資格情報のコレクションです。null 許容型ではありません。The collection of password credentials associated with the service principal. null 許容ではありません。Not nullable.
preferredSingleSignOnModepreferredSingleSignOnMode stringstring このアプリケーションに構成されているシングルサインオンモードを指定します。Specifies the single sign-on mode configured for this application. Azure AD は、優先されるシングルサインオンモードを使用して、Microsoft 365 または Azure AD My Apps からアプリケーションを起動します。Azure AD uses the preferred single sign-on mode to launch the application from Microsoft 365 or the Azure AD My Apps. サポートされている値は、password、saml、external、および oidc です。The supported values are password, saml, external, and oidc.
replyUrlsreplyUrls String コレクションString collection 関連付けられたアプリケーションにサインインするためにユーザー トークンが送信される URL、または関連付けられたアプリケーションに対して OAuth 2.0 認証コードとアクセス トークンが送信されるリダイレクト URI。The URLs that user tokens are sent to for sign in with the associated application, or the redirect URIs that OAuth 2.0 authorization codes and access tokens are sent to for the associated application. null 許容ではありません。Not nullable.
samlSingleSignOnSettingssamlSingleSignOnSettings samlSingleSignOnSettingssamlSingleSignOnSettings saml シングルサインオンに関連する設定のコレクション。The collection for settings related to saml single sign-on.
servicePrincipalNamesservicePrincipalNames String コレクションString collection 関連する アプリケーションからコピーされた identifiersUris のリストが含まれています。Contains the list of identifiersUris , copied over from the associated application. ハイブリッドアプリケーションに追加の値を追加できます。Additional values can be added to hybrid applications. これらの値を使用して、Azure AD 内でこのアプリによって公開されるアクセス許可を識別できます。These values can be used to identify the permissions exposed by this app within Azure AD. 例えば、For example,
  • クライアントアプリは、このプロパティの値に基づくリソース URI を指定して、「aud」クレームで返される URI であるアクセストークンを取得できます。Client apps can specify a resource URI which is based on the values of this property to acquire an access token, which is the URI returned in the “aud” claim.

多値プロパティのフィルター式には、any 演算子が必要です。The any operator is required for filter expressions on multi-valued properties. null 許容ではありません。Not nullable.
servicePrincipalTypeservicePrincipalType StringString サービスプリンシパルがアプリケーションまたは管理された ID を表すかどうかを識別します。Identifies if the service principal represents an application or a managed identity. これは Azure AD によって内部的に設定されます。This is set by Azure AD internally. アプリケーションを表すサービスプリンシパルの場合、これは アプリケーション として設定されます。For a service principal that represents an application this is set as Application. 管理対象の IDを表すサービスプリンシパルの場合、これは ManagedIdentity として設定されます。For a service principal that represent a managed identity this is set as ManagedIdentity.
tagstags String コレクションString collection サービスプリンシパルの分類と識別に使用できるカスタム文字列。Custom strings that can be used to categorize and identify the service principal. null 許容ではありません。Not nullable.
tokenEncryptionKeyIdtokenEncryptionKeyId 文字列String keyCredentials コレクションにある公開キーの keyId を指定します。Specifies the keyId of a public key from the keyCredentials collection. 構成すると、Azure AD は、このプロパティで指定されたキーを使用して暗号化されたこのアプリケーションのトークンを発行します。When configured, Azure AD issues tokens for this application encrypted using the key specified by this property. 暗号化されたトークンを受け取るアプリケーション コードでは、一致する秘密キーを使用してトークンの暗号を解除してから、サインインしているユーザーのトークンとして使用する必要があります。The application code that receives the encrypted token must use the matching private key to decrypt the token before it can be used for the signed-in user.
verifiedPublisherverifiedPublisher verifiedPublisherverifiedPublisher このサービスプリンシパルが表すアプリケーションの認証された発行元を示します。Specifies the verified publisher of the application which this service principal represents.

リレーションシップRelationships

リレーションシップRelationship Type 説明Description
appRoleAssignedToappRoleAssignedTo appRoleAssignmentappRoleAssignment このサービス プリンシパルに割り当てられているプリンシパル (ユーザー、グループ、サービス プリンシパル)。Principals (users, groups, and service principals) that are assigned to this service principal. 読み取り専用です。Read-only.
appRoleAssignmentsappRoleAssignments appRoleAssignment コレクションappRoleAssignment collection このサービスプリンシパルが割り当てられているアプリケーション。Applications that this service principal is assigned to. 読み取り専用です。Read-only. Null 許容型。Nullable.
claimsMappingPoliciesclaimsMappingPolicies claimsMappingPolicy コレクションclaimsMappingPolicy collection このサービス プリンシパルに割り当てられている claimsMappingPolicies。The claimsMappingPolicies assigned to this service principal.
createdObjectscreatedObjects directoryObject コレクションdirectoryObject collection このサービス プリンシパルで作成したディレクトリ オブジェクト。Directory objects created by this service principal. 読み取り専用です。Read-only. Null 許容型。Nullable.
endpointsendpoints endpoint コレクションendpoint collection Discovery に使用できるエンドポイント。Endpoints available for discovery. Sharepoint などのサービスは、他のアプリケーションで検出して使用できるテナント固有 のSharePoint エンドポイントをこのプロパティに入力します。Services like Sharepoint populate this property with a tenant specific SharePoint endpoints that other applications can discover and use in their experiences.
homeRealmDiscoveryPolicieshomeRealmDiscoveryPolicies homeRealmDiscoveryPolicy コレクションhomeRealmDiscoveryPolicy collection このサービス プリンシパルに割り当てられている homeRealmDiscoveryPolicies。The homeRealmDiscoveryPolicies assigned to this service principal.
memberOfmemberOf directoryObject コレクションdirectoryObject collection このサービス プリンシパルがメンバーになっている役割。Roles that this service principal is a member of. HTTP メソッド: GET 読み取り専用。HTTP Methods: GET Read-only. Null 許容型です。Nullable.
oauth2PermissionGrantsoauth2PermissionGrants oAuth2PermissionGrant コレクションoAuth2PermissionGrant collection 委任されたアクセス許可は、サインインしたユーザーに代わってこのサービスプリンシパルが API にアクセスすることを許可します。Delegated permission grants authorizing this service principal to access an API on behalf of a signed-in user. 読み取り専用です。Read-only. Null 許容型。Nullable.
ownedObjectsownedObjects directoryObject コレクションdirectoryObject collection このサービス プリンシパルで所有しているディレクトリ オブジェクト。Directory objects that are owned by this service principal. 読み取り専用です。Read-only. Null 許容型です。Nullable.
ownersowners directoryObject コレクションdirectoryObject collection この servicePrincipal の所有者であるディレクトリオブジェクト。Directory objects that are owners of this servicePrincipal. 所有者は、このオブジェクトの変更が許可されている管理者以外のユーザーまたは servicePrincipals です。The owners are a set of non-admin users or servicePrincipals who are allowed to modify this object. 読み取り専用です。Read-only. Null 許容型。Nullable.
tokenIssuancePoliciestokenIssuancePolicies tokenIssuancePolicy コレクションtokenIssuancePolicy collection このサービスプリンシパルに割り当てられ たtokenIssuancePolicies。The tokenIssuancePolicies assigned to this service principal.
tokenLifetimePolicytokenLifetimePolicies tokenLifetimePolicy コレクションtokenLifetimePolicy collection このサービス プリンシパルに割り当てられている tokenLifetimePolicies。The tokenLifetimePolicies assigned to this service principal.

JSON 表記JSON representation

以下は、リソースの JSON 表記ですHere is a JSON representation of the resource

{
  "accountEnabled": true,
  "addIns": [{"@odata.type": "microsoft.graph.addIn"}],
  "alternativeNames": ["string"] ,
  "appDisplayName": "string",
  "appId": "string",
  "appOwnerOrganizationId": "guid",
  "appRoleAssignmentRequired": true,
  "appRoles": [{"@odata.type": "microsoft.graph.appRole"}],
  "displayName": "string",
  "homepage": "string",
  "id": "string (identifier)",
  "info": {"@odata.type": "microsoft.graph.informationalUrl"},
  "keyCredentials": [{"@odata.type": "microsoft.graph.keyCredential"}],
  "logoutUrl": "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"}
}