servicePrincipal リソースの種類servicePrincipal resource type

重要

Microsoft Graph の/betaバージョンの api は変更される可能性があります。APIs under the /beta version in Microsoft Graph are subject to change. 実稼働アプリケーションでは、これらの API の使用はサポートされていません。Use of these APIs in production applications is not supported.

ディレクトリ内のアプリケーションのインスタンスを表します。Represents an instance of an application in a directory. directoryObject から継承します。Inherits from directoryObject.

このリソースは以下をサポートしています。This resource supports:

  • デルタ関数を提供することにより、デルタ クエリを使用して、増分の追加、削除、更新を追跡します。Using delta query to track incremental additions, deletions, and updates, by providing a delta function.

JSON 表記JSON representation

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

{
  "accountEnabled": true,
  "addIns": [{"@odata.type": "microsoft.graph.addIn"}],
  "appDisplayName": "string",
  "appId": "string",
  "appOwnerOrganizationId": "guid",
  "appRoleAssignmentRequired": true,
  "displayName": "string",
  "errorUrl": "string",
  "homepage": "string",
  "id": "string (identifier)",
  "keyCredentials": [{"@odata.type": "microsoft.graph.keyCredential"}],
  "logoutUrl": "string",
  "oauth2Permissions": [{"@odata.type": "microsoft.graph.oAuth2Permission"}],
  "passwordCredentials": [{"@odata.type": "microsoft.graph.passwordCredential"}],
  "preferredTokenSigningKeyThumbprint": "string",
  "publisherName": "string",
  "replyUrls": ["string"],
  "samlMetadataUrl": "string",
  "servicePrincipalNames": ["string"],
  "tags": ["string"],
  "appRoles": [{"@odata.type": "microsoft.graph.appRole"}]
}

プロパティProperties

プロパティProperty Type 説明Description
accountEnabledaccountEnabled BooleanBoolean サービス プリンシパルのアカウントが有効な場合は true。それ以外の場合は falsetrue if the service principal account is enabled; otherwise, false.
appDisplayNameappDisplayName StringString 関連付けられているアプリケーションによって公開される表示名。The display name exposed by the associated application.
appIdappId StringString 関連付けられたアプリケーションの一意の識別子 (その appId プロパティ)。The unique identifier for the associated application (its appId property).
appRoleAssignmentRequiredappRoleAssignmentRequired BooleanBoolean Azure AD からアプリケーションにユーザー トークンまたはアクセス トークンが発行される前に、ユーザーまたはグループに対する appRoleAssignment が必要かどうかを指定します。Specifies whether an appRoleAssignment to a user or group is required before Azure AD will issue a user or access token to the application. null 許容型ではありません。Not nullable.
appRolesappRoles appRole コレクションappRole collection 関連付けられているアプリケーションによって公開されるアプリケーション ロール。The application roles exposed by the associated application. さらに詳しい情報については、アプリケーション エンティティの appRoles プロパティの定義を参照してください。For more information see the appRoles property definition on the application entity. null 許容型ではありません。Not nullable.
displayNamedisplayName StringString サービス プリンシパルの表示名。The display name for the service principal.
errorUrlerrorUrl StringString
HomePagehomepage StringString 関連付けられたアプリケーションのホーム ページの URL。The URL to the homepage of the associated application.
keyCredentialskeyCredentials keyCredential コレクションkeyCredential collection サービス プリンシパルに関連付けられているキー資格情報のコレクションです。null 許容型ではありません。The collection of key credentials associated with the service principal. null 許容型ではありません。Not nullable.
logoutUrllogoutUrl StringString Microsoft の承認サービスで、フロント チャネルバック チャネルまたは SAML ログアウト プロトコルを使ってユーザーのログアウトするのに使う URL を指定します。Specifies the URL that will be used by Microsoft's authorization service to logout an user using front-channel, back-channel or SAML logout protocols.
oauth2Permissionsoauth2Permissions oAuth2Permission コレクションoAuth2Permission collection 関連付けられているアプリケーションによって公開される OAuth 2.0 のアクセス許可。The OAuth 2.0 permissions exposed by the associated application. さらに詳しい情報については、アプリケーション エンティティの oauth2Permissions プロパティの定義を参照してください。For more information see the oauth2Permissions property definition on the application entity. null 許容型ではありません。Not nullable.
idid StringString サービス プリンシパルの一意識別子。The unique identifier for the service principal. directoryObject から継承されます。Inherited from directoryObject. キー。Key. null 許容ではありません。Not nullable. 読み取り専用です。Read-only.
passwordCredentialspasswordCredentials passwordCredential コレクションpasswordCredential collection サービス プリンシパルに関連付けられているパスワード資格情報のコレクションです。null 許容型ではありません。The collection of password credentials associated with the service principal. null 許容型ではありません。Not nullable.
preferredTokenSigningKeyThumbprintpreferredTokenSigningKeyThumbprint StringString 内部使用専用に予約済みです。Reserved for internal use only. このプロパティに書き込みしたり、依存したりしないでください。Do not write or otherwise rely on this property. 将来のバージョンで削除される可能性があります。May be removed in future versions.
publisherNamepublisherName StringString 関連付けられたアプリケーションが指定されているテナントの表示名。The display name of the tenant in which the associated application is specified.
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.
samlMetadataUrlsamlMetadataUrl StringString
servicePrincipalNamesservicePrincipalNames String コレクションString collection 関連するアプリケーションを識別する URI です。The URIs that identify the associated application. 詳細情報については、「アプリケーション オブジェクトとサービス プリンシパル オブジェクト」を参照してください。複数値プロパティのフィルター式には any 演算子が必要です。For more information see, Application Objects and Service Principal Objects.The any operator is required for filter expressions on multi-valued properties. null 許容型ではありません。Not nullable.
tagstags String コレクションString collection null 許容型ではありません。Not nullable.

