openapi: 3.2.0
info:
  title: Microsoft Azure Purview Metadata Policies Service REST API…
  version: 2021-07-01-preview
servers:
- url: /policyStore
security:
- azure_auth:
  - user_impersonation
tags:
- name: Metadata Roles
paths:
  /metadataRoles:
    get:
      tags:
      - Metadata Roles
      description: Lists roles for Purview Account
      operationId: microsoftAzureMetadatarolesList
      parameters:
      - $ref: '#/components/parameters/api-version'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MetadataRoleList'
        default:
          description: An error response received from the Metadata Policy Service
          headers:
            x-ms-error-code:
              description: The error code
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseModel'
      x-ms-pageable:
        nextLinkName: nextLink
        itemName: values
      x-ms-examples:
        MetadataRoles_List:
          $ref: ./examples/MetadataRoles_List.json
      summary: Microsoft Azure Get Metadataroles
components:
  parameters:
    api-version:
      in: query
      name: api-version
      description: The api version to use.
      required: true
      x-ms-client-name: ApiVersion
      schema:
        type: string
  schemas:
    CnfCondition:
      description: The cnf Condition for a rule
      type: array
      items:
        type: array
        items:
          $ref: '#/components/schemas/AttributeMatcher'
    ErrorResponseModel:
      description: The error response model for metadata policy
      required:
      - error
      type: object
      properties:
        error:
          $ref: '#/components/schemas/ErrorModel'
    ErrorModel:
      description: The error model for metadata policy
      required:
      - code
      - message
      type: object
      properties:
        code:
          description: The error code
          type: string
        message:
          description: The error message
          type: string
        target:
          description: The error target
          type: string
        details:
          description: The error details
          type: array
          items:
            $ref: '#/components/schemas/ErrorModel'
    MetadataRoleProperties:
      type: object
      properties:
        provisioningState:
          description: The provisioningState of role
          type: string
        roleType:
          description: The type of role
          type: string
        friendlyName:
          description: The friendly name of role
          type: string
        description:
          description: The description of role
          type: string
        cnfCondition:
          $ref: '#/components/schemas/CnfCondition'
        dnfCondition:
          $ref: '#/components/schemas/DnfCondition'
        version:
          format: int64
          description: The version of role
          type: integer
    MetadataRole:
      type: object
      properties:
        id:
          description: The Id of role
          type: string
        name:
          description: The name of role
          type: string
        type:
          description: The type of role
          type: string
        properties:
          $ref: '#/components/schemas/MetadataRoleProperties'
    DnfCondition:
      description: The dnf Condition for a rule
      type: array
      items:
        type: array
        items:
          $ref: '#/components/schemas/AttributeMatcher'
    AttributeMatcher:
      description: Attribute matcher for a rule
      type: object
      properties:
        attributeName:
          description: AttributeName
          type: string
        attributeValueIncludes:
          description: Value for attribute
          type: string
        attributeValueIncludedIn:
          description: List of values for attribute
          type: array
          items:
            type: string
        attributeValueExcludes:
          description: Value excluded for attribute
          type: string
        attributeValueExcludedIn:
          description: List of values excluded for attribute
          type: array
          items:
            type: string
    MetadataRoleList:
      description: List of Metadata roles
      required:
      - values
      type: object
      properties:
        values:
          type: array
          items:
            $ref: '#/components/schemas/MetadataRole'
        nextLink:
          type: string
  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: '{Endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/components/parameters/Endpoint'