workflow: previewWorkflow

Пространство имен: microsoft.graph.identityGovernance

Важно!

API версии /beta в Microsoft Graph могут быть изменены. Использование этих API в производственных приложениях не поддерживается. Чтобы определить, доступен ли API в версии 1.0, используйте селектор версий.

Запустите рабочий процесс в режиме предварительного просмотра для выбранных объектов каталога, не затрагивая рабочих пользователей. Это действие активирует обработку рабочего процесса в режиме предварительного просмотра, а результаты можно получить с помощью операции List userProcessingResults с $filter=workflowExecutionType eq 'previewMode'.

Этот API доступен в следующих национальных облачных развертываниях.

Глобальная служба Правительство США L4 Правительство США L5 (DOD) Китай управляется 21Vianet

Разрешения

Выберите разрешение или разрешения, помеченные как наименее привилегированные для этого API. Используйте более привилегированное разрешение или разрешения только в том случае, если это требуется приложению. Дополнительные сведения о делегированных разрешениях и разрешениях приложений см. в разделе Типы разрешений. Дополнительные сведения об этих разрешениях см. в справочнике по разрешениям.

Тип разрешения Разрешения с наименьшими привилегиями Более высокие привилегированные разрешения
Делегированные (рабочая или учебная учетная запись) LifecycleWorkflows-Workflow.ReadWrite.All LifecycleWorkflows.ReadWrite.All
Делегированные (личная учетная запись Майкрософт) Не поддерживается. Не поддерживается.
Приложение LifecycleWorkflows-Workflow.ReadWrite.All LifecycleWorkflows.ReadWrite.All

Важно!

Для делегированного доступа с использованием рабочих или учебных учетных записей пользователю, выполнившего вход, необходимо назначить поддерживаемую роль Microsoft Entra или пользовательскую роль, которая предоставляет разрешения, необходимые для этой операции. Администратор рабочих процессов жизненного цикла — это наименее привилегированная роль, поддерживаемая для этой операции.

HTTP-запрос

POST /identityGovernance/lifecycleWorkflows/workflows/{workflow-id}/previewWorkflow

Заголовки запросов

Имя Описание
Авторизация Bearer {token}. Обязательно. Дополнительные сведения о проверке подлинности и авторизации.
Content-Type application/json. Обязательно.

Текст запроса

В тексте запроса укажите представление параметров в формате JSON.

В следующей таблице показаны параметры, необходимые для этого действия.

Параметр Тип Описание
Предметы Коллекция directoryObject Коллекция объектов каталога (как правило, пользователей), которые необходимо включить в предварительный просмотр. Не более 10 субъектов на запрос. Обязательно.

Отклик

В случае успешного выполнения это действие возвращает код отклика 204 No Content.

Чтобы получить результаты выполнения предварительной версии, используйте операцию List userProcessingResults с $filter=workflowExecutionType eq 'previewMode'. Результаты могут быть недоступны сразу; время зависит от сложности рабочего процесса. Результаты могут включать пользователей из предыдущих предварительных запусков для того же рабочего процесса.

Примеры

Запрос

Ниже показан пример запроса.

POST https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/workflows/14879e66-9ea9-48d0-804d-8fea672d0341/previewWorkflow
Content-Type: application/json

{
  "subjects": [
    {
      "@odata.type": "#microsoft.graph.user",
      "id": "b59552b8-fa7b-4f68-8496-0a529aace8c0"
    },
    {
      "@odata.type": "#microsoft.graph.user",
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
    }
  ]
}

Отклик

Ниже приводится пример отклика.

HTTP/1.1 204 No Content