リレーションシップ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 the service principal is assigned to. 読み取り専用です。Read-only. Null 許容型。Nullable.
createdObjectscreatedObjects directoryObject コレクションdirectoryObject collection このサービス プリンシパルで作成したディレクトリ オブジェクト。Directory objects created by this service principal. 読み取り専用です。Read-only. Null 許容型。Nullable.
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 このサービス プリンシパルに関連付けられているユーザーの偽装許可です。User impersonation grants associated with this service principal. 読み取り専用です。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 このサービス プリンシパルで所有者であるディレクトリ オブジェクト。Directory objects that are owners of this service principal. 所有者は、このオブジェクトの変更を許可されている管理者以外のユーザーです。The owners are a set of non-admin users who are allowed to modify this object. 読み取り専用です。Read-only. Null 許容型です。Nullable.
policypolicy policy コレクションpolicy collection このサービス プリンシパルに割り当てられているポリシー。The policies assigned to this service principal.

メソッドMethods

メソッドMethod 戻り値の型Return Type 説明Description
servicePrincipal を取得するGet servicePrincipal servicePrincipalservicePrincipal servicePrincipal オブジェクトのプロパティとリレーションシップを読み取ります。Read properties and relationships of servicePrincipal object.
servicePrincipals を一覧表示するList servicePrincipals servicePrincipal コレクションservicePrincipal collection servicePrincipal オブジェクトの一覧を取得します。Retrieve a list of servicePrincipal objects.
appRoleAssignment を作成するCreate appRoleAssignment appRoleAssignmentappRoleAssignment appRoleAssignment コレクションに投稿して新しい AppRoleAssignments を作成します。Create a new appRoleAssignment by posting to the appRoleAssignments collection.
appRoleAssignments を一覧表示するList appRoleAssignments appRoleAssignment コレクションappRoleAssignment collection appRoleAssignment オブジェクト コレクションを取得します。Get a appRoleAssignment object collection.
createdObjects を一覧表示するList createdObjects directoryObject コレクションdirectoryObject collection createdObject オブジェクト コレクションを取得します。Get a createdObject object collection.
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.
割り当てられているポリシーを一覧表示するList assigned policies policy コレクションpolicy collection このオブジェクトに割り当てられているすべてのポリシーを取得します。Get all policies assigned to this object.
oauth2PermissionGrants を一覧表示するList oauth2PermissionGrants oAuth2PermissionGrant コレクションoAuth2PermissionGrant collection oAuth2PermissionGrant オブジェクト コレクションを取得します。Get a oAuth2PermissionGrant object collection.
ownedObjects を一覧表示するList ownedObjects directoryObject コレクションdirectoryObject collection ownedObject オブジェクト コレクションを取得します。Get a ownedObject object collection.
所有者を追加するAdd owner directoryObjectdirectoryObject 所有者のコレクションに投稿して、新しい所有者を作成します。Create a new owner by posting to the owners collection.
所有者を一覧表示するList owners directoryObject コレクションdirectoryObject collection owner オブジェクトのコレクションを取得します。Get a owner object collection.
更新するUpdate servicePrincipalservicePrincipal servicePrincipal オブジェクトを更新します。Update servicePrincipal object.
削除するDelete なしNone servicePrincipal オブジェクトを削除します。Delete servicePrincipal object.
checkMemberGroupscheckMemberGroups String コレクションString collection
getMemberGroupsgetMemberGroups String コレクションString collection
getMemberObjectsgetMemberObjects String コレクションString collection
差分delta servicePrincipal コレクションservicePrincipal collection サービス プリンシパルに対する増分の変更を取得します。Get incremental changes for service principals.