microsoft.graph.accessReviewScheduleDefinition

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/microsoft.graph.accessReviewScheduleDefinition",
  "title": "microsoft.graph.accessReviewScheduleDefinition",
  "allOf": [
    {
      "$ref": "#/components/schemas/microsoft.graph.entity"
    },
    {
      "title": "accessReviewScheduleDefinition",
      "required": [
        "@odata.type"
      ],
      "type": "object",
      "properties": {
        "additionalNotificationRecipients": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/microsoft.graph.accessReviewNotificationRecipientItem"
          },
          "description": "Defines the list of additional users or group members to be notified of the access review progress."
        },
        "createdBy": {
          "anyOf": [
            {
              "$ref": "#/components/schemas/microsoft.graph.userIdentity"
            },
            {
              "type": "object",
              "nullable": true
            }
          ],
          "description": "User who created this review. Read-only."
        },
        "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": "Timestamp when the access review series was created. Supports $select. Read-only.",
          "format": "date-time",
          "nullable": true
        },
        "descriptionForAdmins": {
          "type": "string",
          "description": "Description provided by review creators to provide more context of the review to admins. Supports $select.",
          "nullable": true
        },
        "descriptionForReviewers": {
          "type": "string",
          "description": "Description provided  by review creators to provide more context of the review to reviewers. Reviewers see this description in the email sent to them requesting their review. Email notifications support up to 256 characters. Supports $select.",
          "nullable": true
        },
        "displayName": {
          "type": "string",
          "description": "Name of the access review series. Supports $select and $orderby. Required on create.",
          "nullable": true
        },
        "fallbackReviewers": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/microsoft.graph.accessReviewReviewerScope"
          },
          "description": "This collection of reviewer scopes is used to define the list of fallback reviewers. These fallback reviewers are notified to take action if no users are found from the list of reviewers specified. This could occur when either the group owner is specified as the reviewer but the group owner doesn't exist, or manager is specified as reviewer but a user's manager doesn't exist. See accessReviewReviewerScope. Replaces backupReviewers. Supports $select. NOTE: The value of this property will be ignored if fallback reviewers are assigned through the stageSettings property."
        },
        "instanceEnumerationScope": {
          "anyOf": [
            {
              "$ref": "#/components/schemas/microsoft.graph.accessReviewScope"
            },
            {
              "type": "object",
              "nullable": true
            }
          ],
          "description": "This property is required when scoping a review to guest users' access across all Microsoft 365 groups and determines which Microsoft 365 groups are reviewed. Each group becomes a unique accessReviewInstance of the access review series.  For supported scopes, see accessReviewScope. Supports $select. For examples of options for configuring instanceEnumerationScope, see Configure the scope of your access review definition using the Microsoft Graph API."
        },
        "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": "Timestamp when the access review series was last modified. Supports $select. Read-only.",
          "format": "date-time",
          "nullable": true
        },
        "reviewers": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/microsoft.graph.accessReviewReviewerScope"
          },
          "description": "This collection of access review scopes is used to define who are the reviewers. The reviewers property is only updatable if individual users are assigned as reviewers. Required on create. Supports $select. For examples of options for assigning reviewers, see Assign reviewers to your access review definition using the Microsoft Graph API. NOTE: The value of this property will be ignored if reviewers are assigned through the stageSettings property."
        },
        "scope": {
          "anyOf": [
            {
              "$ref": "#/components/schemas/microsoft.graph.accessReviewScope"
            },
            {
              "type": "object",
              "nullable": true
            }
          ],
          "description": "Defines the entities whose access is reviewed. For supported scopes, see accessReviewScope. Required on create. Supports $select and $filter (contains only). For examples of options for configuring scope, see Configure the scope of your access review definition using the Microsoft Graph API."
        },
        "settings": {
          "anyOf": [
            {
              "$ref": "#/components/schemas/microsoft.graph.accessReviewScheduleSettings"
            },
            {
              "type": "object",
              "nullable": true
            }
          ],
          "description": "The settings for an access review series, see type definition below. Supports $select. Required on create."
        },
        "stageSettings": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/microsoft.graph.accessReviewStageSettings"
          },
          "description": "Required only for a multi-stage access review to define the stages and their settings. You can break down each review instance into up to three sequential stages, where each stage can have a different set of reviewers, fallback reviewers, and settings. Stages are created sequentially based on the dependsOn property. Optional.  When this property is defined, its settings are used instead of the corresponding settings in the accessReviewScheduleDefinition object and its settings, reviewers, and fallbackReviewers properties."
        },
        "status": {
          "type": "string",
          "description": "This read-only field specifies the status of an access review. The typical states include Initializing, NotStarted, Starting, InProgress, Completing, Completed, AutoReviewing, and AutoReviewed.  Supports $select, $orderby, and $filter (eq only). Read-only.",
          "nullable": true
        },
        "instances": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/microsoft.graph.accessReviewInstance"
          },
          "description": "If the accessReviewScheduleDefinition is a recurring access review, instances represent each recurrence. A review that doesn't recur will have exactly one instance. Instances also represent each unique resource under review in the accessReviewScheduleDefinition. If a review has multiple resources and multiple instances, each resource has a unique instance for each recurrence.",
          "x-ms-navigationProperty": true
        },
        "@odata.type": {
          "type": "string"
        }
      }
    }
  ],
  "x-ms-discriminator-value": "#microsoft.graph.accessReviewScheduleDefinition"
}