Работа с API управления правами Microsoft Entra
Пространство имен: microsoft.graph
Важно!
API версии /beta в Microsoft Graph могут быть изменены. Использование этих API в производственных приложениях не поддерживается. Чтобы определить, доступен ли API в версии 1.0, используйте селектор версий.
Управление правами Microsoft Entra помогает управлять доступом к группам, приложениям и сайтам SharePoint Online для внутренних пользователей, а также пользователей за пределами организации.
Создавая пакеты доступа с ролями, которые пользователи должны иметь в этих ресурсах, а также определяя политики для того, кто может запрашивать пакет доступа и как долго они могут назначать пакету доступа, вы можете управлять жизненным циклом доступа для внутренних и внешних пользователей.
Типы ресурсов управления правами:
- accessPackage. Определяет коллекции ролей ресурсов и политики для получения доступа к этим ресурсам одним или несколькими пользователями.
- accessPackageAssignmentPolicy: указывает политику, с помощью которой субъекты могут запрашивать или назначаться пакету доступа через назначение пакета доступа.
- accessPackageAssignmentRequest: создается пользователем, который хочет получить назначение пакета доступа.
- accessPackageAssignment: назначение пакета доступа определенному субъекту на определенный период времени.
- accessPackageAssignmentResourceRole: указывает роль для конкретного ресурса, которой субъект был назначен через назначение пакета доступа.
- accessPackageCatalog: контейнер для пакетов доступа.
- accessPackageResource: ссылка на ресурс, связанный с каталогом пакетов для доступа.
- accessPackageResourceRequest: запрос на добавление ресурса в каталог пакетов для доступа.
- accessPackageResourceEnvironment: ссылка на географическое расположение ресурса. Применимо к сайтам SharePoint Online с несколькими регионами.
- connectedOrganization: подключенная организация для внешних пользователей, которые могут запрашивать доступ.
- entitlementManagementSettings: параметры на уровне клиента для управления правами Microsoft Entra.
- утверждение: представляет решения, связанные с запросом пакета доступа.
Кроме того, вы можете управлять назначениями ролей для пользователей, групп пользователей и субъектов-служб для ролей управления правами с помощью определений ролей управления правами.
Руководство, в которое показано, как использовать управление правами для создания пакета ресурсов, которые внутренние пользователи могут самостоятельно запрашивать, см. в статье Создание пакета доступа с помощью API Microsoft Graph.
Клиент, в котором используется управление правами, должен иметь достаточно приобретенных или пробных лицензий. Дополнительные сведения о требованиях к лицензиям для функции управления правами см. в разделе Требования к лицензиям для управления правами.
Методы
В следующей таблице перечислены методы, которые можно использовать для взаимодействия с ресурсами, связанными с управлением правами.
| Метод | Тип возвращаемых данных | Описание |
|---|---|---|
| Получение | entitlementManagementSettings | Чтение свойств объекта entitlementManagementSettings . |
| Обновление | entitlementManagementSettings | Обновите свойства объекта entitlementManagementSettings . |
| Список accessPackages | коллекция accessPackage | Получение списка объектов accessPackage . |
| Создание accessPackage | accessPackage | Создайте объект accessPackage . |
| Получение accessPackage | accessPackage | Чтение свойств и связей объекта accessPackage . |
| Обновление accessPackage | Нет | Обновление свойств объекта accesspackage . |
| Удаление accessPackage | Удаление accessPackage. | |
| FilterByCurrentUser | коллекция accessPackage | Получите список объектов accessPackage , отфильтрованных по вошедшего пользователя. |
| Список accessPackageResourceRoleScopes | коллекция accessPackageResourceRoleScope | Получите список объектов accessPackageResourceRoleScope для пакета доступа. |
| Создание accessPackageResourceRoleScope | Создайте объект accessPackageResourceRoleScope для пакета доступа. | |
| Список несовместимыхAccessPackages | коллекция accessPackage | Получите список несовместимых объектов accesspackage для этого пакета доступа. |
| Добавление accessPackage в incompatibleAccessPackages | Нет | Добавьте ссылку, чтобы указать, что другой пакет доступа несовместим с указанным пакетом доступа. |
| Удаление accessPackage из несовместимогоAccessPackages | Нет | Удалите ссылку, указывающую, что пакет доступа несовместим. |
| Список несовместимых групп | Коллекция group | Получите список несовместимых объектов группы для этого пакета доступа. |
| Добавление группы в несовместимые группы | Нет | Добавьте ссылку, чтобы указать, что членство в группе несовместимо с указанным пакетом доступа. |
| Удаление группы из несовместимых групп | Нет | Удалите ссылку, указывающую, что членство в группе несовместимо. |
| Список 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, отфильтрованных по вошедшему пользователю. |
| cancel | коллекция accessPackageAssignmentRequest | Отмена объекта accessPackageAssignmentRequest, который находится в состоянии отмены: accepted, pendingApproval, pendingNotBefore, . pendingApprovalEscalated |
| Вывод списка accessPackageAssignments | коллекция accessPackageAssignment | Получение списка объектов accessPackageAssignment . |
| FilterByCurrentUser | коллекция accessPackageAssignment | Получите список объектов accessPackageAssignment , отфильтрованных для вошедшего пользователя. |
| перерабатывать | Нет | Автоматическое переоценка и принудительное применение назначений пользователя для определенного пакета доступа. |
| additionalAccessaccessPackageAssignment collection | Получите список объектов accessPackageAssignment для пользователей, которым назначены несовместимые пакеты доступа. | |
| Список accessPackageAssignmentResourceRoles | коллекция accessPackageAssignmentResourceRole | Получите список объектов accessPackageAssignmentResourceRole . |
| Получение accessPackageAssignmentResourceRole | accessPackageAssignmentResourceRole | Получение объекта accessPackageAssignmentResourceRole . |
| Список accessPackageCatalogs | коллекция 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 . |
| Получение connectedOrganization | connectedOrganization | Чтение свойств и связей объекта connectedOrganization . |
| Обновление connectedOrganization | Нет | Обновите connectedOrganization. |
| Удаление connectedOrganization | Нет | Удалите connectedOrganization. |
| Вывод списка internalSponsors | Коллекция directoryObject | Получение списка внутренних спонсоров connectedOrganization . |
| Вывод списка внешнихSponsors | Коллекция directoryObject | Получение списка внешних спонсоров connectedOrganization . |
| Добавление internalSponsors | Нет | Добавьте пользователя или группу во внутренние спонсоры connectedOrganization . |
| Добавление внешнихSponsors | Нет | Добавьте пользователя или группу во внешних спонсоров connectedOrganization . |
| Удаление internalSponsors | Нет | Удалите пользователя или группу из внутренних спонсоров connectedOrganization . |
| Получение утверждения | утверждение | Получение свойств объекта утверждения . |
| Перечисление утвержденийСтеги | коллекция approvalStep | Вывод списка объектов approvalStep , связанных с объектом утверждения . |
| Получение утвержденияТеп | approvalStep | Получение свойств объекта approvalStep . |
| Обновление approvalStep | Нет | Применить решение утвердить или отклонить для объекта approvalStep . |
Типы
- requestorSettings, approvalSettings, questions and assignmentReviewSettings — используется в accessPackageAssignmentPolicy , чтобы указать, кто может запрашивать, кто утверждает и кто проверяет запросы на назначение пакета доступа в этой политике.
- approvalStage — используется в approvalSettings для указания основного, резервного копирования и утверждающих лиц эскалации.
- approvalStep — используется в утверждении для различения различных этапов утверждения.
- подтипы userSetsingleUser, groupMembers, connectedOrganizationMembers, requestorManager, internalSponsors, externalSponsors и targetUserSponsors — используется в requestorSettings, approvalStage, approvalStep и assignmentReviewSettings.
- accessPackageSubject — используется в accessPackageAssignment в качестве пользователя субъекта, которому назначен пакет доступа.
- identitySource — используется в connectedOrganization, одном из azureActiveDirectoryTenant, crossCloudAzureActiveDirectoryTenant, domainIdentitySource или externalDomainFederation.