Microsoft Entra エンタイトルメント管理 API の操作
名前空間: microsoft.graph
重要
Microsoft Graph の /beta バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。
Microsoft Entra エンタイトルメント管理は、組織内外のユーザーだけでなく、内部ユーザーのグループ、アプリケーション、SharePoint Online サイトへのアクセスを管理するのに役立ちます。
ユーザーがこれらのリソース全体で持つ必要があるロールを持つアクセス パッケージを作成し、アクセス パッケージを要求できるユーザーと、アクセス パッケージに割り当てることができる期間のポリシーを定義することで、内部ユーザーと外部ユーザーの両方のアクセスのライフサイクルを管理できます。
エンタイトルメント管理リソースの種類は次のとおりです。
- accessPackage: リソース ロールのコレクションと、1 人以上のユーザーがそれらのリソースへのアクセスを取得する方法に関するポリシーを定義します。
- accessPackageAssignmentPolicy: サブジェクトがアクセス パッケージの割り当てを介してアクセス パッケージを要求または割り当てるポリシーを指定します。
- accessPackageAssignmentRequest: アクセス パッケージの割り当てを取得するユーザーによって作成されます。
- accessPackageAssignment: 特定のサブジェクトへの一定期間のアクセス パッケージの割り当て。
- accessPackageAssignmentResourceRole: アクセス パッケージの割り当てによってサブジェクトが割り当てられたリソース固有のロールを示します。
- accessPackageCatalog: アクセス パッケージのコンテナー。
- accessPackageResource: アクセス パッケージ カタログに関連付けられているリソースへの参照。
- accessPackageResourceRequest: アクセス パッケージ カタログにリソースを追加するための要求。
- accessPackageResourceEnvironment: リソースの位置情報への参照。 Multi-Geo SharePoint Online サイトに適用されます。
- connectedOrganization: アクセスを要求できる外部ユーザー向けの接続された組織。
- entitlementManagementSettings: Microsoft Entra エンタイトルメント管理のテナント全体の設定。
- approval: アクセス パッケージ要求に関連付けられている決定を表します。
さらに、エンタイトルメント管理ロール定義を使用して、ユーザー、ユーザーのグループ、およびエンタイトルメント管理固有のロールに対するサービス プリンシパルの ロールの割り当てを管理できます。
エンタイトルメント管理を使用して、内部ユーザーがセルフサービス要求できるリソースのパッケージを作成する方法を示すチュートリアルについては、「 Microsoft Graph API を使用してアクセス パッケージを作成する」を参照してください。
エンタイトルメント管理が使用されているテナントには、十分な購入ライセンスまたは試用版ライセンスが必要です。 エンタイトルメント管理機能のライセンス要件の詳細については、「 エンタイトルメント管理ライセンスの要件」を参照してください。
メソッド
次の表に、エンタイトルメント管理関連リソースの操作に使用できるメソッドを示します。
| メソッド | 戻り値の種類 | 説明 |
|---|---|---|
| Get | entitlementManagementSettings | entitlementManagementSettings オブジェクトのプロパティを読み取ります。 |
| Update | entitlementManagementSettings | entitlementManagementSettings オブジェクトのプロパティを更新します。 |
| accessPackage を一覧表示する | accessPackage コレクション | accessPackage オブジェクトの一覧を取得します。 |
| accessPackage を作成する | accessPackage | 新しい accessPackage オブジェクトを作成します。 |
| accessPackage を取得する | accessPackage | accessPackage オブジェクトのプロパティとリレーションシップを読み取ります。 |
| accessPackage を更新する | なし | accesspackage オブジェクトのプロパティを更新します。 |
| accessPackage を削除する | accessPackage を削除します。 | |
| FilterByCurrentUser | accessPackage コレクション | サインインしているユーザーでフィルター処理された accessPackage オブジェクトの一覧を取得します。 |
| accessPackageResourceRoleScopes を一覧表示する | accessPackageResourceRoleScope コレクション | アクセス パッケージの accessPackageResourceRoleScope オブジェクトの一覧を取得します。 |
| accessPackageResourceRoleScope を作成する | アクセス パッケージの新しい accessPackageResourceRoleScope オブジェクトを作成します。 | |
| incompatibleAccessPackages を一覧表示する | accessPackage コレクション | このアクセス パッケージの互換性のない accesspackage オブジェクトの一覧を取得します。 |
| accessPackage を incompatibleAccessPackages に追加する | なし | 別の accesspackage が指定されたアクセス パッケージと互換性を持たなきを示すリンクを追加します。 |
| incompatibleAccessPackages から accessPackage を削除する | なし | accesspackage に互換性が見られなかったことを示すリンクを削除します。 |
| incompatibleGroups を一覧表示する | group コレクション | このアクセス パッケージの互換性のない グループ オブジェクトの一覧を取得します。 |
| グループを incompatibleGroups に追加する | なし | グループのメンバーシップが指定されたアクセス パッケージと互換性を持たなきを示すリンクを追加します。 |
| incompatibleGroups からグループを削除する | なし | グループ メンバーシップに互換性がなされていないことを示すリンクを削除します。 |
| accessPackagesIncompatibleWith を一覧表示する | accessPackage コレクション | このアクセス パッケージを互換性のないものとして一覧表示する accesspackage オブジェクトの一覧を取得します。 |
| moveToCatalog | なし | アクセス パッケージを別のカタログに移動します。 |
| accessPackageAssignmentPolicies の一覧表示 | accessPackageAssignmentPolicy コレクション | accessPackageAssignmentPolicy オブジェクトの一覧を取得します。 |
| accessPackageAssignmentPolicy を作成する | accessPackageAssignmentPolicy | 新しい accessPackageAssignmentPolicy オブジェクトを 作成します。 |
| accessPackageAssignmentPolicy を取得する | accessPackageAssignmentPolicy | accessPackageAssignmentPolicy オブジェクトのプロパティとリレーションシップを読み取ります。 |
| accessPackageAssignmentPolicy を更新する | accessPackageAssignmentPolicy | accessPackageAssignmentPolicy オブジェクトのプロパティを更新します。 |
| accessPackageAssignmentPolicy を削除する | accessPackageAssignmentPolicy を削除します。 | |
| accessPackageAssignmentRequests を一覧表示する | accessPackageAssignmentRequest コレクション | accessPackageAssignmentRequest オブジェクトの一覧を取得します。 |
| accessPackageAssignmentRequest を作成する | accessPackageAssignmentRequest | 新しい accessPackageAssignmentRequest を作成します。 |
| accessPackageAssignmentRequest を取得する | accessPackageAssignmentRequest | accessPackageAssignmentRequest オブジェクトのプロパティとリレーションシップを読み取ります。 |
| accessPackageAssignmentRequest を削除する | なし | accessPackageAssignmentRequest を削除します。 |
| FilterByCurrentUser | accessPackageAssignmentRequest コレクション | サインインしているユーザーでフィルター処理された accessPackageAssignmentRequest オブジェクトの一覧を取得します。 |
| 取り消す | accessPackageAssignmentRequest コレクション | 取り消し可能な状態の accessPackageAssignmentRequest オブジェクトを取り消します: accepted、 pendingApproval、 pendingNotBefore、 pendingApprovalEscalated。 |
| accessPackageAssignments を一覧表示する | accessPackageAssignment コレクション | accessPackageAssignment オブジェクトの一覧を取得します。 |
| FilterByCurrentUser | accessPackageAssignment コレクション | サインインしているユーザーでフィルター処理された accessPackageAssignment オブジェクトの一覧を取得します。 |
| 再 | なし | 特定のアクセス パッケージに対してユーザーの割り当てを自動的に再評価して適用します。 |
| additionalAccessaccessPackageAssignment コレクション | 互換性のないアクセス パッケージへの割り当てを持つユーザーの accessPackageAssignment オブジェクトの一覧を取得します。 | |
| accessPackageAssignmentResourceRoles を一覧表示する | accessPackageAssignmentResourceRole コレクション | accessPackageAssignmentResourceRole オブジェクトの一覧を取得します。 |
| accessPackageAssignmentResourceRole を取得する | accessPackageAssignmentResourceRole | accessPackageAssignmentResourceRole オブジェクトを取得します。 |
| accessPackageCatalog を一覧表示する | accessPackageCatalog コレクション | accessPackageCatalogs オブジェクトの一覧を取得します。 |
| accessPackageCatalog を作成する | accessPackageCatalog | 新しい accessPackageCatalog オブジェクトを 作成します。 |
| accessPackageCatalog を取得する | accessPackageCatalog | accessPackageCatalog オブジェクトのプロパティとリレーションシップを読み取ります。 |
| accessPackageCatalog を更新する | なし | accessPackageCatalog オブジェクトのプロパティを更新します。 |
| accessPackageCatalog を削除する | accessPackageCatalog を削除します。 | |
| accessPackageCatalog リソースを一覧表示する | accessPackageResource コレクション | accessPackageResource オブジェクトの一覧を取得します。 |
| accessPackageCatalog リソースのロールを一覧表示する | accessPackageResourceRole コレクション | accessPackageResourceRole オブジェクトの一覧を取得します。 |
| accessPackageResourceRequests を一覧表示する | accessPackageResourceRequest コレクション | accessPackageResourceRequest オブジェクトのプロパティとリレーションシップを読み取ります。 |
| accessPackageResourceRequest を作成する | accessPackageCatalog | 新しい accessPackageResourceRequest オブジェクトを 作成します。 |
| accessPackageResourceEnvironments を一覧表示する | accessPackageResourceEnvironment コレクション | accessPackageResourceEnvironment オブジェクトの一覧を取得します。 |
| accessPackageResourceEnvironment を取得する | accessPackageResourceEnvironment | accessPackageResourceEnvironment オブジェクトのプロパティとリレーションシップを読み取ります。 |
| connectedOrganizations を一覧表示する | connectedOrganization コレクション | connectedOrganization オブジェクトの一覧を取得します。 |
| connectedOrganization を作成する | connectedOrganization | 新しい connectedOrganization オブジェクトを作成します。 |
| 接続の取得Organization | connectedOrganization | connectedOrganization オブジェクトのプロパティとリレーションシップを読み取ります。 |
| connectedOrganization を更新する | なし | connectedOrganization を更新します。 |
| connectedOrganization を削除する | なし | connectedOrganization を削除します。 |
| internalSponsors を一覧表示する | directoryObject コレクション | connectedOrganization の内部スポンサーの一覧を取得します。 |
| externalSponsors を一覧表示する | directoryObject コレクション | connectedOrganization の外部スポンサーの一覧を取得します。 |
| internalSponsors を追加する | なし | connectedOrganization の内部スポンサーにユーザーまたはグループを追加します。 |
| externalSponsors を追加する | なし | connectedOrganization の外部スポンサーにユーザーまたはグループを追加します。 |
| internalSponsors を削除する | なし | connectedOrganization の内部スポンサーからユーザーまたはグループを削除します。 |
| 承認を取得する | 承認 | 承認オブジェクトのプロパティを取得します。 |
| 承認の一覧表示ステップ | approvalStep コレクション | 承認オブジェクトに関連付けられている approvalStepオブジェクトを 一覧表示します。 |
| 承認を取得する手順 | approvalStep | approvalStep オブジェクトのプロパティを取得します。 |
| 承認の更新手順 | なし | approvalStep オブジェクトに対して承認または拒否の決定を適用します。 |
型
- requestorSettings、 approvalSettings、 質問 、 割り当てReviewSettings - accessPackageAssignmentPolicy で使用され、そのポリシーに対するアクセス パッケージの割り当て要求を要求できるユーザー、承認するユーザー、およびレビューするユーザーを指定します。
- approvalStage - プライマリ、バックアップ、エスカレーションの承認者を指定するために approvalSettings で使用されます。
- approvalStep - 承認 で使用され、さまざまな承認手順を区別します。
- userSet サブタイプ singleUser、 groupMembers、 connectedOrganizationMembers、 requestorManager、 internalSponsors、 externalSponsors 、 targetUserSponsors - requestorSettings、 approvalStage、 approvalStep 、 assignmentReviewSettings で使用されます。
- accessPackageSubject - accessPackageAssignment で、アクセス パッケージの割り当てを持つサブジェクト ユーザーとして使用されます。
- identitySource - connectedOrganization、 azureActiveDirectoryTenant、 crossCloudAzureActiveDirectoryTenant、 domainIdentitySource 、または externalDomainFederation のいずれかで使用されます。