Microsoft Graph · Schema

workflowBase

Azure ADCollaborationContactsDocumentsEmailGraphIdentityMicrosoftOffice 365PresentationsProductivitySpreadsheetsT1Tasks

Properties

Name Type Description
category object
createdDateTime string When a workflow was created.
description string A string that describes the purpose of the workflow.
displayName string A string to identify the workflow.
executionConditions object Defines when and for who the workflow will run.
isEnabled boolean Whether the workflow is enabled or disabled. If this setting is true, the workflow can be run on demand or on schedule when isSchedulingEnabled is true.
isSchedulingEnabled boolean If true, the Lifecycle Workflow engine executes the workflow based on the schedule defined by tenant settings. Can't be true for a disabled workflow (where isEnabled is false).
lastModifiedDateTime string When the workflow was last modified.
createdBy object The user who created the workflow.
lastModifiedBy object The unique identifier of the Microsoft Entra identity that last modified the workflow.
tasks array The tasks in the workflow.
@odata.type string
View JSON Schema on GitHub

JSON Schema

microsoft-graph-microsoftgraphidentitygovernanceworkflowbase-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/microsoft.graph.identityGovernance.workflowBase",
  "title": "workflowBase",
  "required": [
    "@odata.type"
  ],
  "type": "object",
  "properties": {
    "category": {
      "$ref": "#/components/schemas/microsoft.graph.identityGovernance.lifecycleWorkflowCategory"
    },
    "createdDateTime": {
      "pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$",
      "type": "string",
      "description": "When a workflow was created.",
      "format": "date-time",
      "nullable": true
    },
    "description": {
      "type": "string",
      "description": "A string that describes the purpose of the workflow.",
      "nullable": true
    },
    "displayName": {
      "type": "string",
      "description": "A string to identify the workflow."
    },
    "executionConditions": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/microsoft.graph.identityGovernance.workflowExecutionConditions"
        },
        {
          "type": "object",
          "nullable": true
        }
      ],
      "description": "Defines when and for who the workflow will run."
    },
    "isEnabled": {
      "type": "boolean",
      "description": "Whether the workflow is enabled or disabled. If this setting is true, the workflow can be run on demand or on schedule when isSchedulingEnabled is true."
    },
    "isSchedulingEnabled": {
      "type": "boolean",
      "description": "If true, the Lifecycle Workflow engine executes the workflow based on the schedule defined by tenant settings. Can't be true for a disabled workflow (where isEnabled is false)."
    },
    "lastModifiedDateTime": {
      "pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$",
      "type": "string",
      "description": "When the workflow was last modified.",
      "format": "date-time",
      "nullable": true
    },
    "createdBy": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/microsoft.graph.user"
        },
        {
          "type": "object",
          "nullable": true
        }
      ],
      "description": "The user who created the workflow.",
      "x-ms-navigationProperty": true
    },
    "lastModifiedBy": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/microsoft.graph.user"
        },
        {
          "type": "object",
          "nullable": true
        }
      ],
      "description": "The unique identifier of the Microsoft Entra identity that last modified the workflow.",
      "x-ms-navigationProperty": true
    },
    "tasks": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/microsoft.graph.identityGovernance.task"
      },
      "description": "The tasks in the workflow.",
      "x-ms-navigationProperty": true
    },
    "@odata.type": {
      "type": "string"
    }
  },
  "discriminator": {
    "propertyName": "@odata.type",
    "mapping": {
      "#microsoft.graph.identityGovernance.workflow": "#/components/schemas/microsoft.graph.identityGovernance.workflow",
      "#microsoft.graph.identityGovernance.workflowVersion": "#/components/schemas/microsoft.graph.identityGovernance.workflowVersion"
    }
  }
}