Microsoft Graph Information Protection is a set of Microsoft Graph APIs that expose Microsoft Purview Information Protection (sensitivity labels and related policies) to applications. It enables developers to discover a tenant’s label taxonomy and policy settings, evaluate which label should apply to given content, and programmatically classify and label files or emails.
openapi: 3.1.0
info:
title: Microsoft Graph Informationprotection
description: Needs a description.
paths:
/informationProtection:
description: Provides operations to manage the informationProtection singleton.
get:
tags:
- informationProtection.informationProtection
summary: Microsoft Graph Get informationProtection
operationId: informationProtection.informationProtection.GetInformationProtection
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved entity
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.informationProtection'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- informationProtection.informationProtection
summary: Microsoft Graph Update informationProtection
operationId: informationProtection.informationProtection.UpdateInformationProtection
requestBody:
description: New property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.informationProtection'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.informationProtection'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
/informationProtection/bitlocker:
description: >-
Provides operations to manage the bitlocker property of the
microsoft.graph.informationProtection entity.
get:
tags:
- informationProtection.bitlocker
summary: Microsoft Graph Get bitlocker from informationProtection
operationId: informationProtection.GetBitlocker
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.bitlocker'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
/informationProtection/bitlocker/recoveryKeys:
description: >-
Provides operations to manage the recoveryKeys property of the
microsoft.graph.bitlocker entity.
get:
tags:
- informationProtection.bitlocker
summary: Microsoft Graph List recoveryKeys
description: >-
Get a list of the bitlockerRecoveryKey objects and their properties. This operation does not return the key property. For information about
how to read the key property, see Get bitlockerRecoveryKey. You can use
this API to programmatically iterate through the list of recovery keys
in the tenant and identify devices with BitLocker enabled. For more
information, see the sample PowerShell code in BitLocker recovery
process.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/bitlocker-list-recoverykeys?view=graph-rest-1.0
operationId: informationProtection.bitlocker.ListRecoveryKeys
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.bitlockerRecoveryKeyCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
/informationProtection/bitlocker/recoveryKeys/{bitlockerRecoveryKey-id}:
description: >-
Provides operations to manage the recoveryKeys property of the
microsoft.graph.bitlocker entity.
get:
tags:
- informationProtection.bitlocker
summary: Microsoft Graph Get bitlockerRecoveryKey
description: >-
Retrieve the properties and relationships of a bitlockerRecoveryKey
object. By default, this operation doesn't return the key property that
represents the actual recovery key. To include the key property in the
response, use the $select OData query parameter. Including the $select
query parameter triggers a Microsoft Entra audit of the operation and
generates an audit log. For more information on audit logs for bitlocker
recovery keys, see the KeyManagement category filter of Microsoft Entra
audit logs.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/bitlockerrecoverykey-get?view=graph-rest-1.0
operationId: informationProtection.bitlocker.GetRecoveryKeys
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.bitlockerRecoveryKey'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: bitlockerRecoveryKey-id
in: path
description: The unique identifier of bitlockerRecoveryKey
required: true
schema:
type: string
x-ms-docs-key-type: bitlockerRecoveryKey
/informationProtection/bitlocker/recoveryKeys/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- informationProtection.bitlocker
summary: Microsoft Graph Get the number of the resource
operationId: informationProtection.bitlocker.recoveryKeys.GetCount-3584
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
/informationProtection/threatAssessmentRequests:
description: >-
Provides operations to manage the threatAssessmentRequests property of the
microsoft.graph.informationProtection entity.
get:
tags:
- informationProtection.threatAssessmentRequest
summary: Microsoft Graph List threatAssessmentRequests
description: >-
Retrieve a list of threatAssessmentRequest objects. A threat assessment
request can be one of the following types:
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/informationprotection-list-threatassessmentrequests?view=graph-rest-1.0
operationId: informationProtection.ListThreatAssessmentRequests
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.threatAssessmentRequestCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- informationProtection.threatAssessmentRequest
summary: Microsoft Graph Create threatAssessmentRequest
description: >-
Create a new threat assessment request. A threat assessment request can
be one of the following types:
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/informationprotection-post-threatassessmentrequests?view=graph-rest-1.0
operationId: informationProtection.CreateThreatAssessmentRequests
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.threatAssessmentRequest'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.threatAssessmentRequest'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
/informationProtection/threatAssessmentRequests/{threatAssessmentRequest-id}:
description: >-
Provides operations to manage the threatAssessmentRequests property of the
microsoft.graph.informationProtection entity.
get:
tags:
- informationProtection.threatAssessmentRequest
summary: Microsoft Graph Get threatAssessmentRequest
description: >-
Retrieve the properties and relationships of a specified
threatAssessmentRequest object. A threat assessment request can be one
of the following types:
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/threatassessmentrequest-get?view=graph-rest-1.0
operationId: informationProtection.GetThreatAssessmentRequests
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.threatAssessmentRequest'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- informationProtection.threatAssessmentRequest
summary: >-
Microsoft Graph Update the navigation property threatAssessmentRequests in informationProtection
operationId: informationProtection.UpdateThreatAssessmentRequests
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.threatAssessmentRequest'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.threatAssessmentRequest'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- informationProtection.threatAssessmentRequest
summary: >-
Microsoft Graph Delete navigation property threatAssessmentRequests for informationProtection
operationId: informationProtection.DeleteThreatAssessmentRequests
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: threatAssessmentRequest-id
in: path
description: The unique identifier of threatAssessmentRequest
required: true
schema:
type: string
x-ms-docs-key-type: threatAssessmentRequest
/informationProtection/threatAssessmentRequests/{threatAssessmentRequest-id}/results:
description: >-
Provides operations to manage the results property of the
microsoft.graph.threatAssessmentRequest entity.
get:
tags:
- informationProtection.threatAssessmentRequest
summary: Microsoft Graph Get results from informationProtection
description: >-
A collection of threat assessment results. Read-only. By default, a GET
/threatAssessmentRequests/{id} does not return this property unless you
apply $expand on it.
operationId: informationProtection.threatAssessmentRequests.ListResults
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.threatAssessmentResultCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- informationProtection.threatAssessmentRequest
summary: Microsoft Graph Create new navigation property to results for informationProtection
operationId: informationProtection.threatAssessmentRequests.CreateResults
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.threatAssessmentResult'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.threatAssessmentResult'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: threatAssessmentRequest-id
in: path
description: The unique identifier of threatAssessmentRequest
required: true
schema:
type: string
x-ms-docs-key-type: threatAssessmentRequest
/informationProtection/threatAssessmentRequests/{threatAssessmentRequest-id}/results/{threatAssessmentResult-id}:
description: >-
Provides operations to manage the results property of the
microsoft.graph.threatAssessmentRequest entity.
get:
tags:
- informationProtection.threatAssessmentRequest
summary: Microsoft Graph Get results from informationProtection
description: >-
A collection of threat assessment results. Read-only. By default, a GET
/threatAssessmentRequests/{id} does not return this property unless you
apply $expand on it.
operationId: informationProtection.threatAssessmentRequests.GetResults
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.threatAssessmentResult'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- informationProtection.threatAssessmentRequest
summary: Microsoft Graph Update the navigation property results in informationProtection
operationId: informationProtection.threatAssessmentRequests.UpdateResults
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.threatAssessmentResult'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.threatAssessmentResult'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- informationProtection.threatAssessmentRequest
summary: Microsoft Graph Delete navigation property results for informationProtection
operationId: informationProtection.threatAssessmentRequests.DeleteResults
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: threatAssessmentRequest-id
in: path
description: The unique identifier of threatAssessmentRequest
required: true
schema:
type: string
x-ms-docs-key-type: threatAssessmentRequest
- name: threatAssessmentResult-id
in: path
description: The unique identifier of threatAssessmentResult
required: true
schema:
type: string
x-ms-docs-key-type: threatAssessmentResult
/informationProtection/threatAssessmentRequests/{threatAssessmentRequest-id}/results/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- informationProtection.threatAssessmentRequest
summary: Microsoft Graph Get the number of the resource
operationId: informationProtection.threatAssessmentRequests.results.GetCount-6c75
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: threatAssessmentRequest-id
in: path
description: The unique identifier of threatAssessmentRequest
required: true
schema:
type: string
x-ms-docs-key-type: threatAssessmentRequest
/informationProtection/threatAssessmentRequests/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- informationProtection.threatAssessmentRequest
summary: Microsoft Graph Get the number of the resource
operationId: informationProtection.threatAssessmentRequests.GetCount-693a
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
components:
schemas:
microsoft.graph.informationProtection:
title: informationProtection
required:
- '@odata.type'
type: object
properties:
bitlocker:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.bitlocker'
- type: object
nullable: true
x-ms-navigationProperty: true
threatAssessmentRequests:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.threatAssessmentRequest'
x-ms-navigationProperty: true
'@odata.type':
type: string
microsoft.graph.bitlocker:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: bitlocker
required:
- '@odata.type'
type: object
properties:
recoveryKeys:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.bitlockerRecoveryKey'
description: The recovery keys associated with the bitlocker entity.
x-ms-navigationProperty: true
'@odata.type':
type: string
x-ms-discriminator-value: '#microsoft.graph.bitlocker'
microsoft.graph.bitlockerRecoveryKey:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: bitlockerRecoveryKey
required:
- '@odata.type'
type: object
properties:
createdDateTime:
pattern: >-
^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$
type: string
description: >-
The date and time when the key was originally backed up to
Microsoft Entra ID. Not nullable.
format: date-time
deviceId:
type: string
description: >-
Identifier of the device the BitLocker key is originally backed
up from. Supports $filter (eq).
nullable: true
key:
type: string
description: >-
The BitLocker recovery key. Returned only on $select. Not
nullable.
volumeType:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.volumeType'
- type: object
nullable: true
description: >-
Indicates the type of volume the BitLocker key is associated
with. The possible values are: 1 (for operatingSystemVolume), 2
(for fixedDataVolume), 3 (for removableDataVolume), and 4 (for
unknownFutureValue).
'@odata.type':
type: string
x-ms-discriminator-value: '#microsoft.graph.bitlockerRecoveryKey'
microsoft.graph.threatAssessmentRequest:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: threatAssessmentRequest
required:
- '@odata.type'
type: object
properties:
category:
$ref: '#/components/schemas/microsoft.graph.threatCategory'
contentType:
anyOf:
- $ref: >-
#/components/schemas/microsoft.graph.threatAssessmentContentType
- type: object
nullable: true
description: >-
The content type of threat assessment. The possible values are:
mail, url, file.
createdBy:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.identitySet'
- type: object
nullable: true
description: The threat assessment request creator.
createdDateTime:
pattern: >-
^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$
type: string
description: >-
The Timestamp type represents date and time information using
ISO 8601 format and is always in UTC time. For example, midnight
UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.
format: date-time
nullable: true
expectedAssessment:
$ref: '#/components/schemas/microsoft.graph.threatExpectedAssessment'
requestSource:
anyOf:
- $ref: >-
#/components/schemas/microsoft.graph.threatAssessmentRequestSource
- type: object
nullable: true
description: >-
The source of the threat assessment request. The possible values
are: administrator.
status:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.threatAssessmentStatus'
- type: object
nullable: true
description: >-
The assessment process status. The possible values are: pending,
completed.
results:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.threatAssessmentResult'
description: >-
A collection of threat assessment results. Read-only. By
default, a GET /threatAssessmentRequests/{id} does not return
this property unless you apply $expand on it.
x-ms-navigationProperty: true
'@odata.type':
type: string
discriminator:
propertyName: '@odata.type'
mapping:
'#microsoft.graph.emailFileAssessmentRequest': '#/components/schemas/microsoft.graph.emailFileAssessmentRequest'
'#microsoft.graph.fileAssessmentRequest': '#/components/schemas/microsoft.graph.fileAssessmentRequest'
'#microsoft.graph.mailAssessmentRequest': '#/components/schemas/microsoft.graph.mailAssessmentRequest'
'#microsoft.graph.urlAssessmentRequest': '#/components/schemas/microsoft.graph.urlAssessmentRequest'
microsoft.graph.threatAssessmentResult:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: threatAssessmentResult
required:
- '@odata.type'
type: object
properties:
createdDateTime:
pattern: >-
^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$
type: string
description: >-
The Timestamp type represents date and time information using
ISO 8601 format and is always in UTC time. For example, midnight
UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.
format: date-time
nullable: true
message:
type: string
description: The result message for each threat assessment.
nullable: true
resultType:
anyOf:
- $ref: >-
#/components/schemas/microsoft.graph.threatAssessmentResultType
- type: object
nullable: true
description: >-
The threat assessment result type. The possible values are:
checkPolicy, rescan.
'@odata.type':
type: string
x-ms-discriminator-value: '#microsoft.graph.threatAssessmentResult'
parameters:
top:
name: $top
in: query
description: Show only the first n items
style: form
explode: false
schema:
minimum: 0
type: integer
example: 50
skip:
name: $skip
in: query
description: Skip the first n items
style: form
explode: false
schema:
minimum: 0
type: integer
search:
name: $search
in: query
description: Search items by search phrases
style: form
explode: false
schema:
type: string
filter:
name: $filter
# --- truncated at 32 KB (32 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/microsoft-graph/refs/heads/main/openapi/informationprotection-openapi-original.yml