Microsoft Purview

Microsoft Purview Metadata Roles API

Operations for managing metadata roles

Documentation GitHub OpenAPI

Documentation

https://learn.microsoft.com/en-us/rest/api/purview/

https://learn.microsoft.com/en-us/purview/tutorial-using-rest-apis

https://learn.microsoft.com/en-us/purview/data-gov-api-create-assets

https://learn.microsoft.com/en-us/rest/api/purview/scanning

https://learn.microsoft.com/en-us/rest/api/purview/account

https://learn.microsoft.com/en-us/azure/active-directory/develop/v2-oauth2-client-creds-grant-flow

https://learn.microsoft.com/en-us/rest/api/purview/datamap

https://learn.microsoft.com/en-us/purview/legacy/how-to-purview-custom-lineage-api-user-guide

https://learn.microsoft.com/en-us/rest/api/purview/metadatapolicies

https://learn.microsoft.com/en-us/purview/legacy/tutorial-metadata-policy-collections-apis

https://learn.microsoft.com/en-us/rest/api/purview/workflow

https://learn.microsoft.com/en-us/rest/api/purview/unified-catalog-api-overview

https://learn.microsoft.com/en-us/purview/data-gov-api-rest-data-plane

https://learn.microsoft.com/en-us/rest/api/purview/unified-catalog-data-quality

https://learn.microsoft.com/en-us/graph/api/resources/security-ediscovery-apioverview?view=graph-rest-1.0

https://learn.microsoft.com/en-us/graph/security-ediscovery-appauthsetup

https://learn.microsoft.com/en-us/purview/edisc-ref-api-guide

https://learn.microsoft.com/en-us/graph/security-information-protection-overview

https://learn.microsoft.com/en-us/graph/security-datasecurityandgovernance-overview

https://learn.microsoft.com/en-us/purview/developer/use-the-api

https://learn.microsoft.com/en-us/graph/api/resources/security-recordsmanagement-overview?view=graph-rest-1.0

Specifications

https://raw.githubusercontent.com/api-evangelist/microsoft-purview/refs/heads/main/openapi/microsoft-purview-metadata-roles-api-openapi.yml

Other Resources

https://azure.microsoft.com/en-us/pricing/details/purview/

https://learn.microsoft.com/en-us/purview/data-map-data-sources

https://learn.microsoft.com/en-us/purview/unified-catalog-data-quality

https://learn.microsoft.com/en-us/purview/sensitivity-labels

https://learn.microsoft.com/en-us/purview/developer/

https://learn.microsoft.com/en-us/graph/compliance-concept-overview

OpenAPI Specification

openapi: 3.1.0
info:
  title: Microsoft Purview Account Accounts Metadata Roles API
  description: APIs for managing Purview accounts, configurations, and administrative settings through Azure Resource Manager. Provides resource management operations for creating, updating, and deleting Purview accounts.
  version: 2021-12-01
  contact:
    name: Microsoft Purview Support
    url: https://learn.microsoft.com/en-us/purview/
  license:
    name: Microsoft API License
    url: https://azure.microsoft.com/en-us/support/legal/
servers:
- url: https://management.azure.com
  description: Azure Resource Manager endpoint
security:
- oauth2: []
tags:
- name: Metadata Roles
  description: Operations for managing metadata roles
paths:
  /metadataRoles:
    get:
      operationId: listMetadataRoles
      summary: Microsoft Purview List metadata roles
      description: Lists the metadata roles available in the Purview account.
      tags:
      - Metadata Roles
      parameters:
      - name: api-version
        in: query
        required: true
        schema:
          type: string
          default: 2021-07-01-preview
      responses:
        '200':
          description: Metadata roles listed successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MetadataRoleList'
        '401':
          description: Unauthorized
components:
  schemas:
    AttributeMatcher:
      type: object
      properties:
        attributeName:
          type: string
        attributeValueIncludes:
          type: string
        attributeValueIncludedIn:
          type: array
          items:
            type: string
        attributeValueExcludes:
          type: string
        attributeValueExcludedIn:
          type: array
          items:
            type: string
    MetadataRole:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        type:
          type: string
        properties:
          type: object
          properties:
            provisioningState:
              type: string
            roleType:
              type: string
            friendlyName:
              type: string
            description:
              type: string
            cnfCondition:
              type: array
              items:
                type: array
                items:
                  $ref: '#/components/schemas/AttributeMatcher'
    MetadataRoleList:
      type: object
      properties:
        values:
          type: array
          items:
            $ref: '#/components/schemas/MetadataRole'
        nextLink:
          type: string
  securitySchemes:
    oauth2:
      type: oauth2
      description: Azure Active Directory OAuth2 authentication
      flows:
        clientCredentials:
          tokenUrl: https://login.microsoftonline.com/{tenantId}/oauth2/v2.0/token
          scopes:
            https://management.azure.com/.default: Access Azure Resource Manager