swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector GetAccessReviewInstances API
schemes:
- https
tags:
- name: GetAccessReviewInstances
paths:
  ? /subscriptions/{subscriptionId}/providers/Microsoft.Authorization/accessReviewScheduleDefinitions/{scheduleDefinitionId}/instances
  : get:
      tags:
      - GetAccessReviewInstances
      operationId: microsoftAzureAccessreviewinstancesList
      x-ms-examples:
        GetAccessReviewInstances:
          $ref: ./examples/GetAccessReviewInstances.json
      description: Get access review instances
      parameters:
      - name: scheduleDefinitionId
        in: path
        required: true
        type: string
        description: The id of the access review schedule definition.
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/AccessReviewsFilterParameter'
      responses:
        '200':
          description: Describe the result of a successful operation.
          schema:
            $ref: '#/definitions/AccessReviewInstanceListResult'
        default:
          description: Unexpected error
          schema:
            $ref: '#/definitions/ErrorDefinition'
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Authorization Accessreviewscheduledefinitions Scheduledefinitionid Instances
definitions:
  AccessReviewInstanceProperties:
    type: object
    properties:
      status:
        type: string
        readOnly: true
        description: This read-only field specifies the status of an access review instance.
        enum:
        - NotStarted
        - InProgress
        - Completed
        - Applied
        - Initializing
        - Applying
        - Completing
        - Scheduled
        - AutoReviewing
        - AutoReviewed
        - Starting
        x-ms-enum:
          name: AccessReviewInstanceStatus
          modelAsString: true
      startDateTime:
        type: string
        format: date-time
        description: The DateTime when the review instance is scheduled to be start.
        x-nullable: false
      endDateTime:
        type: string
        format: date-time
        description: The DateTime when the review instance is scheduled to end.
        x-nullable: false
      reviewers:
        type: array
        items:
          $ref: '#/definitions/AccessReviewReviewer'
        description: This is the collection of reviewers.
        x-ms-identifiers: []
      backupReviewers:
        type: array
        items:
          $ref: '#/definitions/AccessReviewReviewer'
        description: This is the collection of backup reviewers.
        x-ms-identifiers: []
      reviewersType:
        type: string
        readOnly: true
        description: This field specifies the type of reviewers for a review. Usually for a review, reviewers are explicitly assigned. However, in some cases, the reviewers may not be assigned and instead be chosen dynamically. For example managers review or self review.
        enum:
        - Assigned
        - Self
        - Managers
        x-ms-enum:
          name: AccessReviewInstanceReviewersType
          modelAsString: true
    description: Access Review Instance properties.
  ErrorDefinition:
    type: object
    title: Error
    description: Error description and code explaining why an operation failed.
    properties:
      error:
        $ref: '#/definitions/ErrorDefinitionProperties'
        description: Error of the list gateway status.
  AccessReviewInstance:
    type: object
    x-ms-azure-resource: true
    properties:
      id:
        type: string
        readOnly: true
        description: The access review instance id.
      name:
        type: string
        readOnly: true
        description: The access review instance name.
      type:
        type: string
        readOnly: true
        description: The resource type.
      properties:
        x-ms-client-flatten: true
        $ref: '#/definitions/AccessReviewInstanceProperties'
        description: Access Review properties.
    description: Access Review Instance.
  AccessReviewReviewer:
    type: object
    properties:
      principalId:
        type: string
        description: The id of the reviewer(user/servicePrincipal)
      principalType:
        type: string
        readOnly: true
        description: 'The identity type : user/servicePrincipal'
        enum:
        - user
        - servicePrincipal
        x-ms-enum:
          name: AccessReviewReviewerType
          modelAsString: true
    description: Descriptor for what needs to be reviewed
  AccessReviewInstanceListResult:
    type: object
    properties:
      value:
        type: array
        items:
          $ref: '#/definitions/AccessReviewInstance'
        description: Access Review Instance list.
      nextLink:
        type: string
        description: The URL to use for getting the next set of results.
    description: List of Access Review Instances.
  ErrorDefinitionProperties:
    type: object
    title: Error
    description: Error description and code explaining why an operation failed.
    properties:
      message:
        type: string
        readOnly: true
        description: Description of the error.
      code:
        type: string
        description: Error code of list gateway.
parameters:
  AccessReviewsFilterParameter:
    name: $filter
    in: query
    required: false
    type: string
    description: 'The filter to apply on the operation. Other than standard filters, one custom filter option is supported : ''assignedToMeToReview()''. When one specified $filter=assignedToMeToReview(), only items that are assigned to the calling user to review are returned'
    x-ms-skip-url-encoding: true
    x-ms-parameter-location: method
  ApiVersionParameter:
    name: api-version
    in: query
    required: true
    type: string
    description: The API version to be used with the HTTP request.
  SubscriptionIdParameter:
    name: subscriptionId
    in: path
    required: true
    type: string
    description: The ID of the target subscription.
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'