Microsoft Azure Disco Templates API

openapi: 3.2.0
info:
  description: EASM discovers and maps your digital attack surface to provide an "outside-in" perspective using probes to discover assets. The assets are provided with detailed metadata associated, including vulnerabilities, configurations and web components, allowing customers to view and prioritize external risk. The EASM REST API enables you to develop clients that integrate with your application.
  title: Microsoft Azure Azure EASM Disco Templates API
  version: 2022-04-01-preview
servers:
- url: /
security:
- azure_auth:
  - user_impersonation
tags:
- description: Provides access to disco template resources.
  name: Disco Templates
paths:
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/workspaces/{workspaceName}/discoTemplates:
    get:
      parameters:
      - $ref: '#/components/parameters/FilterParameter'
      - $ref: '#/components/parameters/SkipParameter'
      - $ref: '#/components/parameters/MaxPageSizeParameter'
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/components/parameters/WorkspaceNameParameter'
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DiscoTemplatePageResponse'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      tags:
      - Disco Templates
      operationId: microsoftAzureDiscotemplatesList
      summary: Microsoft Azure Retrieve A List Of Disco Templates For The Provided Search…
      x-ms-examples:
        DiscoTemplates:
          $ref: ./examples/DiscoTemplates_List.json
      x-ms-pageable:
        itemName: content
        nextLinkName: nextLink
      description: Needs a more full description created.
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/workspaces/{workspaceName}/discoTemplates/{discoTemplateId}
  : get:
      parameters:
      - $ref: '#/components/parameters/DiscoTemplateIdParameter'
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/components/parameters/WorkspaceNameParameter'
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DiscoTemplateResponse'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      tags:
      - Disco Templates
      operationId: microsoftAzureDiscotemplatesGet
      summary: Microsoft Azure Retrieve A Disco Template With A Given Discotemplateid
      x-ms-examples:
        DiscoTemplates:
          $ref: ./examples/DiscoTemplates_Get.json
      description: Needs a more full description created.
components:
  parameters:
    SkipParameter:
      description: An offset into the collection of the first resource to be returned.
      in: query
      name: skip
      required: false
      x-ms-parameter-location: method
      schema:
        type: integer
        format: int32
        default: 0
    WorkspaceNameParameter:
      description: The name of the Workspace.
      in: path
      name: workspaceName
      required: true
      x-ms-parameter-location: method
      schema:
        type: string
    DiscoTemplateIdParameter:
      in: path
      name: discoTemplateId
      required: true
      x-ms-parameter-location: method
      schema:
        type: string
    MaxPageSizeParameter:
      description: An offset into the collection of the first resource to be returned.
      in: query
      name: maxpagesize
      required: false
      x-ms-parameter-location: method
      schema:
        type: integer
        format: int32
        default: 20
    FilterParameter:
      description: An expression on the resource type that selects the resources to be returned.
      in: query
      name: filter
      required: false
      x-ms-parameter-location: method
      schema:
        type: string
  schemas:
    AssetId:
      description: The list of excludes used for the disco group runs, aka assets to exclude from the discovery algorithm.
      properties:
        displayName:
          type: string
        id:
          type: string
        kind:
          enum:
          - as
          - contact
          - domain
          - host
          - ipAddress
          - ipBlock
          - page
          - sslCert
          type: string
          x-ms-enum:
            modelAsString: true
            name: assetIdKind
        name:
          type: string
      type: object
    InnerError:
      description: This is an object containing more specific information than the current object about the error.
      properties:
        code:
          description: This is a more specific error code than was provided by the containing error..
          type: string
      type: object
    DiscoTemplateResponse:
      properties:
        aliases:
          description: The list of disco template name aliases.
          items:
            description: The list of disco template name aliases.
            type: string
          type: array
        city:
          description: The name of the city.
          type: string
        countryCode:
          description: The country code.
          type: string
        displayName:
          type: string
        id:
          type: string
        industry:
          description: The name of the industry.
          type: string
        name:
          type: string
        region:
          description: The name of the region.
          type: string
        seeds:
          description: The list of disco template seeds.
          items:
            $ref: '#/components/schemas/AssetId'
          type: array
        stateCode:
          description: The state code.
          type: string
      type: object
    DiscoTemplatePageResponse:
      properties:
        content:
          items:
            $ref: '#/components/schemas/DiscoTemplateResponse'
          type: array
        first:
          type: boolean
        last:
          type: boolean
        nextLink:
          type: string
        number:
          format: int32
          type: integer
        numberOfElements:
          format: int32
          type: integer
        size:
          format: int32
          type: integer
        totalElements:
          format: int64
          type: integer
        totalPages:
          format: int32
          type: integer
      type: object
    ErrorResponse:
      properties:
        error:
          $ref: '#/components/schemas/ErrorDetail'
      required:
      - error
      type: object
    ErrorDetail:
      description: This is the top-level error object whose code matches the x-ms-error-code response header
      properties:
        code:
          description: This is one of a server-defined set of error codes.
          type: string
        details:
          description: This is an array of details about specific errors that led to this reported error.
          items:
            $ref: '#/components/schemas/ErrorDetail'
          type: array
        innererror:
          $ref: '#/components/schemas/InnerError'
        message:
          description: This is a human-readable representation of the error.
          type: string
        target:
          description: This is the error target.
          type: string
      required:
      - code
      - message
      type: object
  securitySchemes:
    azure_auth:
      type: oauth2
      flows:
        implicit:
          scopes:
            user_impersonation: impersonate your user account
          authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
      description: Azure Active Directory OAuth2 Flow
x-ms-parameterized-host:
  hostTemplate: '{region}.easm.microsoft.com'
  parameters:
  - $ref: '#/components/parameters/RegionParameter'