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