Microsoft Azure GetAccessReviewHistoryDefinitions API

openapi: 3.2.0
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Get Access Review History Definitions API
tags:
- name: GetAccessReviewHistoryDefinitions
paths:
  /subscriptions/{subscriptionId}/providers/Microsoft.Authorization/accessReviewHistoryDefinitions:
    get:
      tags:
      - GetAccessReviewHistoryDefinitions
      operationId: microsoftAzureAccessreviewhistorydefinitionsList
      x-ms-examples:
        GetAccessReviewHistoryDefinitions:
          $ref: ./examples/GetAccessReviewHistoryDefinitions.json
      description: Lists the accessReviewHistoryDefinitions available from this provider, definition instances are only available for 30 days after creation.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/AccessReviewsHistoryFilterParameter'
      responses:
        '200':
          description: Describe the result of a successful operation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessReviewHistoryDefinitionListResult'
        default:
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDefinition'
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Authorization Accessreviewhistorydefinitions
components:
  parameters:
    AccessReviewsHistoryFilterParameter:
      name: $filter
      in: query
      required: false
      description: The filter to apply on the operation. Only standard filters on definition name and created date are supported
      x-ms-skip-url-encoding: true
      x-ms-parameter-location: method
      schema:
        type: string
    ApiVersionParameter:
      name: api-version
      in: query
      required: true
      description: The API version to be used with the HTTP request.
      schema:
        type: string
    SubscriptionIdParameter:
      name: subscriptionId
      in: path
      required: true
      description: The ID of the target subscription.
      schema:
        type: string
  schemas:
    AccessReviewRecurrenceRange:
      type: object
      properties:
        type:
          type: string
          description: 'The recurrence range type. The possible values are: endDate, noEnd, numbered.'
          enum:
          - endDate
          - noEnd
          - numbered
          x-ms-enum:
            name: AccessReviewRecurrenceRangeType
            modelAsString: true
        numberOfOccurrences:
          type: integer
          format: int32
          description: The number of times to repeat the access review. Required and must be positive if type is numbered.
        startDate:
          type:
          - string
          - 'null'
          format: date-time
          description: The DateTime when the review is scheduled to be start. This could be a date in the future. Required on create.
        endDate:
          type:
          - string
          - 'null'
          format: date-time
          description: The DateTime when the review is scheduled to end. Required if type is endDate
      description: Recurrence Range of an Access Review Schedule Definition.
    AccessReviewScope:
      type: object
      properties:
        resourceId:
          type: string
          readOnly: true
          description: ResourceId in which this review is getting created
        roleDefinitionId:
          type: string
          readOnly: true
          description: This is used to indicate the role being reviewed
        principalType:
          type: string
          readOnly: true
          description: The identity type user/servicePrincipal to review
          enum:
          - user
          - guestUser
          - servicePrincipal
          - user,group
          - redeemedGuestUser
          x-ms-enum:
            name: AccessReviewScopePrincipalType
            modelAsString: true
        assignmentState:
          type: string
          readOnly: true
          description: The role assignment state eligible/active to review
          enum:
          - eligible
          - active
          x-ms-enum:
            name: AccessReviewScopeAssignmentState
            modelAsString: true
        inactiveDuration:
          type: string
          format: duration
          description: 'Duration users are inactive for. The value should be in ISO  8601 format (http://en.wikipedia.org/wiki/ISO_8601#Durations).This code can be used to convert TimeSpan to a valid interval string: XmlConvert.ToString(new TimeSpan(hours, minutes, seconds))'
        expandNestedMemberships:
          type: boolean
          description: Flag to indicate whether to expand nested memberships or not.
      description: Descriptor for what needs to be reviewed
    AccessReviewRecurrencePattern:
      type: object
      properties:
        type:
          type: string
          description: 'The recurrence type : weekly, monthly, etc.'
          enum:
          - weekly
          - absoluteMonthly
          x-ms-enum:
            name: AccessReviewRecurrencePatternType
            modelAsString: true
        interval:
          type: integer
          format: int32
          description: 'The interval for recurrence. For a quarterly review, the interval is 3 for type : absoluteMonthly.'
      description: Recurrence Pattern of an Access Review Schedule Definition.
    AccessReviewHistoryDefinitionListResult:
      type: object
      properties:
        value:
          type: array
          items:
            $ref: '#/components/schemas/AccessReviewHistoryDefinition'
          description: Access Review History Definition list.
        nextLink:
          type: string
          description: The URL to use for getting the next set of results.
      description: List of Access Review History Definitions.
    AccessReviewHistoryDefinition:
      x-ms-azure-resource: true
      type: object
      properties:
        id:
          type: string
          readOnly: true
          description: The access review history definition id.
        name:
          type: string
          readOnly: true
          description: The access review history definition unique id.
        type:
          type: string
          readOnly: true
          description: The resource type.
        properties:
          x-ms-client-flatten: true
          $ref: '#/components/schemas/AccessReviewHistoryDefinitionProperties'
          description: Access Review History Definition properties.
      description: Access Review History Definition.
    AccessReviewHistoryDefinitionProperties:
      type: object
      properties:
        displayName:
          type: string
          description: The display name for the history definition.
        reviewHistoryPeriodStartDateTime:
          type:
          - string
          - 'null'
          format: date-time
          description: Date time used when selecting review data, all reviews included in data start on or after this date. For use only with one-time/non-recurring reports.
          readOnly: true
        reviewHistoryPeriodEndDateTime:
          type:
          - string
          - 'null'
          format: date-time
          description: Date time used when selecting review data, all reviews included in data end on or before this date. For use only with one-time/non-recurring reports.
          readOnly: true
        decisions:
          type:
          - array
          - 'null'
          items:
            type: string
            description: Represents a reviewer's decision for a given review
            enum:
            - Approve
            - Deny
            - NotReviewed
            - DontKnow
            - NotNotified
            x-ms-enum:
              name: AccessReviewResult
              modelAsString: true
          description: Collection of review decisions which the history data should be filtered on. For example if Approve and Deny are supplied the data will only contain review results in which the decision maker approved or denied a review request.
        status:
          type: string
          readOnly: true
          description: This read-only field specifies the of the requested review history data. This is either requested, in-progress, done or error.
          enum:
          - Requested
          - InProgress
          - Done
          - Error
          x-ms-enum:
            name: AccessReviewHistoryDefinitionStatus
            modelAsString: true
        createdDateTime:
          type:
          - string
          - 'null'
          format: date-time
          description: Date time when history definition was created
          readOnly: true
        createdBy:
          readOnly: true
          x-ms-client-flatten: true
          $ref: '#/components/schemas/AccessReviewActorIdentity'
          description: The user or other identity who created this history definition.
        scopes:
          type: array
          items:
            $ref: '#/components/schemas/AccessReviewScope'
          description: A collection of scopes used when selecting review history data
          x-ms-identifiers: []
        settings:
          x-ms-client-flatten: true
          $ref: '#/components/schemas/AccessReviewHistoryScheduleSettings'
          description: Recurrence settings for recurring history reports, skip for one-time reports.
        instances:
          type: array
          items:
            $ref: '#/components/schemas/AccessReviewHistoryInstance'
          description: Set of access review history instances for this history definition.
      description: Access Review History Instances.
    AccessReviewHistoryInstance:
      x-ms-azure-resource: true
      type: object
      properties:
        id:
          type: string
          readOnly: true
          description: The access review history definition instance id.
        name:
          type: string
          readOnly: true
          description: The access review history definition instance unique id.
        type:
          type: string
          readOnly: true
          description: The resource type.
        properties:
          x-ms-client-flatten: true
          $ref: '#/components/schemas/AccessReviewHistoryInstanceProperties'
          description: Access Review History Definition Instance properties.
      description: Access Review History Definition Instance.
    AccessReviewHistoryInstanceProperties:
      type: object
      properties:
        reviewHistoryPeriodStartDateTime:
          type: string
          format: date-time
          readOnly: false
          description: Date time used when selecting review data, all reviews included in data start on or after this date. For use only with one-time/non-recurring reports.
        reviewHistoryPeriodEndDateTime:
          type: string
          format: date-time
          readOnly: false
          description: Date time used when selecting review data, all reviews included in data end on or before this date. For use only with one-time/non-recurring reports.
        displayName:
          type: string
          description: The display name for the parent history definition.
        status:
          type: string
          readOnly: true
          description: Status of the requested review history instance data. This is either requested, in-progress, done or error. The state transitions are as follows - Requested -> InProgress -> Done -> Expired
          enum:
          - Requested
          - InProgress
          - Done
          - Error
          x-ms-enum:
            name: AccessReviewHistoryDefinitionStatus
            modelAsString: true
        runDateTime:
          type:
          - string
          - 'null'
          format: date-time
          description: Date time when the history data report is scheduled to be generated.
        fulfilledDateTime:
          type:
          - string
          - 'null'
          format: date-time
          description: Date time when the history data report is scheduled to be generated.
        downloadUri:
          readOnly: true
          type: string
          description: Uri which can be used to retrieve review history data. To generate this Uri, generateDownloadUri() must be called for a specific accessReviewHistoryDefinitionInstance. The link expires after a 24 hour period. Callers can see the expiration date time by looking at the 'se' parameter in the generated uri.
        expiration:
          type:
          - string
          - 'null'
          format: date-time
          description: Date time when history data report expires and the associated data is deleted.
      description: Access Review History Definition Instance properties.
    AccessReviewActorIdentity:
      type: object
      properties:
        principalId:
          type: string
          readOnly: true
          description: The identity id
        principalType:
          type: string
          readOnly: true
          description: 'The identity type : user/servicePrincipal'
          enum:
          - user
          - servicePrincipal
          x-ms-enum:
            name: AccessReviewActorIdentityType
            modelAsString: true
        principalName:
          type: string
          readOnly: true
          description: The identity display name
        userPrincipalName:
          type: string
          readOnly: true
          description: The user principal name(if valid)
      description: Details of the actor identity
    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.
    AccessReviewHistoryScheduleSettings:
      type: object
      properties:
        pattern:
          x-ms-client-flatten: true
          $ref: '#/components/schemas/AccessReviewRecurrencePattern'
          description: Access Review History Definition recurrence settings.
        range:
          x-ms-client-flatten: true
          $ref: '#/components/schemas/AccessReviewRecurrenceRange'
          description: Access Review History Definition recurrence settings.
      description: Recurrence settings of an Access Review History Definition.
    ErrorDefinition:
      type: object
      title: Error
      description: Error description and code explaining why an operation failed.
      properties:
        error:
          $ref: '#/components/schemas/ErrorDefinitionProperties'
          description: Error of the list gateway status.
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/components/parameters/Endpoint'