Microsoft Azure GetAccessReviewDefaultSettings API

openapi: 3.2.0
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Get Access Review Default Settings API
tags:
- name: GetAccessReviewDefaultSettings
paths:
  /subscriptions/{subscriptionId}/providers/Microsoft.Authorization/accessReviewScheduleSettings/default:
    get:
      tags:
      - GetAccessReviewDefaultSettings
      operationId: microsoftAzureAccessreviewdefaultsettingsGet
      x-ms-examples:
        GetAccessReviewDefaultSettings:
          $ref: ./examples/GetAccessReviewDefaultSettings.json
      description: Get access review default settings for the subscription
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: Describe the result of a successful operation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessReviewDefaultSettings'
        default:
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDefinition'
      summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Authorization Accessreviewschedulesettings Default
components:
  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.
    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.
    AccessReviewDefaultSettings:
      type: object
      x-ms-azure-resource: true
      properties:
        id:
          type: string
          readOnly: true
          description: The access review default settings id. This is only going to be default
        name:
          type: string
          readOnly: true
          description: The access review default settings name. This is always going to be Access Review Default Settings
        type:
          type: string
          readOnly: true
          description: The resource type.
        properties:
          x-ms-client-flatten: true
          $ref: '#/components/schemas/AccessReviewScheduleSettings'
          description: Access Review properties.
      description: Access Review Default Settings.
    AccessReviewScheduleSettings:
      type: object
      properties:
        mailNotificationsEnabled:
          type: boolean
          description: Flag to indicate whether sending mails to reviewers and the review creator is enabled.
        reminderNotificationsEnabled:
          type: boolean
          description: Flag to indicate whether sending reminder emails to reviewers are enabled.
        defaultDecisionEnabled:
          type: boolean
          description: Flag to indicate whether reviewers are required to provide a justification when reviewing access.
        justificationRequiredOnApproval:
          type: boolean
          description: Flag to indicate whether the reviewer is required to pass justification when recording a decision.
        defaultDecision:
          type: string
          description: This specifies the behavior for the autoReview feature when an access review completes.
          enum:
          - Approve
          - Deny
          - Recommendation
          x-ms-enum:
            name: DefaultDecisionType
            modelAsString: true
        autoApplyDecisionsEnabled:
          type: boolean
          description: Flag to indicate whether auto-apply capability, to automatically change the target object access resource, is enabled. If not enabled, a user must, after the review completes, apply the access review.
        recommendationsEnabled:
          type: boolean
          description: Flag to indicate whether showing recommendations to reviewers is enabled.
        recommendationLookBackDuration:
          type: string
          format: duration
          description: 'Recommendations for access reviews are calculated by looking back at 30 days of data(w.r.t the start date of the review) by default. However, in some scenarios, customers want to change how far back to look at and want to configure 60 days, 90 days, etc. instead. This setting allows customers to configure this duration. 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))'
        instanceDurationInDays:
          type: integer
          format: int32
          description: The duration in days for an instance.
        recurrence:
          x-ms-client-flatten: true
          $ref: '#/components/schemas/AccessReviewRecurrenceSettings'
          description: Access Review Settings.
      description: Settings of an Access Review.
    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.
    AccessReviewRecurrenceSettings:
      type: object
      properties:
        pattern:
          x-ms-client-flatten: true
          $ref: '#/components/schemas/AccessReviewRecurrencePattern'
          description: Access Review schedule definition recurrence pattern.
        range:
          x-ms-client-flatten: true
          $ref: '#/components/schemas/AccessReviewRecurrenceRange'
          description: Access Review schedule definition recurrence range.
      description: Recurrence Settings of an Access Review Schedule 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.
  parameters:
    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
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/components/parameters/Endpoint'