openapi: 3.0.4
info:
title: Applications
version: v1.0
servers:
- url: https://graph.microsoft.com/v1.0/
description: Core
paths:
/applications:
get:
tags:
- applications.application
summary: List applications
description: 'Get the list of applications in this organization. This API also returns agentIdentityBlueprint objects, which are identified by the @odata.type property of #microsoft.graph.agentIdentityBlueprint.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/application-list?view=graph-rest-1.0
operationId: application_ListApplication
parameters:
- name: ConsistencyLevel
in: header
description: 'Indicates the requested consistency level. Documentation URL: https://docs.microsoft.com/graph/aad-advanced-queries'
style: simple
schema:
type: string
examples:
example-1:
description: $search and $count queries require the client to set the ConsistencyLevel HTTP header to 'eventual'.
value: eventual
- $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.applicationCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- applications.application
summary: Create application
description: 'Create a new application object. This API can also create an agentIdentityBlueprint object when the @odata.type property is set to #microsoft.graph.agentIdentityBlueprint.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/application-post-applications?view=graph-rest-1.0
operationId: application_CreateApplication
requestBody:
description: New entity
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.application'
required: true
responses:
2XX:
description: Created entity
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.application'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/applications/{application-id}':
get:
tags:
- applications.application
summary: Get application
description: Get the properties and relationships of an application object. This API can be used to get agentIdentityBlueprint objects as well by their ID.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/application-get?view=graph-rest-1.0
operationId: application_GetApplication
parameters:
- name: application-id
in: path
description: The unique identifier of application
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: application
- 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.application'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- applications.application
summary: Upsert application
description: 'Create a new application object if it doesn''t exist, or update the properties of an existing application object. This API can also create an agentIdentityBlueprint object if it doesn''t exist, or update properties of an existing agentIdentityBlueprint, when the @odata.type property is set to #microsoft.graph.agentIdentityBlueprint.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/application-upsert?view=graph-rest-1.0
operationId: application_UpdateApplication
parameters:
- name: application-id
in: path
description: The unique identifier of application
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: application
requestBody:
description: New property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.application'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.application'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- applications.application
summary: Delete application
description: 'Delete an application object. When deleted, apps are moved to a temporary container and can be restored within 30 days. After that time, they are permanently deleted. This API can also delete an agentIdentityBlueprint object by its ID.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/application-delete?view=graph-rest-1.0
operationId: application_DeleteApplication
parameters:
- name: application-id
in: path
description: The unique identifier of application
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: application
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/applications/{application-id}/appManagementPolicies':
get:
tags:
- applications.appManagementPolicy
summary: Get appManagementPolicies from applications
description: The appManagementPolicy applied to this application.
operationId: application_ListAppManagementPolicy
parameters:
- name: application-id
in: path
description: The unique identifier of application
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: application
- $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.appManagementPolicyCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
'/applications/{application-id}/appManagementPolicies/{appManagementPolicy-id}/$ref':
delete:
tags:
- applications.appManagementPolicy
summary: Remove appliesTo
description: 'Remove an appManagementPolicy policy object from an application or service principal object. When you remove the appManagementPolicy, the application or service principal adopts the tenant-wide tenantAppManagementPolicy setting. '
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/appmanagementpolicy-delete-appliesto?view=graph-rest-1.0
operationId: application.appManagementPolicy_DeleteAppManagementPolicyGraphBPreRef
parameters:
- name: application-id
in: path
description: The unique identifier of application
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: application
- name: appManagementPolicy-id
in: path
description: The unique identifier of appManagementPolicy
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: appManagementPolicy
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/applications/{application-id}/appManagementPolicies/$count':
get:
tags:
- applications.appManagementPolicy
summary: Get the number of the resource
operationId: application.appManagementPolicy_GetCount
parameters:
- name: application-id
in: path
description: The unique identifier of application
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: application
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/applications/{application-id}/appManagementPolicies/$ref':
get:
tags:
- applications.appManagementPolicy
summary: Get ref of appManagementPolicies from applications
description: The appManagementPolicy applied to this application.
operationId: application_ListAppManagementPolicyGraphBPreRef
parameters:
- name: application-id
in: path
description: The unique identifier of application
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: application
- $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
responses:
2XX:
$ref: '#/components/responses/StringCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- applications.appManagementPolicy
summary: Assign appliesTo
description: Assign an appManagementPolicy policy object to an application or service principal object. The application or service principal adopts this policy over the tenant-wide tenantAppManagementPolicy setting. Only one policy object can be assigned to an application or service principal.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/appmanagementpolicy-post-appliesto?view=graph-rest-1.0
operationId: application_CreateAppManagementPolicyGraphBPreRef
parameters:
- name: application-id
in: path
description: The unique identifier of application
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: application
requestBody:
$ref: '#/components/requestBodies/refPostBody'
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- applications.appManagementPolicy
summary: Remove appliesTo
description: 'Remove an appManagementPolicy policy object from an application or service principal object. When you remove the appManagementPolicy, the application or service principal adopts the tenant-wide tenantAppManagementPolicy setting. '
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/appmanagementpolicy-delete-appliesto?view=graph-rest-1.0
operationId: application_DeleteAppManagementPolicyGraphBPreRef
parameters:
- name: application-id
in: path
description: The unique identifier of application
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: application
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
- name: '@id'
in: query
description: The delete Uri
required: true
style: form
explode: false
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/applications/{application-id}/createdOnBehalfOf':
get:
tags:
- applications.directoryObject
summary: Get createdOnBehalfOf from applications
description: 'Supports $filter (/$count eq 0, /$count ne 0). Read-only.'
operationId: application_GetCreatedOnBehalfGraphOPre
parameters:
- name: application-id
in: path
description: The unique identifier of application
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: application
- 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.directoryObject'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/applications/{application-id}/extensionProperties':
get:
tags:
- applications.extensionProperty
summary: List extensionProperties (directory extensions)
description: 'Retrieve the list of directory extension definitions, represented by extensionProperty objects on an application.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/application-list-extensionproperty?view=graph-rest-1.0
operationId: application_ListExtensionProperty
parameters:
- name: application-id
in: path
description: The unique identifier of application
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: application
- $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.extensionPropertyCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- applications.extensionProperty
summary: Create extensionProperty (directory extension)
description: 'Create a new directory extension definition, represented by an extensionProperty object.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/application-post-extensionproperty?view=graph-rest-1.0
operationId: application_CreateExtensionProperty
parameters:
- name: application-id
in: path
description: The unique identifier of application
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: application
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.extensionProperty'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.extensionProperty'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/applications/{application-id}/extensionProperties/{extensionProperty-id}':
get:
tags:
- applications.extensionProperty
summary: Get extensionProperty (directory extension)
description: Read a directory extension definition represented by an extensionProperty object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/extensionproperty-get?view=graph-rest-1.0
operationId: application_GetExtensionProperty
parameters:
- name: application-id
in: path
description: The unique identifier of application
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: application
- name: extensionProperty-id
in: path
description: The unique identifier of extensionProperty
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: extensionProperty
- 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.extensionProperty'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- applications.extensionProperty
summary: Update the navigation property extensionProperties in applications
operationId: application_UpdateExtensionProperty
parameters:
- name: application-id
in: path
description: The unique identifier of application
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: application
- name: extensionProperty-id
in: path
description: The unique identifier of extensionProperty
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: extensionProperty
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.extensionProperty'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.extensionProperty'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- applications.extensionProperty
summary: Delete extensionProperty (directory extension)
description: Delete a directory extension definition represented by an extensionProperty object. You can delete only directory extensions that aren't synced from on-premises active directory (AD).
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/extensionproperty-delete?view=graph-rest-1.0
operationId: application_DeleteExtensionProperty
parameters:
- name: application-id
in: path
description: The unique identifier of application
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: application
- name: extensionProperty-id
in: path
description: The unique identifier of extensionProperty
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: extensionProperty
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/applications/{application-id}/extensionProperties/$count':
get:
tags:
- applications.extensionProperty
summary: Get the number of the resource
operationId: application.extensionProperty_GetCount
parameters:
- name: application-id
in: path
description: The unique identifier of application
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: application
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/applications/{application-id}/federatedIdentityCredentials':
get:
tags:
- applications.federatedIdentityCredential
summary: List federatedIdentityCredential objects
description: Get a list of the federatedIdentityCredential objects and their properties assigned to an application.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/federatedidentitycredential-list?view=graph-rest-1.0
operationId: application_ListFederatedIdentityCredential
parameters:
- name: application-id
in: path
description: The unique identifier of application
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: application
- $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.federatedIdentityCredentialCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- applications.federatedIdentityCredential
summary: Create federatedIdentityCredential
description: 'Create a new federatedIdentityCredential object for an application. By configuring a trust relationship between your Microsoft Entra application registration and the identity provider for your compute platform, you can use tokens issued by that platform to authenticate with Microsoft identity platform and call APIs in the Microsoft ecosystem. Maximum of 20 objects can be added to an application.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/federatedidentitycredential-post?view=graph-rest-1.0
operationId: application_CreateFederatedIdentityCredential
parameters:
- name: application-id
in: path
description: The unique identifier of application
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: application
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.federatedIdentityCredential'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.federatedIdentityCredential'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/applications/{application-id}/federatedIdentityCredentials/{federatedIdentityCredential-id}':
get:
tags:
- applications.federatedIdentityCredential
summary: Get federatedIdentityCredential
description: Read the properties and relationships of a federatedIdentityCredential object assigned to an application.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/federatedidentitycredential-get?view=graph-rest-1.0
operationId: application_GetFederatedIdentityCredential
parameters:
- name: application-id
in: path
description: The unique identifier of application
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: application
- name: federatedIdentityCredential-id
in: path
description: The unique identifier of federatedIdentityCredential
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: federatedIdentityCredential
- 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.federatedIdentityCredential'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- applications.federatedIdentityCredential
summary: Upsert federatedIdentityCredential
description: 'Create a new federatedIdentityCredential object for an application if it doesn''t exist, or update the properties of an existing federatedIdentityCredential object. By configuring a trust relationship between your Microsoft Entra application registration and the identity provider for your compute platform, you can use tokens issued by that platform to authenticate with Microsoft identity platform and call APIs in the Microsoft ecosystem. Maximum of 20 objects can be added to an application.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/federatedidentitycredential-upsert?view=graph-rest-1.0
operationId: application_UpdateFederatedIdentityCredential
parameters:
- name: application-id
in: path
description: The unique identifier of application
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: application
- name: federatedIdentityCredential-id
in: path
description: The unique identifier of federatedIdentityCredential
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: federatedIdentityCredential
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.federatedIdentityCredential'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.federatedIdentityCredential'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- applications.federatedIdentityCredential
summary: Delete federatedIdentityCredential
description: Delete a federatedIdentityCredential object from an application.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/federatedidentitycredential-delete?view=graph-rest-1.0
operationId: application_DeleteFederatedIdentityCredential
parameters:
- name: application-id
in: path
description: The unique identifier of application
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: application
- name: federatedIdentityCredential-id
in: path
description: The unique identifier of federatedIdentityCredential
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: federatedIdentityCredential
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/applications/{application-id}/federatedIdentityCredentials(name=''{name}'')':
get:
tags:
- applications.federatedIdentityCredential
summary: Get federatedIdentityCredential
description: Read the properties and relationships of a federatedIdentityCredential object assigned to an application.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/federatedidentitycredential-get?view=graph-rest-1.0
operationId: application.federatedIdentityCredential_GetGraphBPreName
parameters:
- name: application-id
in: path
description: The unique identifier of application
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: application
- name: name
in: path
description: Alternate key of federatedIdentityCredential
required: true
style: simple
schema:
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:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.federatedIdentityCredential'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- applications.federatedIdentityCredential
summary: Upsert federatedIdentityCredential
description: 'Create a new federatedIdentityCredential object for an application if it doesn''t exist, or update the properties of an existing federatedIdentityCredential object. By configuring a trust relationship between your Microsoft Entra application registration and the identity provider for your compute platform, you can use tokens issued by that platform to authenticate with Microsoft identity platform and call APIs in the Microsoft ecosystem. Maximum of 20 objects can be added to an application.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/federatedidentitycredential-upsert?view=graph-rest-1.0
operationId: application.federatedIdentityCredential_UpdateGraphBPreName
parameters:
- name: application-id
in: path
description: The unique identifier of application
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: application
- name: name
in: path
description: Alternate key of federatedIdentityCredential
required: true
style: simple
schema:
type: string
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.federatedIdentityCredential'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.federatedIdentityCredential'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- applications.federatedIdentityCredential
summary: Delete federatedIdentityCredential
description: Delete a federatedIdentityCredential object from an application.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/federatedidentitycredential-delete?view=graph-rest-1.0
operationId: application.federatedIdentityCredential_DeleteGraphBPreName
parameters:
- name: application-id
in: path
description: The unique identifier of application
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: application
- name: name
in: path
description: Alternate key of federatedIdentityCredential
required: true
style: simple
schema:
type: string
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/applications/{application-id}/federatedIdentityCredentials/$count':
get:
tags:
- applications.federatedIdentityCredential
summary: Get the number of the resource
operationId: application.federatedIdentityCredential_GetCount
parameters:
- name: application-id
in: path
description: The unique identifier of application
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: application
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/applications/{application-id}/homeRealmDiscoveryPolicies':
get:
tags:
- applications.homeRealmDiscoveryPolicy
summary: Get homeRealmDiscoveryPolicies from applications
operationId: application_ListHomeRealmDiscoveryPolicy
parameters:
- name: application-id
in: path
description: The unique identifier of application
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: application
- $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.homeRealmDiscoveryPolicyCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
'/applications/{application-id}/homeRealmDiscoveryPolicies/{homeRealmDiscoveryPolicy-id}':
get:
tags:
- applications.homeRealmDiscoveryPolicy
summary: Get homeRealmDiscoveryPolicies from applications
operationId: application_GetHomeRealmDiscoveryPolicy
parameters:
- name: application-id
in: path
description: The unique identifier of application
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: application
- name: homeRealmDiscoveryPolicy-id
in: path
description: The unique identifier of homeRealmDiscoveryPolicy
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: homeRealmDiscoveryPolicy
- 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.homeRealmDiscoveryPolicy'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/applications/{application-id}/homeRealmDiscoveryPolicies/$count':
get:
tags:
- applications.homeRealmDiscoveryPolicy
summary: Get the number of the resource
operationId: application.homeRealmDiscoveryPolicy_GetCount
parameters:
- name: application-id
in: path
description: The unique identifier of application
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: application
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/applications/{application-id}/logo':
get:
tags:
- applications.application
summary: Get logo for application from applications
description: The main logo for the application. Not nullable.
operationId: application_GetLogo
parameters:
- name: application-id
in: path
description: The unique identifier of application
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: application
responses:
2XX:
description: Retrieved media content
content:
application/octet-stream:
schema:
type: string
format: binary
default:
$ref: '#/components/responses/error'
put:
tags:
- applications.application
summary: Update logo for application in applications
description: The main logo for the application. Not nullable.
operationId: application_SetLogo
parameters:
- name: application-id
in: path
description: The unique identifier of application
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: application
requestBody:
description: New media content.
content:
application/octet-stream:
schema:
type: string
format: binary
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
delete:
tags:
- applications.application
summary: Delete logo for application in applications
description: The main logo for the application. Not nullable.
operationId: application_DeleteLogo
parameters:
- name: application-id
in: path
description: The unique identifier of application
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: application
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
'/applications/{application-id}/microsoft.graph.addKey':
post:
tags:
- applications.application.Actions
summary: Invoke action addKey
description: 'Add a key credential to an application. This method, along with removeKey can be used by an application to automate rolling its expiring keys. As part of the request validation for this method, a proof of possession of an existing key is verified before the action can be performed. Applications that don''t have any existing valid certificates (no certificates have been added yet, or all certificates have expired), won''t be able to use this service action. You can use the Update application operation to perform an update instead.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/application-addkey?view=graph-rest-1.0
operationId: application_addKey
parameters:
- name: application-id
in: path
description: The unique identifier of application
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: application
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
keyCredential:
$ref: '#/components/schemas/microsoft.graph.keyCredential'
passwordCredential:
$ref: '#/components/schemas/microsoft.graph.passwordCredential'
proof:
type: string
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.keyCredential'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/applications/{application-id}/microsoft.graph.addPassword':
post:
tags:
- applications.application.Actions
summary: Invoke action addPassword
description: Adds a strong password or secret to an application. You can also add passwords while creating the application.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/application-addpassword?view=graph-rest-1.0
operationId: application_addPassword
parameters:
- name: application-id
in: path
description: The unique identifier of application
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: application
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
passwordCredential:
$ref: '#/components/schemas/microsoft.graph.passwordCredential'
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.passwordCredential'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/applications/{application-id}/microsoft.graph.checkMemberGroups':
post:
tags:
- applications.application.Actions
summary: Invoke action checkMemberGroups
description: "Check for membership in a specified list of group IDs, and return from that list the IDs of groups where a specified object is a member. The specified object can be of one of the following types:\r\n- user\r\n- group\r\n- service principal\r\n- organizational contact\r\n- device\r\n- directory object This function is transitive. You can check up to a maximum of 20 groups per request. This function supports all groups provisioned in Microsoft Entra ID. Because Microsoft 365 groups cannot contain other groups, membership in a Microsoft 365 group is always direct."
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/directoryobject-checkmembergroups?view=graph-rest-1.0
operationId: application_checkMemberGroup
parameters:
- name: application-id
in: path
description: The unique identifier of application
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: application
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
groupIds:
type: array
items:
type: string
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
type: object
properties:
value:
type: array
items:
type: string
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
'/applications/{application-id}/microsoft.graph.checkMemberObjects':
post:
tags:
- applications.application.Actions
summary: Invoke action checkMemberObjects
operationId: application_checkMemberObject
parameters:
- name: application-id
in: path
description: The unique identifier of application
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: application
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
ids:
type: array
items:
type: string
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
type: object
properties:
value:
type: array
items:
type: string
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
'/applications/{application-id}/microsoft.graph.getMemberGroups':
post:
tags:
- applications.application.Actions
summary: Invoke action getMemberGroups
description: 'Return all the group IDs for the groups that the specified user, group, service principal, organizational contact, device, or directory object is a member of. This function is transitive. This API returns up to 11,000 group IDs. If more than 11,000 results are available, it returns a 400 Bad Request error with the DirectoryResultSizeLimitExceeded error code. If you get the DirectoryResultSizeLimitExceeded error code, use the List group transitive memberOf API instead.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/directoryobject-getmembergroups?view=graph-rest-1.0
operationId: application_getMemberGroup
parameters:
- name: application-id
in: path
description: The unique identifier of application
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: application
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
securityEnabledOnly:
type: boolean
default: false
nullable: true
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
type: object
properties:
value:
type: array
items:
type: string
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
'/applications/{application-id}/microsoft.graph.getMemberObjects':
post:
tags:
- applications.application.Actions
summary: Invoke action getMemberObjects
description: "Return all IDs for the groups, administrative units, and directory roles that an object of one of the following types is a member of:\r\n- user\r\n- group\r\n- service principal\r\n- organizational contact\r\n- device\r\n- directory object This function is transitive. Only users and role-enabled groups can be members of directory roles."
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/directoryobject-getmemberobjects?view=graph-rest-1.0
operationId: application_getMemberObject
parameters:
- name: application-id
in: path
description: The unique identifier of application
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: application
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
securityEnabledOnly:
type: boolean
default: false
nullable: true
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
type: object
properties:
value:
type: array
items:
type: string
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
'/applications/{application-id}/microsoft.graph.removeKey':
post:
tags:
- applications.application.Actions
summary: Invoke action removeKey
description: Remove a key credential from an agentIdentityBlueprint. This method along with addKey can be used to automate rolling its expiring keys.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/agentidentityblueprint-removekey?view=graph-rest-1.0
operationId: application_removeKey
parameters:
- name: application-id
in: path
description: The unique identifier of application
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: application
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
keyId:
pattern: '^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$'
type: string
format: uuid
proof:
type: string
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/applications/{application-id}/microsoft.graph.removePassword':
post:
tags:
- applications.application.Actions
summary: Invoke action removePassword
description: Remove a password from an application.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/application-removepassword?view=graph-rest-1.0
operationId: application_removePassword
parameters:
- name: application-id
in: path
description: The unique identifier of application
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: application
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
keyId:
pattern: '^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$'
type: string
format: uuid
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/applications/{application-id}/microsoft.graph.restore':
post:
tags:
- applications.application.Actions
summary: Invoke action restore
description: "Restore a recently deleted directory object from deleted items. The following types are supported:\r\n- administrativeUnit\r\n- application\r\n- agentIdentityBlueprint\r\n- agentIdentity\r\n- agentIdentityBlueprintPrincipal\r\n- agentUser\r\n- certificateBasedAuthPki\r\n- certificateAuthorityDetail\r\n- group\r\n- servicePrincipal\r\n- user If an item is accidentally deleted, you can fully restore the item. Additionally, restoring an application doesn't automatically restore the associated service principal automatically. You must call this API to explicitly restore the deleted service principal. A recently deleted item remains available for up to 30 days. After 30 days, the item is permanently deleted."
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/directory-deleteditems-restore?view=graph-rest-1.0
operationId: application_restore
parameters:
- name: application-id
in: path
description: The unique identifier of application
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: application
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/applications/{application-id}/microsoft.graph.setVerifiedPublisher':
post:
tags:
- applications.application.Actions
summary: Invoke action setVerifiedPublisher
description: 'Set the the verifiedPublisher on an agentIdentityBlueprint. For more information, including prerequisites to setting a verified publisher, see Publisher verification.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/agentidentityblueprint-setverifiedpublisher?view=graph-rest-1.0
operationId: application_setVerifiedPublisher
parameters:
- name: application-id
in: path
description: The unique identifier of application
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: application
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
verifiedPublisherId:
type: string
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/applications/{application-id}/microsoft.graph.unsetVerifiedPublisher':
post:
tags:
- applications.application.Actions
summary: Invoke action unsetVerifiedPublisher
description: 'Unset the verifiedPublisher previously set on an agentIdentityBlueprint, removing all verified publisher properties. For more information, see Publisher verification.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/agentidentityblueprint-unsetverifiedpublisher?view=graph-rest-1.0
operationId: application_unsetVerifiedPublisher
parameters:
- name: application-id
in: path
description: The unique identifier of application
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: application
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/applications/{application-id}/owners':
get:
tags:
- applications.directoryObject
summary: List owners of an application
description: Retrieve a list of owners for an application that are directoryObject types.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/application-list-owners?view=graph-rest-1.0
operationId: application_ListOwner
parameters:
- name: application-id
in: path
description: The unique identifier of application
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: application
- name: ConsistencyLevel
in: header
description: 'Indicates the requested consistency level. Documentation URL: https://docs.microsoft.com/graph/aad-advanced-queries'
style: simple
schema:
type: string
examples:
example-1:
description: $search and $count queries require the client to set the ConsistencyLevel HTTP header to 'eventual'.
value: eventual
- $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.directoryObjectCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
'/applications/{application-id}/owners/{directoryObject-id}/$ref':
delete:
tags:
- applications.directoryObject
summary: Remove application owner
description: 'Remove an owner from an application. As a recommended best practice, apps should have at least two owners.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/application-delete-owners?view=graph-rest-1.0
operationId: application.owner_DeleteDirectoryObjectGraphBPreRef
parameters:
- name: application-id
in: path
description: The unique identifier of application
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: application
- name: directoryObject-id
in: path
description: The unique identifier of directoryObject
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: directoryObject
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/applications/{application-id}/owners/{directoryObject-id}/microsoft.graph.appRoleAssignment':
get:
tags:
- applications.directoryObject
summary: Get the item of type microsoft.graph.directoryObject as microsoft.graph.appRoleAssignment
operationId: application_GetOwnerAsAppRoleAssignment
parameters:
- name: application-id
in: path
description: The unique identifier of application
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: application
- name: directoryObject-id
in: path
description: The unique identifier of directoryObject
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: directoryObject
- name: ConsistencyLevel
in: header
description: 'Indicates the requested consistency level. Documentation URL: https://docs.microsoft.com/graph/aad-advanced-queries'
style: simple
schema:
type: string
examples:
example-1:
description: $search and $count queries require the client to set the ConsistencyLevel HTTP header to 'eventual'.
value: eventual
- 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: Entity result.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.appRoleAssignment'
default:
$ref: '#/components/responses/error'
'/applications/{application-id}/owners/{directoryObject-id}/microsoft.graph.endpoint':
get:
tags:
- applications.directoryObject
summary: Get the item of type microsoft.graph.directoryObject as microsoft.graph.endpoint
operationId: application_GetOwnerAsEndpoint
parameters:
- name: application-id
in: path
description: The unique identifier of application
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: application
- name: directoryObject-id
in: path
description: The unique identifier of directoryObject
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: directoryObject
- name: ConsistencyLevel
in: header
description: 'Indicates the requested consistency level. Documentation URL: https://docs.microsoft.com/graph/aad-advanced-queries'
style: simple
schema:
type: string
examples:
example-1:
description: $search and $count queries require the client to set the ConsistencyLevel HTTP header to 'eventual'.
value: eventual
- 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: Entity result.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.endpoint'
default:
$ref: '#/components/responses/error'
'/applications/{application-id}/owners/{directoryObject-id}/microsoft.graph.servicePrincipal':
get:
tags:
- applications.directoryObject
summary: Get the item of type microsoft.graph.directoryObject as microsoft.graph.servicePrincipal
operationId: application_GetOwnerAsServicePrincipal
parameters:
- name: application-id
in: path
description: The unique identifier of application
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: application
- name: directoryObject-id
in: path
description: The unique identifier of directoryObject
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: directoryObject
- name: ConsistencyLevel
in: header
description: 'Indicates the requested consistency level. Documentation URL: https://docs.microsoft.com/graph/aad-advanced-queries'
style: simple
schema:
type: string
examples:
example-1:
description: $search and $count queries require the client to set the ConsistencyLevel HTTP header to 'eventual'.
value: eventual
- 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: Entity result.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.servicePrincipal'
default:
$ref: '#/components/responses/error'
'/applications/{application-id}/owners/{directoryObject-id}/microsoft.graph.user':
get:
tags:
- applications.directoryObject
summary: Get the item of type microsoft.graph.directoryObject as microsoft.graph.user
operationId: application_GetOwnerAsUser
parameters:
- name: application-id
in: path
description: The unique identifier of application
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: application
- name: directoryObject-id
in: path
description: The unique identifier of directoryObject
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: directoryObject
- name: ConsistencyLevel
in: header
description: 'Indicates the requested consistency level. Documentation URL: https://docs.microsoft.com/graph/aad-advanced-queries'
style: simple
schema:
type: string
examples:
example-1:
description: $search and $count queries require the client to set the ConsistencyLevel HTTP header to 'eventual'.
value: eventual
- 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: Entity result.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.user'
default:
$ref: '#/components/responses/error'
'/applications/{application-id}/owners/$count':
get:
tags:
- applications.directoryObject
summary: Get the number of the resource
operationId: application.owner_GetCount
parameters:
- name: application-id
in: path
description: The unique identifier of application
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: application
- name: ConsistencyLevel
in: header
description: 'Indicates the requested consistency level. Documentation URL: https://docs.microsoft.com/graph/aad-advanced-queries'
style: simple
schema:
type: string
examples:
example-1:
description: $search and $count queries require the client to set the ConsistencyLevel HTTP header to 'eventual'.
value: eventual
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/applications/{application-id}/owners/$ref':
get:
tags:
- applications.directoryObject
summary: List owners of an application
description: Retrieve a list of owners for an application that are directoryObject types.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/application-list-owners?view=graph-rest-1.0
operationId: application_ListOwnerGraphBPreRef
parameters:
- name: application-id
in: path
description: The unique identifier of application
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: application
- name: ConsistencyLevel
in: header
description: 'Indicates the requested consistency level. Documentation URL: https://docs.microsoft.com/graph/aad-advanced-queries'
style: simple
schema:
type: string
examples:
example-1:
description: $search and $count queries require the client to set the ConsistencyLevel HTTP header to 'eventual'.
value: eventual
- $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
responses:
2XX:
$ref: '#/components/responses/StringCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- applications.directoryObject
summary: Add owner
description: 'Add an owner to an application. Application owners can be individual users, the associated service principal, or another service principal.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/application-post-owners?view=graph-rest-1.0
operationId: application_CreateOwnerGraphBPreRef
parameters:
- name: application-id
in: path
description: The unique identifier of application
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: application
requestBody:
$ref: '#/components/requestBodies/refPostBody'
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- applications.directoryObject
summary: Remove application owner
description: 'Remove an owner from an application. As a recommended best practice, apps should have at least two owners.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/application-delete-owners?view=graph-rest-1.0
operationId: application_DeleteOwnerGraphBPreRef
parameters:
- name: application-id
in: path
description: The unique identifier of application
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: application
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
- name: '@id'
in: query
description: The delete Uri
required: true
style: form
explode: false
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/applications/{application-id}/owners/microsoft.graph.appRoleAssignment':
get:
tags:
- applications.directoryObject
summary: Get the items of type microsoft.graph.appRoleAssignment in the microsoft.graph.directoryObject collection
operationId: application_ListOwnerAsAppRoleAssignment
parameters:
- name: application-id
in: path
description: The unique identifier of application
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: application
- name: ConsistencyLevel
in: header
description: 'Indicates the requested consistency level. Documentation URL: https://docs.microsoft.com/graph/aad-advanced-queries'
style: simple
schema:
type: string
examples:
example-1:
description: $search and $count queries require the client to set the ConsistencyLevel HTTP header to 'eventual'.
value: eventual
- $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.appRoleAssignmentCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
'/applications/{application-id}/owners/microsoft.graph.appRoleAssignment/$count':
get:
tags:
- applications.directoryObject
summary: Get the number of the resource
operationId: application.Owner_GetCountAsAppRoleAssignment
parameters:
- name: application-id
in: path
description: The unique identifier of application
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: application
- name: ConsistencyLevel
in: header
description: 'Indicates the requested consistency level. Documentation URL: https://docs.microsoft.com/graph/aad-advanced-queries'
style: simple
schema:
type: string
examples:
example-1:
description: $search and $count queries require the client to set the ConsistencyLevel HTTP header to 'eventual'.
value: eventual
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/applications/{application-id}/owners/microsoft.graph.endpoint':
get:
tags:
- applications.directoryObject
summary: Get the items of type microsoft.graph.endpoint in the microsoft.graph.directoryObject collection
operationId: application_ListOwnerAsEndpoint
parameters:
- name: application-id
in: path
description: The unique identifier of application
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: application
- name: ConsistencyLevel
in: header
description: 'Indicates the requested consistency level. Documentation URL: https://docs.microsoft.com/graph/aad-advanced-queries'
style: simple
schema:
type: string
examples:
example-1:
description: $search and $count queries require the client to set the ConsistencyLevel HTTP header to 'eventual'.
value: eventual
- $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.endpointCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
'/applications/{application-id}/owners/microsoft.graph.endpoint/$count':
get:
tags:
- applications.directoryObject
summary: Get the number of the resource
operationId: application.Owner_GetCountAsEndpoint
parameters:
- name: application-id
in: path
description: The unique identifier of application
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: application
- name: ConsistencyLevel
in: header
description: 'Indicates the requested consistency level. Documentation URL: https://docs.microsoft.com/graph/aad-advanced-queries'
style: simple
schema:
type: string
examples:
example-1:
description: $search and $count queries require the client to set the ConsistencyLevel HTTP header to 'eventual'.
value: eventual
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/applications/{application-id}/owners/microsoft.graph.servicePrincipal':
get:
tags:
- applications.directoryObject
summary: Get the items of type microsoft.graph.servicePrincipal in the microsoft.graph.directoryObject collection
operationId: application_ListOwnerAsServicePrincipal
parameters:
- name: application-id
in: path
description: The unique identifier of application
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: application
- name: ConsistencyLevel
in: header
description: 'Indicates the requested consistency level. Documentation URL: https://docs.microsoft.com/graph/aad-advanced-queries'
style: simple
schema:
type: string
examples:
example-1:
description: $search and $count queries require the client to set the ConsistencyLevel HTTP header to 'eventual'.
value: eventual
- $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.servicePrincipalCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
'/applications/{application-id}/owners/microsoft.graph.servicePrincipal/$count':
get:
tags:
- applications.directoryObject
summary: Get the number of the resource
operationId: application.Owner_GetCountAsServicePrincipal
parameters:
- name: application-id
in: path
description: The unique identifier of application
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: application
- name: ConsistencyLevel
in: header
description: 'Indicates the requested consistency level. Documentation URL: https://docs.microsoft.com/graph/aad-advanced-queries'
style: simple
schema:
type: string
examples:
example-1:
description: $search and $count queries require the client to set the ConsistencyLevel HTTP header to 'eventual'.
value: eventual
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/applications/{application-id}/owners/microsoft.graph.user':
get:
tags:
- applications.directoryObject
summary: Get the items of type microsoft.graph.user in the microsoft.graph.directoryObject collection
operationId: application_ListOwnerAsUser
parameters:
- name: application-id
in: path
description: The unique identifier of application
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: application
- name: ConsistencyLevel
in: header
description: 'Indicates the requested consistency level. Documentation URL: https://docs.microsoft.com/graph/aad-advanced-queries'
style: simple
schema:
type: string
examples:
example-1:
description: $search and $count queries require the client to set the ConsistencyLevel HTTP header to 'eventual'.
value: eventual
- $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.userCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
'/applications/{application-id}/owners/microsoft.graph.user/$count':
get:
tags:
- applications.directoryObject
summary: Get the number of the resource
operationId: application.Owner_GetCountAsUser
parameters:
- name: application-id
in: path
description: The unique identifier of application
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: application
- name: ConsistencyLevel
in: header
description: 'Indicates the requested consistency level. Documentation URL: https://docs.microsoft.com/graph/aad-advanced-queries'
style: simple
schema:
type: string
examples:
example-1:
description: $search and $count queries require the client to set the ConsistencyLevel HTTP header to 'eventual'.
value: eventual
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/applications/{application-id}/synchronization':
get:
tags:
- applications.synchronization
summary: Get synchronization from applications
description: Represents the capability for Microsoft Entra identity synchronization through the Microsoft Graph API.
operationId: application_GetSynchronization
parameters:
- name: application-id
in: path
description: The unique identifier of application
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: application
- 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.synchronization'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
put:
tags:
- applications.synchronization
summary: Update the navigation property synchronization in applications
operationId: application_SetSynchronization
parameters:
- name: application-id
in: path
description: The unique identifier of application
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: application
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.synchronization'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.synchronization'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- applications.synchronization
summary: Delete navigation property synchronization for applications
operationId: application_DeleteSynchronization
parameters:
- name: application-id
in: path
description: The unique identifier of application
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: application
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/applications/{application-id}/synchronization/jobs':
get:
tags:
- applications.synchronization
summary: Get jobs from applications
description: 'Performs synchronization by periodically running in the background, polling for changes in one directory, and pushing them to another directory.'
operationId: application.synchronization_ListJob
parameters:
- name: application-id
in: path
description: The unique identifier of application
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: application
- $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.synchronizationJobCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- applications.synchronization
summary: Create new navigation property to jobs for applications
operationId: application.synchronization_CreateJob
parameters:
- name: application-id
in: path
description: The unique identifier of application
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: application
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.synchronizationJob'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.synchronizationJob'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/applications/{application-id}/synchronization/jobs/{synchronizationJob-id}':
get:
tags:
- applications.synchronization
summary: Get jobs from applications
description: 'Performs synchronization by periodically running in the background, polling for changes in one directory, and pushing them to another directory.'
operationId: application.synchronization_GetJob
parameters:
- name: application-id
in: path
description: The unique identifier of application
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: application
- name: synchronizationJob-id
in: path
description: The unique identifier of synchronizationJob
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: synchronizationJob
- 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.synchronizationJob'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- applications.synchronization
summary: Update the navigation property jobs in applications
operationId: application.synchronization_UpdateJob
parameters:
- name: application-id
in: path
description: The unique identifier of application
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: application
- name: synchronizationJob-id
in: path
description: The unique identifier of synchronizationJob
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: synchronizationJob
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.synchronizationJob'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.synchronizationJob'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- applications.synchronization
summary: Delete navigation property jobs for applications
operationId: application.synchronization_DeleteJob
parameters:
- name: application-id
in: path
description: The unique identifier of application
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: application
- name: synchronizationJob-id
in: path
description: The unique identifier of synchronizationJob
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: synchronizationJob
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/applications/{application-id}/synchronization/jobs/{synchronizationJob-id}/bulkUpload':
get:
tags:
- applications.synchronization
summary: Get bulkUpload from applications
description: The bulk upload operation for the job.
operationId: application.synchronization.job_GetBulkUpload
parameters:
- name: application-id
in: path
description: The unique identifier of application
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: application
- name: synchronizationJob-id
in: path
description: The unique identifier of synchronizationJob
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: synchronizationJob
- 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.bulkUpload'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- applications.synchronization
summary: Update the navigation property bulkUpload in applications
operationId: application.synchronization.job_UpdateBulkUpload
parameters:
- name: application-id
in: path
description: The unique identifier of application
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: application
- name: synchronizationJob-id
in: path
description: The unique identifier of synchronizationJob
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: synchronizationJob
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.bulkUpload'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.bulkUpload'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- applications.synchronization
summary: Delete navigation property bulkUpload for applications
operationId: application.synchronization.job_DeleteBulkUpload
parameters:
- name: application-id
in: path
description: The unique identifier of application
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: application
- name: synchronizationJob-id
in: path
description: The unique identifier of synchronizationJob
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: synchronizationJob
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/applications/{application-id}/synchronization/jobs/{synchronizationJob-id}/bulkUpload/$value':
get:
tags:
- applications.synchronization
summary: Get media content for the navigation property bulkUpload from applications
description: The bulk upload operation for the job.
operationId: application.synchronization.job_GetBulkUploadContent
parameters:
- name: application-id
in: path
description: The unique identifier of application
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: application
- name: synchronizationJob-id
in: path
description: The unique identifier of synchronizationJob
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: synchronizationJob
responses:
2XX:
description: Retrieved media content
content:
application/octet-stream:
schema:
type: string
format: binary
default:
$ref: '#/components/responses/error'
put:
tags:
- applications.synchronization
summary: Update media content for the navigation property bulkUpload in applications
description: The bulk upload operation for the job.
operationId: application.synchronization.job_SetBulkUploadContent
parameters:
- name: application-id
in: path
description: The unique identifier of application
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: application
- name: synchronizationJob-id
in: path
description: The unique identifier of synchronizationJob
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: synchronizationJob
requestBody:
description: New media content.
content:
application/octet-stream:
schema:
type: string
format: binary
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
delete:
tags:
- applications.synchronization
summary: Delete media content for the navigation property bulkUpload in applications
description: The bulk upload operation for the job.
operationId: application.synchronization.job_DeleteBulkUploadContent
parameters:
- name: application-id
in: path
description: The unique identifier of application
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: application
- name: synchronizationJob-id
in: path
description: The unique identifier of synchronizationJob
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: synchronizationJob
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
'/applications/{application-id}/synchronization/jobs/{synchronizationJob-id}/microsoft.graph.pause':
post:
tags:
- applications.synchronization
summary: Invoke action pause
description: 'Temporarily stop a running synchronizationJob. All the progress, including job state, is persisted, and the job will continue from where it left off when a start call is made.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/synchronization-synchronizationjob-pause?view=graph-rest-1.0
operationId: application.synchronization.job_pause
parameters:
- name: application-id
in: path
description: The unique identifier of application
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: application
- name: synchronizationJob-id
in: path
description: The unique identifier of synchronizationJob
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: synchronizationJob
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/applications/{application-id}/synchronization/jobs/{synchronizationJob-id}/microsoft.graph.provisionOnDemand':
post:
tags:
- applications.synchronization
summary: Invoke action provisionOnDemand
description: Select a user and provision the account on-demand for a synchronizationJob. The rate limit for this API is 5 requests per 10 seconds.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/synchronization-synchronizationjob-provisionondemand?view=graph-rest-1.0
operationId: application.synchronization.job_provisionOnDemand
parameters:
- name: application-id
in: path
description: The unique identifier of application
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: application
- name: synchronizationJob-id
in: path
description: The unique identifier of synchronizationJob
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: synchronizationJob
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
parameters:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.synchronizationJobApplicationParameters'
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.stringKeyStringValuePair'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/applications/{application-id}/synchronization/jobs/{synchronizationJob-id}/microsoft.graph.restart':
post:
tags:
- applications.synchronization
summary: Invoke action restart
description: 'Restart a stopped synchronizationJob, forcing it to reprocess all the objects in the directory. Optionally clears existing the synchronization state and previous errors.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/synchronization-synchronizationjob-restart?view=graph-rest-1.0
operationId: application.synchronization.job_restart
parameters:
- name: application-id
in: path
description: The unique identifier of application
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: application
- name: synchronizationJob-id
in: path
description: The unique identifier of synchronizationJob
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: synchronizationJob
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
criteria:
$ref: '#/components/schemas/microsoft.graph.synchronizationJobRestartCriteria'
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/applications/{application-id}/synchronization/jobs/{synchronizationJob-id}/microsoft.graph.start':
post:
tags:
- applications.synchronization
summary: Invoke action start
description: 'Start an existing synchronizationJob. If the job is in a paused state, it continues processing changes from the point where it was paused. If the job is in quarantine, the quarantine status is cleared. Don''t create scripts to call the start job continuously while it''s running because that can cause the service to stop running. Use the start job only when the job is currently paused or in quarantine. '
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/synchronization-synchronizationjob-start?view=graph-rest-1.0
operationId: application.synchronization.job_start
parameters:
- name: application-id
in: path
description: The unique identifier of application
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: application
- name: synchronizationJob-id
in: path
description: The unique identifier of synchronizationJob
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: synchronizationJob
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/applications/{application-id}/synchronization/jobs/{synchronizationJob-id}/microsoft.graph.validateCredentials':
post:
tags:
- applications.synchronization
summary: Invoke action validateCredentials
description: Validate that the credentials are valid in the tenant for a synchronizationJob.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/synchronization-synchronizationjob-validatecredentials?view=graph-rest-1.0
operationId: application.synchronization.job_validateCredential
parameters:
- name: application-id
in: path
description: The unique identifier of application
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: application
- name: synchronizationJob-id
in: path
description: The unique identifier of synchronizationJob
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: synchronizationJob
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
applicationIdentifier:
type: string
nullable: true
templateId:
type: string
nullable: true
useSavedCredentials:
type: boolean
default: false
nullable: true
credentials:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.synchronizationSecretKeyStringValuePair'
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/applications/{application-id}/synchronization/jobs/{synchronizationJob-id}/schema':
get:
tags:
- applications.synchronization
summary: Get schema from applications
description: The synchronization schema configured for the job.
operationId: application.synchronization.job_GetSchema
parameters:
- name: application-id
in: path
description: The unique identifier of application
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: application
- name: synchronizationJob-id
in: path
description: The unique identifier of synchronizationJob
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: synchronizationJob
- 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.synchronizationSchema'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- applications.synchronization
summary: Update the navigation property schema in applications
operationId: application.synchronization.job_UpdateSchema
parameters:
- name: application-id
in: path
description: The unique identifier of application
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: application
- name: synchronizationJob-id
in: path
description: The unique identifier of synchronizationJob
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: synchronizationJob
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.synchronizationSchema'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.synchronizationSchema'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- applications.synchronization
summary: Delete navigation property schema for applications
operationId: application.synchronization.job_DeleteSchema
parameters:
- name: application-id
in: path
description: The unique identifier of application
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: application
- name: synchronizationJob-id
in: path
description: The unique identifier of synchronizationJob
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: synchronizationJob
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/applications/{application-id}/synchronization/jobs/{synchronizationJob-id}/schema/directories':
get:
tags:
- applications.synchronization
summary: Get directories from applications
description: Contains the collection of directories and all of their objects.
operationId: application.synchronization.job.schema_ListDirectory
parameters:
- name: application-id
in: path
description: The unique identifier of application
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: application
- name: synchronizationJob-id
in: path
description: The unique identifier of synchronizationJob
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: synchronizationJob
- $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.directoryDefinitionCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- applications.synchronization
summary: Create new navigation property to directories for applications
operationId: application.synchronization.job.schema_CreateDirectory
parameters:
- name: application-id
in: path
description: The unique identifier of application
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: application
- name: synchronizationJob-id
in: path
description: The unique identifier of synchronizationJob
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: synchronizationJob
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.directoryDefinition'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.directoryDefinition'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/applications/{application-id}/synchronization/jobs/{synchronizationJob-id}/schema/directories/{directoryDefinition-id}':
get:
tags:
- applications.synchronization
summary: Get directories from applications
description: Contains the collection of directories and all of their objects.
operationId: application.synchronization.job.schema_GetDirectory
parameters:
- name: application-id
in: path
description: The unique identifier of application
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: application
- name: synchronizationJob-id
in: path
description: The unique identifier of synchronizationJob
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: synchronizationJob
- name: directoryDefinition-id
in: path
description: The unique identifier of directoryDefinition
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: directoryDefinition
- 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.directoryDefinition'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- applications.synchronization
summary: Update the navigation property directories in applications
operationId: application.synchronization.job.schema_UpdateDirectory
parameters:
- name: application-id
in: path
description: The unique identifier of application
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: application
- name: synchronizationJob-id
in: path
description: The unique identifier of synchronizationJob
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: synchronizationJob
- name: directoryDefinition-id
in: path
description: The unique identifier of directoryDefinition
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: directoryDefinition
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.directoryDefinition'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.directoryDefinition'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- applications.synchronization
summary: Delete navigation property directories for applications
operationId: application.synchronization.job.schema_DeleteDirectory
parameters:
- name: application-id
in: path
description: The unique identifier of application
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: application
- name: synchronizationJob-id
in: path
description: The unique identifier of synchronizationJob
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: synchronizationJob
- name: directoryDefinition-id
in: path
description: The unique identifier of directoryDefinition
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: directoryDefinition
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/applications/{application-id}/synchronization/jobs/{synchronizationJob-id}/schema/directories/{directoryDefinition-id}/microsoft.graph.discover':
post:
tags:
- applications.synchronization
summary: Invoke action discover
description: Discover the latest schema definition for provisioning to an application for the directoryDefinition.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/synchronization-directorydefinition-discover?view=graph-rest-1.0
operationId: application.synchronization.job.schema.directory_discover
parameters:
- name: application-id
in: path
description: The unique identifier of application
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: application
- name: synchronizationJob-id
in: path
description: The unique identifier of synchronizationJob
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: synchronizationJob
- name: directoryDefinition-id
in: path
description: The unique identifier of directoryDefinition
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: directoryDefinition
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.directoryDefinition'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/applications/{application-id}/synchronization/jobs/{synchronizationJob-id}/schema/directories/$count':
get:
tags:
- applications.synchronization
summary: Get the number of the resource
operationId: application.synchronization.job.schema.directory_GetCount
parameters:
- name: application-id
in: path
description: The unique identifier of application
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: application
- name: synchronizationJob-id
in: path
description: The unique identifier of synchronizationJob
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: synchronizationJob
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/applications/{application-id}/synchronization/jobs/{synchronizationJob-id}/schema/microsoft.graph.filterOperators()':
get:
tags:
- applications.synchronization
summary: Invoke function filterOperators
description: List all operators supported in the scoping filters for a synchronizationSchema.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/synchronization-synchronizationschema-filteroperators?view=graph-rest-1.0
operationId: application.synchronization.job.schema_filterOperator
parameters:
- name: application-id
in: path
description: The unique identifier of application
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: application
- name: synchronizationJob-id
in: path
description: The unique identifier of synchronizationJob
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: synchronizationJob
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $orderby
in: query
description: Order items by property values
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: Success
content:
application/json:
schema:
title: Collection of filterOperatorSchema
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.filterOperatorSchema'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
'/applications/{application-id}/synchronization/jobs/{synchronizationJob-id}/schema/microsoft.graph.functions()':
get:
tags:
- applications.synchronization
summary: Invoke function functions
description: List all the functions currently supported in the attributeMappingSource for a synchronizationSchema.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/synchronization-synchronizationschema-functions?view=graph-rest-1.0
operationId: application.synchronization.job.schema_function
parameters:
- name: application-id
in: path
description: The unique identifier of application
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: application
- name: synchronizationJob-id
in: path
description: The unique identifier of synchronizationJob
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: synchronizationJob
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $orderby
in: query
description: Order items by property values
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: Success
content:
application/json:
schema:
title: Collection of attributeMappingFunctionSchema
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.attributeMappingFunctionSchema'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
'/applications/{application-id}/synchronization/jobs/{synchronizationJob-id}/schema/microsoft.graph.parseExpression':
post:
tags:
- applications.synchronization
summary: Invoke action parseExpression
description: 'Parse a given string expression into an attributeMappingSource object for a synchronizationSchema. For more information about expressions, see Writing Expressions for Attribute Mappings in Microsoft Entra ID.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/synchronization-synchronizationschema-parseexpression?view=graph-rest-1.0
operationId: application.synchronization.job.schema_parseExpression
parameters:
- name: application-id
in: path
description: The unique identifier of application
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: application
- name: synchronizationJob-id
in: path
description: The unique identifier of synchronizationJob
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: synchronizationJob
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
expression:
type: string
nullable: true
testInputObject:
$ref: '#/components/schemas/microsoft.graph.expressionInputObject'
targetAttributeDefinition:
$ref: '#/components/schemas/microsoft.graph.attributeDefinition'
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.parseExpressionResponse'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/applications/{application-id}/synchronization/jobs/$count':
get:
tags:
- applications.synchronization
summary: Get the number of the resource
operationId: application.synchronization.job_GetCount
parameters:
- name: application-id
in: path
description: The unique identifier of application
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: application
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/applications/{application-id}/synchronization/jobs/microsoft.graph.validateCredentials':
post:
tags:
- applications.synchronization
summary: Invoke action validateCredentials
operationId: application.synchronization.job_validateCredential
parameters:
- name: application-id
in: path
description: The unique identifier of application
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: application
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
applicationIdentifier:
type: string
nullable: true
templateId:
type: string
nullable: true
useSavedCredentials:
type: boolean
default: false
nullable: true
credentials:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.synchronizationSecretKeyStringValuePair'
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/applications/{application-id}/synchronization/microsoft.graph.acquireAccessToken':
post:
tags:
- applications.synchronization
summary: Invoke action acquireAccessToken
description: Acquire an OAuth access token from the synchronization resource to authorize the Microsoft Entra provisioning service to provision users into an application.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/synchronization-synchronization-acquireaccesstoken?view=graph-rest-1.0
operationId: application.synchronization_acquireAccessToken
parameters:
- name: application-id
in: path
description: The unique identifier of application
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: application
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
credentials:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.synchronizationSecretKeyStringValuePair'
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/applications/{application-id}/synchronization/secrets':
put:
tags:
- applications.synchronization
summary: Update property secrets value.
operationId: application.synchronization_SetSecret
parameters:
- name: application-id
in: path
description: The unique identifier of application
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: application
requestBody:
description: New property values
content:
application/json:
schema:
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.synchronizationSecretKeyStringValuePair'
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.synchronizationSecretKeyStringValuePair'
additionalProperties:
type: object
default:
$ref: '#/components/responses/error'
'/applications/{application-id}/synchronization/secrets/$count':
get:
tags:
- applications.synchronization
summary: Get the number of the resource
operationId: application.synchronization.Secret_GetCount
parameters:
- name: application-id
in: path
description: The unique identifier of application
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: application
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/applications/{application-id}/synchronization/templates':
get:
tags:
- applications.synchronization
summary: Get templates from applications
description: Preconfigured synchronization settings for a particular application.
operationId: application.synchronization_ListTemplate
parameters:
- name: application-id
in: path
description: The unique identifier of application
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: application
- $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.synchronizationTemplateCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- applications.synchronization
summary: Create new navigation property to templates for applications
operationId: application.synchronization_CreateTemplate
parameters:
- name: application-id
in: path
description: The unique identifier of application
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: application
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.synchronizationTemplate'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.synchronizationTemplate'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/applications/{application-id}/synchronization/templates/{synchronizationTemplate-id}':
get:
tags:
- applications.synchronization
summary: Get templates from applications
description: Preconfigured synchronization settings for a particular application.
operationId: application.synchronization_GetTemplate
parameters:
- name: application-id
in: path
description: The unique identifier of application
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: application
- name: synchronizationTemplate-id
in: path
description: The unique identifier of synchronizationTemplate
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: synchronizationTemplate
- 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.synchronizationTemplate'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- applications.synchronization
summary: Update synchronizationTemplate
description: Update (override) the synchronizationTemplate associated with a given application.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/synchronization-synchronizationtemplate-update?view=graph-rest-1.0
operationId: application.synchronization_UpdateTemplate
parameters:
- name: application-id
in: path
description: The unique identifier of application
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: application
- name: synchronizationTemplate-id
in: path
description: The unique identifier of synchronizationTemplate
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: synchronizationTemplate
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.synchronizationTemplate'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.synchronizationTemplate'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- applications.synchronization
summary: Delete navigation property templates for applications
operationId: application.synchronization_DeleteTemplate
parameters:
- name: application-id
in: path
description: The unique identifier of application
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: application
- name: synchronizationTemplate-id
in: path
description: The unique identifier of synchronizationTemplate
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: synchronizationTemplate
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/applications/{application-id}/synchronization/templates/{synchronizationTemplate-id}/schema':
get:
tags:
- applications.synchronization
summary: Get schema from applications
description: Default synchronization schema for the jobs based on this template.
operationId: application.synchronization.template_GetSchema
parameters:
- name: application-id
in: path
description: The unique identifier of application
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: application
- name: synchronizationTemplate-id
in: path
description: The unique identifier of synchronizationTemplate
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: synchronizationTemplate
- 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.synchronizationSchema'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- applications.synchronization
summary: Update the navigation property schema in applications
operationId: application.synchronization.template_UpdateSchema
parameters:
- name: application-id
in: path
description: The unique identifier of application
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: application
- name: synchronizationTemplate-id
in: path
description: The unique identifier of synchronizationTemplate
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: synchronizationTemplate
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.synchronizationSchema'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.synchronizationSchema'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- applications.synchronization
summary: Delete navigation property schema for applications
operationId: application.synchronization.template_DeleteSchema
parameters:
- name: application-id
in: path
description: The unique identifier of application
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: application
- name: synchronizationTemplate-id
in: path
description: The unique identifier of synchronizationTemplate
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: synchronizationTemplate
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/applications/{application-id}/synchronization/templates/{synchronizationTemplate-id}/schema/directories':
get:
tags:
- applications.synchronization
summary: Get directories from applications
description: Contains the collection of directories and all of their objects.
operationId: application.synchronization.template.schema_ListDirectory
parameters:
- name: application-id
in: path
description: The unique identifier of application
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: application
- name: synchronizationTemplate-id
in: path
description: The unique identifier of synchronizationTemplate
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: synchronizationTemplate
- $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.directoryDefinitionCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- applications.synchronization
summary: Create new navigation property to directories for applications
operationId: application.synchronization.template.schema_CreateDirectory
parameters:
- name: application-id
in: path
description: The unique identifier of application
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: application
- name: synchronizationTemplate-id
in: path
description: The unique identifier of synchronizationTemplate
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: synchronizationTemplate
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.directoryDefinition'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.directoryDefinition'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/applications/{application-id}/synchronization/templates/{synchronizationTemplate-id}/schema/directories/{directoryDefinition-id}':
get:
tags:
- applications.synchronization
summary: Get directories from applications
description: Contains the collection of directories and all of their objects.
operationId: application.synchronization.template.schema_GetDirectory
parameters:
- name: application-id
in: path
description: The unique identifier of application
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: application
- name: synchronizationTemplate-id
in: path
description: The unique identifier of synchronizationTemplate
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: synchronizationTemplate
- name: directoryDefinition-id
in: path
description: The unique identifier of directoryDefinition
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: directoryDefinition
- 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.directoryDefinition'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- applications.synchronization
summary: Update the navigation property directories in applications
operationId: application.synchronization.template.schema_UpdateDirectory
parameters:
- name: application-id
in: path
description: The unique identifier of application
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: application
- name: synchronizationTemplate-id
in: path
description: The unique identifier of synchronizationTemplate
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: synchronizationTemplate
- name: directoryDefinition-id
in: path
description: The unique identifier of directoryDefinition
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: directoryDefinition
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.directoryDefinition'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.directoryDefinition'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- applications.synchronization
summary: Delete navigation property directories for applications
operationId: application.synchronization.template.schema_DeleteDirectory
parameters:
- name: application-id
in: path
description: The unique identifier of application
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: application
- name: synchronizationTemplate-id
in: path
description: The unique identifier of synchronizationTemplate
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: synchronizationTemplate
- name: directoryDefinition-id
in: path
description: The unique identifier of directoryDefinition
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: directoryDefinition
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/applications/{application-id}/synchronization/templates/{synchronizationTemplate-id}/schema/directories/{directoryDefinition-id}/microsoft.graph.discover':
post:
tags:
- applications.synchronization
summary: Invoke action discover
description: Discover the latest schema definition for provisioning to an application for the directoryDefinition.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/synchronization-directorydefinition-discover?view=graph-rest-1.0
operationId: application.synchronization.template.schema.directory_discover
parameters:
- name: application-id
in: path
description: The unique identifier of application
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: application
- name: synchronizationTemplate-id
in: path
description: The unique identifier of synchronizationTemplate
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: synchronizationTemplate
- name: directoryDefinition-id
in: path
description: The unique identifier of directoryDefinition
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: directoryDefinition
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.directoryDefinition'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/applications/{application-id}/synchronization/templates/{synchronizationTemplate-id}/schema/directories/$count':
get:
tags:
- applications.synchronization
summary: Get the number of the resource
operationId: application.synchronization.template.schema.directory_GetCount
parameters:
- name: application-id
in: path
description: The unique identifier of application
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: application
- name: synchronizationTemplate-id
in: path
description: The unique identifier of synchronizationTemplate
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: synchronizationTemplate
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/applications/{application-id}/synchronization/templates/{synchronizationTemplate-id}/schema/microsoft.graph.filterOperators()':
get:
tags:
- applications.synchronization
summary: Invoke function filterOperators
description: List all operators supported in the scoping filters for a synchronizationSchema.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/synchronization-synchronizationschema-filteroperators?view=graph-rest-1.0
operationId: application.synchronization.template.schema_filterOperator
parameters:
- name: application-id
in: path
description: The unique identifier of application
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: application
- name: synchronizationTemplate-id
in: path
description: The unique identifier of synchronizationTemplate
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: synchronizationTemplate
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $orderby
in: query
description: Order items by property values
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: Success
content:
application/json:
schema:
title: Collection of filterOperatorSchema
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.filterOperatorSchema'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
'/applications/{application-id}/synchronization/templates/{synchronizationTemplate-id}/schema/microsoft.graph.functions()':
get:
tags:
- applications.synchronization
summary: Invoke function functions
description: List all the functions currently supported in the attributeMappingSource for a synchronizationSchema.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/synchronization-synchronizationschema-functions?view=graph-rest-1.0
operationId: application.synchronization.template.schema_function
parameters:
- name: application-id
in: path
description: The unique identifier of application
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: application
- name: synchronizationTemplate-id
in: path
description: The unique identifier of synchronizationTemplate
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: synchronizationTemplate
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $orderby
in: query
description: Order items by property values
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: Success
content:
application/json:
schema:
title: Collection of attributeMappingFunctionSchema
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.attributeMappingFunctionSchema'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
'/applications/{application-id}/synchronization/templates/{synchronizationTemplate-id}/schema/microsoft.graph.parseExpression':
post:
tags:
- applications.synchronization
summary: Invoke action parseExpression
description: 'Parse a given string expression into an attributeMappingSource object for a synchronizationSchema. For more information about expressions, see Writing Expressions for Attribute Mappings in Microsoft Entra ID.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/synchronization-synchronizationschema-parseexpression?view=graph-rest-1.0
operationId: application.synchronization.template.schema_parseExpression
parameters:
- name: application-id
in: path
description: The unique identifier of application
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: application
- name: synchronizationTemplate-id
in: path
description: The unique identifier of synchronizationTemplate
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: synchronizationTemplate
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
expression:
type: string
nullable: true
testInputObject:
$ref: '#/components/schemas/microsoft.graph.expressionInputObject'
targetAttributeDefinition:
$ref: '#/components/schemas/microsoft.graph.attributeDefinition'
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.parseExpressionResponse'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/applications/{application-id}/synchronization/templates/$count':
get:
tags:
- applications.synchronization
summary: Get the number of the resource
operationId: application.synchronization.template_GetCount
parameters:
- name: application-id
in: path
description: The unique identifier of application
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: application
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/applications/{application-id}/tokenIssuancePolicies':
get:
tags:
- applications.tokenIssuancePolicy
summary: List assigned tokenIssuancePolicies
description: List the tokenIssuancePolicy objects that are assigned to an application.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/application-list-tokenissuancepolicies?view=graph-rest-1.0
operationId: application_ListTokenIssuancePolicy
parameters:
- name: application-id
in: path
description: The unique identifier of application
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: application
- $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.tokenIssuancePolicyCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
'/applications/{application-id}/tokenIssuancePolicies/{tokenIssuancePolicy-id}/$ref':
delete:
tags:
- applications.tokenIssuancePolicy
summary: Remove tokenIssuancePolicy
description: Remove a tokenIssuancePolicy from an application.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/application-delete-tokenissuancepolicies?view=graph-rest-1.0
operationId: application.tokenIssuancePolicy_DeleteTokenIssuancePolicyGraphBPreRef
parameters:
- name: application-id
in: path
description: The unique identifier of application
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: application
- name: tokenIssuancePolicy-id
in: path
description: The unique identifier of tokenIssuancePolicy
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: tokenIssuancePolicy
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/applications/{application-id}/tokenIssuancePolicies/$count':
get:
tags:
- applications.tokenIssuancePolicy
summary: Get the number of the resource
operationId: application.tokenIssuancePolicy_GetCount
parameters:
- name: application-id
in: path
description: The unique identifier of application
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: application
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/applications/{application-id}/tokenIssuancePolicies/$ref':
get:
tags:
- applications.tokenIssuancePolicy
summary: List assigned tokenIssuancePolicies
description: List the tokenIssuancePolicy objects that are assigned to an application.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/application-list-tokenissuancepolicies?view=graph-rest-1.0
operationId: application_ListTokenIssuancePolicyGraphBPreRef
parameters:
- name: application-id
in: path
description: The unique identifier of application
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: application
- $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
responses:
2XX:
$ref: '#/components/responses/StringCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- applications.tokenIssuancePolicy
summary: Assign tokenIssuancePolicy
description: Assign a tokenIssuancePolicy to an application.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/application-post-tokenissuancepolicies?view=graph-rest-1.0
operationId: application_CreateTokenIssuancePolicyGraphBPreRef
parameters:
- name: application-id
in: path
description: The unique identifier of application
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: application
requestBody:
$ref: '#/components/requestBodies/refPostBody'
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- applications.tokenIssuancePolicy
summary: Remove tokenIssuancePolicy
description: Remove a tokenIssuancePolicy from an application.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/application-delete-tokenissuancepolicies?view=graph-rest-1.0
operationId: application_DeleteTokenIssuancePolicyGraphBPreRef
parameters:
- name: application-id
in: path
description: The unique identifier of application
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: application
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
- name: '@id'
in: query
description: The delete Uri
required: true
style: form
explode: false
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/applications/{application-id}/tokenLifetimePolicies':
get:
tags:
- applications.tokenLifetimePolicy
summary: List assigned tokenLifetimePolicies
description: List the tokenLifetimePolicy objects that are assigned to an application. Only one object is returned in the collection because only one tokenLifetimePolicy can be assigned to an application.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/application-list-tokenlifetimepolicies?view=graph-rest-1.0
operationId: application_ListTokenLifetimePolicy
parameters:
- name: application-id
in: path
description: The unique identifier of application
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: application
- $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.tokenLifetimePolicyCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
'/applications/{application-id}/tokenLifetimePolicies/{tokenLifetimePolicy-id}/$ref':
delete:
tags:
- applications.tokenLifetimePolicy
summary: Remove tokenLifetimePolicy
description: Remove a tokenLifetimePolicy from an application.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/application-delete-tokenlifetimepolicies?view=graph-rest-1.0
operationId: application.tokenLifetimePolicy_DeleteTokenLifetimePolicyGraphBPreRef
parameters:
- name: application-id
in: path
description: The unique identifier of application
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: application
- name: tokenLifetimePolicy-id
in: path
description: The unique identifier of tokenLifetimePolicy
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: tokenLifetimePolicy
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/applications/{application-id}/tokenLifetimePolicies/$count':
get:
tags:
- applications.tokenLifetimePolicy
summary: Get the number of the resource
operationId: application.tokenLifetimePolicy_GetCount
parameters:
- name: application-id
in: path
description: The unique identifier of application
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: application
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/applications/{application-id}/tokenLifetimePolicies/$ref':
get:
tags:
- applications.tokenLifetimePolicy
summary: List assigned tokenLifetimePolicies
description: List the tokenLifetimePolicy objects that are assigned to an application. Only one object is returned in the collection because only one tokenLifetimePolicy can be assigned to an application.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/application-list-tokenlifetimepolicies?view=graph-rest-1.0
operationId: application_ListTokenLifetimePolicyGraphBPreRef
parameters:
- name: application-id
in: path
description: The unique identifier of application
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: application
- $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
responses:
2XX:
$ref: '#/components/responses/StringCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- applications.tokenLifetimePolicy
summary: Assign tokenLifetimePolicy
description: Assign a tokenLifetimePolicy to an application. You can have multiple tokenLifetimePolicy policies in a tenant but can assign only one tokenLifetimePolicy per application.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/application-post-tokenlifetimepolicies?view=graph-rest-1.0
operationId: application_CreateTokenLifetimePolicyGraphBPreRef
parameters:
- name: application-id
in: path
description: The unique identifier of application
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: application
requestBody:
$ref: '#/components/requestBodies/refPostBody'
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- applications.tokenLifetimePolicy
summary: Remove tokenLifetimePolicy
description: Remove a tokenLifetimePolicy from an application.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/application-delete-tokenlifetimepolicies?view=graph-rest-1.0
operationId: application_DeleteTokenLifetimePolicyGraphBPreRef
parameters:
- name: application-id
in: path
description: The unique identifier of application
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: application
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
- name: '@id'
in: query
description: The delete Uri
required: true
style: form
explode: false
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/applications(appId=''{appId}'')':
get:
tags:
- applications.application
summary: Get application
description: Get the properties and relationships of an application object. This API can be used to get agentIdentityBlueprint objects as well by their ID.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/application-get?view=graph-rest-1.0
operationId: application_GetApplicationGraphBPreAppId
parameters:
- name: appId
in: path
description: Alternate key of application
required: true
style: simple
schema:
type: string
nullable: true
- 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.application'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- applications.application
summary: Upsert application
description: 'Create a new application object if it doesn''t exist, or update the properties of an existing application object. This API can also create an agentIdentityBlueprint object if it doesn''t exist, or update properties of an existing agentIdentityBlueprint, when the @odata.type property is set to #microsoft.graph.agentIdentityBlueprint.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/application-upsert?view=graph-rest-1.0
operationId: application_UpdateApplicationGraphBPreAppId
parameters:
- name: appId
in: path
description: Alternate key of application
required: true
style: simple
schema:
type: string
nullable: true
requestBody:
description: New property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.application'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.application'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- applications.application
summary: Delete application
description: 'Delete an application object. When deleted, apps are moved to a temporary container and can be restored within 30 days. After that time, they are permanently deleted. This API can also delete an agentIdentityBlueprint object by its ID.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/application-delete?view=graph-rest-1.0
operationId: application_DeleteApplicationGraphBPreAppId
parameters:
- name: appId
in: path
description: Alternate key of application
required: true
style: simple
schema:
type: string
nullable: true
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/applications(uniqueName=''{uniqueName}'')':
get:
tags:
- applications.application
summary: Get application
description: Get the properties and relationships of an application object. This API can be used to get agentIdentityBlueprint objects as well by their ID.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/application-get?view=graph-rest-1.0
operationId: application_GetApplicationGraphBPreUniqueName
parameters:
- name: uniqueName
in: path
description: Alternate key of application
required: true
style: simple
schema:
type: string
nullable: true
- 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.application'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- applications.application
summary: Upsert application
description: 'Create a new application object if it doesn''t exist, or update the properties of an existing application object. This API can also create an agentIdentityBlueprint object if it doesn''t exist, or update properties of an existing agentIdentityBlueprint, when the @odata.type property is set to #microsoft.graph.agentIdentityBlueprint.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/application-upsert?view=graph-rest-1.0
operationId: application_UpdateApplicationGraphBPreUniqueName
parameters:
- name: uniqueName
in: path
description: Alternate key of application
required: true
style: simple
schema:
type: string
nullable: true
requestBody:
description: New property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.application'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.application'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- applications.application
summary: Delete application
description: 'Delete an application object. When deleted, apps are moved to a temporary container and can be restored within 30 days. After that time, they are permanently deleted. This API can also delete an agentIdentityBlueprint object by its ID.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/application-delete?view=graph-rest-1.0
operationId: application_DeleteApplicationGraphBPreUniqueName
parameters:
- name: uniqueName
in: path
description: Alternate key of application
required: true
style: simple
schema:
type: string
nullable: true
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
/applications/$count:
get:
tags:
- applications.application
summary: Get the number of the resource
operationId: application_GetCount
parameters:
- name: ConsistencyLevel
in: header
description: 'Indicates the requested consistency level. Documentation URL: https://docs.microsoft.com/graph/aad-advanced-queries'
style: simple
schema:
type: string
examples:
example-1:
description: $search and $count queries require the client to set the ConsistencyLevel HTTP header to 'eventual'.
value: eventual
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
/applications/microsoft.graph.delta():
get:
tags:
- applications.application.Functions
summary: Invoke function delta
description: 'Get newly created, updated, or deleted applications without performing a full read of the entire resource collection. For more information, see Use delta query to track changes in Microsoft Graph data for details.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/application-delta?view=graph-rest-1.0
operationId: application_delta
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $orderby
in: query
description: Order items by property values
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: Success
content:
application/json:
schema:
title: Collection of application
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.application'
'@odata.nextLink':
type: string
nullable: true
'@odata.deltaLink':
type: string
nullable: true
additionalProperties:
type: object
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
/applications/microsoft.graph.getAvailableExtensionProperties:
post:
tags:
- applications.application.Actions
summary: Invoke action getAvailableExtensionProperties
description: 'Return all directory extension definitions that are registered in a directory, including through multitenant apps. The following entities support extension properties:'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/directoryobject-getavailableextensionproperties?view=graph-rest-1.0
operationId: application_getAvailableExtensionProperty
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
isSyncedFromOnPremises:
type: boolean
default: false
nullable: true
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
title: Collection of extensionProperty
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.extensionProperty'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
/applications/microsoft.graph.getByIds:
post:
tags:
- applications.application.Actions
summary: Invoke action getByIds
description: 'Return the directory objects specified in a list of IDs. Only a subset of user properties are returned by default in v1.0. Some common uses for this function are to:'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/directoryobject-getbyids?view=graph-rest-1.0
operationId: application_getGraphBPreId
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
ids:
type: array
items:
type: string
types:
type: array
items:
type: string
nullable: true
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
title: Collection of directoryObject
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
/applications/microsoft.graph.validateProperties:
post:
tags:
- applications.application.Actions
summary: Invoke action validateProperties
description: "Validate that a Microsoft 365 group's display name or mail nickname complies with naming policies. Clients can use this API to determine whether a display name or mail nickname is valid before trying to create a Microsoft 365 group. To validate the properties of an existing group, use the group: validateProperties function. The following policy validations are performed for the display name and mail nickname properties:\r\n1. Validate the prefix and suffix naming policy\r\n2. Validate the custom banned words policy\r\n3. Validate that the mail nickname is unique This API only returns the first validation failure that is encountered. If the properties fail multiple validations, only the first validation failure is returned. However, you can validate both the mail nickname and the display name and receive a collection of validation errors if you're only validating the prefix and suffix naming policy. To learn more about configuring naming policies, see Configure naming policy."
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/directoryobject-validateproperties?view=graph-rest-1.0
operationId: application_validateProperty
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
entityType:
type: string
nullable: true
displayName:
type: string
nullable: true
mailNickname:
type: string
nullable: true
onBehalfOfUserId:
pattern: '^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$'
type: string
format: uuid
nullable: true
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
/applicationTemplates:
get:
tags:
- applicationTemplates.applicationTemplate
summary: List applicationTemplates
description: 'Retrieve a list of applicationTemplate objects from the Microsoft Entra application gallery. Details about optional risk properties such as riskScore and riskFactors are available with either the Microsoft Entra Suite or Microsoft Entra Internet Access license. If a risk property is included in the request without appropriate license, a @microsoft.graph.licenseRequired OData annotation is returned in the response.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/applicationtemplate-list?view=graph-rest-1.0
operationId: applicationTemplate_ListApplicationTemplate
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.applicationTemplateCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
'/applicationTemplates/{applicationTemplate-id}':
get:
tags:
- applicationTemplates.applicationTemplate
summary: Get applicationTemplate
description: Retrieve the properties of an applicationTemplate object. Details about optional risk properties such as riskScore and riskFactors are available with either the Microsoft Entra Suite or Microsoft Entra Internet Access license.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/applicationtemplate-get?view=graph-rest-1.0
operationId: applicationTemplate_GetApplicationTemplate
parameters:
- name: applicationTemplate-id
in: path
description: The unique identifier of applicationTemplate
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: applicationTemplate
- 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.applicationTemplate'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/applicationTemplates/{applicationTemplate-id}/microsoft.graph.instantiate':
post:
tags:
- applicationTemplates.applicationTemplate.Actions
summary: Invoke action instantiate
description: 'Add an instance of an application from the Microsoft Entra application gallery into your directory. For non-gallery apps, use an application template with one of the following IDs to configure different single sign-on (SSO) modes like SAML SSO and password-based SSO.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/applicationtemplate-instantiate?view=graph-rest-1.0
operationId: applicationTemplate_instantiate
parameters:
- name: applicationTemplate-id
in: path
description: The unique identifier of applicationTemplate
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: applicationTemplate
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
displayName:
type: string
nullable: true
serviceManagementReference:
type: string
nullable: true
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.applicationServicePrincipal'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
/applicationTemplates/$count:
get:
tags:
- applicationTemplates.applicationTemplate
summary: Get the number of the resource
operationId: applicationTemplate_GetCount
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/groups/{group-id}/appRoleAssignments':
get:
tags:
- groups.appRoleAssignment
summary: List appRoleAssignments granted to a group
description: Retrieve the list of appRoleAssignment that have been granted to a group.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/group-list-approleassignments?view=graph-rest-1.0
operationId: group_ListAppRoleAssignment
parameters:
- name: group-id
in: path
description: The unique identifier of group
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: group
- name: ConsistencyLevel
in: header
description: 'Indicates the requested consistency level. Documentation URL: https://docs.microsoft.com/graph/aad-advanced-queries'
style: simple
schema:
type: string
examples:
example-1:
description: $search and $count queries require the client to set the ConsistencyLevel HTTP header to 'eventual'.
value: eventual
- $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.appRoleAssignmentCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- groups.appRoleAssignment
summary: Grant an appRoleAssignment to a group
description: 'Use this API to assign an app role to a security group. All direct members of the group will be considered assigned. Security groups with dynamic memberships are supported. To grant an app role assignment to a group, you need three identifiers: Additional licenses might be required to use a group to manage access to applications.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/group-post-approleassignments?view=graph-rest-1.0
operationId: group_CreateAppRoleAssignment
parameters:
- name: group-id
in: path
description: The unique identifier of group
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: group
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.appRoleAssignment'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.appRoleAssignment'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/groups/{group-id}/appRoleAssignments/{appRoleAssignment-id}':
get:
tags:
- groups.appRoleAssignment
summary: Get appRoleAssignments from groups
description: Represents the app roles granted to a group for an application. Supports $expand.
operationId: group_GetAppRoleAssignment
parameters:
- name: group-id
in: path
description: The unique identifier of group
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: group
- name: appRoleAssignment-id
in: path
description: The unique identifier of appRoleAssignment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: appRoleAssignment
- name: ConsistencyLevel
in: header
description: 'Indicates the requested consistency level. Documentation URL: https://docs.microsoft.com/graph/aad-advanced-queries'
style: simple
schema:
type: string
examples:
example-1:
description: $search and $count queries require the client to set the ConsistencyLevel HTTP header to 'eventual'.
value: eventual
- 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.appRoleAssignment'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- groups.appRoleAssignment
summary: Update the navigation property appRoleAssignments in groups
operationId: group_UpdateAppRoleAssignment
parameters:
- name: group-id
in: path
description: The unique identifier of group
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: group
- name: appRoleAssignment-id
in: path
description: The unique identifier of appRoleAssignment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: appRoleAssignment
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.appRoleAssignment'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.appRoleAssignment'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- groups.appRoleAssignment
summary: Delete appRoleAssignment
description: Deletes an appRoleAssignment that a group has been granted.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/group-delete-approleassignments?view=graph-rest-1.0
operationId: group_DeleteAppRoleAssignment
parameters:
- name: group-id
in: path
description: The unique identifier of group
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: group
- name: appRoleAssignment-id
in: path
description: The unique identifier of appRoleAssignment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: appRoleAssignment
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/groups/{group-id}/appRoleAssignments/$count':
get:
tags:
- groups.appRoleAssignment
summary: Get the number of the resource
operationId: group.appRoleAssignment_GetCount
parameters:
- name: group-id
in: path
description: The unique identifier of group
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: group
- name: ConsistencyLevel
in: header
description: 'Indicates the requested consistency level. Documentation URL: https://docs.microsoft.com/graph/aad-advanced-queries'
style: simple
schema:
type: string
examples:
example-1:
description: $search and $count queries require the client to set the ConsistencyLevel HTTP header to 'eventual'.
value: eventual
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
/servicePrincipals:
get:
tags:
- servicePrincipals.servicePrincipal
summary: List servicePrincipals
description: 'Retrieve a list of servicePrincipal objects. This API also returns agentIdentityBlueprintPrincipal objects, which are identified by the @odata.type property of #microsoft.graph.agentIdentityBlueprintPrincipal.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/serviceprincipal-list?view=graph-rest-1.0
operationId: servicePrincipal_ListServicePrincipal
parameters:
- name: ConsistencyLevel
in: header
description: 'Indicates the requested consistency level. Documentation URL: https://docs.microsoft.com/graph/aad-advanced-queries'
style: simple
schema:
type: string
examples:
example-1:
description: $search and $count queries require the client to set the ConsistencyLevel HTTP header to 'eventual'.
value: eventual
- $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.servicePrincipalCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- servicePrincipals.servicePrincipal
summary: Create servicePrincipal
description: 'Create a new servicePrincipal object. This API can also create an agentIdentityBlueprintPrincipal object from an agentIdentityBlueprint when the @odata.type property is set to #microsoft.graph.agentIdentityBlueprintPrincipal.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/serviceprincipal-post-serviceprincipals?view=graph-rest-1.0
operationId: servicePrincipal_CreateServicePrincipal
requestBody:
description: New entity
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.servicePrincipal'
required: true
responses:
2XX:
description: Created entity
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.servicePrincipal'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/servicePrincipals/{servicePrincipal-id}':
get:
tags:
- servicePrincipals.servicePrincipal
summary: Get servicePrincipal
description: Retrieve the properties and relationships of a servicePrincipal object. This API can be used to get agentIdentityBlueprintPrincipal objects as well by their ID.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/serviceprincipal-get?view=graph-rest-1.0
operationId: servicePrincipal_GetServicePrincipal
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- 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.servicePrincipal'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- servicePrincipals.servicePrincipal
summary: Upsert servicePrincipal
description: 'Create a new servicePrincipal object if it doesn''t exist, or update the properties of an existing servicePrincipal object. This API can also create an agentIdentityBlueprintPrincipal object from an agentIdentityBlueprint if it doesn''t exist, or update properties of an existing agentIdentityBlueprintPrincipal, when the @odata.type property is set to #microsoft.graph.agentIdentityBlueprintPrincipal.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/serviceprincipal-upsert?view=graph-rest-1.0
operationId: servicePrincipal_UpdateServicePrincipal
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
requestBody:
description: New property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.servicePrincipal'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.servicePrincipal'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- servicePrincipals.servicePrincipal
summary: Delete servicePrincipal
description: Delete a servicePrincipal object. This API can also delete an agentIdentityBlueprintPrincipal object by its ID.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/serviceprincipal-delete?view=graph-rest-1.0
operationId: servicePrincipal_DeleteServicePrincipal
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/servicePrincipals/{servicePrincipal-id}/appManagementPolicies':
get:
tags:
- servicePrincipals.appManagementPolicy
summary: Get appManagementPolicies from servicePrincipals
description: The appManagementPolicy applied to this application.
operationId: servicePrincipal_ListAppManagementPolicy
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- $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.appManagementPolicyCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
'/servicePrincipals/{servicePrincipal-id}/appManagementPolicies/{appManagementPolicy-id}':
get:
tags:
- servicePrincipals.appManagementPolicy
summary: Get appManagementPolicies from servicePrincipals
description: The appManagementPolicy applied to this application.
operationId: servicePrincipal_GetAppManagementPolicy
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- name: appManagementPolicy-id
in: path
description: The unique identifier of appManagementPolicy
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: appManagementPolicy
- 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.appManagementPolicy'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/servicePrincipals/{servicePrincipal-id}/appManagementPolicies/$count':
get:
tags:
- servicePrincipals.appManagementPolicy
summary: Get the number of the resource
operationId: servicePrincipal.appManagementPolicy_GetCount
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/servicePrincipals/{servicePrincipal-id}/appRoleAssignedTo':
get:
tags:
- servicePrincipals.appRoleAssignment
summary: Get appRoleAssignment
description: Read the properties and relationships of an appRoleAssignment object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/serviceprincipal-list-approleassignedto?view=graph-rest-1.0
operationId: servicePrincipal_ListAppRoleAssignedTo
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- $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.appRoleAssignmentCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- servicePrincipals.appRoleAssignment
summary: Grant an appRoleAssignment for a service principal
description: 'Assign an app role for a resource service principal, to a user, group, or client service principal. App roles that are assigned to service principals are also known as application permissions. Application permissions can be granted directly with app role assignments, or through a consent experience. To grant an app role assignment, you need three identifiers:'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/serviceprincipal-post-approleassignedto?view=graph-rest-1.0
operationId: servicePrincipal_CreateAppRoleAssignedTo
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.appRoleAssignment'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.appRoleAssignment'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/servicePrincipals/{servicePrincipal-id}/appRoleAssignedTo/{appRoleAssignment-id}':
get:
tags:
- servicePrincipals.appRoleAssignment
summary: Get appRoleAssignment
description: Read the properties and relationships of an appRoleAssignment object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/approleassignment-get?view=graph-rest-1.0
operationId: servicePrincipal_GetAppRoleAssignedTo
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- name: appRoleAssignment-id
in: path
description: The unique identifier of appRoleAssignment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: appRoleAssignment
- 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.appRoleAssignment'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- servicePrincipals.appRoleAssignment
summary: Update the navigation property appRoleAssignedTo in servicePrincipals
operationId: servicePrincipal_UpdateAppRoleAssignedTo
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- name: appRoleAssignment-id
in: path
description: The unique identifier of appRoleAssignment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: appRoleAssignment
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.appRoleAssignment'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.appRoleAssignment'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- servicePrincipals.appRoleAssignment
summary: Delete appRoleAssignedTo
description: 'Deletes an appRoleAssignment that a user, group, or client service principal has been granted for a resource service principal.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/serviceprincipal-delete-approleassignedto?view=graph-rest-1.0
operationId: servicePrincipal_DeleteAppRoleAssignedTo
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- name: appRoleAssignment-id
in: path
description: The unique identifier of appRoleAssignment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: appRoleAssignment
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/servicePrincipals/{servicePrincipal-id}/appRoleAssignedTo/$count':
get:
tags:
- servicePrincipals.appRoleAssignment
summary: Get the number of the resource
operationId: servicePrincipal.appRoleAssignedTo_GetCount
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/servicePrincipals/{servicePrincipal-id}/appRoleAssignments':
get:
tags:
- servicePrincipals.appRoleAssignment
summary: Get appRoleAssignment
description: Read the properties and relationships of an appRoleAssignment object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/serviceprincipal-list-approleassignments?view=graph-rest-1.0
operationId: servicePrincipal_ListAppRoleAssignment
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- name: ConsistencyLevel
in: header
description: 'Indicates the requested consistency level. Documentation URL: https://docs.microsoft.com/graph/aad-advanced-queries'
style: simple
schema:
type: string
examples:
example-1:
description: $search and $count queries require the client to set the ConsistencyLevel HTTP header to 'eventual'.
value: eventual
- $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.appRoleAssignmentCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- servicePrincipals.appRoleAssignment
summary: Grant an appRoleAssignment to a service principal
description: 'Assign an app role to a client service principal. App roles that are assigned to service principals are also known as application permissions. Application permissions can be granted directly with app role assignments, or through a consent experience. To grant an app role assignment to a client service principal, you need three identifiers:'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/serviceprincipal-post-approleassignments?view=graph-rest-1.0
operationId: servicePrincipal_CreateAppRoleAssignment
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.appRoleAssignment'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.appRoleAssignment'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/servicePrincipals/{servicePrincipal-id}/appRoleAssignments/{appRoleAssignment-id}':
get:
tags:
- servicePrincipals.appRoleAssignment
summary: Get appRoleAssignment
description: Read the properties and relationships of an appRoleAssignment object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/approleassignment-get?view=graph-rest-1.0
operationId: servicePrincipal_GetAppRoleAssignment
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- name: appRoleAssignment-id
in: path
description: The unique identifier of appRoleAssignment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: appRoleAssignment
- 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.appRoleAssignment'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- servicePrincipals.appRoleAssignment
summary: Update the navigation property appRoleAssignments in servicePrincipals
operationId: servicePrincipal_UpdateAppRoleAssignment
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- name: appRoleAssignment-id
in: path
description: The unique identifier of appRoleAssignment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: appRoleAssignment
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.appRoleAssignment'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.appRoleAssignment'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- servicePrincipals.appRoleAssignment
summary: Delete appRoleAssignment
description: Deletes an appRoleAssignment that a service principal has been granted. App roles which are assigned to service principals are also known as application permissions. Deleting an app role assignment for a service principal is equivalent to revoking the app-only permission grant.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/serviceprincipal-delete-approleassignments?view=graph-rest-1.0
operationId: servicePrincipal_DeleteAppRoleAssignment
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- name: appRoleAssignment-id
in: path
description: The unique identifier of appRoleAssignment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: appRoleAssignment
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/servicePrincipals/{servicePrincipal-id}/appRoleAssignments/$count':
get:
tags:
- servicePrincipals.appRoleAssignment
summary: Get the number of the resource
operationId: servicePrincipal.appRoleAssignment_GetCount
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- name: ConsistencyLevel
in: header
description: 'Indicates the requested consistency level. Documentation URL: https://docs.microsoft.com/graph/aad-advanced-queries'
style: simple
schema:
type: string
examples:
example-1:
description: $search and $count queries require the client to set the ConsistencyLevel HTTP header to 'eventual'.
value: eventual
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/servicePrincipals/{servicePrincipal-id}/claimsMappingPolicies':
get:
tags:
- servicePrincipals.claimsMappingPolicy
summary: List assigned claimsMappingPolicy
description: List the claimsMappingPolicy objects that are assigned to a servicePrincipal.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/serviceprincipal-list-claimsmappingpolicies?view=graph-rest-1.0
operationId: servicePrincipal_ListClaimsMappingPolicy
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- $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.claimsMappingPolicyCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
'/servicePrincipals/{servicePrincipal-id}/claimsMappingPolicies/{claimsMappingPolicy-id}/$ref':
delete:
tags:
- servicePrincipals.claimsMappingPolicy
summary: Remove claimsMappingPolicy
description: Remove a claimsMappingPolicy from a servicePrincipal.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/serviceprincipal-delete-claimsmappingpolicies?view=graph-rest-1.0
operationId: servicePrincipal.claimsMappingPolicy_DeleteClaimsMappingPolicyGraphBPreRef
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- name: claimsMappingPolicy-id
in: path
description: The unique identifier of claimsMappingPolicy
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: claimsMappingPolicy
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/servicePrincipals/{servicePrincipal-id}/claimsMappingPolicies/$count':
get:
tags:
- servicePrincipals.claimsMappingPolicy
summary: Get the number of the resource
operationId: servicePrincipal.claimsMappingPolicy_GetCount
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/servicePrincipals/{servicePrincipal-id}/claimsMappingPolicies/$ref':
get:
tags:
- servicePrincipals.claimsMappingPolicy
summary: List assigned claimsMappingPolicy
description: List the claimsMappingPolicy objects that are assigned to a servicePrincipal.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/serviceprincipal-list-claimsmappingpolicies?view=graph-rest-1.0
operationId: servicePrincipal_ListClaimsMappingPolicyGraphBPreRef
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- $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
responses:
2XX:
$ref: '#/components/responses/StringCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- servicePrincipals.claimsMappingPolicy
summary: Assign claimsMappingPolicy
description: Assign a claimsMappingPolicy to a servicePrincipal.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/serviceprincipal-post-claimsmappingpolicies?view=graph-rest-1.0
operationId: servicePrincipal_CreateClaimsMappingPolicyGraphBPreRef
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
requestBody:
$ref: '#/components/requestBodies/refPostBody'
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- servicePrincipals.claimsMappingPolicy
summary: Remove claimsMappingPolicy
description: Remove a claimsMappingPolicy from a servicePrincipal.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/serviceprincipal-delete-claimsmappingpolicies?view=graph-rest-1.0
operationId: servicePrincipal_DeleteClaimsMappingPolicyGraphBPreRef
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
- name: '@id'
in: query
description: The delete Uri
required: true
style: form
explode: false
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/servicePrincipals/{servicePrincipal-id}/createdObjects':
get:
tags:
- servicePrincipals.directoryObject
summary: 'servicePrincipal: List createdObjects'
description: Retrieve a list of directoryobject objects.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/serviceprincipal-list-createdobjects?view=graph-rest-1.0
operationId: servicePrincipal_ListCreatedObject
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- $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.directoryObjectCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
'/servicePrincipals/{servicePrincipal-id}/createdObjects/{directoryObject-id}':
get:
tags:
- servicePrincipals.directoryObject
summary: Get createdObjects from servicePrincipals
description: Directory objects created by this service principal. Read-only. Nullable.
operationId: servicePrincipal_GetCreatedObject
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- name: directoryObject-id
in: path
description: The unique identifier of directoryObject
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: directoryObject
- 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.directoryObject'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/servicePrincipals/{servicePrincipal-id}/createdObjects/{directoryObject-id}/microsoft.graph.servicePrincipal':
get:
tags:
- servicePrincipals.directoryObject
summary: Get the item of type microsoft.graph.directoryObject as microsoft.graph.servicePrincipal
operationId: servicePrincipal_GetCreatedObjectAsServicePrincipal
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- name: directoryObject-id
in: path
description: The unique identifier of directoryObject
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: directoryObject
- 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: Entity result.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.servicePrincipal'
default:
$ref: '#/components/responses/error'
'/servicePrincipals/{servicePrincipal-id}/createdObjects/$count':
get:
tags:
- servicePrincipals.directoryObject
summary: Get the number of the resource
operationId: servicePrincipal.createdObject_GetCount
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/servicePrincipals/{servicePrincipal-id}/createdObjects/microsoft.graph.servicePrincipal':
get:
tags:
- servicePrincipals.directoryObject
summary: Get the items of type microsoft.graph.servicePrincipal in the microsoft.graph.directoryObject collection
operationId: servicePrincipal_ListCreatedObjectAsServicePrincipal
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- $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.servicePrincipalCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
'/servicePrincipals/{servicePrincipal-id}/createdObjects/microsoft.graph.servicePrincipal/$count':
get:
tags:
- servicePrincipals.directoryObject
summary: Get the number of the resource
operationId: servicePrincipal.CreatedObject_GetCountAsServicePrincipal
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/servicePrincipals/{servicePrincipal-id}/delegatedPermissionClassifications':
get:
tags:
- servicePrincipals.delegatedPermissionClassification
summary: List delegatedPermissionClassifications collection of servicePrincipal
description: Retrieve the list of delegatedPermissionClassification currently configured for the delegated permissions exposed by an API.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/serviceprincipal-list-delegatedpermissionclassifications?view=graph-rest-1.0
operationId: servicePrincipal_ListDelegatedPermissionClassification
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- $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.delegatedPermissionClassificationCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- servicePrincipals.delegatedPermissionClassification
summary: Create delegatedPermissionClassification
description: Classify a delegated permission by adding a delegatedPermissionClassification to the servicePrincipal representing the API.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/serviceprincipal-post-delegatedpermissionclassifications?view=graph-rest-1.0
operationId: servicePrincipal_CreateDelegatedPermissionClassification
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.delegatedPermissionClassification'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.delegatedPermissionClassification'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/servicePrincipals/{servicePrincipal-id}/delegatedPermissionClassifications/{delegatedPermissionClassification-id}':
get:
tags:
- servicePrincipals.delegatedPermissionClassification
summary: Get delegatedPermissionClassifications from servicePrincipals
operationId: servicePrincipal_GetDelegatedPermissionClassification
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- name: delegatedPermissionClassification-id
in: path
description: The unique identifier of delegatedPermissionClassification
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: delegatedPermissionClassification
- 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.delegatedPermissionClassification'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- servicePrincipals.delegatedPermissionClassification
summary: Update the navigation property delegatedPermissionClassifications in servicePrincipals
operationId: servicePrincipal_UpdateDelegatedPermissionClassification
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- name: delegatedPermissionClassification-id
in: path
description: The unique identifier of delegatedPermissionClassification
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: delegatedPermissionClassification
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.delegatedPermissionClassification'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.delegatedPermissionClassification'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- servicePrincipals.delegatedPermissionClassification
summary: Delete delegatedPermissionClassification
description: Deletes a delegatedPermissionClassification which had previously been set for a delegated permission.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/serviceprincipal-delete-delegatedpermissionclassifications?view=graph-rest-1.0
operationId: servicePrincipal_DeleteDelegatedPermissionClassification
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- name: delegatedPermissionClassification-id
in: path
description: The unique identifier of delegatedPermissionClassification
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: delegatedPermissionClassification
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/servicePrincipals/{servicePrincipal-id}/delegatedPermissionClassifications/$count':
get:
tags:
- servicePrincipals.delegatedPermissionClassification
summary: Get the number of the resource
operationId: servicePrincipal.delegatedPermissionClassification_GetCount
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/servicePrincipals/{servicePrincipal-id}/endpoints':
get:
tags:
- servicePrincipals.endpoint
summary: Get endpoints from servicePrincipals
operationId: servicePrincipal_ListEndpoint
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- $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.endpointCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- servicePrincipals.endpoint
summary: Create new navigation property to endpoints for servicePrincipals
operationId: servicePrincipal_CreateEndpoint
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.endpoint'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.endpoint'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/servicePrincipals/{servicePrincipal-id}/endpoints/{endpoint-id}':
get:
tags:
- servicePrincipals.endpoint
summary: Get endpoints from servicePrincipals
operationId: servicePrincipal_GetEndpoint
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- name: endpoint-id
in: path
description: The unique identifier of endpoint
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: endpoint
- 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.endpoint'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- servicePrincipals.endpoint
summary: Update the navigation property endpoints in servicePrincipals
operationId: servicePrincipal_UpdateEndpoint
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- name: endpoint-id
in: path
description: The unique identifier of endpoint
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: endpoint
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.endpoint'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.endpoint'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- servicePrincipals.endpoint
summary: Delete navigation property endpoints for servicePrincipals
operationId: servicePrincipal_DeleteEndpoint
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- name: endpoint-id
in: path
description: The unique identifier of endpoint
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: endpoint
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/servicePrincipals/{servicePrincipal-id}/endpoints/$count':
get:
tags:
- servicePrincipals.endpoint
summary: Get the number of the resource
operationId: servicePrincipal.endpoint_GetCount
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/servicePrincipals/{servicePrincipal-id}/federatedIdentityCredentials':
get:
tags:
- servicePrincipals.federatedIdentityCredential
summary: Get federatedIdentityCredentials from servicePrincipals
description: 'Federated identities for a specific type of service principal - managed identity. Supports $expand and $filter (/$count eq 0, /$count ne 0).'
operationId: servicePrincipal_ListFederatedIdentityCredential
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- $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.federatedIdentityCredentialCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- servicePrincipals.federatedIdentityCredential
summary: Create new navigation property to federatedIdentityCredentials for servicePrincipals
operationId: servicePrincipal_CreateFederatedIdentityCredential
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.federatedIdentityCredential'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.federatedIdentityCredential'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/servicePrincipals/{servicePrincipal-id}/federatedIdentityCredentials/{federatedIdentityCredential-id}':
get:
tags:
- servicePrincipals.federatedIdentityCredential
summary: Get federatedIdentityCredentials from servicePrincipals
description: 'Federated identities for a specific type of service principal - managed identity. Supports $expand and $filter (/$count eq 0, /$count ne 0).'
operationId: servicePrincipal_GetFederatedIdentityCredential
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- name: federatedIdentityCredential-id
in: path
description: The unique identifier of federatedIdentityCredential
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: federatedIdentityCredential
- 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.federatedIdentityCredential'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- servicePrincipals.federatedIdentityCredential
summary: Update the navigation property federatedIdentityCredentials in servicePrincipals
operationId: servicePrincipal_UpdateFederatedIdentityCredential
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- name: federatedIdentityCredential-id
in: path
description: The unique identifier of federatedIdentityCredential
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: federatedIdentityCredential
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.federatedIdentityCredential'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.federatedIdentityCredential'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- servicePrincipals.federatedIdentityCredential
summary: Delete navigation property federatedIdentityCredentials for servicePrincipals
operationId: servicePrincipal_DeleteFederatedIdentityCredential
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- name: federatedIdentityCredential-id
in: path
description: The unique identifier of federatedIdentityCredential
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: federatedIdentityCredential
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/servicePrincipals/{servicePrincipal-id}/federatedIdentityCredentials(name=''{name}'')':
get:
tags:
- servicePrincipals.federatedIdentityCredential
summary: Get federatedIdentityCredentials from servicePrincipals
description: 'Federated identities for a specific type of service principal - managed identity. Supports $expand and $filter (/$count eq 0, /$count ne 0).'
operationId: servicePrincipal.federatedIdentityCredential_GetGraphBPreName
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- name: name
in: path
description: Alternate key of federatedIdentityCredential
required: true
style: simple
schema:
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:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.federatedIdentityCredential'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- servicePrincipals.federatedIdentityCredential
summary: Update the navigation property federatedIdentityCredentials in servicePrincipals
operationId: servicePrincipal.federatedIdentityCredential_UpdateGraphBPreName
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- name: name
in: path
description: Alternate key of federatedIdentityCredential
required: true
style: simple
schema:
type: string
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.federatedIdentityCredential'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.federatedIdentityCredential'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- servicePrincipals.federatedIdentityCredential
summary: Delete navigation property federatedIdentityCredentials for servicePrincipals
operationId: servicePrincipal.federatedIdentityCredential_DeleteGraphBPreName
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- name: name
in: path
description: Alternate key of federatedIdentityCredential
required: true
style: simple
schema:
type: string
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/servicePrincipals/{servicePrincipal-id}/federatedIdentityCredentials/$count':
get:
tags:
- servicePrincipals.federatedIdentityCredential
summary: Get the number of the resource
operationId: servicePrincipal.federatedIdentityCredential_GetCount
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/servicePrincipals/{servicePrincipal-id}/homeRealmDiscoveryPolicies':
get:
tags:
- servicePrincipals.homeRealmDiscoveryPolicy
summary: List assigned homeRealmDiscoveryPolicy
description: List the homeRealmDiscoveryPolicy objects that are assigned to a servicePrincipal.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/serviceprincipal-list-homerealmdiscoverypolicies?view=graph-rest-1.0
operationId: servicePrincipal_ListHomeRealmDiscoveryPolicy
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- $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.homeRealmDiscoveryPolicyCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
'/servicePrincipals/{servicePrincipal-id}/homeRealmDiscoveryPolicies/{homeRealmDiscoveryPolicy-id}/$ref':
delete:
tags:
- servicePrincipals.homeRealmDiscoveryPolicy
summary: Remove homeRealmDiscoveryPolicy
description: Remove a homeRealmDiscoveryPolicy from a servicePrincipal.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/serviceprincipal-delete-homerealmdiscoverypolicies?view=graph-rest-1.0
operationId: servicePrincipal.homeRealmDiscoveryPolicy_DeleteHomeRealmDiscoveryPolicyGraphBPreRef
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- name: homeRealmDiscoveryPolicy-id
in: path
description: The unique identifier of homeRealmDiscoveryPolicy
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: homeRealmDiscoveryPolicy
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/servicePrincipals/{servicePrincipal-id}/homeRealmDiscoveryPolicies/$count':
get:
tags:
- servicePrincipals.homeRealmDiscoveryPolicy
summary: Get the number of the resource
operationId: servicePrincipal.homeRealmDiscoveryPolicy_GetCount
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/servicePrincipals/{servicePrincipal-id}/homeRealmDiscoveryPolicies/$ref':
get:
tags:
- servicePrincipals.homeRealmDiscoveryPolicy
summary: List assigned homeRealmDiscoveryPolicy
description: List the homeRealmDiscoveryPolicy objects that are assigned to a servicePrincipal.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/serviceprincipal-list-homerealmdiscoverypolicies?view=graph-rest-1.0
operationId: servicePrincipal_ListHomeRealmDiscoveryPolicyGraphBPreRef
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- $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
responses:
2XX:
$ref: '#/components/responses/StringCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- servicePrincipals.homeRealmDiscoveryPolicy
summary: Assign homeRealmDiscoveryPolicy
description: Assign a homeRealmDiscoveryPolicy to a servicePrincipal.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/serviceprincipal-post-homerealmdiscoverypolicies?view=graph-rest-1.0
operationId: servicePrincipal_CreateHomeRealmDiscoveryPolicyGraphBPreRef
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
requestBody:
$ref: '#/components/requestBodies/refPostBody'
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- servicePrincipals.homeRealmDiscoveryPolicy
summary: Remove homeRealmDiscoveryPolicy
description: Remove a homeRealmDiscoveryPolicy from a servicePrincipal.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/serviceprincipal-delete-homerealmdiscoverypolicies?view=graph-rest-1.0
operationId: servicePrincipal_DeleteHomeRealmDiscoveryPolicyGraphBPreRef
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
- name: '@id'
in: query
description: The delete Uri
required: true
style: form
explode: false
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/servicePrincipals/{servicePrincipal-id}/memberOf':
get:
tags:
- servicePrincipals.directoryObject
summary: List servicePrincipal memberOf
description: Get the groups and directory roles that this servicePrincipal is a direct member of. This operation is not transitive.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/serviceprincipal-list-memberof?view=graph-rest-1.0
operationId: servicePrincipal_ListMemberGraphOPre
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- name: ConsistencyLevel
in: header
description: 'Indicates the requested consistency level. Documentation URL: https://docs.microsoft.com/graph/aad-advanced-queries'
style: simple
schema:
type: string
examples:
example-1:
description: $search and $count queries require the client to set the ConsistencyLevel HTTP header to 'eventual'.
value: eventual
- $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.directoryObjectCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
'/servicePrincipals/{servicePrincipal-id}/memberOf/{directoryObject-id}':
get:
tags:
- servicePrincipals.directoryObject
summary: Get memberOf from servicePrincipals
description: 'Roles that this service principal is a member of. HTTP Methods: GET Read-only. Nullable. Supports $expand.'
operationId: servicePrincipal_GetMemberGraphOPre
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- name: directoryObject-id
in: path
description: The unique identifier of directoryObject
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: directoryObject
- name: ConsistencyLevel
in: header
description: 'Indicates the requested consistency level. Documentation URL: https://docs.microsoft.com/graph/aad-advanced-queries'
style: simple
schema:
type: string
examples:
example-1:
description: $search and $count queries require the client to set the ConsistencyLevel HTTP header to 'eventual'.
value: eventual
- 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.directoryObject'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/servicePrincipals/{servicePrincipal-id}/memberOf/{directoryObject-id}/microsoft.graph.administrativeUnit':
get:
tags:
- servicePrincipals.directoryObject
summary: Get the item of type microsoft.graph.directoryObject as microsoft.graph.administrativeUnit
operationId: servicePrincipal_GetMemberGraphOPreAsAdministrativeUnit
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- name: directoryObject-id
in: path
description: The unique identifier of directoryObject
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: directoryObject
- name: ConsistencyLevel
in: header
description: 'Indicates the requested consistency level. Documentation URL: https://docs.microsoft.com/graph/aad-advanced-queries'
style: simple
schema:
type: string
examples:
example-1:
description: $search and $count queries require the client to set the ConsistencyLevel HTTP header to 'eventual'.
value: eventual
- 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: Entity result.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.administrativeUnit'
default:
$ref: '#/components/responses/error'
'/servicePrincipals/{servicePrincipal-id}/memberOf/{directoryObject-id}/microsoft.graph.directoryRole':
get:
tags:
- servicePrincipals.directoryObject
summary: Get the item of type microsoft.graph.directoryObject as microsoft.graph.directoryRole
operationId: servicePrincipal_GetMemberGraphOPreAsDirectoryRole
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- name: directoryObject-id
in: path
description: The unique identifier of directoryObject
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: directoryObject
- name: ConsistencyLevel
in: header
description: 'Indicates the requested consistency level. Documentation URL: https://docs.microsoft.com/graph/aad-advanced-queries'
style: simple
schema:
type: string
examples:
example-1:
description: $search and $count queries require the client to set the ConsistencyLevel HTTP header to 'eventual'.
value: eventual
- 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: Entity result.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.directoryRole'
default:
$ref: '#/components/responses/error'
'/servicePrincipals/{servicePrincipal-id}/memberOf/{directoryObject-id}/microsoft.graph.group':
get:
tags:
- servicePrincipals.directoryObject
summary: Get the item of type microsoft.graph.directoryObject as microsoft.graph.group
operationId: servicePrincipal_GetMemberGraphOPreAsGroup
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- name: directoryObject-id
in: path
description: The unique identifier of directoryObject
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: directoryObject
- name: ConsistencyLevel
in: header
description: 'Indicates the requested consistency level. Documentation URL: https://docs.microsoft.com/graph/aad-advanced-queries'
style: simple
schema:
type: string
examples:
example-1:
description: $search and $count queries require the client to set the ConsistencyLevel HTTP header to 'eventual'.
value: eventual
- 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: Entity result.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.group'
default:
$ref: '#/components/responses/error'
'/servicePrincipals/{servicePrincipal-id}/memberOf/$count':
get:
tags:
- servicePrincipals.directoryObject
summary: Get the number of the resource
operationId: servicePrincipal.memberOf_GetCount
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- name: ConsistencyLevel
in: header
description: 'Indicates the requested consistency level. Documentation URL: https://docs.microsoft.com/graph/aad-advanced-queries'
style: simple
schema:
type: string
examples:
example-1:
description: $search and $count queries require the client to set the ConsistencyLevel HTTP header to 'eventual'.
value: eventual
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/servicePrincipals/{servicePrincipal-id}/memberOf/microsoft.graph.administrativeUnit':
get:
tags:
- servicePrincipals.directoryObject
summary: Get the items of type microsoft.graph.administrativeUnit in the microsoft.graph.directoryObject collection
operationId: servicePrincipal_ListMemberGraphOPreAsAdministrativeUnit
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- name: ConsistencyLevel
in: header
description: 'Indicates the requested consistency level. Documentation URL: https://docs.microsoft.com/graph/aad-advanced-queries'
style: simple
schema:
type: string
examples:
example-1:
description: $search and $count queries require the client to set the ConsistencyLevel HTTP header to 'eventual'.
value: eventual
- $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.administrativeUnitCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
'/servicePrincipals/{servicePrincipal-id}/memberOf/microsoft.graph.administrativeUnit/$count':
get:
tags:
- servicePrincipals.directoryObject
summary: Get the number of the resource
operationId: servicePrincipal.MemberOf_GetCountAsAdministrativeUnit
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- name: ConsistencyLevel
in: header
description: 'Indicates the requested consistency level. Documentation URL: https://docs.microsoft.com/graph/aad-advanced-queries'
style: simple
schema:
type: string
examples:
example-1:
description: $search and $count queries require the client to set the ConsistencyLevel HTTP header to 'eventual'.
value: eventual
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/servicePrincipals/{servicePrincipal-id}/memberOf/microsoft.graph.directoryRole':
get:
tags:
- servicePrincipals.directoryObject
summary: Get the items of type microsoft.graph.directoryRole in the microsoft.graph.directoryObject collection
operationId: servicePrincipal_ListMemberGraphOPreAsDirectoryRole
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- name: ConsistencyLevel
in: header
description: 'Indicates the requested consistency level. Documentation URL: https://docs.microsoft.com/graph/aad-advanced-queries'
style: simple
schema:
type: string
examples:
example-1:
description: $search and $count queries require the client to set the ConsistencyLevel HTTP header to 'eventual'.
value: eventual
- $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.directoryRoleCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
'/servicePrincipals/{servicePrincipal-id}/memberOf/microsoft.graph.directoryRole/$count':
get:
tags:
- servicePrincipals.directoryObject
summary: Get the number of the resource
operationId: servicePrincipal.MemberOf_GetCountAsDirectoryRole
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- name: ConsistencyLevel
in: header
description: 'Indicates the requested consistency level. Documentation URL: https://docs.microsoft.com/graph/aad-advanced-queries'
style: simple
schema:
type: string
examples:
example-1:
description: $search and $count queries require the client to set the ConsistencyLevel HTTP header to 'eventual'.
value: eventual
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/servicePrincipals/{servicePrincipal-id}/memberOf/microsoft.graph.group':
get:
tags:
- servicePrincipals.directoryObject
summary: Get the items of type microsoft.graph.group in the microsoft.graph.directoryObject collection
operationId: servicePrincipal_ListMemberGraphOPreAsGroup
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- name: ConsistencyLevel
in: header
description: 'Indicates the requested consistency level. Documentation URL: https://docs.microsoft.com/graph/aad-advanced-queries'
style: simple
schema:
type: string
examples:
example-1:
description: $search and $count queries require the client to set the ConsistencyLevel HTTP header to 'eventual'.
value: eventual
- $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.groupCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
'/servicePrincipals/{servicePrincipal-id}/memberOf/microsoft.graph.group/$count':
get:
tags:
- servicePrincipals.directoryObject
summary: Get the number of the resource
operationId: servicePrincipal.MemberOf_GetCountAsGroup
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- name: ConsistencyLevel
in: header
description: 'Indicates the requested consistency level. Documentation URL: https://docs.microsoft.com/graph/aad-advanced-queries'
style: simple
schema:
type: string
examples:
example-1:
description: $search and $count queries require the client to set the ConsistencyLevel HTTP header to 'eventual'.
value: eventual
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/servicePrincipals/{servicePrincipal-id}/microsoft.graph.addKey':
post:
tags:
- servicePrincipals.servicePrincipal.Actions
summary: Invoke action addKey
description: 'Adds a key credential to a servicePrincipal. This method along with removeKey can be used by a servicePrincipal to automate rolling its expiring keys. As part of the request validation for this method, a proof of possession of an existing key is verified before the action can be performed. ServicePrincipals that don''t have any existing valid certificates (i.e.: no certificates have been added yet, or all certificates have expired), won''t be able to use this service action. Update servicePrincipal can be used to perform an update instead.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/serviceprincipal-addkey?view=graph-rest-1.0
operationId: servicePrincipal_addKey
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
keyCredential:
$ref: '#/components/schemas/microsoft.graph.keyCredential'
passwordCredential:
$ref: '#/components/schemas/microsoft.graph.passwordCredential'
proof:
type: string
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.keyCredential'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/servicePrincipals/{servicePrincipal-id}/microsoft.graph.addPassword':
post:
tags:
- servicePrincipals.servicePrincipal.Actions
summary: Invoke action addPassword
description: Add a strong password or secret to a servicePrincipal object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/serviceprincipal-addpassword?view=graph-rest-1.0
operationId: servicePrincipal_addPassword
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
passwordCredential:
$ref: '#/components/schemas/microsoft.graph.passwordCredential'
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.passwordCredential'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/servicePrincipals/{servicePrincipal-id}/microsoft.graph.addTokenSigningCertificate':
post:
tags:
- servicePrincipals.servicePrincipal.Actions
summary: Invoke action addTokenSigningCertificate
description: "Create a self-signed signing certificate and return a selfSignedCertificate object, which is the public part of the generated certificate. The self-signed signing certificate is composed of the following objects, which are added to the servicePrincipal: \r\n+ The keyCredentials object with the following objects:\r\n + A private key object with usage set to Sign.\r\n + A public key object with usage set to Verify.\r\n+ The passwordCredentials object. All the objects have the same value of customKeyIdentifier. The passwordCredential is used to open the PFX file (private key). It and the associated private key object have the same value of keyId. When set during creation through the displayName property, the subject of the certificate cannot be updated. The startDateTime is set to the same time the certificate is created using the action. The endDateTime can be up to three years after the certificate is created."
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/serviceprincipal-addtokensigningcertificate?view=graph-rest-1.0
operationId: servicePrincipal_addTokenSigningCertificate
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
displayName:
type: string
nullable: true
endDateTime:
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
format: date-time
nullable: true
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.selfSignedCertificate'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/servicePrincipals/{servicePrincipal-id}/microsoft.graph.checkMemberGroups':
post:
tags:
- servicePrincipals.servicePrincipal.Actions
summary: Invoke action checkMemberGroups
description: "Check for membership in a specified list of group IDs, and return from that list the IDs of groups where a specified object is a member. The specified object can be of one of the following types:\r\n- user\r\n- group\r\n- service principal\r\n- organizational contact\r\n- device\r\n- directory object This function is transitive. You can check up to a maximum of 20 groups per request. This function supports all groups provisioned in Microsoft Entra ID. Because Microsoft 365 groups cannot contain other groups, membership in a Microsoft 365 group is always direct."
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/directoryobject-checkmembergroups?view=graph-rest-1.0
operationId: servicePrincipal_checkMemberGroup
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
groupIds:
type: array
items:
type: string
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
type: object
properties:
value:
type: array
items:
type: string
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
'/servicePrincipals/{servicePrincipal-id}/microsoft.graph.checkMemberObjects':
post:
tags:
- servicePrincipals.servicePrincipal.Actions
summary: Invoke action checkMemberObjects
operationId: servicePrincipal_checkMemberObject
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
ids:
type: array
items:
type: string
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
type: object
properties:
value:
type: array
items:
type: string
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
'/servicePrincipals/{servicePrincipal-id}/microsoft.graph.getMemberGroups':
post:
tags:
- servicePrincipals.servicePrincipal.Actions
summary: Invoke action getMemberGroups
description: 'Return all the group IDs for the groups that the specified user, group, service principal, organizational contact, device, or directory object is a member of. This function is transitive. This API returns up to 11,000 group IDs. If more than 11,000 results are available, it returns a 400 Bad Request error with the DirectoryResultSizeLimitExceeded error code. If you get the DirectoryResultSizeLimitExceeded error code, use the List group transitive memberOf API instead.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/directoryobject-getmembergroups?view=graph-rest-1.0
operationId: servicePrincipal_getMemberGroup
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
securityEnabledOnly:
type: boolean
default: false
nullable: true
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
type: object
properties:
value:
type: array
items:
type: string
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
'/servicePrincipals/{servicePrincipal-id}/microsoft.graph.getMemberObjects':
post:
tags:
- servicePrincipals.servicePrincipal.Actions
summary: Invoke action getMemberObjects
description: "Return all IDs for the groups, administrative units, and directory roles that an object of one of the following types is a member of:\r\n- user\r\n- group\r\n- service principal\r\n- organizational contact\r\n- device\r\n- directory object This function is transitive. Only users and role-enabled groups can be members of directory roles."
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/directoryobject-getmemberobjects?view=graph-rest-1.0
operationId: servicePrincipal_getMemberObject
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
securityEnabledOnly:
type: boolean
default: false
nullable: true
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
type: object
properties:
value:
type: array
items:
type: string
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
'/servicePrincipals/{servicePrincipal-id}/microsoft.graph.removeKey':
post:
tags:
- servicePrincipals.servicePrincipal.Actions
summary: Invoke action removeKey
description: 'Remove a key credential from a servicePrincipal. This method along with addKey can be used by a servicePrincipal to automate rolling its expiring keys. As part of the request validation for this method, a proof of possession of an existing key is verified before the action can be performed.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/serviceprincipal-removekey?view=graph-rest-1.0
operationId: servicePrincipal_removeKey
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
keyId:
pattern: '^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$'
type: string
format: uuid
proof:
type: string
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/servicePrincipals/{servicePrincipal-id}/microsoft.graph.removePassword':
post:
tags:
- servicePrincipals.servicePrincipal.Actions
summary: Invoke action removePassword
description: Remove a password from a servicePrincipal object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/serviceprincipal-removepassword?view=graph-rest-1.0
operationId: servicePrincipal_removePassword
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
keyId:
pattern: '^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$'
type: string
format: uuid
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/servicePrincipals/{servicePrincipal-id}/microsoft.graph.restore':
post:
tags:
- servicePrincipals.servicePrincipal.Actions
summary: Invoke action restore
description: "Restore a recently deleted directory object from deleted items. The following types are supported:\r\n- administrativeUnit\r\n- application\r\n- agentIdentityBlueprint\r\n- agentIdentity\r\n- agentIdentityBlueprintPrincipal\r\n- agentUser\r\n- certificateBasedAuthPki\r\n- certificateAuthorityDetail\r\n- group\r\n- servicePrincipal\r\n- user If an item is accidentally deleted, you can fully restore the item. Additionally, restoring an application doesn't automatically restore the associated service principal automatically. You must call this API to explicitly restore the deleted service principal. A recently deleted item remains available for up to 30 days. After 30 days, the item is permanently deleted."
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/directory-deleteditems-restore?view=graph-rest-1.0
operationId: servicePrincipal_restore
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/servicePrincipals/{servicePrincipal-id}/oauth2PermissionGrants':
get:
tags:
- servicePrincipals.oAuth2PermissionGrant
summary: List oauth2PermissionGrants granted to a service principal
description: 'Retrieve a list of oAuth2PermissionGrant entities, representing delegated permissions granted to the service principal (representing the client application) to access an API on behalf of a user.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/serviceprincipal-list-oauth2permissiongrants?view=graph-rest-1.0
operationId: servicePrincipal_ListOauth2PermissionGrant
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- $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.oAuth2PermissionGrantCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
'/servicePrincipals/{servicePrincipal-id}/oauth2PermissionGrants/{oAuth2PermissionGrant-id}':
get:
tags:
- servicePrincipals.oAuth2PermissionGrant
summary: Get oauth2PermissionGrants from servicePrincipals
description: Delegated permission grants authorizing this service principal to access an API on behalf of a signed-in user. Read-only. Nullable.
operationId: servicePrincipal_GetOauth2PermissionGrant
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- name: oAuth2PermissionGrant-id
in: path
description: The unique identifier of oAuth2PermissionGrant
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: oAuth2PermissionGrant
- 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.oAuth2PermissionGrant'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/servicePrincipals/{servicePrincipal-id}/oauth2PermissionGrants/$count':
get:
tags:
- servicePrincipals.oAuth2PermissionGrant
summary: Get the number of the resource
operationId: servicePrincipal.oauth2PermissionGrant_GetCount
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/servicePrincipals/{servicePrincipal-id}/ownedObjects':
get:
tags:
- servicePrincipals.directoryObject
summary: 'servicePrincipals: List ownedObjects'
description: Retrieve a list of objects owned by the servicePrincipal. This could include applications or groups.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/serviceprincipal-list-ownedobjects?view=graph-rest-1.0
operationId: servicePrincipal_ListOwnedObject
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- $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.directoryObjectCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
'/servicePrincipals/{servicePrincipal-id}/ownedObjects/{directoryObject-id}':
get:
tags:
- servicePrincipals.directoryObject
summary: Get ownedObjects from servicePrincipals
description: 'Directory objects that this service principal owns. Read-only. Nullable. Supports $expand, $select nested in $expand, and $filter (/$count eq 0, /$count ne 0, /$count eq 1, /$count ne 1).'
operationId: servicePrincipal_GetOwnedObject
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- name: directoryObject-id
in: path
description: The unique identifier of directoryObject
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: directoryObject
- 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.directoryObject'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/servicePrincipals/{servicePrincipal-id}/ownedObjects/{directoryObject-id}/microsoft.graph.application':
get:
tags:
- servicePrincipals.directoryObject
summary: Get the item of type microsoft.graph.directoryObject as microsoft.graph.application
operationId: servicePrincipal_GetOwnedObjectAsApplication
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- name: directoryObject-id
in: path
description: The unique identifier of directoryObject
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: directoryObject
- 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: Entity result.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.application'
default:
$ref: '#/components/responses/error'
'/servicePrincipals/{servicePrincipal-id}/ownedObjects/{directoryObject-id}/microsoft.graph.appRoleAssignment':
get:
tags:
- servicePrincipals.directoryObject
summary: Get the item of type microsoft.graph.directoryObject as microsoft.graph.appRoleAssignment
operationId: servicePrincipal_GetOwnedObjectAsAppRoleAssignment
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- name: directoryObject-id
in: path
description: The unique identifier of directoryObject
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: directoryObject
- 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: Entity result.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.appRoleAssignment'
default:
$ref: '#/components/responses/error'
'/servicePrincipals/{servicePrincipal-id}/ownedObjects/{directoryObject-id}/microsoft.graph.endpoint':
get:
tags:
- servicePrincipals.directoryObject
summary: Get the item of type microsoft.graph.directoryObject as microsoft.graph.endpoint
operationId: servicePrincipal_GetOwnedObjectAsEndpoint
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- name: directoryObject-id
in: path
description: The unique identifier of directoryObject
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: directoryObject
- 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: Entity result.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.endpoint'
default:
$ref: '#/components/responses/error'
'/servicePrincipals/{servicePrincipal-id}/ownedObjects/{directoryObject-id}/microsoft.graph.group':
get:
tags:
- servicePrincipals.directoryObject
summary: Get the item of type microsoft.graph.directoryObject as microsoft.graph.group
operationId: servicePrincipal_GetOwnedObjectAsGroup
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- name: directoryObject-id
in: path
description: The unique identifier of directoryObject
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: directoryObject
- 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: Entity result.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.group'
default:
$ref: '#/components/responses/error'
'/servicePrincipals/{servicePrincipal-id}/ownedObjects/{directoryObject-id}/microsoft.graph.servicePrincipal':
get:
tags:
- servicePrincipals.directoryObject
summary: Get the item of type microsoft.graph.directoryObject as microsoft.graph.servicePrincipal
operationId: servicePrincipal_GetOwnedObjectAsServicePrincipal
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- name: directoryObject-id
in: path
description: The unique identifier of directoryObject
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: directoryObject
- 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: Entity result.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.servicePrincipal'
default:
$ref: '#/components/responses/error'
'/servicePrincipals/{servicePrincipal-id}/ownedObjects/$count':
get:
tags:
- servicePrincipals.directoryObject
summary: Get the number of the resource
operationId: servicePrincipal.ownedObject_GetCount
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/servicePrincipals/{servicePrincipal-id}/ownedObjects/microsoft.graph.application':
get:
tags:
- servicePrincipals.directoryObject
summary: Get the items of type microsoft.graph.application in the microsoft.graph.directoryObject collection
operationId: servicePrincipal_ListOwnedObjectAsApplication
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- $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.applicationCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
'/servicePrincipals/{servicePrincipal-id}/ownedObjects/microsoft.graph.application/$count':
get:
tags:
- servicePrincipals.directoryObject
summary: Get the number of the resource
operationId: servicePrincipal.OwnedObject_GetCountAsApplication
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/servicePrincipals/{servicePrincipal-id}/ownedObjects/microsoft.graph.appRoleAssignment':
get:
tags:
- servicePrincipals.directoryObject
summary: Get the items of type microsoft.graph.appRoleAssignment in the microsoft.graph.directoryObject collection
operationId: servicePrincipal_ListOwnedObjectAsAppRoleAssignment
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- $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.appRoleAssignmentCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
'/servicePrincipals/{servicePrincipal-id}/ownedObjects/microsoft.graph.appRoleAssignment/$count':
get:
tags:
- servicePrincipals.directoryObject
summary: Get the number of the resource
operationId: servicePrincipal.OwnedObject_GetCountAsAppRoleAssignment
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/servicePrincipals/{servicePrincipal-id}/ownedObjects/microsoft.graph.endpoint':
get:
tags:
- servicePrincipals.directoryObject
summary: Get the items of type microsoft.graph.endpoint in the microsoft.graph.directoryObject collection
operationId: servicePrincipal_ListOwnedObjectAsEndpoint
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- $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.endpointCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
'/servicePrincipals/{servicePrincipal-id}/ownedObjects/microsoft.graph.endpoint/$count':
get:
tags:
- servicePrincipals.directoryObject
summary: Get the number of the resource
operationId: servicePrincipal.OwnedObject_GetCountAsEndpoint
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/servicePrincipals/{servicePrincipal-id}/ownedObjects/microsoft.graph.group':
get:
tags:
- servicePrincipals.directoryObject
summary: Get the items of type microsoft.graph.group in the microsoft.graph.directoryObject collection
operationId: servicePrincipal_ListOwnedObjectAsGroup
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- $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.groupCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
'/servicePrincipals/{servicePrincipal-id}/ownedObjects/microsoft.graph.group/$count':
get:
tags:
- servicePrincipals.directoryObject
summary: Get the number of the resource
operationId: servicePrincipal.OwnedObject_GetCountAsGroup
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/servicePrincipals/{servicePrincipal-id}/ownedObjects/microsoft.graph.servicePrincipal':
get:
tags:
- servicePrincipals.directoryObject
summary: Get the items of type microsoft.graph.servicePrincipal in the microsoft.graph.directoryObject collection
operationId: servicePrincipal_ListOwnedObjectAsServicePrincipal
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- $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.servicePrincipalCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
'/servicePrincipals/{servicePrincipal-id}/ownedObjects/microsoft.graph.servicePrincipal/$count':
get:
tags:
- servicePrincipals.directoryObject
summary: Get the number of the resource
operationId: servicePrincipal.OwnedObject_GetCountAsServicePrincipal
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/servicePrincipals/{servicePrincipal-id}/owners':
get:
tags:
- servicePrincipals.directoryObject
summary: Get owners from servicePrincipals
description: 'Directory objects that are owners of this servicePrincipal. The owners are a set of nonadmin users or servicePrincipals who are allowed to modify this object. Supports $expand, $filter (/$count eq 0, /$count ne 0, /$count eq 1, /$count ne 1), and $select nested in $expand.'
operationId: servicePrincipal_ListOwner
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- name: ConsistencyLevel
in: header
description: 'Indicates the requested consistency level. Documentation URL: https://docs.microsoft.com/graph/aad-advanced-queries'
style: simple
schema:
type: string
examples:
example-1:
description: $search and $count queries require the client to set the ConsistencyLevel HTTP header to 'eventual'.
value: eventual
- $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.directoryObjectCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
'/servicePrincipals/{servicePrincipal-id}/owners/{directoryObject-id}/$ref':
delete:
tags:
- servicePrincipals.directoryObject
summary: Remove service principal owner
description: 'Remove an owner from a servicePrincipal object. As a recommended best practice, service principals should have at least two owners.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/serviceprincipal-delete-owners?view=graph-rest-1.0
operationId: servicePrincipal.owner_DeleteDirectoryObjectGraphBPreRef
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- name: directoryObject-id
in: path
description: The unique identifier of directoryObject
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: directoryObject
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/servicePrincipals/{servicePrincipal-id}/owners/{directoryObject-id}/microsoft.graph.appRoleAssignment':
get:
tags:
- servicePrincipals.directoryObject
summary: Get the item of type microsoft.graph.directoryObject as microsoft.graph.appRoleAssignment
operationId: servicePrincipal_GetOwnerAsAppRoleAssignment
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- name: directoryObject-id
in: path
description: The unique identifier of directoryObject
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: directoryObject
- name: ConsistencyLevel
in: header
description: 'Indicates the requested consistency level. Documentation URL: https://docs.microsoft.com/graph/aad-advanced-queries'
style: simple
schema:
type: string
examples:
example-1:
description: $search and $count queries require the client to set the ConsistencyLevel HTTP header to 'eventual'.
value: eventual
- 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: Entity result.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.appRoleAssignment'
default:
$ref: '#/components/responses/error'
'/servicePrincipals/{servicePrincipal-id}/owners/{directoryObject-id}/microsoft.graph.endpoint':
get:
tags:
- servicePrincipals.directoryObject
summary: Get the item of type microsoft.graph.directoryObject as microsoft.graph.endpoint
operationId: servicePrincipal_GetOwnerAsEndpoint
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- name: directoryObject-id
in: path
description: The unique identifier of directoryObject
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: directoryObject
- name: ConsistencyLevel
in: header
description: 'Indicates the requested consistency level. Documentation URL: https://docs.microsoft.com/graph/aad-advanced-queries'
style: simple
schema:
type: string
examples:
example-1:
description: $search and $count queries require the client to set the ConsistencyLevel HTTP header to 'eventual'.
value: eventual
- 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: Entity result.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.endpoint'
default:
$ref: '#/components/responses/error'
'/servicePrincipals/{servicePrincipal-id}/owners/{directoryObject-id}/microsoft.graph.servicePrincipal':
get:
tags:
- servicePrincipals.directoryObject
summary: Get the item of type microsoft.graph.directoryObject as microsoft.graph.servicePrincipal
operationId: servicePrincipal_GetOwnerAsServicePrincipal
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- name: directoryObject-id
in: path
description: The unique identifier of directoryObject
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: directoryObject
- name: ConsistencyLevel
in: header
description: 'Indicates the requested consistency level. Documentation URL: https://docs.microsoft.com/graph/aad-advanced-queries'
style: simple
schema:
type: string
examples:
example-1:
description: $search and $count queries require the client to set the ConsistencyLevel HTTP header to 'eventual'.
value: eventual
- 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: Entity result.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.servicePrincipal'
default:
$ref: '#/components/responses/error'
'/servicePrincipals/{servicePrincipal-id}/owners/{directoryObject-id}/microsoft.graph.user':
get:
tags:
- servicePrincipals.directoryObject
summary: Get the item of type microsoft.graph.directoryObject as microsoft.graph.user
operationId: servicePrincipal_GetOwnerAsUser
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- name: directoryObject-id
in: path
description: The unique identifier of directoryObject
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: directoryObject
- name: ConsistencyLevel
in: header
description: 'Indicates the requested consistency level. Documentation URL: https://docs.microsoft.com/graph/aad-advanced-queries'
style: simple
schema:
type: string
examples:
example-1:
description: $search and $count queries require the client to set the ConsistencyLevel HTTP header to 'eventual'.
value: eventual
- 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: Entity result.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.user'
default:
$ref: '#/components/responses/error'
'/servicePrincipals/{servicePrincipal-id}/owners/$count':
get:
tags:
- servicePrincipals.directoryObject
summary: Get the number of the resource
operationId: servicePrincipal.owner_GetCount
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- name: ConsistencyLevel
in: header
description: 'Indicates the requested consistency level. Documentation URL: https://docs.microsoft.com/graph/aad-advanced-queries'
style: simple
schema:
type: string
examples:
example-1:
description: $search and $count queries require the client to set the ConsistencyLevel HTTP header to 'eventual'.
value: eventual
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/servicePrincipals/{servicePrincipal-id}/owners/$ref':
get:
tags:
- servicePrincipals.directoryObject
summary: Get ref of owners from servicePrincipals
description: 'Directory objects that are owners of this servicePrincipal. The owners are a set of nonadmin users or servicePrincipals who are allowed to modify this object. Supports $expand, $filter (/$count eq 0, /$count ne 0, /$count eq 1, /$count ne 1), and $select nested in $expand.'
operationId: servicePrincipal_ListOwnerGraphBPreRef
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- name: ConsistencyLevel
in: header
description: 'Indicates the requested consistency level. Documentation URL: https://docs.microsoft.com/graph/aad-advanced-queries'
style: simple
schema:
type: string
examples:
example-1:
description: $search and $count queries require the client to set the ConsistencyLevel HTTP header to 'eventual'.
value: eventual
- $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
responses:
2XX:
$ref: '#/components/responses/StringCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- servicePrincipals.directoryObject
summary: 'servicePrincipal: Add owner'
description: 'Use this API to add an owner for the servicePrincipal. Service principal owners can be users, the service principal itself, or other service principals.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/serviceprincipal-post-owners?view=graph-rest-1.0
operationId: servicePrincipal_CreateOwnerGraphBPreRef
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
requestBody:
$ref: '#/components/requestBodies/refPostBody'
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- servicePrincipals.directoryObject
summary: Remove service principal owner
description: 'Remove an owner from a servicePrincipal object. As a recommended best practice, service principals should have at least two owners.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/serviceprincipal-delete-owners?view=graph-rest-1.0
operationId: servicePrincipal_DeleteOwnerGraphBPreRef
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
- name: '@id'
in: query
description: The delete Uri
required: true
style: form
explode: false
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/servicePrincipals/{servicePrincipal-id}/owners/microsoft.graph.appRoleAssignment':
get:
tags:
- servicePrincipals.directoryObject
summary: Get the items of type microsoft.graph.appRoleAssignment in the microsoft.graph.directoryObject collection
operationId: servicePrincipal_ListOwnerAsAppRoleAssignment
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- name: ConsistencyLevel
in: header
description: 'Indicates the requested consistency level. Documentation URL: https://docs.microsoft.com/graph/aad-advanced-queries'
style: simple
schema:
type: string
examples:
example-1:
description: $search and $count queries require the client to set the ConsistencyLevel HTTP header to 'eventual'.
value: eventual
- $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.appRoleAssignmentCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
'/servicePrincipals/{servicePrincipal-id}/owners/microsoft.graph.appRoleAssignment/$count':
get:
tags:
- servicePrincipals.directoryObject
summary: Get the number of the resource
operationId: servicePrincipal.Owner_GetCountAsAppRoleAssignment
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- name: ConsistencyLevel
in: header
description: 'Indicates the requested consistency level. Documentation URL: https://docs.microsoft.com/graph/aad-advanced-queries'
style: simple
schema:
type: string
examples:
example-1:
description: $search and $count queries require the client to set the ConsistencyLevel HTTP header to 'eventual'.
value: eventual
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/servicePrincipals/{servicePrincipal-id}/owners/microsoft.graph.endpoint':
get:
tags:
- servicePrincipals.directoryObject
summary: Get the items of type microsoft.graph.endpoint in the microsoft.graph.directoryObject collection
operationId: servicePrincipal_ListOwnerAsEndpoint
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- name: ConsistencyLevel
in: header
description: 'Indicates the requested consistency level. Documentation URL: https://docs.microsoft.com/graph/aad-advanced-queries'
style: simple
schema:
type: string
examples:
example-1:
description: $search and $count queries require the client to set the ConsistencyLevel HTTP header to 'eventual'.
value: eventual
- $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.endpointCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
'/servicePrincipals/{servicePrincipal-id}/owners/microsoft.graph.endpoint/$count':
get:
tags:
- servicePrincipals.directoryObject
summary: Get the number of the resource
operationId: servicePrincipal.Owner_GetCountAsEndpoint
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- name: ConsistencyLevel
in: header
description: 'Indicates the requested consistency level. Documentation URL: https://docs.microsoft.com/graph/aad-advanced-queries'
style: simple
schema:
type: string
examples:
example-1:
description: $search and $count queries require the client to set the ConsistencyLevel HTTP header to 'eventual'.
value: eventual
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/servicePrincipals/{servicePrincipal-id}/owners/microsoft.graph.servicePrincipal':
get:
tags:
- servicePrincipals.directoryObject
summary: Get the items of type microsoft.graph.servicePrincipal in the microsoft.graph.directoryObject collection
operationId: servicePrincipal_ListOwnerAsServicePrincipal
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- name: ConsistencyLevel
in: header
description: 'Indicates the requested consistency level. Documentation URL: https://docs.microsoft.com/graph/aad-advanced-queries'
style: simple
schema:
type: string
examples:
example-1:
description: $search and $count queries require the client to set the ConsistencyLevel HTTP header to 'eventual'.
value: eventual
- $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.servicePrincipalCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
'/servicePrincipals/{servicePrincipal-id}/owners/microsoft.graph.servicePrincipal/$count':
get:
tags:
- servicePrincipals.directoryObject
summary: Get the number of the resource
operationId: servicePrincipal.Owner_GetCountAsServicePrincipal
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- name: ConsistencyLevel
in: header
description: 'Indicates the requested consistency level. Documentation URL: https://docs.microsoft.com/graph/aad-advanced-queries'
style: simple
schema:
type: string
examples:
example-1:
description: $search and $count queries require the client to set the ConsistencyLevel HTTP header to 'eventual'.
value: eventual
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/servicePrincipals/{servicePrincipal-id}/owners/microsoft.graph.user':
get:
tags:
- servicePrincipals.directoryObject
summary: Get the items of type microsoft.graph.user in the microsoft.graph.directoryObject collection
operationId: servicePrincipal_ListOwnerAsUser
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- name: ConsistencyLevel
in: header
description: 'Indicates the requested consistency level. Documentation URL: https://docs.microsoft.com/graph/aad-advanced-queries'
style: simple
schema:
type: string
examples:
example-1:
description: $search and $count queries require the client to set the ConsistencyLevel HTTP header to 'eventual'.
value: eventual
- $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.userCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
'/servicePrincipals/{servicePrincipal-id}/owners/microsoft.graph.user/$count':
get:
tags:
- servicePrincipals.directoryObject
summary: Get the number of the resource
operationId: servicePrincipal.Owner_GetCountAsUser
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- name: ConsistencyLevel
in: header
description: 'Indicates the requested consistency level. Documentation URL: https://docs.microsoft.com/graph/aad-advanced-queries'
style: simple
schema:
type: string
examples:
example-1:
description: $search and $count queries require the client to set the ConsistencyLevel HTTP header to 'eventual'.
value: eventual
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/servicePrincipals/{servicePrincipal-id}/remoteDesktopSecurityConfiguration':
get:
tags:
- servicePrincipals.remoteDesktopSecurityConfiguration
summary: Get remoteDesktopSecurityConfiguration
description: Read the properties and relationships of a remoteDesktopSecurityConfiguration object on a servicePrincipal. Use this configuration to view the Microsoft Entra ID Remote Desktop Services (RDS) authentication protocol to authenticate a user to Microsoft Entra joined or Microsoft Entra hybrid joined devices. Additionally you can view any targetDeviceGroups that have been configured for SSO.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/remotedesktopsecurityconfiguration-get?view=graph-rest-1.0
operationId: servicePrincipal_GetRemoteDesktopSecurityConfiguration
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- 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.remoteDesktopSecurityConfiguration'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- servicePrincipals.remoteDesktopSecurityConfiguration
summary: Update remoteDesktopSecurityConfiguration
description: Update the properties of a remoteDesktopSecurityConfiguration object on the servicePrincipal. Use this configuration to enable or disable the Microsoft Entra ID Remote Desktop Services (RDS) authentication protocol to authenticate a user to Microsoft Entra joined or Microsoft Entra hybrid joined devices.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/remotedesktopsecurityconfiguration-update?view=graph-rest-1.0
operationId: servicePrincipal_UpdateRemoteDesktopSecurityConfiguration
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.remoteDesktopSecurityConfiguration'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.remoteDesktopSecurityConfiguration'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- servicePrincipals.remoteDesktopSecurityConfiguration
summary: Delete remoteDesktopSecurityConfiguration
description: 'Delete a remoteDesktopSecurityConfiguration object on a servicePrincipal. Removing remoteDesktopSecurityConfiguration object on the servicePrincipal disables the Microsoft Entra ID Remote Desktop Services (RDS) authentication protocol to authenticate a user to Microsoft Entra joined or Microsoft Entra hybrid joined devices, and removes any target device groups that you configured for SSO.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/serviceprincipal-delete-remotedesktopsecurityconfiguration?view=graph-rest-1.0
operationId: servicePrincipal_DeleteRemoteDesktopSecurityConfiguration
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/servicePrincipals/{servicePrincipal-id}/remoteDesktopSecurityConfiguration/approvedClientApps':
get:
tags:
- servicePrincipals.remoteDesktopSecurityConfiguration
summary: List approvedClientApp objects
description: The collection of approved client apps that are associated with the RDS configuration. Supports $expand.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/remotedesktopsecurityconfiguration-list-approvedclientapps?view=graph-rest-1.0
operationId: servicePrincipal.remoteDesktopSecurityConfiguration_ListApprovedClientApp
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- $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.approvedClientAppCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- servicePrincipals.remoteDesktopSecurityConfiguration
summary: Create approvedClientApp
description: Create a new approvedClientApp object for the remoteDesktopSecurityConfiguration object on a service principal. You can configure a maximum of 20 approved client apps.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/remotedesktopsecurityconfiguration-post-approvedclientapps?view=graph-rest-1.0
operationId: servicePrincipal.remoteDesktopSecurityConfiguration_CreateApprovedClientApp
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.approvedClientApp'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.approvedClientApp'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/servicePrincipals/{servicePrincipal-id}/remoteDesktopSecurityConfiguration/approvedClientApps/{approvedClientApp-id}':
get:
tags:
- servicePrincipals.remoteDesktopSecurityConfiguration
summary: Get approvedClientApp
description: Read the properties and relationships of a approvedClientApp object for the remoteDesktopSecurityConfiguration object on a servicePrincipal.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/approvedclientapp-get?view=graph-rest-1.0
operationId: servicePrincipal.remoteDesktopSecurityConfiguration_GetApprovedClientApp
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- name: approvedClientApp-id
in: path
description: The unique identifier of approvedClientApp
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: approvedClientApp
- 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.approvedClientApp'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- servicePrincipals.remoteDesktopSecurityConfiguration
summary: Update approvedClientApp
description: Update the properties of an approvedClientApp object for a remotedesktopsecurityconfiguration.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/approvedclientapp-update?view=graph-rest-1.0
operationId: servicePrincipal.remoteDesktopSecurityConfiguration_UpdateApprovedClientApp
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- name: approvedClientApp-id
in: path
description: The unique identifier of approvedClientApp
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: approvedClientApp
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.approvedClientApp'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.approvedClientApp'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- servicePrincipals.remoteDesktopSecurityConfiguration
summary: Delete approvedClientApp
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/remotedesktopsecurityconfiguration-delete-approvedclientapps?view=graph-rest-1.0
operationId: servicePrincipal.remoteDesktopSecurityConfiguration_DeleteApprovedClientApp
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- name: approvedClientApp-id
in: path
description: The unique identifier of approvedClientApp
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: approvedClientApp
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/servicePrincipals/{servicePrincipal-id}/remoteDesktopSecurityConfiguration/approvedClientApps/$count':
get:
tags:
- servicePrincipals.remoteDesktopSecurityConfiguration
summary: Get the number of the resource
operationId: servicePrincipal.remoteDesktopSecurityConfiguration.approvedClientApp_GetCount
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/servicePrincipals/{servicePrincipal-id}/remoteDesktopSecurityConfiguration/targetDeviceGroups':
get:
tags:
- servicePrincipals.remoteDesktopSecurityConfiguration
summary: List targetDeviceGroups
description: Get a list of the targetDeviceGroup objects and their properties on the remoteDesktopSecurityConfiguration resource on the servicePrincipal. Any user authenticating using the Microsoft Entra ID Remote Desktop Services (RDS) authentication protocol to a Microsoft Entra joined or Microsoft Entra hybrid joined device that belongs to the targetDeviceGroup will get SSO.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/remotedesktopsecurityconfiguration-list-targetdevicegroups?view=graph-rest-1.0
operationId: servicePrincipal.remoteDesktopSecurityConfiguration_ListTargetDeviceGroup
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- $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.targetDeviceGroupCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- servicePrincipals.remoteDesktopSecurityConfiguration
summary: Create targetDeviceGroup
description: Create a new targetDeviceGroup object for the remoteDesktopSecurityConfiguration object on the servicePrincipal. You can configure a maximum of 10 target device groups for the remoteDesktopSecurityConfiguration object on the servicePrincipal.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/remotedesktopsecurityconfiguration-post-targetdevicegroups?view=graph-rest-1.0
operationId: servicePrincipal.remoteDesktopSecurityConfiguration_CreateTargetDeviceGroup
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.targetDeviceGroup'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.targetDeviceGroup'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/servicePrincipals/{servicePrincipal-id}/remoteDesktopSecurityConfiguration/targetDeviceGroups/{targetDeviceGroup-id}':
get:
tags:
- servicePrincipals.remoteDesktopSecurityConfiguration
summary: Get targetDeviceGroup
description: Read the properties and relationships of a targetDeviceGroup object for the remoteDesktopSecurityConfiguration object on the servicePrincipal.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/targetdevicegroup-get?view=graph-rest-1.0
operationId: servicePrincipal.remoteDesktopSecurityConfiguration_GetTargetDeviceGroup
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- name: targetDeviceGroup-id
in: path
description: The unique identifier of targetDeviceGroup
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: targetDeviceGroup
- 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.targetDeviceGroup'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- servicePrincipals.remoteDesktopSecurityConfiguration
summary: Update targetDeviceGroup
description: Update the properties of a targetDeviceGroup object for remoteDesktopSecurityConfiguration object on the servicePrincipal. You can configure a maximum of 10 target device groups for the remoteDesktopSecurityConfiguraiton object on the servicePrincipal.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/targetdevicegroup-update?view=graph-rest-1.0
operationId: servicePrincipal.remoteDesktopSecurityConfiguration_UpdateTargetDeviceGroup
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- name: targetDeviceGroup-id
in: path
description: The unique identifier of targetDeviceGroup
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: targetDeviceGroup
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.targetDeviceGroup'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.targetDeviceGroup'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- servicePrincipals.remoteDesktopSecurityConfiguration
summary: Delete targetDeviceGroup
description: Delete a targetDeviceGroup object for the remoteDesktopSecurityConfiguration object on the servicePrincipal. Any user authenticating using the Microsoft Entra ID Remote Desktop Services (RDS) authentication protocol to a Microsoft Entra joined or Microsoft Entra hybrid joined device that's in the removed targetDeviceGroup doesn't get SSO prompts.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/remotedesktopsecurityconfiguration-delete-targetdevicegroups?view=graph-rest-1.0
operationId: servicePrincipal.remoteDesktopSecurityConfiguration_DeleteTargetDeviceGroup
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- name: targetDeviceGroup-id
in: path
description: The unique identifier of targetDeviceGroup
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: targetDeviceGroup
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/servicePrincipals/{servicePrincipal-id}/remoteDesktopSecurityConfiguration/targetDeviceGroups/$count':
get:
tags:
- servicePrincipals.remoteDesktopSecurityConfiguration
summary: Get the number of the resource
operationId: servicePrincipal.remoteDesktopSecurityConfiguration.targetDeviceGroup_GetCount
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/servicePrincipals/{servicePrincipal-id}/synchronization':
get:
tags:
- servicePrincipals.synchronization
summary: Get synchronization from servicePrincipals
description: Represents the capability for Microsoft Entra identity synchronization through the Microsoft Graph API.
operationId: servicePrincipal_GetSynchronization
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- 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.synchronization'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
put:
tags:
- servicePrincipals.synchronization
summary: Update the navigation property synchronization in servicePrincipals
operationId: servicePrincipal_SetSynchronization
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.synchronization'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.synchronization'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- servicePrincipals.synchronization
summary: Delete navigation property synchronization for servicePrincipals
operationId: servicePrincipal_DeleteSynchronization
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/servicePrincipals/{servicePrincipal-id}/synchronization/jobs':
get:
tags:
- servicePrincipals.synchronization
summary: List synchronization jobs
description: List existing synchronizationJob objects for a given application instance (service principal).
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/synchronization-synchronization-list-jobs?view=graph-rest-1.0
operationId: servicePrincipal.synchronization_ListJob
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- $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.synchronizationJobCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- servicePrincipals.synchronization
summary: Create synchronizationJob
description: Create a new synchronizationJob with a default synchronization schema. The job is created in a disabled state. Call Start job to start synchronization.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/synchronization-synchronization-post-jobs?view=graph-rest-1.0
operationId: servicePrincipal.synchronization_CreateJob
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.synchronizationJob'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.synchronizationJob'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/servicePrincipals/{servicePrincipal-id}/synchronization/jobs/{synchronizationJob-id}':
get:
tags:
- servicePrincipals.synchronization
summary: Get synchronizationJob
description: Retrieve an existing synchronizationJob and its properties.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/synchronization-synchronizationjob-get?view=graph-rest-1.0
operationId: servicePrincipal.synchronization_GetJob
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- name: synchronizationJob-id
in: path
description: The unique identifier of synchronizationJob
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: synchronizationJob
- 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.synchronizationJob'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- servicePrincipals.synchronization
summary: Update the navigation property jobs in servicePrincipals
operationId: servicePrincipal.synchronization_UpdateJob
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- name: synchronizationJob-id
in: path
description: The unique identifier of synchronizationJob
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: synchronizationJob
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.synchronizationJob'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.synchronizationJob'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- servicePrincipals.synchronization
summary: Delete synchronizationJob
description: 'Stop the synchronizationJob, and permanently delete all the state associated with it. Synchronized accounts are left as-is.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/synchronization-synchronizationjob-delete?view=graph-rest-1.0
operationId: servicePrincipal.synchronization_DeleteJob
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- name: synchronizationJob-id
in: path
description: The unique identifier of synchronizationJob
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: synchronizationJob
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/servicePrincipals/{servicePrincipal-id}/synchronization/jobs/{synchronizationJob-id}/bulkUpload':
get:
tags:
- servicePrincipals.synchronization
summary: Get bulkUpload from servicePrincipals
description: The bulk upload operation for the job.
operationId: servicePrincipal.synchronization.job_GetBulkUpload
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- name: synchronizationJob-id
in: path
description: The unique identifier of synchronizationJob
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: synchronizationJob
- 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.bulkUpload'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- servicePrincipals.synchronization
summary: Update the navigation property bulkUpload in servicePrincipals
operationId: servicePrincipal.synchronization.job_UpdateBulkUpload
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- name: synchronizationJob-id
in: path
description: The unique identifier of synchronizationJob
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: synchronizationJob
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.bulkUpload'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.bulkUpload'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- servicePrincipals.synchronization
summary: Delete navigation property bulkUpload for servicePrincipals
operationId: servicePrincipal.synchronization.job_DeleteBulkUpload
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- name: synchronizationJob-id
in: path
description: The unique identifier of synchronizationJob
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: synchronizationJob
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/servicePrincipals/{servicePrincipal-id}/synchronization/jobs/{synchronizationJob-id}/bulkUpload/$value':
get:
tags:
- servicePrincipals.synchronization
summary: Get media content for the navigation property bulkUpload from servicePrincipals
description: The bulk upload operation for the job.
operationId: servicePrincipal.synchronization.job_GetBulkUploadContent
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- name: synchronizationJob-id
in: path
description: The unique identifier of synchronizationJob
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: synchronizationJob
responses:
2XX:
description: Retrieved media content
content:
application/octet-stream:
schema:
type: string
format: binary
default:
$ref: '#/components/responses/error'
put:
tags:
- servicePrincipals.synchronization
summary: Update media content for the navigation property bulkUpload in servicePrincipals
description: The bulk upload operation for the job.
operationId: servicePrincipal.synchronization.job_SetBulkUploadContent
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- name: synchronizationJob-id
in: path
description: The unique identifier of synchronizationJob
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: synchronizationJob
requestBody:
description: New media content.
content:
application/octet-stream:
schema:
type: string
format: binary
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
delete:
tags:
- servicePrincipals.synchronization
summary: Delete media content for the navigation property bulkUpload in servicePrincipals
description: The bulk upload operation for the job.
operationId: servicePrincipal.synchronization.job_DeleteBulkUploadContent
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- name: synchronizationJob-id
in: path
description: The unique identifier of synchronizationJob
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: synchronizationJob
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
'/servicePrincipals/{servicePrincipal-id}/synchronization/jobs/{synchronizationJob-id}/microsoft.graph.pause':
post:
tags:
- servicePrincipals.synchronization
summary: Invoke action pause
description: 'Temporarily stop a running synchronizationJob. All the progress, including job state, is persisted, and the job will continue from where it left off when a start call is made.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/synchronization-synchronizationjob-pause?view=graph-rest-1.0
operationId: servicePrincipal.synchronization.job_pause
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- name: synchronizationJob-id
in: path
description: The unique identifier of synchronizationJob
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: synchronizationJob
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/servicePrincipals/{servicePrincipal-id}/synchronization/jobs/{synchronizationJob-id}/microsoft.graph.provisionOnDemand':
post:
tags:
- servicePrincipals.synchronization
summary: Invoke action provisionOnDemand
description: Select a user and provision the account on-demand for a synchronizationJob. The rate limit for this API is 5 requests per 10 seconds.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/synchronization-synchronizationjob-provisionondemand?view=graph-rest-1.0
operationId: servicePrincipal.synchronization.job_provisionOnDemand
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- name: synchronizationJob-id
in: path
description: The unique identifier of synchronizationJob
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: synchronizationJob
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
parameters:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.synchronizationJobApplicationParameters'
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.stringKeyStringValuePair'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/servicePrincipals/{servicePrincipal-id}/synchronization/jobs/{synchronizationJob-id}/microsoft.graph.restart':
post:
tags:
- servicePrincipals.synchronization
summary: Invoke action restart
description: 'Restart a stopped synchronizationJob, forcing it to reprocess all the objects in the directory. Optionally clears existing the synchronization state and previous errors.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/synchronization-synchronizationjob-restart?view=graph-rest-1.0
operationId: servicePrincipal.synchronization.job_restart
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- name: synchronizationJob-id
in: path
description: The unique identifier of synchronizationJob
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: synchronizationJob
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
criteria:
$ref: '#/components/schemas/microsoft.graph.synchronizationJobRestartCriteria'
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/servicePrincipals/{servicePrincipal-id}/synchronization/jobs/{synchronizationJob-id}/microsoft.graph.start':
post:
tags:
- servicePrincipals.synchronization
summary: Invoke action start
description: 'Start an existing synchronizationJob. If the job is in a paused state, it continues processing changes from the point where it was paused. If the job is in quarantine, the quarantine status is cleared. Don''t create scripts to call the start job continuously while it''s running because that can cause the service to stop running. Use the start job only when the job is currently paused or in quarantine. '
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/synchronization-synchronizationjob-start?view=graph-rest-1.0
operationId: servicePrincipal.synchronization.job_start
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- name: synchronizationJob-id
in: path
description: The unique identifier of synchronizationJob
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: synchronizationJob
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/servicePrincipals/{servicePrincipal-id}/synchronization/jobs/{synchronizationJob-id}/microsoft.graph.validateCredentials':
post:
tags:
- servicePrincipals.synchronization
summary: Invoke action validateCredentials
description: Validate that the credentials are valid in the tenant for a synchronizationJob.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/synchronization-synchronizationjob-validatecredentials?view=graph-rest-1.0
operationId: servicePrincipal.synchronization.job_validateCredential
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- name: synchronizationJob-id
in: path
description: The unique identifier of synchronizationJob
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: synchronizationJob
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
applicationIdentifier:
type: string
nullable: true
templateId:
type: string
nullable: true
useSavedCredentials:
type: boolean
default: false
nullable: true
credentials:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.synchronizationSecretKeyStringValuePair'
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/servicePrincipals/{servicePrincipal-id}/synchronization/jobs/{synchronizationJob-id}/schema':
get:
tags:
- servicePrincipals.synchronization
summary: Get synchronizationSchema
description: Retrieve the synchronizationSchema for a given synchronization job or template.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/synchronization-synchronizationschema-get?view=graph-rest-1.0
operationId: servicePrincipal.synchronization.job_GetSchema
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- name: synchronizationJob-id
in: path
description: The unique identifier of synchronizationJob
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: synchronizationJob
- 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.synchronizationSchema'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- servicePrincipals.synchronization
summary: Update synchronizationSchema
description: 'Update the synchronizationSchema for a given job or template. This method fully replaces the current schema with the one provided in the request. To update the schema of a template, make the call on the application object. You must be the owner of the application.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/synchronization-synchronizationschema-update?view=graph-rest-1.0
operationId: servicePrincipal.synchronization.job_UpdateSchema
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- name: synchronizationJob-id
in: path
description: The unique identifier of synchronizationJob
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: synchronizationJob
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.synchronizationSchema'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.synchronizationSchema'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- servicePrincipals.synchronization
summary: Delete navigation property schema for servicePrincipals
operationId: servicePrincipal.synchronization.job_DeleteSchema
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- name: synchronizationJob-id
in: path
description: The unique identifier of synchronizationJob
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: synchronizationJob
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/servicePrincipals/{servicePrincipal-id}/synchronization/jobs/{synchronizationJob-id}/schema/directories':
get:
tags:
- servicePrincipals.synchronization
summary: Get directories from servicePrincipals
description: Contains the collection of directories and all of their objects.
operationId: servicePrincipal.synchronization.job.schema_ListDirectory
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- name: synchronizationJob-id
in: path
description: The unique identifier of synchronizationJob
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: synchronizationJob
- $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.directoryDefinitionCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- servicePrincipals.synchronization
summary: Create new navigation property to directories for servicePrincipals
operationId: servicePrincipal.synchronization.job.schema_CreateDirectory
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- name: synchronizationJob-id
in: path
description: The unique identifier of synchronizationJob
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: synchronizationJob
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.directoryDefinition'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.directoryDefinition'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/servicePrincipals/{servicePrincipal-id}/synchronization/jobs/{synchronizationJob-id}/schema/directories/{directoryDefinition-id}':
get:
tags:
- servicePrincipals.synchronization
summary: Get directories from servicePrincipals
description: Contains the collection of directories and all of their objects.
operationId: servicePrincipal.synchronization.job.schema_GetDirectory
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- name: synchronizationJob-id
in: path
description: The unique identifier of synchronizationJob
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: synchronizationJob
- name: directoryDefinition-id
in: path
description: The unique identifier of directoryDefinition
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: directoryDefinition
- 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.directoryDefinition'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- servicePrincipals.synchronization
summary: Update the navigation property directories in servicePrincipals
operationId: servicePrincipal.synchronization.job.schema_UpdateDirectory
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- name: synchronizationJob-id
in: path
description: The unique identifier of synchronizationJob
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: synchronizationJob
- name: directoryDefinition-id
in: path
description: The unique identifier of directoryDefinition
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: directoryDefinition
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.directoryDefinition'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.directoryDefinition'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- servicePrincipals.synchronization
summary: Delete navigation property directories for servicePrincipals
operationId: servicePrincipal.synchronization.job.schema_DeleteDirectory
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- name: synchronizationJob-id
in: path
description: The unique identifier of synchronizationJob
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: synchronizationJob
- name: directoryDefinition-id
in: path
description: The unique identifier of directoryDefinition
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: directoryDefinition
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/servicePrincipals/{servicePrincipal-id}/synchronization/jobs/{synchronizationJob-id}/schema/directories/{directoryDefinition-id}/microsoft.graph.discover':
post:
tags:
- servicePrincipals.synchronization
summary: Invoke action discover
description: Discover the latest schema definition for provisioning to an application for the directoryDefinition.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/synchronization-directorydefinition-discover?view=graph-rest-1.0
operationId: servicePrincipal.synchronization.job.schema.directory_discover
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- name: synchronizationJob-id
in: path
description: The unique identifier of synchronizationJob
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: synchronizationJob
- name: directoryDefinition-id
in: path
description: The unique identifier of directoryDefinition
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: directoryDefinition
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.directoryDefinition'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/servicePrincipals/{servicePrincipal-id}/synchronization/jobs/{synchronizationJob-id}/schema/directories/$count':
get:
tags:
- servicePrincipals.synchronization
summary: Get the number of the resource
operationId: servicePrincipal.synchronization.job.schema.directory_GetCount
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- name: synchronizationJob-id
in: path
description: The unique identifier of synchronizationJob
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: synchronizationJob
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/servicePrincipals/{servicePrincipal-id}/synchronization/jobs/{synchronizationJob-id}/schema/microsoft.graph.filterOperators()':
get:
tags:
- servicePrincipals.synchronization
summary: Invoke function filterOperators
description: List all operators supported in the scoping filters for a synchronizationSchema.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/synchronization-synchronizationschema-filteroperators?view=graph-rest-1.0
operationId: servicePrincipal.synchronization.job.schema_filterOperator
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- name: synchronizationJob-id
in: path
description: The unique identifier of synchronizationJob
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: synchronizationJob
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $orderby
in: query
description: Order items by property values
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: Success
content:
application/json:
schema:
title: Collection of filterOperatorSchema
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.filterOperatorSchema'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
'/servicePrincipals/{servicePrincipal-id}/synchronization/jobs/{synchronizationJob-id}/schema/microsoft.graph.functions()':
get:
tags:
- servicePrincipals.synchronization
summary: Invoke function functions
description: List all the functions currently supported in the attributeMappingSource for a synchronizationSchema.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/synchronization-synchronizationschema-functions?view=graph-rest-1.0
operationId: servicePrincipal.synchronization.job.schema_function
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- name: synchronizationJob-id
in: path
description: The unique identifier of synchronizationJob
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: synchronizationJob
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $orderby
in: query
description: Order items by property values
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: Success
content:
application/json:
schema:
title: Collection of attributeMappingFunctionSchema
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.attributeMappingFunctionSchema'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
'/servicePrincipals/{servicePrincipal-id}/synchronization/jobs/{synchronizationJob-id}/schema/microsoft.graph.parseExpression':
post:
tags:
- servicePrincipals.synchronization
summary: Invoke action parseExpression
description: 'Parse a given string expression into an attributeMappingSource object for a synchronizationSchema. For more information about expressions, see Writing Expressions for Attribute Mappings in Microsoft Entra ID.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/synchronization-synchronizationschema-parseexpression?view=graph-rest-1.0
operationId: servicePrincipal.synchronization.job.schema_parseExpression
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- name: synchronizationJob-id
in: path
description: The unique identifier of synchronizationJob
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: synchronizationJob
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
expression:
type: string
nullable: true
testInputObject:
$ref: '#/components/schemas/microsoft.graph.expressionInputObject'
targetAttributeDefinition:
$ref: '#/components/schemas/microsoft.graph.attributeDefinition'
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.parseExpressionResponse'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/servicePrincipals/{servicePrincipal-id}/synchronization/jobs/$count':
get:
tags:
- servicePrincipals.synchronization
summary: Get the number of the resource
operationId: servicePrincipal.synchronization.job_GetCount
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/servicePrincipals/{servicePrincipal-id}/synchronization/jobs/microsoft.graph.validateCredentials':
post:
tags:
- servicePrincipals.synchronization
summary: Invoke action validateCredentials
operationId: servicePrincipal.synchronization.job_validateCredential
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
applicationIdentifier:
type: string
nullable: true
templateId:
type: string
nullable: true
useSavedCredentials:
type: boolean
default: false
nullable: true
credentials:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.synchronizationSecretKeyStringValuePair'
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/servicePrincipals/{servicePrincipal-id}/synchronization/microsoft.graph.acquireAccessToken':
post:
tags:
- servicePrincipals.synchronization
summary: Invoke action acquireAccessToken
description: Acquire an OAuth access token from the synchronization resource to authorize the Microsoft Entra provisioning service to provision users into an application.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/synchronization-synchronization-acquireaccesstoken?view=graph-rest-1.0
operationId: servicePrincipal.synchronization_acquireAccessToken
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
credentials:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.synchronizationSecretKeyStringValuePair'
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/servicePrincipals/{servicePrincipal-id}/synchronization/secrets':
put:
tags:
- servicePrincipals.synchronization
summary: Add synchronization secrets
description: Provide credentials for establishing connectivity with the target system and store them in the synchronization resource.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/synchronization-serviceprincipal-put-synchronization?view=graph-rest-1.0
operationId: servicePrincipal.synchronization_SetSecret
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
requestBody:
description: New property values
content:
application/json:
schema:
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.synchronizationSecretKeyStringValuePair'
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.synchronizationSecretKeyStringValuePair'
additionalProperties:
type: object
default:
$ref: '#/components/responses/error'
'/servicePrincipals/{servicePrincipal-id}/synchronization/secrets/$count':
get:
tags:
- servicePrincipals.synchronization
summary: Get the number of the resource
operationId: servicePrincipal.synchronization.Secret_GetCount
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/servicePrincipals/{servicePrincipal-id}/synchronization/templates':
get:
tags:
- servicePrincipals.synchronization
summary: List existing synchronization templates
description: List synchronizationTemplate objects associated with a given application or service principal.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/synchronization-synchronization-list-templates?view=graph-rest-1.0
operationId: servicePrincipal.synchronization_ListTemplate
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- $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.synchronizationTemplateCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- servicePrincipals.synchronization
summary: Create new navigation property to templates for servicePrincipals
operationId: servicePrincipal.synchronization_CreateTemplate
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.synchronizationTemplate'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.synchronizationTemplate'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/servicePrincipals/{servicePrincipal-id}/synchronization/templates/{synchronizationTemplate-id}':
get:
tags:
- servicePrincipals.synchronization
summary: Get templates from servicePrincipals
description: Preconfigured synchronization settings for a particular application.
operationId: servicePrincipal.synchronization_GetTemplate
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- name: synchronizationTemplate-id
in: path
description: The unique identifier of synchronizationTemplate
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: synchronizationTemplate
- 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.synchronizationTemplate'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- servicePrincipals.synchronization
summary: Update the navigation property templates in servicePrincipals
operationId: servicePrincipal.synchronization_UpdateTemplate
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- name: synchronizationTemplate-id
in: path
description: The unique identifier of synchronizationTemplate
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: synchronizationTemplate
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.synchronizationTemplate'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.synchronizationTemplate'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- servicePrincipals.synchronization
summary: Delete navigation property templates for servicePrincipals
operationId: servicePrincipal.synchronization_DeleteTemplate
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- name: synchronizationTemplate-id
in: path
description: The unique identifier of synchronizationTemplate
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: synchronizationTemplate
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/servicePrincipals/{servicePrincipal-id}/synchronization/templates/{synchronizationTemplate-id}/schema':
get:
tags:
- servicePrincipals.synchronization
summary: Get schema from servicePrincipals
description: Default synchronization schema for the jobs based on this template.
operationId: servicePrincipal.synchronization.template_GetSchema
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- name: synchronizationTemplate-id
in: path
description: The unique identifier of synchronizationTemplate
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: synchronizationTemplate
- 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.synchronizationSchema'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- servicePrincipals.synchronization
summary: Update the navigation property schema in servicePrincipals
operationId: servicePrincipal.synchronization.template_UpdateSchema
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- name: synchronizationTemplate-id
in: path
description: The unique identifier of synchronizationTemplate
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: synchronizationTemplate
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.synchronizationSchema'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.synchronizationSchema'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- servicePrincipals.synchronization
summary: Delete navigation property schema for servicePrincipals
operationId: servicePrincipal.synchronization.template_DeleteSchema
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- name: synchronizationTemplate-id
in: path
description: The unique identifier of synchronizationTemplate
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: synchronizationTemplate
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/servicePrincipals/{servicePrincipal-id}/synchronization/templates/{synchronizationTemplate-id}/schema/directories':
get:
tags:
- servicePrincipals.synchronization
summary: Get directories from servicePrincipals
description: Contains the collection of directories and all of their objects.
operationId: servicePrincipal.synchronization.template.schema_ListDirectory
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- name: synchronizationTemplate-id
in: path
description: The unique identifier of synchronizationTemplate
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: synchronizationTemplate
- $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.directoryDefinitionCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- servicePrincipals.synchronization
summary: Create new navigation property to directories for servicePrincipals
operationId: servicePrincipal.synchronization.template.schema_CreateDirectory
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- name: synchronizationTemplate-id
in: path
description: The unique identifier of synchronizationTemplate
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: synchronizationTemplate
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.directoryDefinition'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.directoryDefinition'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/servicePrincipals/{servicePrincipal-id}/synchronization/templates/{synchronizationTemplate-id}/schema/directories/{directoryDefinition-id}':
get:
tags:
- servicePrincipals.synchronization
summary: Get directories from servicePrincipals
description: Contains the collection of directories and all of their objects.
operationId: servicePrincipal.synchronization.template.schema_GetDirectory
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- name: synchronizationTemplate-id
in: path
description: The unique identifier of synchronizationTemplate
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: synchronizationTemplate
- name: directoryDefinition-id
in: path
description: The unique identifier of directoryDefinition
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: directoryDefinition
- 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.directoryDefinition'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- servicePrincipals.synchronization
summary: Update the navigation property directories in servicePrincipals
operationId: servicePrincipal.synchronization.template.schema_UpdateDirectory
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- name: synchronizationTemplate-id
in: path
description: The unique identifier of synchronizationTemplate
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: synchronizationTemplate
- name: directoryDefinition-id
in: path
description: The unique identifier of directoryDefinition
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: directoryDefinition
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.directoryDefinition'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.directoryDefinition'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- servicePrincipals.synchronization
summary: Delete navigation property directories for servicePrincipals
operationId: servicePrincipal.synchronization.template.schema_DeleteDirectory
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- name: synchronizationTemplate-id
in: path
description: The unique identifier of synchronizationTemplate
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: synchronizationTemplate
- name: directoryDefinition-id
in: path
description: The unique identifier of directoryDefinition
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: directoryDefinition
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/servicePrincipals/{servicePrincipal-id}/synchronization/templates/{synchronizationTemplate-id}/schema/directories/{directoryDefinition-id}/microsoft.graph.discover':
post:
tags:
- servicePrincipals.synchronization
summary: Invoke action discover
description: Discover the latest schema definition for provisioning to an application for the directoryDefinition.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/synchronization-directorydefinition-discover?view=graph-rest-1.0
operationId: servicePrincipal.synchronization.template.schema.directory_discover
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- name: synchronizationTemplate-id
in: path
description: The unique identifier of synchronizationTemplate
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: synchronizationTemplate
- name: directoryDefinition-id
in: path
description: The unique identifier of directoryDefinition
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: directoryDefinition
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.directoryDefinition'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/servicePrincipals/{servicePrincipal-id}/synchronization/templates/{synchronizationTemplate-id}/schema/directories/$count':
get:
tags:
- servicePrincipals.synchronization
summary: Get the number of the resource
operationId: servicePrincipal.synchronization.template.schema.directory_GetCount
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- name: synchronizationTemplate-id
in: path
description: The unique identifier of synchronizationTemplate
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: synchronizationTemplate
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/servicePrincipals/{servicePrincipal-id}/synchronization/templates/{synchronizationTemplate-id}/schema/microsoft.graph.filterOperators()':
get:
tags:
- servicePrincipals.synchronization
summary: Invoke function filterOperators
description: List all operators supported in the scoping filters for a synchronizationSchema.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/synchronization-synchronizationschema-filteroperators?view=graph-rest-1.0
operationId: servicePrincipal.synchronization.template.schema_filterOperator
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- name: synchronizationTemplate-id
in: path
description: The unique identifier of synchronizationTemplate
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: synchronizationTemplate
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $orderby
in: query
description: Order items by property values
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: Success
content:
application/json:
schema:
title: Collection of filterOperatorSchema
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.filterOperatorSchema'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
'/servicePrincipals/{servicePrincipal-id}/synchronization/templates/{synchronizationTemplate-id}/schema/microsoft.graph.functions()':
get:
tags:
- servicePrincipals.synchronization
summary: Invoke function functions
description: List all the functions currently supported in the attributeMappingSource for a synchronizationSchema.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/synchronization-synchronizationschema-functions?view=graph-rest-1.0
operationId: servicePrincipal.synchronization.template.schema_function
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- name: synchronizationTemplate-id
in: path
description: The unique identifier of synchronizationTemplate
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: synchronizationTemplate
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $orderby
in: query
description: Order items by property values
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: Success
content:
application/json:
schema:
title: Collection of attributeMappingFunctionSchema
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.attributeMappingFunctionSchema'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
'/servicePrincipals/{servicePrincipal-id}/synchronization/templates/{synchronizationTemplate-id}/schema/microsoft.graph.parseExpression':
post:
tags:
- servicePrincipals.synchronization
summary: Invoke action parseExpression
description: 'Parse a given string expression into an attributeMappingSource object for a synchronizationSchema. For more information about expressions, see Writing Expressions for Attribute Mappings in Microsoft Entra ID.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/synchronization-synchronizationschema-parseexpression?view=graph-rest-1.0
operationId: servicePrincipal.synchronization.template.schema_parseExpression
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- name: synchronizationTemplate-id
in: path
description: The unique identifier of synchronizationTemplate
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: synchronizationTemplate
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
expression:
type: string
nullable: true
testInputObject:
$ref: '#/components/schemas/microsoft.graph.expressionInputObject'
targetAttributeDefinition:
$ref: '#/components/schemas/microsoft.graph.attributeDefinition'
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.parseExpressionResponse'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/servicePrincipals/{servicePrincipal-id}/synchronization/templates/$count':
get:
tags:
- servicePrincipals.synchronization
summary: Get the number of the resource
operationId: servicePrincipal.synchronization.template_GetCount
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/servicePrincipals/{servicePrincipal-id}/tokenIssuancePolicies':
get:
tags:
- servicePrincipals.tokenIssuancePolicy
summary: Get tokenIssuancePolicies from servicePrincipals
description: The tokenIssuancePolicies assigned to this service principal.
operationId: servicePrincipal_ListTokenIssuancePolicy
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- $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.tokenIssuancePolicyCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
'/servicePrincipals/{servicePrincipal-id}/tokenIssuancePolicies/{tokenIssuancePolicy-id}/$ref':
delete:
tags:
- servicePrincipals.tokenIssuancePolicy
summary: Delete ref of navigation property tokenIssuancePolicies for servicePrincipals
operationId: servicePrincipal.tokenIssuancePolicy_DeleteTokenIssuancePolicyGraphBPreRef
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- name: tokenIssuancePolicy-id
in: path
description: The unique identifier of tokenIssuancePolicy
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: tokenIssuancePolicy
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/servicePrincipals/{servicePrincipal-id}/tokenIssuancePolicies/$count':
get:
tags:
- servicePrincipals.tokenIssuancePolicy
summary: Get the number of the resource
operationId: servicePrincipal.tokenIssuancePolicy_GetCount
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/servicePrincipals/{servicePrincipal-id}/tokenIssuancePolicies/$ref':
get:
tags:
- servicePrincipals.tokenIssuancePolicy
summary: Get ref of tokenIssuancePolicies from servicePrincipals
description: The tokenIssuancePolicies assigned to this service principal.
operationId: servicePrincipal_ListTokenIssuancePolicyGraphBPreRef
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- $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
responses:
2XX:
$ref: '#/components/responses/StringCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- servicePrincipals.tokenIssuancePolicy
summary: Create new navigation property ref to tokenIssuancePolicies for servicePrincipals
operationId: servicePrincipal_CreateTokenIssuancePolicyGraphBPreRef
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
requestBody:
$ref: '#/components/requestBodies/refPostBody'
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- servicePrincipals.tokenIssuancePolicy
summary: Delete ref of navigation property tokenIssuancePolicies for servicePrincipals
operationId: servicePrincipal_DeleteTokenIssuancePolicyGraphBPreRef
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
- name: '@id'
in: query
description: The delete Uri
required: true
style: form
explode: false
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/servicePrincipals/{servicePrincipal-id}/tokenLifetimePolicies':
get:
tags:
- servicePrincipals.tokenLifetimePolicy
summary: List assigned tokenLifetimePolicies
description: List the tokenLifetimePolicy objects that are assigned to a servicePrincipal. Only one object is returned in the collection because only one tokenLifetimePolicy can be assigned to a service principal.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/serviceprincipal-list-tokenlifetimepolicies?view=graph-rest-1.0
operationId: servicePrincipal_ListTokenLifetimePolicy
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- $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.tokenLifetimePolicyCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
'/servicePrincipals/{servicePrincipal-id}/tokenLifetimePolicies/{tokenLifetimePolicy-id}/$ref':
delete:
tags:
- servicePrincipals.tokenLifetimePolicy
summary: Remove tokenLifetimePolicies
description: Remove a tokenLifetimePolicy object from a service principal.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/serviceprincipal-delete-tokenlifetimepolicies?view=graph-rest-1.0
operationId: servicePrincipal.tokenLifetimePolicy_DeleteTokenLifetimePolicyGraphBPreRef
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- name: tokenLifetimePolicy-id
in: path
description: The unique identifier of tokenLifetimePolicy
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: tokenLifetimePolicy
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/servicePrincipals/{servicePrincipal-id}/tokenLifetimePolicies/$count':
get:
tags:
- servicePrincipals.tokenLifetimePolicy
summary: Get the number of the resource
operationId: servicePrincipal.tokenLifetimePolicy_GetCount
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/servicePrincipals/{servicePrincipal-id}/tokenLifetimePolicies/$ref':
get:
tags:
- servicePrincipals.tokenLifetimePolicy
summary: List assigned tokenLifetimePolicies
description: List the tokenLifetimePolicy objects that are assigned to a servicePrincipal. Only one object is returned in the collection because only one tokenLifetimePolicy can be assigned to a service principal.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/serviceprincipal-list-tokenlifetimepolicies?view=graph-rest-1.0
operationId: servicePrincipal_ListTokenLifetimePolicyGraphBPreRef
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- $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
responses:
2XX:
$ref: '#/components/responses/StringCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- servicePrincipals.tokenLifetimePolicy
summary: Add tokenLifetimePolicy
description: Assign a tokenLifetimePolicy to a servicePrincipal. You can have multiple tokenLifetimePolicy policies in a tenant but can assign only one tokenLifetimePolicy per service principal.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/serviceprincipal-post-tokenlifetimepolicies?view=graph-rest-1.0
operationId: servicePrincipal_CreateTokenLifetimePolicyGraphBPreRef
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
requestBody:
$ref: '#/components/requestBodies/refPostBody'
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- servicePrincipals.tokenLifetimePolicy
summary: Remove tokenLifetimePolicies
description: Remove a tokenLifetimePolicy object from a service principal.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/serviceprincipal-delete-tokenlifetimepolicies?view=graph-rest-1.0
operationId: servicePrincipal_DeleteTokenLifetimePolicyGraphBPreRef
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
- name: '@id'
in: query
description: The delete Uri
required: true
style: form
explode: false
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/servicePrincipals/{servicePrincipal-id}/transitiveMemberOf':
get:
tags:
- servicePrincipals.directoryObject
summary: List servicePrincipal transitive memberOf
description: Get the groups and directory roles that this servicePrincipal is a member of. This operation is transitive and will include all groups that this service principal is a nested member of.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/serviceprincipal-list-transitivememberof?view=graph-rest-1.0
operationId: servicePrincipal_ListTransitiveMemberGraphOPre
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- name: ConsistencyLevel
in: header
description: 'Indicates the requested consistency level. Documentation URL: https://docs.microsoft.com/graph/aad-advanced-queries'
style: simple
schema:
type: string
examples:
example-1:
description: $search and $count queries require the client to set the ConsistencyLevel HTTP header to 'eventual'.
value: eventual
- $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.directoryObjectCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
'/servicePrincipals/{servicePrincipal-id}/transitiveMemberOf/{directoryObject-id}':
get:
tags:
- servicePrincipals.directoryObject
summary: Get transitiveMemberOf from servicePrincipals
operationId: servicePrincipal_GetTransitiveMemberGraphOPre
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- name: directoryObject-id
in: path
description: The unique identifier of directoryObject
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: directoryObject
- name: ConsistencyLevel
in: header
description: 'Indicates the requested consistency level. Documentation URL: https://docs.microsoft.com/graph/aad-advanced-queries'
style: simple
schema:
type: string
examples:
example-1:
description: $search and $count queries require the client to set the ConsistencyLevel HTTP header to 'eventual'.
value: eventual
- 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.directoryObject'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/servicePrincipals/{servicePrincipal-id}/transitiveMemberOf/{directoryObject-id}/microsoft.graph.administrativeUnit':
get:
tags:
- servicePrincipals.directoryObject
summary: Get the item of type microsoft.graph.directoryObject as microsoft.graph.administrativeUnit
operationId: servicePrincipal_GetTransitiveMemberGraphOPreAsAdministrativeUnit
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- name: directoryObject-id
in: path
description: The unique identifier of directoryObject
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: directoryObject
- name: ConsistencyLevel
in: header
description: 'Indicates the requested consistency level. Documentation URL: https://docs.microsoft.com/graph/aad-advanced-queries'
style: simple
schema:
type: string
examples:
example-1:
description: $search and $count queries require the client to set the ConsistencyLevel HTTP header to 'eventual'.
value: eventual
- 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: Entity result.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.administrativeUnit'
default:
$ref: '#/components/responses/error'
'/servicePrincipals/{servicePrincipal-id}/transitiveMemberOf/{directoryObject-id}/microsoft.graph.directoryRole':
get:
tags:
- servicePrincipals.directoryObject
summary: Get the item of type microsoft.graph.directoryObject as microsoft.graph.directoryRole
operationId: servicePrincipal_GetTransitiveMemberGraphOPreAsDirectoryRole
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- name: directoryObject-id
in: path
description: The unique identifier of directoryObject
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: directoryObject
- name: ConsistencyLevel
in: header
description: 'Indicates the requested consistency level. Documentation URL: https://docs.microsoft.com/graph/aad-advanced-queries'
style: simple
schema:
type: string
examples:
example-1:
description: $search and $count queries require the client to set the ConsistencyLevel HTTP header to 'eventual'.
value: eventual
- 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: Entity result.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.directoryRole'
default:
$ref: '#/components/responses/error'
'/servicePrincipals/{servicePrincipal-id}/transitiveMemberOf/{directoryObject-id}/microsoft.graph.group':
get:
tags:
- servicePrincipals.directoryObject
summary: Get the item of type microsoft.graph.directoryObject as microsoft.graph.group
operationId: servicePrincipal_GetTransitiveMemberGraphOPreAsGroup
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- name: directoryObject-id
in: path
description: The unique identifier of directoryObject
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: directoryObject
- name: ConsistencyLevel
in: header
description: 'Indicates the requested consistency level. Documentation URL: https://docs.microsoft.com/graph/aad-advanced-queries'
style: simple
schema:
type: string
examples:
example-1:
description: $search and $count queries require the client to set the ConsistencyLevel HTTP header to 'eventual'.
value: eventual
- 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: Entity result.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.group'
default:
$ref: '#/components/responses/error'
'/servicePrincipals/{servicePrincipal-id}/transitiveMemberOf/$count':
get:
tags:
- servicePrincipals.directoryObject
summary: Get the number of the resource
operationId: servicePrincipal.transitiveMemberOf_GetCount
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- name: ConsistencyLevel
in: header
description: 'Indicates the requested consistency level. Documentation URL: https://docs.microsoft.com/graph/aad-advanced-queries'
style: simple
schema:
type: string
examples:
example-1:
description: $search and $count queries require the client to set the ConsistencyLevel HTTP header to 'eventual'.
value: eventual
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/servicePrincipals/{servicePrincipal-id}/transitiveMemberOf/microsoft.graph.administrativeUnit':
get:
tags:
- servicePrincipals.directoryObject
summary: Get the items of type microsoft.graph.administrativeUnit in the microsoft.graph.directoryObject collection
operationId: servicePrincipal_ListTransitiveMemberGraphOPreAsAdministrativeUnit
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- name: ConsistencyLevel
in: header
description: 'Indicates the requested consistency level. Documentation URL: https://docs.microsoft.com/graph/aad-advanced-queries'
style: simple
schema:
type: string
examples:
example-1:
description: $search and $count queries require the client to set the ConsistencyLevel HTTP header to 'eventual'.
value: eventual
- $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.administrativeUnitCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
'/servicePrincipals/{servicePrincipal-id}/transitiveMemberOf/microsoft.graph.administrativeUnit/$count':
get:
tags:
- servicePrincipals.directoryObject
summary: Get the number of the resource
operationId: servicePrincipal.TransitiveMemberOf_GetCountAsAdministrativeUnit
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- name: ConsistencyLevel
in: header
description: 'Indicates the requested consistency level. Documentation URL: https://docs.microsoft.com/graph/aad-advanced-queries'
style: simple
schema:
type: string
examples:
example-1:
description: $search and $count queries require the client to set the ConsistencyLevel HTTP header to 'eventual'.
value: eventual
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/servicePrincipals/{servicePrincipal-id}/transitiveMemberOf/microsoft.graph.directoryRole':
get:
tags:
- servicePrincipals.directoryObject
summary: Get the items of type microsoft.graph.directoryRole in the microsoft.graph.directoryObject collection
operationId: servicePrincipal_ListTransitiveMemberGraphOPreAsDirectoryRole
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- name: ConsistencyLevel
in: header
description: 'Indicates the requested consistency level. Documentation URL: https://docs.microsoft.com/graph/aad-advanced-queries'
style: simple
schema:
type: string
examples:
example-1:
description: $search and $count queries require the client to set the ConsistencyLevel HTTP header to 'eventual'.
value: eventual
- $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.directoryRoleCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
'/servicePrincipals/{servicePrincipal-id}/transitiveMemberOf/microsoft.graph.directoryRole/$count':
get:
tags:
- servicePrincipals.directoryObject
summary: Get the number of the resource
operationId: servicePrincipal.TransitiveMemberOf_GetCountAsDirectoryRole
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- name: ConsistencyLevel
in: header
description: 'Indicates the requested consistency level. Documentation URL: https://docs.microsoft.com/graph/aad-advanced-queries'
style: simple
schema:
type: string
examples:
example-1:
description: $search and $count queries require the client to set the ConsistencyLevel HTTP header to 'eventual'.
value: eventual
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/servicePrincipals/{servicePrincipal-id}/transitiveMemberOf/microsoft.graph.group':
get:
tags:
- servicePrincipals.directoryObject
summary: Get the items of type microsoft.graph.group in the microsoft.graph.directoryObject collection
operationId: servicePrincipal_ListTransitiveMemberGraphOPreAsGroup
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- name: ConsistencyLevel
in: header
description: 'Indicates the requested consistency level. Documentation URL: https://docs.microsoft.com/graph/aad-advanced-queries'
style: simple
schema:
type: string
examples:
example-1:
description: $search and $count queries require the client to set the ConsistencyLevel HTTP header to 'eventual'.
value: eventual
- $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.groupCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
'/servicePrincipals/{servicePrincipal-id}/transitiveMemberOf/microsoft.graph.group/$count':
get:
tags:
- servicePrincipals.directoryObject
summary: Get the number of the resource
operationId: servicePrincipal.TransitiveMemberOf_GetCountAsGroup
parameters:
- name: servicePrincipal-id
in: path
description: The unique identifier of servicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipal
- name: ConsistencyLevel
in: header
description: 'Indicates the requested consistency level. Documentation URL: https://docs.microsoft.com/graph/aad-advanced-queries'
style: simple
schema:
type: string
examples:
example-1:
description: $search and $count queries require the client to set the ConsistencyLevel HTTP header to 'eventual'.
value: eventual
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/servicePrincipals(appId=''{appId}'')':
get:
tags:
- servicePrincipals.servicePrincipal
summary: Get servicePrincipal
description: Retrieve the properties and relationships of a servicePrincipal object. This API can be used to get agentIdentityBlueprintPrincipal objects as well by their ID.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/serviceprincipal-get?view=graph-rest-1.0
operationId: servicePrincipal_GetServicePrincipalGraphBPreAppId
parameters:
- name: appId
in: path
description: Alternate key of servicePrincipal
required: true
style: simple
schema:
type: string
nullable: true
- 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.servicePrincipal'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- servicePrincipals.servicePrincipal
summary: Upsert servicePrincipal
description: 'Create a new servicePrincipal object if it doesn''t exist, or update the properties of an existing servicePrincipal object. This API can also create an agentIdentityBlueprintPrincipal object from an agentIdentityBlueprint if it doesn''t exist, or update properties of an existing agentIdentityBlueprintPrincipal, when the @odata.type property is set to #microsoft.graph.agentIdentityBlueprintPrincipal.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/serviceprincipal-upsert?view=graph-rest-1.0
operationId: servicePrincipal_UpdateServicePrincipalGraphBPreAppId
parameters:
- name: appId
in: path
description: Alternate key of servicePrincipal
required: true
style: simple
schema:
type: string
nullable: true
requestBody:
description: New property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.servicePrincipal'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.servicePrincipal'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- servicePrincipals.servicePrincipal
summary: Delete servicePrincipal
description: Delete a servicePrincipal object. This API can also delete an agentIdentityBlueprintPrincipal object by its ID.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/serviceprincipal-delete?view=graph-rest-1.0
operationId: servicePrincipal_DeleteServicePrincipalGraphBPreAppId
parameters:
- name: appId
in: path
description: Alternate key of servicePrincipal
required: true
style: simple
schema:
type: string
nullable: true
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
/servicePrincipals/$count:
get:
tags:
- servicePrincipals.servicePrincipal
summary: Get the number of the resource
operationId: servicePrincipal_GetCount
parameters:
- name: ConsistencyLevel
in: header
description: 'Indicates the requested consistency level. Documentation URL: https://docs.microsoft.com/graph/aad-advanced-queries'
style: simple
schema:
type: string
examples:
example-1:
description: $search and $count queries require the client to set the ConsistencyLevel HTTP header to 'eventual'.
value: eventual
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
/servicePrincipals/microsoft.graph.delta():
get:
tags:
- servicePrincipals.servicePrincipal.Functions
summary: Invoke function delta
description: 'Get newly created, updated, or deleted service principals without having to perform a full read of the entire resource collection. For more information, see Use delta query to track changes in Microsoft Graph data for details.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/serviceprincipal-delta?view=graph-rest-1.0
operationId: servicePrincipal_delta
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $orderby
in: query
description: Order items by property values
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: Success
content:
application/json:
schema:
title: Collection of servicePrincipal
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.servicePrincipal'
'@odata.nextLink':
type: string
nullable: true
'@odata.deltaLink':
type: string
nullable: true
additionalProperties:
type: object
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
/servicePrincipals/microsoft.graph.getAvailableExtensionProperties:
post:
tags:
- servicePrincipals.servicePrincipal.Actions
summary: Invoke action getAvailableExtensionProperties
description: 'Return all directory extension definitions that are registered in a directory, including through multitenant apps. The following entities support extension properties:'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/directoryobject-getavailableextensionproperties?view=graph-rest-1.0
operationId: servicePrincipal_getAvailableExtensionProperty
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
isSyncedFromOnPremises:
type: boolean
default: false
nullable: true
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
title: Collection of extensionProperty
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.extensionProperty'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
/servicePrincipals/microsoft.graph.getByIds:
post:
tags:
- servicePrincipals.servicePrincipal.Actions
summary: Invoke action getByIds
description: 'Return the directory objects specified in a list of IDs. Only a subset of user properties are returned by default in v1.0. Some common uses for this function are to:'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/directoryobject-getbyids?view=graph-rest-1.0
operationId: servicePrincipal_getGraphBPreId
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
ids:
type: array
items:
type: string
types:
type: array
items:
type: string
nullable: true
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
title: Collection of directoryObject
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
/servicePrincipals/microsoft.graph.validateProperties:
post:
tags:
- servicePrincipals.servicePrincipal.Actions
summary: Invoke action validateProperties
description: "Validate that a Microsoft 365 group's display name or mail nickname complies with naming policies. Clients can use this API to determine whether a display name or mail nickname is valid before trying to create a Microsoft 365 group. To validate the properties of an existing group, use the group: validateProperties function. The following policy validations are performed for the display name and mail nickname properties:\r\n1. Validate the prefix and suffix naming policy\r\n2. Validate the custom banned words policy\r\n3. Validate that the mail nickname is unique This API only returns the first validation failure that is encountered. If the properties fail multiple validations, only the first validation failure is returned. However, you can validate both the mail nickname and the display name and receive a collection of validation errors if you're only validating the prefix and suffix naming policy. To learn more about configuring naming policies, see Configure naming policy."
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/directoryobject-validateproperties?view=graph-rest-1.0
operationId: servicePrincipal_validateProperty
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
entityType:
type: string
nullable: true
displayName:
type: string
nullable: true
mailNickname:
type: string
nullable: true
onBehalfOfUserId:
pattern: '^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$'
type: string
format: uuid
nullable: true
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/users/{user-id}/appRoleAssignments':
get:
tags:
- users.appRoleAssignment
summary: List appRoleAssignments (for agentUser)
description: Retrieve the list of appRoleAssignments granted to an agentUser.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/agentuser-list-approleassignments?view=graph-rest-1.0
operationId: user_ListAppRoleAssignment
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: ConsistencyLevel
in: header
description: 'Indicates the requested consistency level. Documentation URL: https://docs.microsoft.com/graph/aad-advanced-queries'
style: simple
schema:
type: string
examples:
example-1:
description: $search and $count queries require the client to set the ConsistencyLevel HTTP header to 'eventual'.
value: eventual
- $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.appRoleAssignmentCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- users.appRoleAssignment
summary: Create appRoleAssignment (for agentUser)
description: Grant an app role assignment to an agentUser.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/agentuser-post-approleassignments?view=graph-rest-1.0
operationId: user_CreateAppRoleAssignment
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.appRoleAssignment'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.appRoleAssignment'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/users/{user-id}/appRoleAssignments/{appRoleAssignment-id}':
get:
tags:
- users.appRoleAssignment
summary: Get appRoleAssignments from users
description: Represents the app roles a user is granted for an application. Supports $expand.
operationId: user_GetAppRoleAssignment
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: appRoleAssignment-id
in: path
description: The unique identifier of appRoleAssignment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: appRoleAssignment
- name: ConsistencyLevel
in: header
description: 'Indicates the requested consistency level. Documentation URL: https://docs.microsoft.com/graph/aad-advanced-queries'
style: simple
schema:
type: string
examples:
example-1:
description: $search and $count queries require the client to set the ConsistencyLevel HTTP header to 'eventual'.
value: eventual
- 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.appRoleAssignment'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- users.appRoleAssignment
summary: Update the navigation property appRoleAssignments in users
operationId: user_UpdateAppRoleAssignment
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: appRoleAssignment-id
in: path
description: The unique identifier of appRoleAssignment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: appRoleAssignment
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.appRoleAssignment'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.appRoleAssignment'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- users.appRoleAssignment
summary: Delete appRoleAssignment
description: Delete an appRoleAssignment that has been granted to a user.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/user-delete-approleassignments?view=graph-rest-1.0
operationId: user_DeleteAppRoleAssignment
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: appRoleAssignment-id
in: path
description: The unique identifier of appRoleAssignment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: appRoleAssignment
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/users/{user-id}/appRoleAssignments/$count':
get:
tags:
- users.appRoleAssignment
summary: Get the number of the resource
operationId: user.appRoleAssignment_GetCount
parameters:
- name: user-id
in: path
description: The unique identifier of user
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: user
- name: ConsistencyLevel
in: header
description: 'Indicates the requested consistency level. Documentation URL: https://docs.microsoft.com/graph/aad-advanced-queries'
style: simple
schema:
type: string
examples:
example-1:
description: $search and $count queries require the client to set the ConsistencyLevel HTTP header to 'eventual'.
value: eventual
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
components:
schemas:
microsoft.graph.application:
allOf:
- $ref: '#/components/schemas/microsoft.graph.directoryObject'
- title: application
type: object
properties:
addIns:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.addIn'
description: 'Defines custom behavior that a consuming service can use to call an app in specific contexts. For example, applications that can render file streams can set the addIns property for its ''FileHandler'' functionality. This lets services like Microsoft 365 call the application in the context of a document the user is working on.'
api:
$ref: '#/components/schemas/microsoft.graph.apiApplication'
appId:
type: string
description: The unique identifier for the application that is assigned to an application by Microsoft Entra ID. Not nullable. Read-only. Alternate key. Supports $filter (eq).
nullable: true
applicationTemplateId:
type: string
description: 'Unique identifier of the applicationTemplate. Supports $filter (eq, not, ne). Read-only. null if the app wasn''t created from an application template.'
nullable: true
appRoles:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.appRole'
description: 'The collection of roles defined for the application. With app role assignments, these roles can be assigned to users, groups, or service principals associated with other applications. Not nullable.'
authenticationBehaviors:
$ref: '#/components/schemas/microsoft.graph.authenticationBehaviors'
certification:
$ref: '#/components/schemas/microsoft.graph.certification'
createdByAppId:
type: string
description: The appId of the application that created this application. Set internally by Microsoft Entra ID. Read-only.
nullable: true
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 the application was registered. The DateTimeOffset 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. Read-only. Supports $filter (eq, ne, not, ge, le, in, and eq on null values) and $orderby.'
format: date-time
nullable: true
defaultRedirectUri:
type: string
nullable: true
description:
type: string
description: 'Free text field to provide a description of the application object to end users. The maximum allowed size is 1,024 characters. Supports $filter (eq, ne, not, ge, le, startsWith) and $search.'
nullable: true
disabledByMicrosoftStatus:
type: string
description: 'Specifies whether Microsoft has disabled the registered application. The possible values are: null (default value), NotDisabled, and DisabledDueToViolationOfServicesAgreement (reasons include suspicious, abusive, or malicious activity, or a violation of the Microsoft Services Agreement). Supports $filter (eq, ne, not).'
nullable: true
displayName:
type: string
description: 'The display name for the application. Maximum length is 256 characters. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values), $search, and $orderby.'
nullable: true
groupMembershipClaims:
type: string
description: 'Configures the groups claim issued in a user or OAuth 2.0 access token that the application expects. To set this attribute, use one of the following valid string values: None, SecurityGroup (for security groups and Microsoft Entra roles), All (this gets all of the security groups, distribution groups, and Microsoft Entra directory roles that the signed-in user is a member of).'
nullable: true
identifierUris:
type: array
items:
type: string
description: 'Also known as App ID URI, this value is set when an application is used as a resource app. The identifierUris acts as the prefix for the scopes you reference in your API''s code, and it must be globally unique across Microsoft Entra ID. For more information on valid identifierUris patterns and best practices, see Microsoft Entra application registration security best practices. Not nullable. Supports $filter (eq, ne, ge, le, startsWith).'
info:
$ref: '#/components/schemas/microsoft.graph.informationalUrl'
isDeviceOnlyAuthSupported:
type: boolean
description: Specifies whether this application supports device authentication without a user. The default is false.
nullable: true
isDisabled:
type: boolean
nullable: true
isFallbackPublicClient:
type: boolean
description: 'Specifies the fallback application type as public client, such as an installed application running on a mobile device. The default value is false, which means the fallback application type is confidential client such as a web app. There are certain scenarios where Microsoft Entra ID can''t determine the client application type. For example, the ROPC flow where it''s configured without specifying a redirect URI. In those cases, Microsoft Entra ID interprets the application type based on the value of this property.'
nullable: true
keyCredentials:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.keyCredential'
description: 'The collection of key credentials associated with the application. Not nullable. Supports $filter (eq, not, ge, le).'
logo:
type: string
description: The main logo for the application. Not nullable.
format: base64url
managerApplications:
type: array
items:
pattern: '^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$'
type: string
format: uuid
description: 'A collection of application IDs for Microsoft first-party applications designated as managers. Manager applications can create service principals, agent identities, and agent users for managed agent blueprints. Limited to a maximum of 10 entries. Not nullable. Only supported on agentIdentityBlueprint objects; attempts to set this property on non-agent-blueprint applications return an error. Not returned by default; must be explicitly requested via $select.'
nativeAuthenticationApisEnabled:
$ref: '#/components/schemas/microsoft.graph.nativeAuthenticationApisEnabled'
notes:
type: string
description: Notes relevant for the management of the application.
nullable: true
oauth2RequirePostResponse:
type: boolean
optionalClaims:
$ref: '#/components/schemas/microsoft.graph.optionalClaims'
parentalControlSettings:
$ref: '#/components/schemas/microsoft.graph.parentalControlSettings'
passwordCredentials:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.passwordCredential'
description: The collection of password credentials associated with the application. Not nullable.
publicClient:
$ref: '#/components/schemas/microsoft.graph.publicClientApplication'
publisherDomain:
type: string
description: 'The verified publisher domain for the application. Read-only. For more information, see How to: Configure an application''s publisher domain. Supports $filter (eq, ne, ge, le, startsWith).'
nullable: true
requestSignatureVerification:
$ref: '#/components/schemas/microsoft.graph.requestSignatureVerification'
requiredResourceAccess:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.requiredResourceAccess'
description: 'Specifies the resources that the application needs to access. This property also specifies the set of delegated permissions and application roles that it needs for each of those resources. This configuration of access to the required resources drives the consent experience. No more than 50 resource services (APIs) can be configured. Beginning mid-October 2021, the total number of required permissions must not exceed 400. For more information, see Limits on requested permissions per app. Not nullable. Supports $filter (eq, not, ge, le).'
samlMetadataUrl:
type: string
description: The URL where the service exposes SAML metadata for federation. This property is valid only for single-tenant applications. Nullable.
nullable: true
serviceManagementReference:
type: string
description: References application or service contact information from a Service or Asset Management database. Nullable.
nullable: true
servicePrincipalLockConfiguration:
$ref: '#/components/schemas/microsoft.graph.servicePrincipalLockConfiguration'
signInAudience:
type: string
description: 'Specifies the Microsoft accounts that are supported for the current application. The possible values are: AzureADMyOrg (default), AzureADMultipleOrgs, AzureADandPersonalMicrosoftAccount, and PersonalMicrosoftAccount. See more in the table. The value of this object also limits the number of permissions an app can request. For more information, see Limits on requested permissions per app. The value for this property has implications on other app object properties. As a result, if you change this property, you might need to change other properties first. For more information, see Validation differences for signInAudience.Supports $filter (eq, ne, not).'
nullable: true
spa:
$ref: '#/components/schemas/microsoft.graph.spaApplication'
tags:
type: array
items:
type: string
description: 'Custom strings that can be used to categorize and identify the application. Not nullable. Strings added here will also appear in the tags property of any associated service principals.Supports $filter (eq, not, ge, le, startsWith) and $search.'
tokenEncryptionKeyId:
pattern: '^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$'
type: string
description: 'Specifies the keyId of a public key from the keyCredentials collection. When configured, Microsoft Entra ID encrypts all the tokens it emits by using the key this property points to. The application code that receives the encrypted token must use the matching private key to decrypt the token before it can be used for the signed-in user.'
format: uuid
nullable: true
uniqueName:
type: string
description: The unique identifier that can be assigned to an application and used as an alternate key. Immutable. Read-only.
nullable: true
verifiedPublisher:
$ref: '#/components/schemas/microsoft.graph.verifiedPublisher'
web:
$ref: '#/components/schemas/microsoft.graph.webApplication'
appManagementPolicies:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.appManagementPolicy'
description: The appManagementPolicy applied to this application.
x-ms-navigationProperty: true
createdOnBehalfOf:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
extensionProperties:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.extensionProperty'
description: 'Read-only. Nullable. Supports $expand and $filter (/$count eq 0, /$count ne 0).'
x-ms-navigationProperty: true
federatedIdentityCredentials:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.federatedIdentityCredential'
description: 'Federated identities for applications. Supports $expand and $filter (startsWith, /$count eq 0, /$count ne 0).'
x-ms-navigationProperty: true
homeRealmDiscoveryPolicies:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.homeRealmDiscoveryPolicy'
x-ms-navigationProperty: true
owners:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
description: 'Directory objects that are owners of this application. The owners are a set of nonadmin users or service principals who are allowed to modify this object. Supports $expand, $filter (/$count eq 0, /$count ne 0, /$count eq 1, /$count ne 1), and $select nested in $expand.'
x-ms-navigationProperty: true
synchronization:
$ref: '#/components/schemas/microsoft.graph.synchronization'
tokenIssuancePolicies:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.tokenIssuancePolicy'
x-ms-navigationProperty: true
tokenLifetimePolicies:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.tokenLifetimePolicy'
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.directoryObject:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: directoryObject
type: object
properties:
deletedDateTime:
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: Date and time when this object was deleted. Always null when the object hasn't been deleted.
format: date-time
nullable: true
additionalProperties:
type: object
microsoft.graph.extensionProperty:
allOf:
- $ref: '#/components/schemas/microsoft.graph.directoryObject'
- title: extensionProperty
type: object
properties:
appDisplayName:
type: string
description: Display name of the application object on which this extension property is defined. Read-only.
nullable: true
dataType:
type: string
description: 'Specifies the data type of the value the extension property can hold. Following values are supported. Binary - 256 bytes maximumBooleanDateTime - Must be specified in ISO 8601 format. Will be stored in UTC.Integer - 32-bit value.LargeInteger - 64-bit value.String - 256 characters maximumNot nullable. For multivalued directory extensions, these limits apply per value in the collection.'
isMultiValued:
type: boolean
description: 'Defines the directory extension as a multi-valued property. When true, the directory extension property can store a collection of objects of the dataType; for example, a collection of string types such as ''extensionb7b1c57b532f40b8b5ed4b7a7ba67401jobGroupTracker'': [''String 1'', ''String 2'']. The default value is false. Supports $filter (eq).'
isSyncedFromOnPremises:
type: boolean
description: Indicates if this extension property was synced from on-premises active directory using Microsoft Entra Connect. Read-only.
nullable: true
name:
type: string
description: Name of the extension property. Not nullable. Supports $filter (eq).
targetObjects:
type: array
items:
type: string
description: Following values are supported. Not nullable. UserGroupAdministrativeUnitApplicationDeviceOrganization
additionalProperties:
type: object
microsoft.graph.federatedIdentityCredential:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: federatedIdentityCredential
type: object
properties:
audiences:
type: array
items:
type: string
description: The audience that can appear in the external token. This field is mandatory and should be set to api://AzureADTokenExchange for Microsoft Entra ID. It says what Microsoft identity platform should accept in the aud claim in the incoming token. This value represents Microsoft Entra ID in your external identity provider and has no fixed value across identity providers - you might need to create a new application registration in your identity provider to serve as the audience of this token. This field can only accept a single value and has a limit of 600 characters. Required.
description:
type: string
description: 'The unvalidated description of the federated identity credential, provided by the user. It has a limit of 600 characters. Optional.'
nullable: true
issuer:
type: string
description: 'The URL of the external identity provider, which must match the issuer claim of the external token being exchanged. The combination of the values of issuer and subject must be unique within the app. It has a limit of 600 characters. Required.'
name:
type: string
description: 'The unique identifier for the federated identity credential, which has a limit of 120 characters and must be URL friendly. The string is immutable after it''s created. Alternate key. Required. Not nullable. Supports $filter (eq).'
subject:
type: string
description: 'Required. The identifier of the external software workload within the external identity provider. Like the audience value, it has no fixed format; each identity provider uses their own - sometimes a GUID, sometimes a colon delimited identifier, sometimes arbitrary strings. The value here must match the sub claim within the token presented to Microsoft Entra ID. The combination of issuer and subject must be unique within the app. It has a limit of 600 characters. Supports $filter (eq).'
nullable: true
additionalProperties:
type: object
microsoft.graph.homeRealmDiscoveryPolicy:
allOf:
- $ref: '#/components/schemas/microsoft.graph.stsPolicy'
- title: homeRealmDiscoveryPolicy
type: object
additionalProperties:
type: object
microsoft.graph.keyCredential:
title: keyCredential
type: object
properties:
customKeyIdentifier:
type: string
description: 'A 40-character binary type that can be used to identify the credential. Optional. When not provided in the payload, defaults to the thumbprint of the certificate.'
format: base64url
nullable: true
displayName:
type: string
description: 'The friendly name for the key, with a maximum length of 90 characters. Longer values are accepted but shortened. Optional.'
nullable: true
endDateTime:
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 at which the credential expires. The DateTimeOffset 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
key:
type: string
description: 'The certificate''s raw data in byte array converted to Base64 string. Requires $select to retrieve; only available for single object requests (GET /applications/{applicationId}?$select=keyCredentials or GET /servicePrincipals/{servicePrincipalId}?$select=keyCredentials); otherwise, it''s always null. From a .cer certificate, you can read the key using the Convert.ToBase64String() method. For more information, see Get the certificate key.'
format: base64url
nullable: true
keyId:
pattern: '^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$'
type: string
description: The unique identifier (GUID) for the key.
format: uuid
nullable: true
startDateTime:
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 at which the credential becomes valid.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
type:
type: string
description: 'The type of key credential; for example, Symmetric, AsymmetricX509Cert.'
nullable: true
usage:
type: string
description: 'A string that describes the purpose for which the key can be used; for example, Verify.'
nullable: true
additionalProperties:
type: object
microsoft.graph.passwordCredential:
title: passwordCredential
type: object
properties:
customKeyIdentifier:
type: string
description: Do not use.
format: base64url
nullable: true
displayName:
type: string
description: Friendly name for the password. Optional.
nullable: true
endDateTime:
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 at which the password expires represented using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Optional.'
format: date-time
nullable: true
hint:
type: string
description: Contains the first three characters of the password. Read-only.
nullable: true
keyId:
pattern: '^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$'
type: string
description: The unique identifier for the password.
format: uuid
nullable: true
secretText:
type: string
description: Read-only; Contains the strong passwords generated by Microsoft Entra ID that are 16-64 characters in length. The generated password value is only returned during the initial POST request to addPassword. There is no way to retrieve this password in the future.
nullable: true
startDateTime:
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 at which the password becomes valid. 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. Optional.'
format: date-time
nullable: true
additionalProperties:
type: object
microsoft.graph.appRoleAssignment:
allOf:
- $ref: '#/components/schemas/microsoft.graph.directoryObject'
- title: appRoleAssignment
type: object
properties:
appRoleId:
pattern: '^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$'
type: string
description: 'The identifier (id) for the app role that''s assigned to the principal. This app role must be exposed in the appRoles property on the resource application''s service principal (resourceId). If the resource application hasn''t declared any app roles, a default app role ID of 00000000-0000-0000-0000-000000000000 can be specified to signal that the principal is assigned to the resource app without any specific app roles. Required on create.'
format: uuid
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 time when the app role assignment was created. 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. Read-only.'
format: date-time
nullable: true
principalDisplayName:
type: string
description: 'The display name of the user, group, or service principal that was granted the app role assignment. Maximum length is 256 characters. Read-only. Supports $filter (eq and startswith).'
nullable: true
principalId:
pattern: '^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$'
type: string
description: 'The unique identifier (id) for the user, security group, or service principal being granted the app role. Security groups with dynamic memberships are supported. Required on create.'
format: uuid
nullable: true
principalType:
type: string
description: 'The type of the assigned principal. This can either be User, Group, or ServicePrincipal. Read-only.'
nullable: true
resourceDisplayName:
type: string
description: The display name of the resource app's service principal to which the assignment is made. Maximum length is 256 characters.
nullable: true
resourceId:
pattern: '^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$'
type: string
description: The unique identifier (id) for the resource service principal for which the assignment is made. Required on create. Supports $filter (eq only).
format: uuid
nullable: true
additionalProperties:
type: object
microsoft.graph.endpoint:
allOf:
- $ref: '#/components/schemas/microsoft.graph.directoryObject'
- title: endpoint
type: object
properties:
capability:
type: string
providerId:
type: string
nullable: true
providerName:
type: string
nullable: true
providerResourceId:
type: string
nullable: true
uri:
type: string
additionalProperties:
type: object
microsoft.graph.servicePrincipal:
allOf:
- $ref: '#/components/schemas/microsoft.graph.directoryObject'
- title: servicePrincipal
type: object
properties:
accountEnabled:
type: boolean
description: 'true if the service principal account is enabled; otherwise, false. If set to false, then no users are able to sign in to this app, even if they''re assigned to it. Supports $filter (eq, ne, not, in).'
nullable: true
addIns:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.addIn'
description: 'Defines custom behavior that a consuming service can use to call an app in specific contexts. For example, applications that can render file streams may set the addIns property for its ''FileHandler'' functionality. This lets services like Microsoft 365 call the application in the context of a document the user is working on.'
alternativeNames:
type: array
items:
type: string
description: 'Used to retrieve service principals by subscription, identify resource group and full resource IDs for managed identities. Supports $filter (eq, not, ge, le, startsWith).'
appDescription:
type: string
description: The description exposed by the associated application.
nullable: true
appDisplayName:
type: string
description: The display name exposed by the associated application. Maximum length is 256 characters.
nullable: true
appId:
type: string
description: 'The unique identifier for the associated application (its appId property). Alternate key. Supports $filter (eq, ne, not, in, startsWith).'
nullable: true
applicationTemplateId:
type: string
description: 'Unique identifier of the applicationTemplate. Supports $filter (eq, not, ne). Read-only. null if the service principal wasn''t created from an application template.'
nullable: true
appOwnerOrganizationId:
pattern: '^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$'
type: string
description: 'Contains the tenant ID where the application is registered. This is applicable only to service principals backed by applications. Supports $filter (eq, ne, NOT, ge, le).'
format: uuid
nullable: true
appRoleAssignmentRequired:
type: boolean
description: 'Specifies whether users or other service principals need to be granted an app role assignment for this service principal before users can sign in or apps can get tokens. The default value is false. Not nullable. Supports $filter (eq, ne, NOT).'
appRoles:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.appRole'
description: 'The roles exposed by the application that''s linked to this service principal. For more information, see the appRoles property definition on the application entity. Not nullable.'
createdByAppId:
type: string
description: The appId of the application that created this service principal. Set internally by Microsoft Entra ID. Read-only.
nullable: true
customSecurityAttributes:
$ref: '#/components/schemas/microsoft.graph.customSecurityAttributeValue'
description:
type: string
description: 'Free text field to provide an internal end-user facing description of the service principal. End-user portals such MyApps displays the application description in this field. The maximum allowed size is 1,024 characters. Supports $filter (eq, ne, not, ge, le, startsWith) and $search.'
nullable: true
disabledByMicrosoftStatus:
type: string
description: 'Specifies whether Microsoft has disabled the registered application. The possible values are: null (default value), NotDisabled, and DisabledDueToViolationOfServicesAgreement (reasons include suspicious, abusive, or malicious activity, or a violation of the Microsoft Services Agreement). Supports $filter (eq, ne, not).'
nullable: true
displayName:
type: string
description: 'The display name for the service principal. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values), $search, and $orderby.'
nullable: true
homepage:
type: string
description: Home page or landing page of the application.
nullable: true
info:
$ref: '#/components/schemas/microsoft.graph.informationalUrl'
isDisabled:
type: boolean
nullable: true
keyCredentials:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.keyCredential'
description: 'The collection of key credentials associated with the service principal. Not nullable. Supports $filter (eq, not, ge, le).'
loginUrl:
type: string
description: 'Specifies the URL where the service provider redirects the user to Microsoft Entra ID to authenticate. Microsoft Entra ID uses the URL to launch the application from Microsoft 365 or the Microsoft Entra My Apps. When blank, Microsoft Entra ID performs IdP-initiated sign-on for applications configured with SAML-based single sign-on. The user launches the application from Microsoft 365, the Microsoft Entra My Apps, or the Microsoft Entra SSO URL.'
nullable: true
logoutUrl:
type: string
description: 'Specifies the URL that the Microsoft''s authorization service uses to sign out a user using OpenID Connect front-channel, back-channel, or SAML sign out protocols.'
nullable: true
notes:
type: string
description: 'Free text field to capture information about the service principal, typically used for operational purposes. Maximum allowed size is 1,024 characters.'
nullable: true
notificationEmailAddresses:
type: array
items:
type: string
description: Specifies the list of email addresses where Microsoft Entra ID sends a notification when the active certificate is near the expiration date. This is only for the certificates used to sign the SAML token issued for Microsoft Entra Gallery applications.
oauth2PermissionScopes:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.permissionScope'
description: 'The delegated permissions exposed by the application. For more information, see the oauth2PermissionScopes property on the application entity''s api property. Not nullable.'
passwordCredentials:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.passwordCredential'
description: The collection of password credentials associated with the application. Not nullable.
preferredSingleSignOnMode:
type: string
description: 'Specifies the single sign-on mode configured for this application. Microsoft Entra ID uses the preferred single sign-on mode to launch the application from Microsoft 365 or the My Apps portal. The supported values are password, saml, notSupported, and oidc. Note: This field might be null for older SAML apps and for OIDC applications where it isn''t set automatically.'
nullable: true
preferredTokenSigningKeyThumbprint:
type: string
description: 'This property can be used on SAML applications (apps that have preferredSingleSignOnMode set to saml) to control which certificate is used to sign the SAML responses. For applications that aren''t SAML, don''t write or otherwise rely on this property.'
nullable: true
replyUrls:
type: array
items:
type: string
description: 'The URLs that user tokens are sent to for sign in with the associated application, or the redirect URIs that OAuth 2.0 authorization codes and access tokens are sent to for the associated application. Not nullable.'
resourceSpecificApplicationPermissions:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.resourceSpecificPermission'
description: 'The resource-specific application permissions exposed by this application. Currently, resource-specific permissions are only supported for Teams apps accessing to specific chats and teams using Microsoft Graph. Read-only.'
samlSingleSignOnSettings:
$ref: '#/components/schemas/microsoft.graph.samlSingleSignOnSettings'
servicePrincipalNames:
type: array
items:
type: string
description: 'Contains the list of identifiersUris, copied over from the associated application. Additional values can be added to hybrid applications. These values can be used to identify the permissions exposed by this app within Microsoft Entra ID. For example,Client apps can specify a resource URI that is based on the values of this property to acquire an access token, which is the URI returned in the ''aud'' claim.The any operator is required for filter expressions on multi-valued properties. Not nullable. Supports $filter (eq, not, ge, le, startsWith).'
servicePrincipalType:
type: string
description: 'Identifies whether the service principal represents an application, a managed identity, or a legacy application. This property is set by Microsoft Entra ID internally. The servicePrincipalType property can be set to three different values: Application - A service principal that represents an application or service. The appId property identifies the associated app registration, and matches the appId of an application, possibly from a different tenant. If the associated app registration is missing, tokens aren''t issued for the service principal.ManagedIdentity - A service principal that represents a managed identity. Service principals representing managed identities can be granted access and permissions, but can''t be updated or modified directly.Legacy - A service principal that represents an app created before app registrations, or through legacy experiences. A legacy service principal can have credentials, service principal names, reply URLs, and other properties that are editable by an authorized user, but doesn''t have an associated app registration. The appId value doesn''t associate the service principal with an app registration. The service principal can only be used in the tenant where it was created.ServiceIdentity - A service principal that represents an agent identity.SocialIdp - For internal use.'
nullable: true
signInAudience:
type: string
description: 'Specifies the Microsoft accounts that are supported for the current application. Read-only. Supported values are:AzureADMyOrg: Users with a Microsoft work or school account in my organization''s Microsoft Entra tenant (single-tenant).AzureADMultipleOrgs: Users with a Microsoft work or school account in any organization''s Microsoft Entra tenant (multitenant).AzureADandPersonalMicrosoftAccount: Users with a personal Microsoft account, or a work or school account in any organization''s Microsoft Entra tenant.PersonalMicrosoftAccount: Users with a personal Microsoft account only.'
nullable: true
tags:
type: array
items:
type: string
description: 'Custom strings that can be used to categorize and identify the service principal. Not nullable. The value is the union of strings set here and on the associated application entity''s tags property.Supports $filter (eq, not, ge, le, startsWith).'
tokenEncryptionKeyId:
pattern: '^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$'
type: string
description: 'Specifies the keyId of a public key from the keyCredentials collection. When configured, Microsoft Entra ID issues tokens for this application encrypted using the key specified by this property. The application code that receives the encrypted token must use the matching private key to decrypt the token before it can be used for the signed-in user.'
format: uuid
nullable: true
verifiedPublisher:
$ref: '#/components/schemas/microsoft.graph.verifiedPublisher'
appManagementPolicies:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.appManagementPolicy'
description: The appManagementPolicy applied to this application.
x-ms-navigationProperty: true
appRoleAssignedTo:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.appRoleAssignment'
description: 'App role assignments for this app or service, granted to users, groups, and other service principals. Supports $expand.'
x-ms-navigationProperty: true
appRoleAssignments:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.appRoleAssignment'
description: 'App role assignment for another app or service, granted to this service principal. Supports $expand.'
x-ms-navigationProperty: true
claimsMappingPolicies:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.claimsMappingPolicy'
description: The claimsMappingPolicies assigned to this service principal. Supports $expand.
x-ms-navigationProperty: true
createdObjects:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
description: Directory objects created by this service principal. Read-only. Nullable.
x-ms-navigationProperty: true
delegatedPermissionClassifications:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.delegatedPermissionClassification'
x-ms-navigationProperty: true
endpoints:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.endpoint'
x-ms-navigationProperty: true
federatedIdentityCredentials:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.federatedIdentityCredential'
description: 'Federated identities for a specific type of service principal - managed identity. Supports $expand and $filter (/$count eq 0, /$count ne 0).'
x-ms-navigationProperty: true
homeRealmDiscoveryPolicies:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.homeRealmDiscoveryPolicy'
description: The homeRealmDiscoveryPolicies assigned to this service principal. Supports $expand.
x-ms-navigationProperty: true
memberOf:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
description: 'Roles that this service principal is a member of. HTTP Methods: GET Read-only. Nullable. Supports $expand.'
x-ms-navigationProperty: true
oauth2PermissionGrants:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.oAuth2PermissionGrant'
description: Delegated permission grants authorizing this service principal to access an API on behalf of a signed-in user. Read-only. Nullable.
x-ms-navigationProperty: true
ownedObjects:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
description: 'Directory objects that this service principal owns. Read-only. Nullable. Supports $expand, $select nested in $expand, and $filter (/$count eq 0, /$count ne 0, /$count eq 1, /$count ne 1).'
x-ms-navigationProperty: true
owners:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
description: 'Directory objects that are owners of this servicePrincipal. The owners are a set of nonadmin users or servicePrincipals who are allowed to modify this object. Supports $expand, $filter (/$count eq 0, /$count ne 0, /$count eq 1, /$count ne 1), and $select nested in $expand.'
x-ms-navigationProperty: true
remoteDesktopSecurityConfiguration:
$ref: '#/components/schemas/microsoft.graph.remoteDesktopSecurityConfiguration'
synchronization:
$ref: '#/components/schemas/microsoft.graph.synchronization'
tokenIssuancePolicies:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.tokenIssuancePolicy'
description: The tokenIssuancePolicies assigned to this service principal.
x-ms-navigationProperty: true
tokenLifetimePolicies:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.tokenLifetimePolicy'
description: The tokenLifetimePolicies assigned to this service principal.
x-ms-navigationProperty: true
transitiveMemberOf:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.user:
allOf:
- $ref: '#/components/schemas/microsoft.graph.directoryObject'
- title: user
type: object
properties:
aboutMe:
type: string
description: A freeform text entry field for the user to describe themselves. Requires $select to retrieve.
nullable: true
accountEnabled:
type: boolean
description: 'true if the account is enabled; otherwise, false. This property is required when a user is created. Requires $select to retrieve. Supports $filter (eq, ne, not, and in). This property is subject to sensitive action restrictions; only specific privileged administrator roles can update it.'
nullable: true
ageGroup:
type: string
description: 'Sets the age group of the user. Allowed values: null, Minor, NotAdult, and Adult. For more information, see legal age group property definitions. Requires $select to retrieve. Supports $filter (eq, ne, not, and in).'
nullable: true
assignedLicenses:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.assignedLicense'
description: 'The licenses that are assigned to the user, including inherited (group-based) licenses. This property doesn''t differentiate between directly assigned and inherited licenses. Use the licenseAssignmentStates property to identify the directly assigned and inherited licenses. Not nullable. Requires $select to retrieve. Supports $filter (eq, not, /$count eq 0, /$count ne 0).'
assignedPlans:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.assignedPlan'
description: The plans that are assigned to the user. Read-only. Not nullable. Requires $select to retrieve. Supports $filter (eq and not).
authorizationInfo:
$ref: '#/components/schemas/microsoft.graph.authorizationInfo'
birthday:
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 birthday of the user. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014, is 2014-01-01T00:00:00Z. Requires $select to retrieve.'
format: date-time
businessPhones:
type: array
items:
type: string
description: 'The telephone numbers for the user. NOTE: Although it''s a string collection, only one number can be set for this property. Read-only for users synced from the on-premises directory. Returned by default. Supports $filter (eq, not, ge, le, startsWith). This property is subject to sensitive action restrictions; only specific privileged administrator roles can update it.'
city:
type: string
description: 'The city where the user is located. Maximum length is 128 characters. Requires $select to retrieve. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).'
nullable: true
companyName:
type: string
description: 'The name of the company that the user is associated with. This property can be useful for describing the company that a guest comes from. The maximum length is 64 characters.Requires $select to retrieve. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).'
nullable: true
consentProvidedForMinor:
type: string
description: 'Sets whether consent was obtained for minors. Allowed values: null, Granted, Denied, and NotRequired. For more information, see legal age group property definitions. Requires $select to retrieve. Supports $filter (eq, ne, not, and in).'
nullable: true
country:
type: string
description: 'The country or region where the user is located; for example, US or UK. Maximum length is 128 characters. Requires $select to retrieve. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).'
nullable: true
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 the user was created, in ISO 8601 format and UTC. The value can''t be modified and is automatically populated when the entity is created. Nullable. For on-premises users, the value represents when they were first created in Microsoft Entra ID. Property is null for some users created before June 2018 and on-premises users that were synced to Microsoft Entra ID before June 2018. Read-only. Requires $select to retrieve. Supports $filter (eq, ne, not , ge, le, in).'
format: date-time
nullable: true
creationType:
type: string
description: 'Indicates whether the user account was created through one of the following methods: As a regular school or work account (null). As an external account (Invitation). As a local account for an Azure Active Directory B2C tenant (LocalAccount). Through self-service sign-up by an internal user using email verification (EmailVerified). Through self-service sign-up by a guest signing up through a link that is part of a user flow (SelfServiceSignUp). Read-only.Requires $select to retrieve. Supports $filter (eq, ne, not, in).'
nullable: true
customSecurityAttributes:
$ref: '#/components/schemas/microsoft.graph.customSecurityAttributeValue'
department:
type: string
description: 'The name of the department in which the user works. Maximum length is 64 characters. Requires $select to retrieve. Supports $filter (eq, ne, not , ge, le, in, and eq on null values).'
nullable: true
deviceEnrollmentLimit:
maximum: 2147483647
minimum: -2147483648
type: number
description: The limit on the maximum number of devices that the user is permitted to enroll. Allowed values are 5 or 1000.
format: int32
displayName:
type: string
description: 'The name displayed in the address book for the user. This value is usually the combination of the user''s first name, middle initial, and family name. This property is required when a user is created and it can''t be cleared during updates. Maximum length is 256 characters. Returned by default. Supports $filter (eq, ne, not , ge, le, in, startsWith, and eq on null values), $orderby, and $search.'
nullable: true
employeeHireDate:
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 user was hired or will start work in a future hire. Requires $select to retrieve. Supports $filter (eq, ne, not , ge, le, in).'
format: date-time
nullable: true
employeeId:
type: string
description: 'The employee identifier assigned to the user by the organization. The maximum length is 16 characters. Requires $select to retrieve. Supports $filter (eq, ne, not , ge, le, in, startsWith, and eq on null values).'
nullable: true
employeeLeaveDateTime:
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 user left or will leave the organization. To read this property, the calling app must be assigned the User-LifeCycleInfo.Read.All permission. To write this property, the calling app must be assigned the User.Read.All and User-LifeCycleInfo.ReadWrite.All permissions. To read this property in delegated scenarios, the admin needs at least one of the following Microsoft Entra roles: Lifecycle Workflows Administrator (least privilege), Global Reader. To write this property in delegated scenarios, the admin needs the Global Administrator role. Supports $filter (eq, ne, not , ge, le, in). For more information, see Configure the employeeLeaveDateTime property for a user.'
format: date-time
nullable: true
employeeOrgData:
$ref: '#/components/schemas/microsoft.graph.employeeOrgData'
employeeType:
type: string
description: 'Captures enterprise worker type. For example, Employee, Contractor, Consultant, or Vendor. Requires $select to retrieve. Supports $filter (eq, ne, not , ge, le, in, startsWith).'
nullable: true
externalUserState:
type: string
description: 'For a guest invited to the tenant using the invitation API, this property represents the invited user''s invitation status. For invited users, the state can be PendingAcceptance or Accepted, or null for all other users. Requires $select to retrieve. Supports $filter (eq, ne, not , in).'
nullable: true
externalUserStateChangeDateTime:
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: 'Shows the timestamp for the latest change to the externalUserState property. Requires $select to retrieve. Supports $filter (eq, ne, not , in).'
format: date-time
nullable: true
faxNumber:
type: string
description: 'The fax number of the user. Requires $select to retrieve. Supports $filter (eq, ne, not , ge, le, in, startsWith, and eq on null values).'
nullable: true
givenName:
type: string
description: 'The given name (first name) of the user. Maximum length is 64 characters. Returned by default. Supports $filter (eq, ne, not , ge, le, in, startsWith, and eq on null values).'
nullable: true
hireDate:
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 hire date of the user. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014, is 2014-01-01T00:00:00Z. Requires $select to retrieve. Note: This property is specific to SharePoint in Microsoft 365. We recommend using the native employeeHireDate property to set and update hire date values using Microsoft Graph APIs.'
format: date-time
identities:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.objectIdentity'
description: 'Represents the identities that can be used to sign in to this user account. Microsoft (also known as a local account), organizations, or social identity providers such as Facebook, Google, and Microsoft can provide identity and tie it to a user account. It might contain multiple items with the same signInType value. Requires $select to retrieve. Supports $filter (eq) with limitations.'
identityParentId:
type: string
nullable: true
imAddresses:
type: array
items:
type: string
nullable: true
description: 'The instant message voice-over IP (VOIP) session initiation protocol (SIP) addresses for the user. Read-only. Requires $select to retrieve. Supports $filter (eq, not, ge, le, startsWith).'
interests:
type: array
items:
type: string
nullable: true
description: A list for the user to describe their interests. Requires $select to retrieve.
isManagementRestricted:
type: boolean
description: 'true if the user is a member of a restricted management administrative unit. If not set, the default value is null and the default behavior is false. Read-only. To manage a user who is a member of a restricted management administrative unit, the administrator or calling app must be assigned a Microsoft Entra role at the scope of the restricted management administrative unit. Requires $select to retrieve.'
nullable: true
isResourceAccount:
type: boolean
description: Don't use – reserved for future use.
nullable: true
jobTitle:
type: string
description: 'The user''s job title. Maximum length is 128 characters. Returned by default. Supports $filter (eq, ne, not , ge, le, in, startsWith, and eq on null values).'
nullable: true
lastPasswordChangeDateTime:
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 time when this Microsoft Entra user last changed their password or when their password was created, whichever date the latest action was performed. The date and time information uses ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Requires $select to retrieve.'
format: date-time
nullable: true
legalAgeGroupClassification:
type: string
description: 'Used by enterprise applications to determine the legal age group of the user. This property is read-only and calculated based on ageGroup and consentProvidedForMinor properties. Allowed values: null, Undefined, MinorWithOutParentalConsent, MinorWithParentalConsent, MinorNoParentalConsentRequired, NotAdult, and Adult. For more information, see legal age group property definitions. Requires $select to retrieve.'
nullable: true
licenseAssignmentStates:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.licenseAssignmentState'
description: State of license assignments for this user. Also indicates licenses that are directly assigned or the user inherited through group memberships. Read-only. Requires $select to retrieve.
mail:
type: string
description: 'The SMTP address for the user, for example, jeff@contoso.com. Changes to this property update the user''s proxyAddresses collection to include the value as an SMTP address. This property can''t contain accent characters. NOTE: We don''t recommend updating this property for Azure AD B2C user profiles. Use the otherMails property instead. Returned by default. Supports $filter (eq, ne, not, ge, le, in, startsWith, endsWith, and eq on null values).'
nullable: true
mailboxSettings:
$ref: '#/components/schemas/microsoft.graph.mailboxSettings'
mailNickname:
type: string
description: 'The mail alias for the user. This property must be specified when a user is created. Maximum length is 64 characters. Requires $select to retrieve. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).'
nullable: true
mobilePhone:
type: string
description: 'The primary cellular telephone number for the user. Read-only for users synced from the on-premises directory. Maximum length is 64 characters. Returned by default. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values) and $search. This property is subject to sensitive action restrictions; only specific privileged administrator roles can update it.'
nullable: true
mySite:
type: string
description: The URL for the user's site. Requires $select to retrieve.
nullable: true
officeLocation:
type: string
description: 'The office location in the user''s place of business. Returned by default. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).'
nullable: true
onPremisesDistinguishedName:
type: string
description: Contains the on-premises Active Directory distinguished name or DN. The property is only populated for customers who are synchronizing their on-premises directory to Microsoft Entra ID via Microsoft Entra Connect. Read-only. Requires $select to retrieve.
nullable: true
onPremisesDomainName:
type: string
description: 'Contains the on-premises domainFQDN, also called dnsDomainName synchronized from the on-premises directory. The property is only populated for customers who are synchronizing their on-premises directory to Microsoft Entra ID via Microsoft Entra Connect. Read-only. Requires $select to retrieve.'
nullable: true
onPremisesExtensionAttributes:
$ref: '#/components/schemas/microsoft.graph.onPremisesExtensionAttributes'
onPremisesImmutableId:
type: string
description: 'This property is used to associate an on-premises Active Directory user account to their Microsoft Entra user object. This property must be specified when creating a new user account in the Graph if you''re using a federated domain for the user''s userPrincipalName (UPN) property. NOTE: The $ and _ characters can''t be used when specifying this property. Requires $select to retrieve. Supports $filter (eq, ne, not, ge, le, in). This property is subject to sensitive action restrictions; only specific privileged administrator roles can update it.'
nullable: true
onPremisesLastSyncDateTime:
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: 'Indicates the last time at which the object was synced with the on-premises directory; for example: 2013-02-16T03:04:54Z. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. Requires $select to retrieve. Supports $filter (eq, ne, not, ge, le, in).'
format: date-time
nullable: true
onPremisesProvisioningErrors:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.onPremisesProvisioningError'
description: 'Errors when using Microsoft synchronization product during provisioning. Requires $select to retrieve. Supports $filter (eq, not, ge, le).'
onPremisesSamAccountName:
type: string
description: 'Contains the on-premises samAccountName synchronized from the on-premises directory. The property is only populated for customers who are synchronizing their on-premises directory to Microsoft Entra ID via Microsoft Entra Connect. Read-only. Requires $select to retrieve. Supports $filter (eq, ne, not, ge, le, in, startsWith).'
nullable: true
onPremisesSecurityIdentifier:
type: string
description: Contains the on-premises security identifier (SID) for the user that was synchronized from on-premises to the cloud. Read-only. Requires $select to retrieve. Supports $filter (eq including on null values).
nullable: true
onPremisesSyncEnabled:
type: boolean
description: 'true if this user object is currently being synced from an on-premises Active Directory (AD); otherwise the user isn''t being synced and can be managed in Microsoft Entra ID. Read-only. Requires $select to retrieve. Supports $filter (eq, ne, not, in, and eq on null values).'
nullable: true
onPremisesUserPrincipalName:
type: string
description: 'Contains the on-premises userPrincipalName synchronized from the on-premises directory. The property is only populated for customers who are synchronizing their on-premises directory to Microsoft Entra ID via Microsoft Entra Connect. Read-only. Requires $select to retrieve. Supports $filter (eq, ne, not, ge, le, in, startsWith).'
nullable: true
otherMails:
type: array
items:
type: string
description: 'A list of other email addresses for the user; for example: [''bob@contoso.com'', ''Robert@fabrikam.com'']. Can store up to 250 values, each with a limit of 250 characters. NOTE: This property can''t contain accent characters. Requires $select to retrieve. Supports $filter (eq, not, ge, le, in, startsWith, endsWith, /$count eq 0, /$count ne 0). This property is subject to sensitive action restrictions; only specific privileged administrator roles can update it.'
passwordPolicies:
type: string
description: 'Specifies password policies for the user. This value is an enumeration with one possible value being DisableStrongPassword, which allows weaker passwords than the default policy to be specified. DisablePasswordExpiration can also be specified. The two might be specified together; for example: DisablePasswordExpiration, DisableStrongPassword. Requires $select to retrieve. For more information on the default password policies, see Microsoft Entra password policies. Supports $filter (ne, not, and eq on null values).'
nullable: true
passwordProfile:
$ref: '#/components/schemas/microsoft.graph.passwordProfile'
pastProjects:
type: array
items:
type: string
nullable: true
description: A list for the user to enumerate their past projects. Requires $select to retrieve.
postalCode:
type: string
description: 'The postal code for the user''s postal address. The postal code is specific to the user''s country or region. In the United States of America, this attribute contains the ZIP code. Maximum length is 40 characters. Requires $select to retrieve. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).'
nullable: true
preferredDataLocation:
type: string
description: 'The preferred data location for the user. For more information, see OneDrive Online Multi-Geo.'
nullable: true
preferredLanguage:
type: string
description: 'The preferred language for the user. The preferred language format is based on RFC 4646. The name is a combination of an ISO 639 two-letter lowercase culture code associated with the language, and an ISO 3166 two-letter uppercase subculture code associated with the country or region. Example: ''en-US'', or ''es-ES''. Returned by default. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values)'
nullable: true
preferredName:
type: string
description: The preferred name for the user. Not Supported. This attribute returns an empty string.Requires $select to retrieve.
nullable: true
print:
$ref: '#/components/schemas/microsoft.graph.userPrint'
provisionedPlans:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.provisionedPlan'
description: 'The plans that are provisioned for the user. Read-only. Not nullable. Requires $select to retrieve. Supports $filter (eq, not, ge, le).'
proxyAddresses:
type: array
items:
type: string
description: 'For example: [''SMTP: bob@contoso.com'', ''smtp: bob@sales.contoso.com'']. Changes to the mail property update this collection to include the value as an SMTP address. For more information, see mail and proxyAddresses properties. The proxy address prefixed with SMTP (capitalized) is the primary proxy address, while those addresses prefixed with smtp are the secondary proxy addresses. For Azure AD B2C accounts, this property has a limit of 10 unique addresses. Read-only in Microsoft Graph; you can update this property only through the Microsoft 365 admin center. Not nullable. Requires $select to retrieve. Supports $filter (eq, not, ge, le, startsWith, endsWith, /$count eq 0, /$count ne 0).'
responsibilities:
type: array
items:
type: string
nullable: true
description: A list for the user to enumerate their responsibilities. Requires $select to retrieve.
schools:
type: array
items:
type: string
nullable: true
description: A list for the user to enumerate the schools they attended. Requires $select to retrieve.
securityIdentifier:
type: string
description: 'Security identifier (SID) of the user, used in Windows scenarios. Read-only. Returned by default. Supports $select and $filter (eq, not, ge, le, startsWith).'
nullable: true
serviceProvisioningErrors:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.serviceProvisioningError'
description: 'Errors published by a federated service describing a nontransient, service-specific error regarding the properties or link from a user object. Supports $filter (eq, not, for isResolved and serviceInstance).'
showInAddressList:
type: boolean
description: Do not use in Microsoft Graph. Manage this property through the Microsoft 365 admin center instead. Represents whether the user should be included in the Outlook global address list. See Known issue.
nullable: true
signInActivity:
$ref: '#/components/schemas/microsoft.graph.signInActivity'
signInSessionsValidFromDateTime:
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: 'Any refresh tokens or session tokens (session cookies) issued before this time are invalid. Applications get an error when using an invalid refresh or session token to acquire a delegated access token (to access APIs such as Microsoft Graph). If this happens, the application needs to acquire a new refresh token by requesting the authorized endpoint. Read-only. Use revokeSignInSessions to reset. Requires $select to retrieve.'
format: date-time
nullable: true
skills:
type: array
items:
type: string
nullable: true
description: A list for the user to enumerate their skills. Requires $select to retrieve.
state:
type: string
description: 'The state or province in the user''s address. Maximum length is 128 characters. Requires $select to retrieve. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).'
nullable: true
streetAddress:
type: string
description: 'The street address of the user''s place of business. Maximum length is 1,024 characters. Requires $select to retrieve. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).'
nullable: true
surname:
type: string
description: 'The user''s surname (family name or last name). Maximum length is 64 characters. Returned by default. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).'
nullable: true
usageLocation:
type: string
description: 'A two-letter country code (ISO standard 3166). Required for users that are assigned licenses due to legal requirements to check for availability of services in countries/regions. Examples include: US, JP, and GB. Not nullable. Requires $select to retrieve. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).'
nullable: true
userPrincipalName:
type: string
description: 'The user principal name (UPN) of the user. The UPN is an Internet-style sign-in name for the user based on the Internet standard RFC 822. By convention, this value should map to the user''s email name. The general format is alias@domain, where the domain must be present in the tenant''s collection of verified domains. This property is required when a user is created. The verified domains for the tenant can be accessed from the verifiedDomains property of organization.NOTE: This property can''t contain accent characters. Only the following characters are allowed A - Z, a - z, 0 - 9, '' . - _ ! # ^ ~. For the complete list of allowed characters, see username policies. Returned by default. Supports $filter (eq, ne, not, ge, le, in, startsWith, endsWith) and $orderby. This property is subject to sensitive action restrictions; only specific privileged administrator roles can update it.'
nullable: true
userType:
type: string
description: 'A string value that can be used to classify user types in your directory. The possible values are Member and Guest. Requires $select to retrieve. Supports $filter (eq, ne, not, in, and eq on null values). NOTE: For more information about the permissions for members and guests, see What are the default user permissions in Microsoft Entra ID?'
nullable: true
activities:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.userActivity'
description: The user's activities across devices. Read-only. Nullable.
x-ms-navigationProperty: true
adhocCalls:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.adhocCall'
description: Ad hoc calls associated with the user. Read-only. Nullable.
x-ms-navigationProperty: true
agreementAcceptances:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.agreementAcceptance'
description: The user's terms of use acceptance statuses. Read-only. Nullable.
x-ms-navigationProperty: true
appRoleAssignments:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.appRoleAssignment'
description: Represents the app roles a user is granted for an application. Supports $expand.
x-ms-navigationProperty: true
authentication:
$ref: '#/components/schemas/microsoft.graph.authentication'
calendar:
$ref: '#/components/schemas/microsoft.graph.calendar'
calendarGroups:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.calendarGroup'
description: The user's calendar groups. Read-only. Nullable.
x-ms-navigationProperty: true
calendars:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.calendar'
description: The user's calendars. Read-only. Nullable.
x-ms-navigationProperty: true
calendarView:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.event'
description: The calendar view for the calendar. Read-only. Nullable.
x-ms-navigationProperty: true
chats:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.chat'
x-ms-navigationProperty: true
cloudClipboard:
$ref: '#/components/schemas/microsoft.graph.cloudClipboardRoot'
cloudPCs:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.cloudPC'
description: The user's Cloud PCs. Read-only. Nullable.
x-ms-navigationProperty: true
contactFolders:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.contactFolder'
description: The user's contacts folders. Read-only. Nullable.
x-ms-navigationProperty: true
contacts:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.contact'
description: The user's contacts. Read-only. Nullable.
x-ms-navigationProperty: true
createdObjects:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
description: Directory objects that the user created. Read-only. Nullable.
x-ms-navigationProperty: true
dataSecurityAndGovernance:
$ref: '#/components/schemas/microsoft.graph.userDataSecurityAndGovernance'
deviceManagementTroubleshootingEvents:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.deviceManagementTroubleshootingEvent'
description: The list of troubleshooting events for this user.
x-ms-navigationProperty: true
directReports:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
description: The users and contacts that report to the user. (The users and contacts that have their manager property set to this user.) Read-only. Nullable. Supports $expand.
x-ms-navigationProperty: true
drive:
$ref: '#/components/schemas/microsoft.graph.drive'
drives:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.drive'
description: A collection of drives available for this user. Read-only.
x-ms-navigationProperty: true
employeeExperience:
$ref: '#/components/schemas/microsoft.graph.employeeExperienceUser'
events:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.event'
description: The user's events. Default is to show Events under the Default Calendar. Read-only. Nullable.
x-ms-navigationProperty: true
extensions:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.extension'
description: The collection of open extensions defined for the user. Read-only. Supports $expand. Nullable.
x-ms-navigationProperty: true
followedSites:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.site'
x-ms-navigationProperty: true
inferenceClassification:
$ref: '#/components/schemas/microsoft.graph.inferenceClassification'
insights:
$ref: '#/components/schemas/microsoft.graph.itemInsights'
joinedTeams:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.team'
x-ms-navigationProperty: true
licenseDetails:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.licenseDetails'
description: A collection of this user's license details. Read-only.
x-ms-navigationProperty: true
mailFolders:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.mailFolder'
description: The user's mail folders. Read-only. Nullable.
x-ms-navigationProperty: true
managedAppRegistrations:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.managedAppRegistration'
description: Zero or more managed app registrations that belong to the user.
x-ms-navigationProperty: true
managedDevices:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.managedDevice'
description: The managed devices associated with the user.
x-ms-navigationProperty: true
manager:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
memberOf:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
description: The groups and directory roles that the user is a member of. Read-only. Nullable. Supports $expand.
x-ms-navigationProperty: true
messages:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.message'
description: The messages in a mailbox or folder. Read-only. Nullable.
x-ms-navigationProperty: true
oauth2PermissionGrants:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.oAuth2PermissionGrant'
x-ms-navigationProperty: true
onenote:
$ref: '#/components/schemas/microsoft.graph.onenote'
onlineMeetings:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.onlineMeeting'
description: 'Information about a meeting, including the URL used to join a meeting, the attendees list, and the description.'
x-ms-navigationProperty: true
onPremisesSyncBehavior:
$ref: '#/components/schemas/microsoft.graph.onPremisesSyncBehavior'
outlook:
$ref: '#/components/schemas/microsoft.graph.outlookUser'
ownedDevices:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
description: 'Devices the user owns. Read-only. Nullable. Supports $expand and $filter (/$count eq 0, /$count ne 0, /$count eq 1, /$count ne 1).'
x-ms-navigationProperty: true
ownedObjects:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
description: 'Directory objects the user owns. Read-only. Nullable. Supports $expand, $select nested in $expand, and $filter (/$count eq 0, /$count ne 0, /$count eq 1, /$count ne 1).'
x-ms-navigationProperty: true
people:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.person'
description: People that are relevant to the user. Read-only. Nullable.
x-ms-navigationProperty: true
permissionGrants:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.resourceSpecificPermissionGrant'
description: List all resource-specific permission grants of a user.
x-ms-navigationProperty: true
photo:
$ref: '#/components/schemas/microsoft.graph.profilePhoto'
photos:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.profilePhoto'
description: The collection of the user's profile photos in different sizes. Read-only.
x-ms-navigationProperty: true
planner:
$ref: '#/components/schemas/microsoft.graph.plannerUser'
presence:
$ref: '#/components/schemas/microsoft.graph.presence'
registeredDevices:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
description: Devices that are registered for the user. Read-only. Nullable. Supports $expand and returns up to 100 objects.
x-ms-navigationProperty: true
scopedRoleMemberOf:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.scopedRoleMembership'
x-ms-navigationProperty: true
settings:
$ref: '#/components/schemas/microsoft.graph.userSettings'
solutions:
$ref: '#/components/schemas/microsoft.graph.userSolutionRoot'
sponsorOf:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
description: 'Directory objects that this user sponsors, such as guest users, agent users, agent blueprints, agent blueprint principals, and agent identities. If the user is a member of a group that''s a sponsor, the objects sponsored by that group are also included. Read-only. Nullable. Supports $filter, $count, $select, $expand, $top, and $skip.'
x-ms-navigationProperty: true
sponsors:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
description: 'The users and groups responsible for this guest''s privileges in the tenant and keeping the guest''s information and access updated. (HTTP Methods: GET, POST, DELETE.). Supports $expand.'
x-ms-navigationProperty: true
teamwork:
$ref: '#/components/schemas/microsoft.graph.userTeamwork'
todo:
$ref: '#/components/schemas/microsoft.graph.todo'
transitiveMemberOf:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
description: 'The groups, including nested groups, and directory roles that a user is a member of. Nullable.'
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.synchronization:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: synchronization
type: object
properties:
secrets:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.synchronizationSecretKeyStringValuePair'
description: Represents a collection of credentials to access provisioned cloud applications.
jobs:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.synchronizationJob'
description: 'Performs synchronization by periodically running in the background, polling for changes in one directory, and pushing them to another directory.'
x-ms-navigationProperty: true
templates:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.synchronizationTemplate'
description: Preconfigured synchronization settings for a particular application.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.synchronizationJob:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: synchronizationJob
type: object
properties:
schedule:
$ref: '#/components/schemas/microsoft.graph.synchronizationSchedule'
status:
$ref: '#/components/schemas/microsoft.graph.synchronizationStatus'
synchronizationJobSettings:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.keyValuePair'
description: Settings associated with the job. Some settings are inherited from the template.
templateId:
type: string
description: Identifier of the synchronization template this job is based on.
nullable: true
bulkUpload:
$ref: '#/components/schemas/microsoft.graph.bulkUpload'
schema:
$ref: '#/components/schemas/microsoft.graph.synchronizationSchema'
additionalProperties:
type: object
microsoft.graph.bulkUpload:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: bulkUpload
type: object
additionalProperties:
type: object
microsoft.graph.synchronizationJobApplicationParameters:
title: synchronizationJobApplicationParameters
type: object
properties:
ruleId:
type: string
description: The identifier of the synchronizationRule to be applied. This rule ID is defined in the schema for a given synchronization job or template.
nullable: true
subjects:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.synchronizationJobSubject'
description: The identifiers of one or more objects to which a synchronizationJob is to be applied.
additionalProperties:
type: object
microsoft.graph.stringKeyStringValuePair:
title: stringKeyStringValuePair
type: object
properties:
key:
type: string
description: Key.
nullable: true
value:
type: string
description: Value.
nullable: true
additionalProperties:
type: object
microsoft.graph.synchronizationJobRestartCriteria:
title: synchronizationJobRestartCriteria
type: object
properties:
resetScope:
$ref: '#/components/schemas/microsoft.graph.synchronizationJobRestartScope'
additionalProperties:
type: object
microsoft.graph.synchronizationSecretKeyStringValuePair:
title: synchronizationSecretKeyStringValuePair
type: object
properties:
key:
$ref: '#/components/schemas/microsoft.graph.synchronizationSecret'
value:
type: string
description: The value of the secret.
nullable: true
additionalProperties:
type: object
microsoft.graph.synchronizationSchema:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: synchronizationSchema
type: object
properties:
synchronizationRules:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.synchronizationRule'
description: A collection of synchronization rules configured for the synchronizationJob or synchronizationTemplate.
version:
type: string
description: 'The version of the schema, updated automatically with every schema change.'
nullable: true
directories:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryDefinition'
description: Contains the collection of directories and all of their objects.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.directoryDefinition:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: directoryDefinition
type: object
properties:
discoverabilities:
$ref: '#/components/schemas/microsoft.graph.directoryDefinitionDiscoverabilities'
discoveryDateTime:
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: 'Represents the discovery date and time 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
name:
type: string
description: Name of the directory. Must be unique within the synchronization schema. Not nullable.
nullable: true
objects:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.objectDefinition'
description: Collection of objects supported by the directory.
readOnly:
type: boolean
description: Whether this object is read-only.
version:
type: string
description: Read only value that indicates version discovered. null if discovery hasn't yet occurred.
nullable: true
additionalProperties:
type: object
microsoft.graph.filterOperatorSchema:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: filterOperatorSchema
type: object
properties:
arity:
$ref: '#/components/schemas/microsoft.graph.scopeOperatorType'
multivaluedComparisonType:
$ref: '#/components/schemas/microsoft.graph.scopeOperatorMultiValuedComparisonType'
supportedAttributeTypes:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.attributeType'
description: 'Attribute types supported by the operator. The possible values are: Boolean, Binary, Reference, Integer, String.'
additionalProperties:
type: object
microsoft.graph.attributeMappingFunctionSchema:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: attributeMappingFunctionSchema
type: object
properties:
parameters:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.attributeMappingParameterSchema'
description: Collection of function parameters.
additionalProperties:
type: object
microsoft.graph.expressionInputObject:
title: expressionInputObject
type: object
properties:
definition:
$ref: '#/components/schemas/microsoft.graph.objectDefinition'
properties:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.stringKeyObjectValuePair'
description: Property values of the test object.
additionalProperties:
type: object
microsoft.graph.attributeDefinition:
title: attributeDefinition
type: object
properties:
anchor:
type: boolean
description: 'true if the attribute should be used as the anchor for the object. Anchor attributes must have a unique value identifying an object, and must be immutable. Default is false. One, and only one, of the object''s attributes must be designated as the anchor to support synchronization.'
apiExpressions:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.stringKeyStringValuePair'
caseExact:
type: boolean
description: true if value of this attribute should be treated as case-sensitive. This setting affects how the synchronization engine detects changes for the attribute.
defaultValue:
type: string
description: The default value of the attribute.
nullable: true
flowNullValues:
type: boolean
description: '''true'' to allow null values for attributes.'
metadata:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.attributeDefinitionMetadataEntry'
description: Metadata for the given object.
multivalued:
type: boolean
description: true if an attribute can have multiple values. Default is false.
mutability:
$ref: '#/components/schemas/microsoft.graph.mutability'
name:
type: string
description: Name of the attribute. Must be unique within the object definition. Not nullable.
nullable: true
referencedObjects:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.referencedObject'
description: 'For attributes with reference type, lists referenced objects (for example, the manager attribute would list User as the referenced object).'
required:
type: boolean
description: 'true if attribute is required. Object can not be created if any of the required attributes are missing. If during synchronization, the required attribute has no value, the default value will be used. If default the value was not set, synchronization will record an error.'
type:
$ref: '#/components/schemas/microsoft.graph.attributeType'
additionalProperties:
type: object
microsoft.graph.parseExpressionResponse:
title: parseExpressionResponse
type: object
properties:
error:
$ref: '#/components/schemas/microsoft.graph.publicError'
evaluationResult:
type: array
items:
type: string
nullable: true
description: A collection of values produced by the evaluation of the expression.
evaluationSucceeded:
type: boolean
description: true if the evaluation was successful.
parsedExpression:
$ref: '#/components/schemas/microsoft.graph.attributeMappingSource'
parsingSucceeded:
type: boolean
description: true if the expression was parsed successfully.
additionalProperties:
type: object
microsoft.graph.synchronizationTemplate:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: synchronizationTemplate
type: object
properties:
applicationId:
pattern: '^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$'
type: string
description: Identifier of the application this template belongs to.
format: uuid
default:
type: boolean
description: true if this template is recommended to be the default for the application.
description:
type: string
description: Description of the template.
nullable: true
discoverable:
type: boolean
description: true if this template should appear in the collection of templates available for the application instance (service principal).
factoryTag:
type: string
description: One of the well-known factory tags supported by the synchronization engine. The factoryTag tells the synchronization engine which implementation to use when processing jobs based on this template.
nullable: true
metadata:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.synchronizationMetadataEntry'
description: 'Additional extension properties. Unless mentioned explicitly, metadata values should not be changed.'
schema:
$ref: '#/components/schemas/microsoft.graph.synchronizationSchema'
additionalProperties:
type: object
microsoft.graph.applicationTemplate:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: applicationTemplate
type: object
properties:
categories:
type: array
items:
type: string
nullable: true
description: 'The list of categories for the application. Supported values can be: Collaboration, Business Management, Consumer, Content management, CRM, Data services, Developer services, E-commerce, Education, ERP, Finance, Health, Human resources, IT infrastructure, Mail, Management, Marketing, Media, Productivity, Project management, Telecommunications, Tools, Travel, and Web design & hosting. Supports $filter (contains).'
deprecationDate:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$'
type: string
description: 'Deprecation date for this application. If specified, the application will be removed from the Microsoft Entra application gallery on this date.'
format: date
nullable: true
description:
type: string
description: A description of the application.
nullable: true
displayName:
type: string
description: The name of the application. Supports $filter (contains).
nullable: true
endpoints:
type: array
items:
type: string
nullable: true
description: A collection of string URLs representing various domains that are used by this application.
homePageUrl:
type: string
description: The home page URL of the application.
nullable: true
isEntraIntegrated:
type: boolean
description: 'Indicates whether the application is integrated with Entra ID (for example, through single sign-on or user provisioning).'
lastModifiedDateTime:
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 data for the application was last updated, represented using ISO 8601 format and always in UTC time.'
format: date-time
nullable: true
logoUrl:
type: string
description: The URL to get the logo for this application.
nullable: true
publisher:
type: string
description: The name of the publisher for this application.
nullable: true
riskFactors:
$ref: '#/components/schemas/microsoft.graph.applicationRiskFactors'
riskScore:
$ref: '#/components/schemas/microsoft.graph.applicationRiskScore'
supportedProvisioningTypes:
type: array
items:
type: string
nullable: true
description: The list of provisioning modes supported by this application. The only valid value is sync.
supportedSingleSignOnModes:
type: array
items:
type: string
nullable: true
description: 'The list of single sign-on modes supported by this application. The supported values are oidc, password, saml, and notSupported.'
additionalProperties:
type: object
microsoft.graph.applicationServicePrincipal:
title: applicationServicePrincipal
type: object
properties:
application:
$ref: '#/components/schemas/microsoft.graph.application'
servicePrincipal:
$ref: '#/components/schemas/microsoft.graph.servicePrincipal'
additionalProperties:
type: object
microsoft.graph.appManagementPolicy:
allOf:
- $ref: '#/components/schemas/microsoft.graph.policyBase'
- title: appManagementPolicy
type: object
properties:
isEnabled:
type: boolean
description: Denotes whether the policy is enabled.
restrictions:
$ref: '#/components/schemas/microsoft.graph.customAppManagementConfiguration'
appliesTo:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
description: Collection of applications and service principals to which the policy is applied.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.delegatedPermissionClassification:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: delegatedPermissionClassification
type: object
properties:
classification:
$ref: '#/components/schemas/microsoft.graph.permissionClassificationType'
permissionId:
type: string
description: The unique identifier (id) for the delegated permission listed in the oauth2PermissionScopes collection of the servicePrincipal. Required on create. Doesn't support $filter.
nullable: true
permissionName:
type: string
description: The claim value (value) for the delegated permission listed in the oauth2PermissionScopes collection of the servicePrincipal. Doesn't support $filter.
nullable: true
additionalProperties:
type: object
microsoft.graph.administrativeUnit:
allOf:
- $ref: '#/components/schemas/microsoft.graph.directoryObject'
- title: administrativeUnit
type: object
properties:
description:
type: string
description: 'An optional description for the administrative unit. Supports $filter (eq, ne, in, startsWith), $search.'
nullable: true
displayName:
type: string
description: 'Display name for the administrative unit. Maximum length is 256 characters. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values), $search, and $orderby.'
nullable: true
isMemberManagementRestricted:
type: boolean
description: 'true if members of this administrative unit should be treated as sensitive, which requires specific permissions to manage. If not set, the default value is null and the default behavior is false. Use this property to define administrative units with roles that don''t inherit from tenant-level administrators, and where the management of individual member objects is limited to administrators scoped to a restricted management administrative unit. This property is immutable and can''t be changed later. For more information on how to work with restricted management administrative units, see Restricted management administrative units in Microsoft Entra ID.'
nullable: true
membershipRule:
type: string
description: 'The dynamic membership rule for the administrative unit. For more information about the rules you can use for dynamic administrative units and dynamic groups, see Manage rules for dynamic membership groups in Microsoft Entra ID.'
nullable: true
membershipRuleProcessingState:
type: string
description: 'Controls whether the dynamic membership rule is actively processed. Set to On to activate the dynamic membership rule, or Paused to stop updating membership dynamically.'
nullable: true
membershipType:
type: string
description: 'Indicates the membership type for the administrative unit. The possible values are: dynamic, assigned. If not set, the default value is null and the default behavior is assigned.'
nullable: true
visibility:
type: string
description: 'Controls whether the administrative unit and its members are hidden or public. Can be set to HiddenMembership. If not set, the default value is null and the default behavior is public. When set to HiddenMembership, only members of the administrative unit can list other members of the administrative unit.'
nullable: true
extensions:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.extension'
description: The collection of open extensions defined for this administrative unit. Nullable.
x-ms-navigationProperty: true
members:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
description: Users and groups that are members of this administrative unit. Supports $expand.
x-ms-navigationProperty: true
scopedRoleMembers:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.scopedRoleMembership'
description: Scoped-role members of this administrative unit.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.directoryRole:
allOf:
- $ref: '#/components/schemas/microsoft.graph.directoryObject'
- title: directoryRole
type: object
properties:
description:
type: string
description: 'The description for the directory role. Read-only. Supports $filter (eq), $search, $select.'
nullable: true
displayName:
type: string
description: 'The display name for the directory role. Read-only. Supports $filter (eq), $search, $select.'
nullable: true
roleTemplateId:
type: string
description: 'The id of the directoryRoleTemplate that this role is based on. The property must be specified when activating a directory role in a tenant with a POST operation. After the directory role has been activated, the property is read-only. Supports $filter (eq), $select.'
nullable: true
members:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
description: 'Users that are members of this directory role. HTTP Methods: GET, POST, DELETE. Read-only. Nullable. Supports $expand.'
x-ms-navigationProperty: true
scopedMembers:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.scopedRoleMembership'
description: Members of this directory role that are scoped to administrative units. Read-only. Nullable.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.group:
allOf:
- $ref: '#/components/schemas/microsoft.graph.directoryObject'
- title: group
type: object
properties:
accessType:
$ref: '#/components/schemas/microsoft.graph.groupAccessType'
allowExternalSenders:
type: boolean
description: 'Indicates if people external to the organization can send messages to the group. The default value is false. Requires $select to retrieve. Supported only on the Get group API (GET /groups/{ID}).'
nullable: true
assignedLabels:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.assignedLabel'
description: 'The list of sensitivity label pairs (label ID, label name) associated with a Microsoft 365 group or a cloud security group. Requires a Microsoft Entra ID P1 license. Requires $select to retrieve. This property can be specified during group creation or update. However, for cloud security groups, it''s immutable once set. This property can be updated only in delegated scenarios where the caller requires both the Microsoft Graph permission and a supported administrator role. See Key differences from Microsoft 365 group labeling to learn more about managing this property for Microsoft 365 vs. cloud security groups.'
assignedLicenses:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.assignedLicense'
description: The licenses that are assigned to the group. Requires $select to retrieve. Supports $filter (eq). Read-only.
autoSubscribeNewMembers:
type: boolean
description: 'Indicates if new members added to the group are autosubscribed to receive email notifications. You can set this property in a PATCH request for the group; don''t set it in the initial POST request that creates the group. Default value is false. Requires $select to retrieve. Supported only on the Get group API (GET /groups/{ID}).'
nullable: true
classification:
type: string
description: 'Describes a classification for the group (such as low, medium, or high business impact). Valid values for this property are defined by creating a ClassificationList setting value, based on the template definition.Returned by default. Supports $filter (eq, ne, not, ge, le, startsWith).'
nullable: true
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: 'Timestamp of when the group was created. The value can''t be modified and is automatically populated when the group is created. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on January 1, 2014 is 2014-01-01T00:00:00Z. Returned by default. Read-only.'
format: date-time
nullable: true
description:
type: string
description: 'An optional description for the group. Returned by default. Supports $filter (eq, ne, not, ge, le, startsWith) and $search.'
nullable: true
displayName:
type: string
description: 'The display name for the group. This property is required when a group is created and can''t be cleared during updates. Maximum length is 256 characters. Returned by default. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values), $search, and $orderby.'
nullable: true
expirationDateTime:
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: 'Timestamp of when the group is set to expire. It''s null for security groups, but for Microsoft 365 groups, it represents when the group is set to expire as defined in the groupLifecyclePolicy. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on January 1, 2014 is 2014-01-01T00:00:00Z. Returned by default. Supports $filter (eq, ne, not, ge, le, in). Read-only.'
format: date-time
nullable: true
groupTypes:
type: array
items:
type: string
description: 'Specifies the group type and its membership. If the collection contains Unified, the group is a Microsoft 365 group; otherwise, it''s either a security group or a distribution group. For details, see groups overview.If the collection includes DynamicMembership, the group has dynamic membership; otherwise, membership is static. Returned by default. Supports $filter (eq, not).'
hasMembersWithLicenseErrors:
type: boolean
description: 'Indicates whether there are members in this group that have license errors from its group-based license assignment. This property is never returned on a GET operation. You can use it as a $filter argument to get groups that have members with license errors (that is, filter for this property being true). See an example. Supports $filter (eq).'
nullable: true
hideFromAddressLists:
type: boolean
description: 'True if the group isn''t displayed in certain parts of the Outlook UI: the Address Book, address lists for selecting message recipients, and the Browse Groups dialog for searching groups; otherwise, false. The default value is false. Requires $select to retrieve. Supported only on the Get group API (GET /groups/{ID}).'
nullable: true
hideFromOutlookClients:
type: boolean
description: 'True if the group isn''t displayed in Outlook clients, such as Outlook for Windows and Outlook on the web; otherwise, false. The default value is false. Requires $select to retrieve. Supported only on the Get group API (GET /groups/{ID}).'
nullable: true
infoCatalogs:
type: array
items:
type: string
isArchived:
type: boolean
description: 'When a group is associated with a team, this property determines whether the team is in read-only mode.To read this property, use the /group/{groupId}/team endpoint or the Get team API. To update this property, use the archiveTeam and unarchiveTeam APIs.'
nullable: true
isAssignableToRole:
type: boolean
description: 'Indicates whether this group can be assigned to a Microsoft Entra role. Optional. This property can only be set while creating the group and is immutable. If set to true, the securityEnabled property must also be set to true, visibility must be Hidden, and the group can''t be a dynamic group (that is, groupTypes can''t contain DynamicMembership). Only callers with at least the Privileged Role Administrator role can set this property. The caller must also be assigned the RoleManagement.ReadWrite.Directory permission to set this property or update the membership of such groups. For more, see Using a group to manage Microsoft Entra role assignmentsUsing this feature requires a Microsoft Entra ID P1 license. Returned by default. Supports $filter (eq, ne, not).'
nullable: true
isFavorite:
type: boolean
description: 'Indicates whether the user marked the group as favorite. Requires $select to retrieve. Supported only on the Get group API (GET /groups/{ID}).'
nullable: true
isManagementRestricted:
type: boolean
description: 'Indicates whether the group is a member of a restricted management administrative unit. If not set, the default value is null and the default behavior is false. Read-only. To manage a group member of a restricted management administrative unit, the administrator or calling app must be assigned a Microsoft Entra role at the scope of the restricted management administrative unit. Requires $select to retrieve.'
nullable: true
isSubscribedByMail:
type: boolean
description: 'Indicates whether the signed-in user is subscribed to receive email conversations. The default value is true. Requires $select to retrieve. Supported only on the Get group API (GET /groups/{ID}).'
nullable: true
licenseProcessingState:
$ref: '#/components/schemas/microsoft.graph.licenseProcessingState'
mail:
type: string
description: 'The SMTP address for the group, for example, ''serviceadmins@contoso.com''. Returned by default. Read-only. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).'
nullable: true
mailEnabled:
type: boolean
description: 'Specifies whether the group is mail-enabled. Required. Returned by default. Supports $filter (eq, ne, not).'
nullable: true
mailNickname:
type: string
description: 'The mail alias for the group, unique for Microsoft 365 groups in the organization. Maximum length is 64 characters. This property can contain only characters in the ASCII character set 0 - 127 except the following characters: @ () / [] '' ; : <> , SPACE. Required. Returned by default. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).'
nullable: true
membershipRule:
type: string
description: 'The rule that determines members for this group if the group is a dynamic group (groupTypes contains DynamicMembership). For more information about the syntax of the membership rule, see Membership Rules syntax. Returned by default. Supports $filter (eq, ne, not, ge, le, startsWith).'
nullable: true
membershipRuleProcessingState:
type: string
description: 'Indicates whether the dynamic membership processing is on or paused. Possible values are On or Paused. Returned by default. Supports $filter (eq, ne, not, in).'
nullable: true
onPremisesDomainName:
type: string
description: 'Contains the on-premises domain FQDN, also called dnsDomainName synchronized from the on-premises directory. The property is only populated for customers synchronizing their on-premises directory to Microsoft Entra ID via Microsoft Entra Connect.Returned by default. Read-only.'
nullable: true
onPremisesExtensionAttributes:
$ref: '#/components/schemas/microsoft.graph.onPremisesExtensionAttributes'
onPremisesLastSyncDateTime:
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: 'Indicates the last time at which the group was synced with the on-premises directory. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on January 1, 2014 is 2014-01-01T00:00:00Z. Returned by default. Read-only. Supports $filter (eq, ne, not, ge, le, in).'
format: date-time
nullable: true
onPremisesNetBiosName:
type: string
description: Contains the on-premises netBios name synchronized from the on-premises directory. The property is only populated for customers synchronizing their on-premises directory to Microsoft Entra ID via Microsoft Entra Connect.Returned by default. Read-only.
nullable: true
onPremisesProvisioningErrors:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.onPremisesProvisioningError'
description: 'Errors when using Microsoft synchronization product during provisioning. Returned by default. Supports $filter (eq, not).'
onPremisesSamAccountName:
type: string
description: 'Contains the on-premises SAM account name synchronized from the on-premises directory. The property is only populated for customers synchronizing their on-premises directory to Microsoft Entra ID via Microsoft Entra Connect.Returned by default. Supports $filter (eq, ne, not, ge, le, in, startsWith). Read-only.'
nullable: true
onPremisesSecurityIdentifier:
type: string
description: Contains the on-premises security identifier (SID) for the group synchronized from on-premises to the cloud. Read-only. Returned by default. Supports $filter (eq including on null values).
nullable: true
onPremisesSyncEnabled:
type: boolean
description: 'true if this group is synced from an on-premises directory; false if this group was originally synced from an on-premises directory but is no longer synced; null if this object has never synced from an on-premises directory (default). Returned by default. Read-only. Supports $filter (eq, ne, not, in, and eq on null values).'
nullable: true
organizationId:
type: string
nullable: true
preferredDataLocation:
type: string
description: 'The preferred data location for the Microsoft 365 group. By default, the group inherits the group creator''s preferred data location. To set this property, the calling app must be granted the Directory.ReadWrite.All permission and the user be assigned at least one of the following Microsoft Entra roles: User Account Administrator Directory Writer Exchange Administrator SharePoint Administrator For more information about this property, see OneDrive Online Multi-Geo. Nullable. Returned by default.'
nullable: true
preferredLanguage:
type: string
description: 'The preferred language for a Microsoft 365 group. Should follow ISO 639-1 Code; for example, en-US. Returned by default. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).'
nullable: true
proxyAddresses:
type: array
items:
type: string
description: 'Email addresses for the group that direct to the same group mailbox. For example: [''SMTP: bob@contoso.com'', ''smtp: bob@sales.contoso.com'']. The any operator is required to filter expressions on multi-valued properties. Returned by default. Read-only. Not nullable. Supports $filter (eq, not, ge, le, startsWith, endsWith, /$count eq 0, /$count ne 0).'
renewedDateTime:
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: 'Timestamp of when the group was last renewed. This value can''t be modified directly and is only updated via the renew service action. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on January 1, 2014 is 2014-01-01T00:00:00Z. Returned by default. Supports $filter (eq, ne, not, ge, le, in). Read-only.'
format: date-time
nullable: true
resourceBehaviorOptions:
type: array
items:
type: string
description: 'Specifies the group behaviors that can be set for a Microsoft 365 group during creation. This property can be set only as part of creation (POST). For the list of possible values, see Microsoft 365 group behaviors and provisioning options.'
resourceProvisioningOptions:
type: array
items:
type: string
description: 'Specifies the group resources that are associated with the Microsoft 365 group. The possible value is Team. For more information, see Microsoft 365 group behaviors and provisioning options. Returned by default. Supports $filter (eq, not, startsWith).'
securityEnabled:
type: boolean
description: 'Specifies whether the group is a security group. Required. Returned by default. Supports $filter (eq, ne, not, in).'
nullable: true
securityIdentifier:
type: string
description: 'Security identifier of the group, used in Windows scenarios. Read-only. Returned by default.'
nullable: true
serviceProvisioningErrors:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.serviceProvisioningError'
description: 'Errors published by a federated service describing a nontransient, service-specific error regarding the properties or link from a group object. Supports $filter (eq, not, for isResolved and serviceInstance).'
theme:
type: string
description: 'Specifies a Microsoft 365 group''s color theme. Possible values are Teal, Purple, Green, Blue, Pink, Orange, or Red. Returned by default.'
nullable: true
uniqueName:
type: string
description: The unique identifier that can be assigned to a group and used as an alternate key. Immutable. Read-only.
nullable: true
unseenConversationsCount:
maximum: 2147483647
minimum: -2147483648
type: number
description: 'Count of conversations that have had one or more new posts delivered since the signed-in user''s last visit to the group. This property is the same as unseenCount. Requires $select to retrieve. Supported only on the Get group API (GET /groups/{ID}).'
format: int32
nullable: true
unseenCount:
maximum: 2147483647
minimum: -2147483648
type: number
description: 'Count of conversations that have received new posts since the signed-in user last visited the group. This property is the same as unseenConversationsCount.Requires $select to retrieve. Supported only on the Get group API (GET /groups/{ID}).'
format: int32
nullable: true
unseenMessagesCount:
maximum: 2147483647
minimum: -2147483648
type: number
description: 'Count of new posts that have been delivered to the group''s conversations since the signed-in user''s last visit to the group. Requires $select to retrieve. Supported only on the Get group API (GET /groups/{ID}).'
format: int32
nullable: true
visibility:
type: string
description: 'Specifies the group join policy and group content visibility for groups. The possible values are: Private, Public, or HiddenMembership. HiddenMembership can be set only for Microsoft 365 groups when the groups are created. It can''t be updated later. Other values of visibility can be updated after group creation. If visibility value isn''t specified during group creation on Microsoft Graph, a security group is created as Private by default, and the Microsoft 365 group is Public. Groups assignable to roles are always Private. To learn more, see group visibility options. Returned by default. Nullable.'
nullable: true
welcomeMessageEnabled:
type: boolean
nullable: true
acceptedSenders:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
description: 'The list of users or groups allowed to create posts or calendar events in this group. If this list is nonempty, then only users or groups listed here are allowed to post.'
x-ms-navigationProperty: true
appRoleAssignments:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.appRoleAssignment'
description: Represents the app roles granted to a group for an application. Supports $expand.
x-ms-navigationProperty: true
calendar:
$ref: '#/components/schemas/microsoft.graph.calendar'
calendarView:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.event'
description: The calendar view for the calendar. Read-only.
x-ms-navigationProperty: true
conversations:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.conversation'
description: The group's conversations.
x-ms-navigationProperty: true
createdOnBehalfOf:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
drive:
$ref: '#/components/schemas/microsoft.graph.drive'
drives:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.drive'
description: The group's drives. Read-only.
x-ms-navigationProperty: true
events:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.event'
description: The group's calendar events.
x-ms-navigationProperty: true
extensions:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.extension'
description: The collection of open extensions defined for the group. Read-only. Nullable.
x-ms-navigationProperty: true
groupLifecyclePolicies:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.groupLifecyclePolicy'
description: The collection of lifecycle policies for this group. Read-only. Nullable.
x-ms-navigationProperty: true
memberOf:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
description: 'Groups that this group is a member of. HTTP Methods: GET (supported for all groups). Read-only. Nullable. Supports $expand.'
x-ms-navigationProperty: true
members:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
description: 'The members of this group, who can be users, devices, other groups, or service principals. Supports the List members, Add member, and Remove member operations. Nullable. Supports $expand including nested $select. For example, /groups?$filter=startsWith(displayName,''Role'')&$select=id,displayName&$expand=members($select=id,userPrincipalName,displayName).'
x-ms-navigationProperty: true
membersWithLicenseErrors:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
description: A list of group members with license errors from this group-based license assignment. Read-only.
x-ms-navigationProperty: true
onenote:
$ref: '#/components/schemas/microsoft.graph.onenote'
onPremisesSyncBehavior:
$ref: '#/components/schemas/microsoft.graph.onPremisesSyncBehavior'
owners:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
description: 'The owners of the group who can be users or service principals. Limited to 100 owners. Nullable. If this property isn''t specified when creating a Microsoft 365 group the calling user (admin or non-admin) is automatically assigned as the group owner. A non-admin user can''t explicitly add themselves to this collection when they''re creating the group. For more information, see the related known issue. For security groups, the admin user isn''t automatically added to this collection. For more information, see the related known issue. Supports $filter (/$count eq 0, /$count ne 0, /$count eq 1, /$count ne 1); Supports $expand including nested $select. For example, /groups?$filter=startsWith(displayName,''Role'')&$select=id,displayName&$expand=owners($select=id,userPrincipalName,displayName).'
x-ms-navigationProperty: true
permissionGrants:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.resourceSpecificPermissionGrant'
x-ms-navigationProperty: true
photo:
$ref: '#/components/schemas/microsoft.graph.profilePhoto'
photos:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.profilePhoto'
description: The profile photos owned by the group. Read-only. Nullable.
x-ms-navigationProperty: true
planner:
$ref: '#/components/schemas/microsoft.graph.plannerGroup'
rejectedSenders:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
description: The list of users or groups not allowed to create posts or calendar events in this group. Nullable
x-ms-navigationProperty: true
settings:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.groupSetting'
description: 'Settings that can govern this group''s behavior, like whether members can invite guests to the group. Nullable.'
x-ms-navigationProperty: true
sites:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.site'
description: The list of SharePoint sites in this group. Access the default site with /sites/root.
x-ms-navigationProperty: true
team:
$ref: '#/components/schemas/microsoft.graph.team'
threads:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.conversationThread'
description: The group's conversation threads. Nullable.
x-ms-navigationProperty: true
transitiveMemberOf:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
description: 'The groups that a group is a member of, either directly or through nested membership. Nullable.'
x-ms-navigationProperty: true
transitiveMembers:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
description: The direct and transitive members of a group. Nullable.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.selfSignedCertificate:
title: selfSignedCertificate
type: object
properties:
customKeyIdentifier:
type: string
description: Custom key identifier.
format: base64url
nullable: true
displayName:
type: string
description: The friendly name for the key.
nullable: true
endDateTime:
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 at which the credential expires. The timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on January 1, 2014 is 2014-01-01T00:00:00Z.'
format: date-time
nullable: true
key:
type: string
description: The value for the key credential. Should be a Base-64 encoded value.
format: base64url
nullable: true
keyId:
pattern: '^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$'
type: string
description: The unique identifier (GUID) for the key.
format: uuid
nullable: true
startDateTime:
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 at which the credential becomes valid. The timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on January 1, 2014 is 2014-01-01T00:00:00Z.'
format: date-time
nullable: true
thumbprint:
type: string
description: The thumbprint value for the key.
nullable: true
type:
type: string
description: The type of key credential. AsymmetricX509Cert.
nullable: true
usage:
type: string
description: A string that describes the purpose for which the key can be used. The possible value is Verify.
nullable: true
additionalProperties:
type: object
microsoft.graph.oAuth2PermissionGrant:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: oAuth2PermissionGrant
type: object
properties:
clientId:
type: string
description: The object id (not appId) of the client service principal for the application that's authorized to act on behalf of a signed-in user when accessing an API. Required. Supports $filter (eq only).
consentType:
type: string
description: 'Indicates if authorization is granted for the client application to impersonate all users or only a specific user. AllPrincipals indicates authorization to impersonate all users. Principal indicates authorization to impersonate a specific user. Consent on behalf of all users can be granted by an administrator. Nonadmin users might be authorized to consent on behalf of themselves in some cases, for some delegated permissions. Required. Supports $filter (eq only).'
nullable: true
principalId:
type: string
description: 'The id of the user on behalf of whom the client is authorized to access the resource, when consentType is Principal. If consentType is AllPrincipals this value is null. Required when consentType is Principal. Supports $filter (eq only).'
nullable: true
resourceId:
type: string
description: The id of the resource service principal to which access is authorized. This identifies the API that the client is authorized to attempt to call on behalf of a signed-in user. Supports $filter (eq only).
scope:
type: string
description: 'A space-separated list of the claim values for delegated permissions that should be included in access tokens for the resource application (the API). For example, openid User.Read GroupMember.Read.All. Each claim value should match the value field of one of the delegated permissions defined by the API, listed in the oauth2PermissionScopes property of the resource service principal. Must not exceed 3,850 characters in length.'
nullable: true
additionalProperties:
type: object
microsoft.graph.remoteDesktopSecurityConfiguration:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: remoteDesktopSecurityConfiguration
type: object
properties:
isRemoteDesktopProtocolEnabled:
type: boolean
description: Determines if Microsoft Entra ID RDS authentication protocol for RDP is enabled.
approvedClientApps:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.approvedClientApp'
description: The collection of approved client apps that are associated with the RDS configuration. Supports $expand.
x-ms-navigationProperty: true
targetDeviceGroups:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.targetDeviceGroup'
description: The collection of target device groups that are associated with the RDS security configuration that will be enabled for SSO when a client connects to the target device over RDP using the new Microsoft Entra ID RDS authentication protocol.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.approvedClientApp:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: approvedClientApp
type: object
properties:
displayName:
type: string
description: The display name of the approved client application.
nullable: true
additionalProperties:
type: object
microsoft.graph.targetDeviceGroup:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: targetDeviceGroup
type: object
properties:
displayName:
type: string
description: Display name for the target device group.
nullable: true
additionalProperties:
type: object
microsoft.graph.addIn:
title: addIn
type: object
properties:
id:
pattern: '^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$'
type: string
description: The unique identifier for the addIn object.
format: uuid
nullable: true
properties:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.keyValue'
description: The collection of key-value pairs that define parameters that the consuming service can use or call. You must specify this property when performing a POST or a PATCH operation on the addIns collection. Required.
type:
type: string
description: The unique name for the functionality exposed by the app.
additionalProperties:
type: object
microsoft.graph.apiApplication:
title: apiApplication
type: object
properties:
acceptMappedClaims:
type: boolean
description: 'When true, allows an application to use claims mapping without specifying a custom signing key.'
nullable: true
knownClientApplications:
type: array
items:
pattern: '^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$'
type: string
format: uuid
nullable: true
description: 'Used for bundling consent if you have a solution that contains two parts: a client app and a custom web API app. If you set the appID of the client app to this value, the user only consents once to the client app. Microsoft Entra ID knows that consenting to the client means implicitly consenting to the web API and automatically provisions service principals for both APIs at the same time. Both the client and the web API app must be registered in the same tenant.'
oauth2PermissionScopes:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.permissionScope'
description: 'The definition of the delegated permissions exposed by the web API represented by this application registration. These delegated permissions may be requested by a client application, and may be granted by users or administrators during consent. Delegated permissions are sometimes referred to as OAuth 2.0 scopes.'
preAuthorizedApplications:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.preAuthorizedApplication'
description: 'Lists the client applications that are preauthorized with the specified delegated permissions to access this application''s APIs. Users aren''t required to consent to any preauthorized application (for the permissions specified). However, any other permissions not listed in preAuthorizedApplications (requested through incremental consent for example) will require user consent.'
requestedAccessTokenVersion:
maximum: 2147483647
minimum: -2147483648
type: number
description: 'Specifies the access token version expected by this resource. This changes the version and format of the JWT produced independent of the endpoint or client used to request the access token. The endpoint used, v1.0 or v2.0, is chosen by the client and only impacts the version of id_tokens. Resources need to explicitly configure requestedAccessTokenVersion to indicate the supported access token format. Possible values for requestedAccessTokenVersion are 1, 2, or null. If the value is null, this defaults to 1, which corresponds to the v1.0 endpoint. If signInAudience on the application is configured as AzureADandPersonalMicrosoftAccount or PersonalMicrosoftAccount, the value for this property must be 2.'
format: int32
nullable: true
additionalProperties:
type: object
microsoft.graph.appRole:
title: appRole
type: object
properties:
allowedMemberTypes:
type: array
items:
type: string
description: 'Specifies whether this app role can be assigned to users and groups (by setting to [''User'']), to other application''s (by setting to [''Application''], or both (by setting to [''User'', ''Application'']). App roles supporting assignment to other applications'' service principals are also known as application permissions. The ''Application'' value is only supported for app roles defined on application entities.'
description:
type: string
description: 'The description for the app role. This is displayed when the app role is being assigned and, if the app role functions as an application permission, during consent experiences.'
nullable: true
displayName:
type: string
description: Display name for the permission that appears in the app role assignment and consent experiences.
nullable: true
id:
pattern: '^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$'
type: string
description: 'Unique role identifier inside the appRoles collection. When creating a new app role, a new GUID identifier must be provided.'
format: uuid
isEnabled:
type: boolean
description: 'When creating or updating an app role, this must be set to true (which is the default). To delete a role, this must first be set to false. At that point, in a subsequent call, this role may be removed.'
origin:
type: string
description: Specifies if the app role is defined on the application object or on the servicePrincipal entity. Must not be included in any POST or PATCH requests. Read-only.
nullable: true
value:
type: string
description: 'Specifies the value to include in the roles claim in ID tokens and access tokens authenticating an assigned user or service principal. Must not exceed 120 characters in length. Allowed characters are : ! # $ % & '' ( ) * + , - . / : ; = ? @ [ ] ^ + _ { } ~, and characters in the ranges 0-9, A-Z and a-z. Any other character, including the space character, aren''t allowed. May not begin with ..'
nullable: true
additionalProperties:
type: object
microsoft.graph.authenticationBehaviors:
title: authenticationBehaviors
type: object
properties:
blockAzureADGraphAccess:
type: boolean
nullable: true
removeUnverifiedEmailClaim:
type: boolean
nullable: true
requireClientServicePrincipal:
type: boolean
nullable: true
additionalProperties:
type: object
microsoft.graph.certification:
title: certification
type: object
properties:
certificationDetailsUrl:
type: string
description: URL that shows certification details for the application.
nullable: true
readOnly: true
certificationExpirationDateTime:
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 when the current certification for the application expires.
format: date-time
nullable: true
isCertifiedByMicrosoft:
type: boolean
description: Indicates whether the application is certified by Microsoft.
nullable: true
readOnly: true
isPublisherAttested:
type: boolean
description: Indicates whether the application developer or publisher completed Publisher Attestation.
nullable: true
lastCertificationDateTime:
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 when the certification for the application was most recently added or updated.
format: date-time
nullable: true
additionalProperties:
type: object
microsoft.graph.informationalUrl:
title: informationalUrl
type: object
properties:
logoUrl:
type: string
description: 'CDN URL to the application''s logo, Read-only.'
nullable: true
marketingUrl:
type: string
description: 'Link to the application''s marketing page. For example, https://www.contoso.com/app/marketing'
nullable: true
privacyStatementUrl:
type: string
description: 'Link to the application''s privacy statement. For example, https://www.contoso.com/app/privacy'
nullable: true
supportUrl:
type: string
description: 'Link to the application''s support page. For example, https://www.contoso.com/app/support'
nullable: true
termsOfServiceUrl:
type: string
description: 'Link to the application''s terms of service statement. For example, https://www.contoso.com/app/termsofservice'
nullable: true
additionalProperties:
type: object
microsoft.graph.nativeAuthenticationApisEnabled:
title: nativeAuthenticationApisEnabled
enum:
- none
- all
- unknownFutureValue
type: string
x-ms-enum-flags:
isFlags: true
microsoft.graph.optionalClaims:
title: optionalClaims
type: object
properties:
accessToken:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.optionalClaim'
description: The optional claims returned in the JWT access token.
idToken:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.optionalClaim'
description: The optional claims returned in the JWT ID token.
saml2Token:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.optionalClaim'
description: The optional claims returned in the SAML token.
additionalProperties:
type: object
microsoft.graph.parentalControlSettings:
title: parentalControlSettings
type: object
properties:
countriesBlockedForMinors:
type: array
items:
type: string
nullable: true
description: Specifies the two-letter ISO country codes. Access to the application will be blocked for minors from the countries specified in this list.
legalAgeGroupRule:
type: string
description: 'Specifies the legal age group rule that applies to users of the app. Can be set to one of the following values: ValueDescriptionAllowDefault. Enforces the legal minimum. This means parental consent is required for minors in the European Union and Korea.RequireConsentForPrivacyServicesEnforces the user to specify date of birth to comply with COPPA rules. RequireConsentForMinorsRequires parental consent for ages below 18, regardless of country/region minor rules.RequireConsentForKidsRequires parental consent for ages below 14, regardless of country/region minor rules.BlockMinorsBlocks minors from using the app.'
nullable: true
additionalProperties:
type: object
microsoft.graph.publicClientApplication:
title: publicClientApplication
type: object
properties:
redirectUris:
type: array
items:
type: string
description: 'Specifies the URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent. For iOS and macOS apps, specify the value following the syntax msauth.{BUNDLEID}://auth, replacing ''{BUNDLEID}''. For example, if the bundle ID is com.microsoft.identitysample.MSALiOS, the URI is msauth.com.microsoft.identitysample.MSALiOS://auth.'
additionalProperties:
type: object
microsoft.graph.requestSignatureVerification:
title: requestSignatureVerification
type: object
properties:
allowedWeakAlgorithms:
$ref: '#/components/schemas/microsoft.graph.weakAlgorithms'
isSignedRequestRequired:
type: boolean
description: Specifies whether signed authentication requests for this application should be required.
additionalProperties:
type: object
microsoft.graph.requiredResourceAccess:
title: requiredResourceAccess
type: object
properties:
resourceAccess:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.resourceAccess'
description: The list of OAuth2.0 permission scopes and app roles that the application requires from the specified resource.
resourceAppId:
type: string
description: The unique identifier for the resource that the application requires access to. This should be equal to the appId declared on the target resource application.
additionalProperties:
type: object
microsoft.graph.servicePrincipalLockConfiguration:
title: servicePrincipalLockConfiguration
type: object
properties:
allProperties:
type: boolean
description: 'Enables locking all sensitive properties. The sensitive properties are keyCredentials, passwordCredentials, and tokenEncryptionKeyId.'
nullable: true
credentialsWithUsageSign:
type: boolean
description: Locks the keyCredentials and passwordCredentials properties for modification where credential usage type is Sign.
nullable: true
credentialsWithUsageVerify:
type: boolean
description: Locks the keyCredentials and passwordCredentials properties for modification where credential usage type is Verify. This locks OAuth service principals.
nullable: true
isEnabled:
type: boolean
description: 'Enables or disables service principal lock configuration. To allow the sensitive properties to be updated, update this property to false to disable the lock on the service principal.'
tokenEncryptionKeyId:
type: boolean
description: Locks the tokenEncryptionKeyId property for modification on the service principal.
nullable: true
additionalProperties:
type: object
microsoft.graph.spaApplication:
title: spaApplication
type: object
properties:
redirectUris:
type: array
items:
type: string
description: 'Specifies the URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent.'
additionalProperties:
type: object
microsoft.graph.verifiedPublisher:
title: verifiedPublisher
type: object
properties:
addedDateTime:
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 when the verified publisher was first added or most recently updated.
format: date-time
nullable: true
displayName:
type: string
description: The verified publisher name from the app publisher's Partner Center account.
nullable: true
verifiedPublisherId:
type: string
description: The ID of the verified publisher from the app publisher's Partner Center account.
nullable: true
additionalProperties:
type: object
microsoft.graph.webApplication:
title: webApplication
type: object
properties:
homePageUrl:
type: string
description: Home page or landing page of the application.
nullable: true
implicitGrantSettings:
$ref: '#/components/schemas/microsoft.graph.implicitGrantSettings'
logoutUrl:
type: string
description: 'Specifies the URL that is used by Microsoft''s authorization service to log out a user using front-channel, back-channel or SAML logout protocols.'
nullable: true
redirectUris:
type: array
items:
type: string
description: 'Specifies the URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent.'
redirectUriSettings:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.redirectUriSettings'
additionalProperties:
type: object
microsoft.graph.tokenIssuancePolicy:
allOf:
- $ref: '#/components/schemas/microsoft.graph.stsPolicy'
- title: tokenIssuancePolicy
type: object
additionalProperties:
type: object
microsoft.graph.tokenLifetimePolicy:
allOf:
- $ref: '#/components/schemas/microsoft.graph.stsPolicy'
- title: tokenLifetimePolicy
type: object
additionalProperties:
type: object
microsoft.graph.entity:
title: entity
type: object
properties:
id:
type: string
description: The unique identifier for an entity. Read-only.
additionalProperties:
type: object
microsoft.graph.stsPolicy:
allOf:
- $ref: '#/components/schemas/microsoft.graph.policyBase'
- title: stsPolicy
type: object
properties:
definition:
type: array
items:
type: string
description: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required.
isOrganizationDefault:
type: boolean
description: 'If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false.'
nullable: true
appliesTo:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.customSecurityAttributeValue:
title: customSecurityAttributeValue
type: object
additionalProperties:
type: object
microsoft.graph.permissionScope:
title: permissionScope
type: object
properties:
adminConsentDescription:
type: string
description: 'A description of the delegated permissions, intended to be read by an administrator granting the permission on behalf of all users. This text appears in tenant-wide admin consent experiences.'
nullable: true
adminConsentDisplayName:
type: string
description: 'The permission''s title, intended to be read by an administrator granting the permission on behalf of all users.'
nullable: true
id:
pattern: '^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$'
type: string
description: Unique delegated permission identifier inside the collection of delegated permissions defined for a resource application.
format: uuid
isEnabled:
type: boolean
description: 'When you create or update a permission, this property must be set to true (which is the default). To delete a permission, this property must first be set to false. At that point, in a subsequent call, the permission may be removed.'
origin:
type: string
nullable: true
type:
type: string
description: 'The possible values are: User and Admin. Specifies whether this delegated permission should be considered safe for non-admin users to consent to on behalf of themselves, or whether an administrator consent should always be required. While Microsoft Graph defines the default consent requirement for each permission, the tenant administrator may override the behavior in their organization (by allowing, restricting, or limiting user consent to this delegated permission). For more information, see Configure how users consent to applications.'
nullable: true
userConsentDescription:
type: string
description: 'A description of the delegated permissions, intended to be read by a user granting the permission on their own behalf. This text appears in consent experiences where the user is consenting only on behalf of themselves.'
nullable: true
userConsentDisplayName:
type: string
description: 'A title for the permission, intended to be read by a user granting the permission on their own behalf. This text appears in consent experiences where the user is consenting only on behalf of themselves.'
nullable: true
value:
type: string
description: 'Specifies the value to include in the scp (scope) claim in access tokens. Must not exceed 120 characters in length. Allowed characters are : ! # $ % & '' ( ) * + , - . / : ; = ? @ [ ] ^ + _ { } ~, and characters in the ranges 0-9, A-Z and a-z. Any other character, including the space character, aren''t allowed. May not begin with ..'
nullable: true
additionalProperties:
type: object
microsoft.graph.resourceSpecificPermission:
title: resourceSpecificPermission
type: object
properties:
description:
type: string
description: Describes the level of access that the resource-specific permission represents.
nullable: true
displayName:
type: string
description: The display name for the resource-specific permission.
nullable: true
id:
pattern: '^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$'
type: string
description: The unique identifier for the resource-specific application permission.
format: uuid
isEnabled:
type: boolean
description: Indicates whether the permission is enabled.
value:
type: string
description: The value of the permission.
nullable: true
additionalProperties:
type: object
microsoft.graph.samlSingleSignOnSettings:
title: samlSingleSignOnSettings
type: object
properties:
relayState:
type: string
description: The relative URI the service provider would redirect to after completion of the single sign-on flow.
nullable: true
additionalProperties:
type: object
microsoft.graph.claimsMappingPolicy:
allOf:
- $ref: '#/components/schemas/microsoft.graph.stsPolicy'
- title: claimsMappingPolicy
type: object
additionalProperties:
type: object
microsoft.graph.assignedLicense:
title: assignedLicense
type: object
properties:
disabledPlans:
type: array
items:
pattern: '^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$'
type: string
format: uuid
description: A collection of the unique identifiers for plans that have been disabled. IDs are available in servicePlans > servicePlanId in the tenant's subscribedSkus or serviceStatus > servicePlanId in the tenant's companySubscription.
skuId:
pattern: '^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$'
type: string
description: The unique identifier for the SKU. Corresponds to the skuId from subscribedSkus or companySubscription.
format: uuid
nullable: true
additionalProperties:
type: object
microsoft.graph.assignedPlan:
title: assignedPlan
type: object
properties:
assignedDateTime:
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 at which the plan was assigned. 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
capabilityStatus:
type: string
description: 'Condition of the capability assignment. The possible values are Enabled, Warning, Suspended, Deleted, LockedOut. See a detailed description of each value.'
nullable: true
service:
type: string
description: 'The name of the service; for example, exchange.'
nullable: true
servicePlanId:
pattern: '^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$'
type: string
description: 'A GUID that identifies the service plan. For a complete list of GUIDs and their equivalent friendly service names, see Product names and service plan identifiers for licensing.'
format: uuid
nullable: true
additionalProperties:
type: object
microsoft.graph.authorizationInfo:
title: authorizationInfo
type: object
properties:
certificateUserIds:
type: array
items:
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.employeeOrgData:
title: employeeOrgData
type: object
properties:
costCenter:
type: string
description: The cost center associated with the user. Requires $select to retrieve. Supports $filter.
nullable: true
division:
type: string
description: The name of the division in which the user works. Requires $select to retrieve. Supports $filter.
nullable: true
additionalProperties:
type: object
microsoft.graph.objectIdentity:
title: objectIdentity
type: object
properties:
issuer:
type: string
description: 'Specifies the issuer of the identity, for example facebook.com. 512 character limit. For local accounts (where signInType isn''t federated), this property is the local default domain name for the tenant, for example contoso.com. For guests from other Microsoft Entra organizations, this is the domain of the federated organization, for example contoso.com. For more information about filtering behavior for this property, see Filtering on the identities property of a user.'
nullable: true
issuerAssignedId:
type: string
description: 'Specifies the unique identifier assigned to the user by the issuer. 64 character limit. The combination of issuer and issuerAssignedId must be unique within the organization. Represents the sign-in name for the user, when signInType is set to emailAddress or userName (also known as local accounts).When signInType is set to: emailAddress (or a custom string that starts with emailAddress like emailAddress1), issuerAssignedId must be a valid email addressuserName, issuerAssignedId must begin with an alphabetical character or number, and can only contain alphanumeric characters and the following symbols: - or _ For more information about filtering behavior for this property, see Filtering on the identities property of a user.'
nullable: true
signInType:
type: string
description: 'Specifies the user sign-in types in your directory, such as emailAddress, userName, federated, or userPrincipalName. federated represents a unique identifier for a user from an issuer that can be in any format chosen by the issuer. Setting or updating a userPrincipalName identity updates the value of the userPrincipalName property on the user object. The validations performed on the userPrincipalName property on the user object, for example, verified domains and acceptable characters, are performed when setting or updating a userPrincipalName identity. Extra validation is enforced on issuerAssignedId when the sign-in type is set to emailAddress or userName. This property can also be set to any custom string. For more information about filtering behavior for this property, see Filtering on the identities property of a user.'
nullable: true
additionalProperties:
type: object
microsoft.graph.licenseAssignmentState:
title: licenseAssignmentState
type: object
properties:
assignedByGroup:
type: string
description: 'Indicates whether the license is directly-assigned or inherited from a group. If directly-assigned, this field is null; if inherited through a group membership, this field contains the ID of the group. Read-Only.'
nullable: true
disabledPlans:
type: array
items:
pattern: '^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$'
type: string
format: uuid
nullable: true
description: The service plans that are disabled in this assignment. Read-Only.
error:
type: string
description: 'License assignment failure error. If the license is assigned successfully, this field will be Null. Read-Only. The possible values are CountViolation, MutuallyExclusiveViolation, DependencyViolation, ProhibitedInUsageLocationViolation, UniquenessViolation, and Other. For more information on how to identify and resolve license assignment errors, see here.'
nullable: true
lastUpdatedDateTime:
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 when the state of the license assignment was last updated.
format: date-time
nullable: true
skuId:
pattern: '^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$'
type: string
description: The unique identifier for the SKU. Read-Only.
format: uuid
nullable: true
state:
type: string
description: 'Indicate the current state of this assignment. Read-Only. The possible values are Active, ActiveWithError, Disabled, and Error.'
nullable: true
additionalProperties:
type: object
microsoft.graph.mailboxSettings:
title: mailboxSettings
type: object
properties:
archiveFolder:
type: string
description: Folder ID of an archive folder for the user.
nullable: true
automaticRepliesSetting:
$ref: '#/components/schemas/microsoft.graph.automaticRepliesSetting'
dateFormat:
type: string
description: The date format for the user's mailbox.
nullable: true
delegateMeetingMessageDeliveryOptions:
$ref: '#/components/schemas/microsoft.graph.delegateMeetingMessageDeliveryOptions'
language:
$ref: '#/components/schemas/microsoft.graph.localeInfo'
timeFormat:
type: string
description: The time format for the user's mailbox.
nullable: true
timeZone:
type: string
description: The default time zone for the user's mailbox.
nullable: true
userPurpose:
$ref: '#/components/schemas/microsoft.graph.userPurpose'
workingHours:
$ref: '#/components/schemas/microsoft.graph.workingHours'
additionalProperties:
type: object
microsoft.graph.onPremisesExtensionAttributes:
title: onPremisesExtensionAttributes
type: object
properties:
extensionAttribute1:
type: string
description: First customizable extension attribute.
nullable: true
extensionAttribute10:
type: string
description: Tenth customizable extension attribute.
nullable: true
extensionAttribute11:
type: string
description: Eleventh customizable extension attribute.
nullable: true
extensionAttribute12:
type: string
description: Twelfth customizable extension attribute.
nullable: true
extensionAttribute13:
type: string
description: Thirteenth customizable extension attribute.
nullable: true
extensionAttribute14:
type: string
description: Fourteenth customizable extension attribute.
nullable: true
extensionAttribute15:
type: string
description: Fifteenth customizable extension attribute.
nullable: true
extensionAttribute2:
type: string
description: Second customizable extension attribute.
nullable: true
extensionAttribute3:
type: string
description: Third customizable extension attribute.
nullable: true
extensionAttribute4:
type: string
description: Fourth customizable extension attribute.
nullable: true
extensionAttribute5:
type: string
description: Fifth customizable extension attribute.
nullable: true
extensionAttribute6:
type: string
description: Sixth customizable extension attribute.
nullable: true
extensionAttribute7:
type: string
description: Seventh customizable extension attribute.
nullable: true
extensionAttribute8:
type: string
description: Eighth customizable extension attribute.
nullable: true
extensionAttribute9:
type: string
description: Ninth customizable extension attribute.
nullable: true
additionalProperties:
type: object
microsoft.graph.onPremisesProvisioningError:
title: onPremisesProvisioningError
type: object
properties:
category:
type: string
description: 'Category of the provisioning error. Note: Currently, there is only one possible value. Possible value: PropertyConflict - indicates a property value is not unique. Other objects contain the same value for the property.'
nullable: true
occurredDateTime:
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 at which the error occurred.
format: date-time
nullable: true
propertyCausingError:
type: string
description: 'Name of the directory property causing the error. Current possible values: UserPrincipalName or ProxyAddress'
nullable: true
value:
type: string
description: Value of the property causing the error.
nullable: true
additionalProperties:
type: object
microsoft.graph.passwordProfile:
title: passwordProfile
type: object
properties:
forceChangePasswordNextSignIn:
type: boolean
description: true if the user must change their password on the next sign-in; otherwise false.
nullable: true
forceChangePasswordNextSignInWithMfa:
type: boolean
description: 'If true, at next sign-in, the user must perform a multifactor authentication (MFA) before being forced to change their password. The behavior is identical to forceChangePasswordNextSignIn except that the user is required to first perform a multifactor authentication before password change. After a password change, this property will be automatically reset to false. If not set, default is false.'
nullable: true
password:
type: string
description: 'The password for the user. This property is required when a user is created. It can be updated, but the user will be required to change the password on the next sign-in. The password must satisfy minimum requirements as specified by the user''s passwordPolicies property. By default, a strong password is required.'
nullable: true
additionalProperties:
type: object
microsoft.graph.userPrint:
title: userPrint
type: object
properties:
recentPrinterShares:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.printerShare'
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.provisionedPlan:
title: provisionedPlan
type: object
properties:
capabilityStatus:
type: string
description: 'Condition of the capability assignment. The possible values are Enabled, Warning, Suspended, Deleted, LockedOut. See a detailed description of each value.'
nullable: true
provisioningStatus:
type: string
description: 'The possible values are:Success - Service is fully provisioned.Disabled - Service is disabled.Error - The service plan isn''t provisioned and is in an error state.PendingInput - The service isn''t provisioned and is awaiting service confirmation.PendingActivation - The service is provisioned but requires explicit activation by an administrator (for example, Intune_O365 service plan)PendingProvisioning - Microsoft has added a new service to the product SKU and it isn''t activated in the tenant.'
nullable: true
service:
type: string
description: 'The name of the service; for example, ''AccessControlS2S''.'
nullable: true
additionalProperties:
type: object
microsoft.graph.serviceProvisioningError:
title: serviceProvisioningError
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 at which the error occurred.
format: date-time
nullable: true
isResolved:
type: boolean
description: Indicates whether the error has been attended to.
nullable: true
serviceInstance:
type: string
description: 'Qualified service instance (for example, ''SharePoint/Dublin'') that published the service error information.'
nullable: true
additionalProperties:
type: object
microsoft.graph.signInActivity:
title: signInActivity
type: object
properties:
lastNonInteractiveSignInDateTime:
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 last non-interactive sign-in date for a specific user. You can use this field to calculate the last time a client attempted (either successfully or unsuccessfully) to sign in to the directory on behalf of a user. Because some users may use clients to access tenant resources rather than signing into your tenant directly, you can use the non-interactive sign-in date to along with lastSignInDateTime to identify inactive users. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Microsoft Entra ID maintains non-interactive sign-ins going back to May 2020. For more information about using the value of this property, see Manage inactive user accounts in Microsoft Entra ID.'
format: date-time
nullable: true
lastNonInteractiveSignInRequestId:
type: string
description: Request identifier of the last non-interactive sign-in performed by this user.
nullable: true
lastSignInDateTime:
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 last interactive sign-in date and time for a specific user. This property records the last time a user attempted an interactive sign-in to the directory—whether the attempt was successful or not. Note: Since unsuccessful attempts are also logged, this value might not accurately reflect actual system usage. For tracking actual account access, please use the lastSuccessfulSignInDateTime property. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.'
format: date-time
nullable: true
lastSignInRequestId:
type: string
description: Request identifier of the last interactive sign-in performed by this user.
nullable: true
lastSuccessfulSignInDateTime:
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 of the user''s most recent successful interactive or non-interactive sign-in. Use this property if you need to determine when the account was truly accessed. This field can be used to build reports, such as inactive users. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Microsoft Entra ID maintains interactive sign-ins going back to April 2020. For more information about using the value of this property, see Manage inactive user accounts in Microsoft Entra ID.'
format: date-time
nullable: true
lastSuccessfulSignInRequestId:
type: string
description: The request ID of the last successful sign-in.
nullable: true
additionalProperties:
type: object
microsoft.graph.userActivity:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: userActivity
type: object
properties:
activationUrl:
type: string
description: Required. URL used to launch the activity in the best native experience represented by the appId. Might launch a web-based app if no native app exists.
activitySourceHost:
type: string
description: 'Required. URL for the domain representing the cross-platform identity mapping for the app. Mapping is stored either as a JSON file hosted on the domain or configurable via Windows Dev Center. The JSON file is named cross-platform-app-identifiers and is hosted at root of your HTTPS domain, either at the top level domain or include a sub domain. For example: https://contoso.com or https://myapp.contoso.com but NOT https://myapp.contoso.com/somepath. You must have a unique file and domain (or sub domain) per cross-platform app identity. For example, a separate file and domain is needed for Word vs. PowerPoint.'
appActivityId:
type: string
description: Required. The unique activity ID in the context of the app - supplied by caller and immutable thereafter.
appDisplayName:
type: string
description: Optional. Short text description of the app used to generate the activity for use in cases when the app is not installed on the user’s local device.
nullable: true
contentInfo:
$ref: '#/components/schemas/microsoft.graph.Json'
contentUrl:
type: string
description: 'Optional. Used in the event the content can be rendered outside of a native or web-based app experience (for example, a pointer to an item in an RSS feed).'
nullable: true
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: Set by the server. DateTime in UTC when the object was created on the server.
format: date-time
nullable: true
expirationDateTime:
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: Set by the server. DateTime in UTC when the object expired on the server.
format: date-time
nullable: true
fallbackUrl:
type: string
description: 'Optional. URL used to launch the activity in a web-based app, if available.'
nullable: true
lastModifiedDateTime:
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: Set by the server. DateTime in UTC when the object was modified on the server.
format: date-time
nullable: true
status:
$ref: '#/components/schemas/microsoft.graph.status'
userTimezone:
type: string
description: Optional. The timezone in which the user's device used to generate the activity was located at activity creation time; values supplied as Olson IDs in order to support cross-platform representation.
nullable: true
visualElements:
$ref: '#/components/schemas/microsoft.graph.visualInfo'
historyItems:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.activityHistoryItem'
description: Optional. NavigationProperty/Containment; navigation property to the activity's historyItems.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.adhocCall:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: adhocCall
type: object
properties:
recordings:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.callRecording'
description: The recordings of a call. Read-only.
x-ms-navigationProperty: true
transcripts:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.callTranscript'
description: The transcripts of a call. Read-only.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.agreementAcceptance:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: agreementAcceptance
type: object
properties:
agreementFileId:
type: string
description: The identifier of the agreement file accepted by the user.
nullable: true
agreementId:
type: string
description: The identifier of the agreement.
nullable: true
deviceDisplayName:
type: string
description: The display name of the device used for accepting the agreement.
nullable: true
deviceId:
type: string
description: The unique identifier of the device used for accepting the agreement. Supports $filter (eq) and eq for null values.
nullable: true
deviceOSType:
type: string
description: The operating system used to accept the agreement.
nullable: true
deviceOSVersion:
type: string
description: The operating system version of the device used to accept the agreement.
nullable: true
expirationDateTime:
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 expiration date time of the acceptance. 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. Supports $filter (eq, ge, le) and eq for null values.'
format: date-time
nullable: true
recordedDateTime:
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
state:
$ref: '#/components/schemas/microsoft.graph.agreementAcceptanceState'
userDisplayName:
type: string
description: Display name of the user when the acceptance was recorded.
nullable: true
userEmail:
type: string
description: Email of the user when the acceptance was recorded.
nullable: true
userId:
type: string
description: The identifier of the user who accepted the agreement. Supports $filter (eq).
nullable: true
userPrincipalName:
type: string
description: UPN of the user when the acceptance was recorded.
nullable: true
additionalProperties:
type: object
microsoft.graph.authentication:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: authentication
type: object
properties:
emailMethods:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.emailAuthenticationMethod'
description: The email address registered to a user for authentication.
x-ms-navigationProperty: true
externalAuthenticationMethods:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.externalAuthenticationMethod'
description: Represents the external MFA registered to a user for authentication using an external identity provider.
x-ms-navigationProperty: true
fido2Methods:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.fido2AuthenticationMethod'
description: Represents the FIDO2 security keys registered to a user for authentication.
x-ms-navigationProperty: true
methods:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.authenticationMethod'
description: Represents all authentication methods registered to a user.
x-ms-navigationProperty: true
microsoftAuthenticatorMethods:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.microsoftAuthenticatorAuthenticationMethod'
description: The details of the Microsoft Authenticator app registered to a user for authentication.
x-ms-navigationProperty: true
operations:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.longRunningOperation'
description: 'Represents the status of a long-running operation, such as a password reset operation.'
x-ms-navigationProperty: true
passwordMethods:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.passwordAuthenticationMethod'
description: 'Represents the password registered to a user for authentication. For security, the password itself is never returned in the object, but action can be taken to reset a password.'
x-ms-navigationProperty: true
phoneMethods:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.phoneAuthenticationMethod'
description: The phone numbers registered to a user for authentication.
x-ms-navigationProperty: true
platformCredentialMethods:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.platformCredentialAuthenticationMethod'
description: Represents a platform credential instance registered to a user on Mac OS.
x-ms-navigationProperty: true
softwareOathMethods:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.softwareOathAuthenticationMethod'
description: The software OATH time-based one-time password (TOTP) applications registered to a user for authentication.
x-ms-navigationProperty: true
temporaryAccessPassMethods:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.temporaryAccessPassAuthenticationMethod'
description: Represents a Temporary Access Pass registered to a user for authentication through time-limited passcodes.
x-ms-navigationProperty: true
windowsHelloForBusinessMethods:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.windowsHelloForBusinessAuthenticationMethod'
description: Represents the Windows Hello for Business authentication method registered to a user for authentication.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.calendar:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: calendar
type: object
properties:
allowedOnlineMeetingProviders:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.onlineMeetingProviderType'
description: 'Represent the online meeting service providers that can be used to create online meetings in this calendar. The possible values are: unknown, skypeForBusiness, skypeForConsumer, teamsForBusiness.'
canEdit:
type: boolean
description: 'true if the user can write to the calendar, false otherwise. This property is true for the user who created the calendar. This property is also true for a user who shared a calendar and granted write access.'
nullable: true
canShare:
type: boolean
description: 'true if the user has permission to share the calendar, false otherwise. Only the user who created the calendar can share it.'
nullable: true
canViewPrivateItems:
type: boolean
description: 'If true, the user can read calendar items that have been marked private, false otherwise.'
nullable: true
changeKey:
type: string
description: 'Identifies the version of the calendar object. Every time the calendar is changed, changeKey changes as well. This allows Exchange to apply changes to the correct version of the object. Read-only.'
nullable: true
color:
$ref: '#/components/schemas/microsoft.graph.calendarColor'
defaultOnlineMeetingProvider:
$ref: '#/components/schemas/microsoft.graph.onlineMeetingProviderType'
hexColor:
type: string
description: 'The calendar color, expressed in a hex color code of three hexadecimal values, each ranging from 00 to FF and representing the red, green, or blue components of the color in the RGB color space. If the user has never explicitly set a color for the calendar, this property is empty. Read-only.'
nullable: true
isDefaultCalendar:
type: boolean
description: 'true if this is the default calendar where new events are created by default, false otherwise.'
nullable: true
isRemovable:
type: boolean
description: Indicates whether this user calendar can be deleted from the user mailbox.
nullable: true
isTallyingResponses:
type: boolean
description: Indicates whether this user calendar supports tracking of meeting responses. Only meeting invites sent from users' primary calendars support tracking of meeting responses.
nullable: true
name:
type: string
description: The calendar name.
nullable: true
owner:
$ref: '#/components/schemas/microsoft.graph.emailAddress'
calendarPermissions:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.calendarPermission'
description: The permissions of the users with whom the calendar is shared.
x-ms-navigationProperty: true
calendarView:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.event'
description: The calendar view for the calendar. Navigation property. Read-only.
x-ms-navigationProperty: true
events:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.event'
description: The events in the calendar. Navigation property. Read-only.
x-ms-navigationProperty: true
multiValueExtendedProperties:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.multiValueLegacyExtendedProperty'
description: The collection of multi-value extended properties defined for the calendar. Read-only. Nullable.
x-ms-navigationProperty: true
singleValueExtendedProperties:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.singleValueLegacyExtendedProperty'
description: The collection of single-value extended properties defined for the calendar. Read-only. Nullable.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.calendarGroup:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: calendarGroup
type: object
properties:
changeKey:
type: string
description: 'Identifies the version of the calendar group. Every time the calendar group is changed, ChangeKey changes as well. This allows Exchange to apply changes to the correct version of the object. Read-only.'
nullable: true
classId:
pattern: '^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$'
type: string
description: The class identifier. Read-only.
format: uuid
nullable: true
name:
type: string
description: The group name.
nullable: true
calendars:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.calendar'
description: The calendars in the calendar group. Navigation property. Read-only. Nullable.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.event:
allOf:
- $ref: '#/components/schemas/microsoft.graph.outlookItem'
- title: event
type: object
properties:
allowNewTimeProposals:
type: boolean
description: 'true if the meeting organizer allows invitees to propose a new time when responding; otherwise, false. Optional. The default is true.'
nullable: true
attendees:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.attendee'
description: The collection of attendees for the event.
body:
$ref: '#/components/schemas/microsoft.graph.itemBody'
bodyPreview:
type: string
description: The preview of the message associated with the event. It's in text format.
nullable: true
cancelledOccurrences:
type: array
items:
type: string
description: 'Contains occurrenceId property values of canceled instances in a recurring series, if the event is the series master. Instances in a recurring series that are canceled are called canceled occurences.Requires $select to retrieve. Only returned in a Get operation that specifies the ID (seriesMasterId property value) of a series master event.'
end:
$ref: '#/components/schemas/microsoft.graph.dateTimeTimeZone'
hasAttachments:
type: boolean
description: Set to true if the event has attachments.
nullable: true
hideAttendees:
type: boolean
description: 'When set to true, each attendee only sees themselves in the meeting request and meeting Tracking list. The default is false.'
nullable: true
iCalUId:
type: string
description: A unique identifier for an event across calendars. This ID is different for each occurrence in a recurring series. Read-only.
nullable: true
importance:
$ref: '#/components/schemas/microsoft.graph.importance'
isAllDay:
type: boolean
description: 'Set to true if the event lasts all day. If true, regardless of whether it''s a single-day or multi-day event, start, and endtime must be set to midnight and be in the same time zone.'
nullable: true
isCancelled:
type: boolean
description: Set to true if the event has been canceled.
nullable: true
isDraft:
type: boolean
description: 'Set to true if the user has updated the meeting in Outlook but hasn''t sent the updates to attendees. Set to false if all changes are sent, or if the event is an appointment without any attendees.'
nullable: true
isOnlineMeeting:
type: boolean
description: 'True if this event has online meeting information (that is, onlineMeeting points to an onlineMeetingInfo resource), false otherwise. Default is false (onlineMeeting is null). Optional. After you set isOnlineMeeting to true, Microsoft Graph initializes onlineMeeting. Subsequently, Outlook ignores any further changes to isOnlineMeeting, and the meeting remains available online.'
nullable: true
isOrganizer:
type: boolean
description: Set to true if the calendar owner (specified by the owner property of the calendar) is the organizer of the event (specified by the organizer property of the event). It also applies if a delegate organized the event on behalf of the owner.
nullable: true
isReminderOn:
type: boolean
description: Set to true if an alert is set to remind the user of the event.
nullable: true
location:
$ref: '#/components/schemas/microsoft.graph.location'
locations:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.location'
description: 'The locations where the event is held or attended from. The location and locations properties always correspond with each other. If you update the location property, any prior locations in the locations collection are removed and replaced by the new location value.'
onlineMeeting:
$ref: '#/components/schemas/microsoft.graph.onlineMeetingInfo'
onlineMeetingProvider:
$ref: '#/components/schemas/microsoft.graph.onlineMeetingProviderType'
onlineMeetingUrl:
type: string
description: 'A URL for an online meeting. The property is set only when an organizer specifies in Outlook that an event is an online meeting such as Skype. Read-only.To access the URL to join an online meeting, use joinUrl which is exposed via the onlineMeeting property of the event. The onlineMeetingUrl property will be deprecated in the future.'
nullable: true
organizer:
$ref: '#/components/schemas/microsoft.graph.recipient'
originalEndTimeZone:
type: string
description: The end time zone that was set when the event was created. A value of tzone://Microsoft/Custom indicates that a legacy custom time zone was set in desktop Outlook.
nullable: true
originalStart:
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: 'Represents the start time of an event when it''s initially created as an occurrence or exception in a recurring series. This property is not returned for events that are single instances. Its date and time information is expressed in ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z'
format: date-time
nullable: true
originalStartTimeZone:
type: string
description: The start time zone that was set when the event was created. A value of tzone://Microsoft/Custom indicates that a legacy custom time zone was set in desktop Outlook.
nullable: true
recurrence:
$ref: '#/components/schemas/microsoft.graph.patternedRecurrence'
reminderMinutesBeforeStart:
maximum: 2147483647
minimum: -2147483648
type: number
description: The number of minutes before the event start time that the reminder alert occurs.
format: int32
nullable: true
responseRequested:
type: boolean
description: 'Default is true, which represents the organizer would like an invitee to send a response to the event.'
nullable: true
responseStatus:
$ref: '#/components/schemas/microsoft.graph.responseStatus'
sensitivity:
$ref: '#/components/schemas/microsoft.graph.sensitivity'
seriesMasterId:
type: string
description: 'The ID for the recurring series master item, if this event is part of a recurring series.'
nullable: true
showAs:
$ref: '#/components/schemas/microsoft.graph.freeBusyStatus'
start:
$ref: '#/components/schemas/microsoft.graph.dateTimeTimeZone'
subject:
type: string
description: The text of the event's subject line.
nullable: true
transactionId:
type: string
description: 'A custom identifier specified by a client app for the server to avoid redundant POST operations in case of client retries to create the same event. It''s useful when low network connectivity causes the client to time out before receiving a response from the server for the client''s prior create-event request. After you set transactionId when creating an event, you can''t change transactionId in a subsequent update. This property is only returned in a response payload if an app has set it. Optional.'
nullable: true
type:
$ref: '#/components/schemas/microsoft.graph.eventType'
webLink:
type: string
description: 'The URL to open the event in Outlook on the web.Outlook on the web opens the event in the browser if you are signed in to your mailbox. Otherwise, Outlook on the web prompts you to sign in.This URL can''t be accessed from within an iFrame.'
nullable: true
attachments:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.attachment'
description: 'The collection of FileAttachment, ItemAttachment, and referenceAttachment attachments for the event. Navigation property. Read-only. Nullable.'
x-ms-navigationProperty: true
calendar:
$ref: '#/components/schemas/microsoft.graph.calendar'
exceptionOccurrences:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.event'
description: 'Contains the id property values of the event instances that are exceptions in a recurring series.Exceptions can differ from other occurrences in a recurring series, such as the subject, start or end times, or attendees. Exceptions don''t include canceled occurrences.Requires $select and $expand to retrieve. Only returned in a GET operation that specifies the ID (seriesMasterId property value) of a series master event.'
x-ms-navigationProperty: true
extensions:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.extension'
description: The collection of open extensions defined for the event. Nullable.
x-ms-navigationProperty: true
instances:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.event'
description: 'The occurrences of a recurring series, if the event is a series master. This property includes occurrences that are part of the recurrence pattern, and exceptions modified, but doesn''t include occurrences canceled from the series. Navigation property. Read-only. Nullable.'
x-ms-navigationProperty: true
multiValueExtendedProperties:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.multiValueLegacyExtendedProperty'
description: The collection of multi-value extended properties defined for the event. Read-only. Nullable.
x-ms-navigationProperty: true
singleValueExtendedProperties:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.singleValueLegacyExtendedProperty'
description: The collection of single-value extended properties defined for the event. Read-only. Nullable.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.chat:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: chat
type: object
properties:
chatType:
$ref: '#/components/schemas/microsoft.graph.chatType'
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: Date and time at which the chat was created. Read-only.
format: date-time
nullable: true
isHiddenForAllMembers:
type: boolean
description: Indicates whether the chat is hidden for all its members. Read-only.
nullable: true
lastUpdatedDateTime:
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: Date and time at which the chat was renamed or the list of members was last changed. Read-only.
format: date-time
nullable: true
migrationMode:
$ref: '#/components/schemas/microsoft.graph.migrationMode'
onlineMeetingInfo:
$ref: '#/components/schemas/microsoft.graph.teamworkOnlineMeetingInfo'
originalCreatedDateTime:
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: Timestamp of the original creation time for the chat. The value is null if the chat never entered migration mode.
format: date-time
nullable: true
tenantId:
type: string
description: The identifier of the tenant in which the chat was created. Read-only.
nullable: true
topic:
type: string
description: (Optional) Subject or topic for the chat. Only available for group chats.
nullable: true
viewpoint:
$ref: '#/components/schemas/microsoft.graph.chatViewpoint'
webUrl:
type: string
description: 'The URL for the chat in Microsoft Teams. The URL should be treated as an opaque blob, and not parsed. Read-only.'
nullable: true
installedApps:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.teamsAppInstallation'
description: A collection of all the apps in the chat. Nullable.
x-ms-navigationProperty: true
lastMessagePreview:
$ref: '#/components/schemas/microsoft.graph.chatMessageInfo'
members:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.conversationMember'
description: A collection of all the members in the chat. Nullable.
x-ms-navigationProperty: true
messages:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.chatMessage'
description: A collection of all the messages in the chat. Nullable.
x-ms-navigationProperty: true
permissionGrants:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.resourceSpecificPermissionGrant'
description: A collection of permissions granted to apps for the chat.
x-ms-navigationProperty: true
pinnedMessages:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.pinnedChatMessageInfo'
description: A collection of all the pinned messages in the chat. Nullable.
x-ms-navigationProperty: true
tabs:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.teamsTab'
description: A collection of all the tabs in the chat. Nullable.
x-ms-navigationProperty: true
targetedMessages:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.targetedChatMessage'
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.cloudClipboardRoot:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: cloudClipboardRoot
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.cloudClipboardItem'
description: Represents a collection of Cloud Clipboard items.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.cloudPC:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: cloudPC
type: object
properties:
aadDeviceId:
type: string
description: 'The Microsoft Entra device ID for the Cloud PC, also known as the Azure Active Directory (Azure AD) device ID, that consists of 32 characters in a GUID format. Generated on a VM joined to Microsoft Entra ID. Read-only.'
nullable: true
displayName:
type: string
description: 'The display name for the Cloud PC. Maximum length is 64 characters. Read-only. You can use the cloudPC: rename API to modify the Cloud PC name.'
nullable: true
gracePeriodEndDateTime:
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 grace period ends and reprovisioning or deprovisioning happen. Required only if the status is inGracePeriod. The timestamp is shown in ISO 8601 format and Coordinated Universal Time (UTC). For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.'
format: date-time
nullable: true
imageDisplayName:
type: string
description: 'The name of the operating system image used for the Cloud PC. Maximum length is 50 characters. Only letters (A-Z, a-z), numbers (0-9), and special characters (-,,.) are allowed for this property. The property value can''t begin or end with an underscore. Read-only.'
nullable: true
lastModifiedDateTime:
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 last modified date and time of the Cloud PC. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.'
format: date-time
managedDeviceId:
type: string
description: The Intune enrolled device ID for the Cloud PC that consists of 32 characters in a GUID format. The managedDeviceId property of Windows 365 Business Cloud PCs is always null as Windows 365 Business Cloud PCs aren't Intune-enrolled automatically by Windows 365. Read-only.
nullable: true
managedDeviceName:
type: string
description: The Intune enrolled device name for the Cloud PC. The managedDeviceName property of Windows 365 Business Cloud PCs is always null as Windows 365 Business Cloud PCs aren't Intune-enrolled automatically by Windows 365. Read-only.
nullable: true
onPremisesConnectionName:
type: string
description: The on-premises connection that applied during the provisioning of Cloud PCs. Read-only.
nullable: true
provisioningPolicyId:
type: string
description: The provisioning policy ID for the Cloud PC that consists of 32 characters in a GUID format. A policy defines the type of Cloud PC the user wants to create. Read-only.
nullable: true
provisioningPolicyName:
type: string
description: The provisioning policy that applied during the provisioning of Cloud PCs. Maximum length is 120 characters. Read-only.
nullable: true
provisioningType:
$ref: '#/components/schemas/microsoft.graph.cloudPcProvisioningType'
servicePlanId:
type: string
description: 'The service plan ID for the Cloud PC that consists of 32 characters in a GUID format. For more information about service plans, see Product names and service plan identifiers for licensing. Read-only.'
nullable: true
servicePlanName:
type: string
description: The service plan name for the customer-facing Cloud PC entity. Read-only.
nullable: true
userPrincipalName:
type: string
description: 'The user principal name (UPN) of the user assigned to the Cloud PC. Maximum length is 113 characters. For more information on username policies, see Password policies and account restrictions in Microsoft Entra ID. Read-only.'
nullable: true
additionalProperties:
type: object
microsoft.graph.contactFolder:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: contactFolder
type: object
properties:
displayName:
type: string
description: The folder's display name.
nullable: true
parentFolderId:
type: string
description: The ID of the folder's parent folder.
nullable: true
childFolders:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.contactFolder'
description: The collection of child folders in the folder. Navigation property. Read-only. Nullable.
x-ms-navigationProperty: true
contacts:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.contact'
description: The contacts in the folder. Navigation property. Read-only. Nullable.
x-ms-navigationProperty: true
multiValueExtendedProperties:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.multiValueLegacyExtendedProperty'
description: The collection of multi-value extended properties defined for the contactFolder. Read-only. Nullable.
x-ms-navigationProperty: true
singleValueExtendedProperties:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.singleValueLegacyExtendedProperty'
description: The collection of single-value extended properties defined for the contactFolder. Read-only. Nullable.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.contact:
allOf:
- $ref: '#/components/schemas/microsoft.graph.outlookItem'
- title: contact
type: object
properties:
assistantName:
type: string
description: The name of the contact's assistant.
nullable: true
birthday:
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 contact''s birthday. 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
businessAddress:
$ref: '#/components/schemas/microsoft.graph.physicalAddress'
businessHomePage:
type: string
description: The business home page of the contact.
nullable: true
businessPhones:
type: array
items:
type: string
nullable: true
description: The contact's business phone numbers.
children:
type: array
items:
type: string
nullable: true
description: The names of the contact's children.
companyName:
type: string
description: The name of the contact's company.
nullable: true
department:
type: string
description: The contact's department.
nullable: true
displayName:
type: string
description: 'The contact''s display name. You can specify the display name in a create or update operation. Note that later updates to other properties may cause an automatically generated value to overwrite the displayName value you have specified. To preserve a pre-existing value, always include it as displayName in an update operation.'
nullable: true
emailAddresses:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.emailAddress'
description: The contact's email addresses.
fileAs:
type: string
description: The name the contact is filed under.
nullable: true
generation:
type: string
description: The contact's suffix.
nullable: true
givenName:
type: string
description: The contact's given name.
nullable: true
homeAddress:
$ref: '#/components/schemas/microsoft.graph.physicalAddress'
homePhones:
type: array
items:
type: string
nullable: true
description: The contact's home phone numbers.
imAddresses:
type: array
items:
type: string
nullable: true
description: The contact's instant messaging (IM) addresses.
initials:
type: string
description: The contact's initials.
nullable: true
jobTitle:
type: string
description: The contact’s job title.
nullable: true
manager:
type: string
description: The name of the contact's manager.
nullable: true
middleName:
type: string
description: The contact's middle name.
nullable: true
mobilePhone:
type: string
description: The contact's mobile phone number.
nullable: true
nickName:
type: string
description: The contact's nickname.
nullable: true
officeLocation:
type: string
description: The location of the contact's office.
nullable: true
otherAddress:
$ref: '#/components/schemas/microsoft.graph.physicalAddress'
parentFolderId:
type: string
description: The ID of the contact's parent folder.
nullable: true
personalNotes:
type: string
description: The user's notes about the contact.
nullable: true
primaryEmailAddress:
$ref: '#/components/schemas/microsoft.graph.emailAddress'
profession:
type: string
description: The contact's profession.
nullable: true
secondaryEmailAddress:
$ref: '#/components/schemas/microsoft.graph.emailAddress'
spouseName:
type: string
description: The name of the contact's spouse/partner.
nullable: true
surname:
type: string
description: The contact's surname.
nullable: true
tertiaryEmailAddress:
$ref: '#/components/schemas/microsoft.graph.emailAddress'
title:
type: string
description: The contact's title.
nullable: true
yomiCompanyName:
type: string
description: The phonetic Japanese company name of the contact.
nullable: true
yomiGivenName:
type: string
description: The phonetic Japanese given name (first name) of the contact.
nullable: true
yomiSurname:
type: string
description: The phonetic Japanese surname (last name) of the contact.
nullable: true
extensions:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.extension'
description: The collection of open extensions defined for the contact. Read-only. Nullable.
x-ms-navigationProperty: true
multiValueExtendedProperties:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.multiValueLegacyExtendedProperty'
description: The collection of multi-value extended properties defined for the contact. Read-only. Nullable.
x-ms-navigationProperty: true
photo:
$ref: '#/components/schemas/microsoft.graph.profilePhoto'
singleValueExtendedProperties:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.singleValueLegacyExtendedProperty'
description: The collection of single-value extended properties defined for the contact. Read-only. Nullable.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.userDataSecurityAndGovernance:
allOf:
- $ref: '#/components/schemas/microsoft.graph.dataSecurityAndGovernance'
- title: userDataSecurityAndGovernance
type: object
properties:
activities:
$ref: '#/components/schemas/microsoft.graph.activitiesContainer'
protectionScopes:
$ref: '#/components/schemas/microsoft.graph.userProtectionScopeContainer'
additionalProperties:
type: object
microsoft.graph.deviceManagementTroubleshootingEvent:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: deviceManagementTroubleshootingEvent
type: object
properties:
correlationId:
type: string
description: Id used for tracing the failure in the service.
nullable: true
eventDateTime:
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: Time when the event occurred .
format: date-time
additionalProperties:
type: object
description: Event representing an general failure.
microsoft.graph.drive:
allOf:
- $ref: '#/components/schemas/microsoft.graph.baseItem'
- title: drive
type: object
properties:
driveType:
type: string
description: Describes the type of drive represented by this resource. OneDrive personal drives return personal. OneDrive for Business returns business. SharePoint document libraries return documentLibrary. Read-only.
nullable: true
owner:
$ref: '#/components/schemas/microsoft.graph.identitySet'
quota:
$ref: '#/components/schemas/microsoft.graph.quota'
sharePointIds:
$ref: '#/components/schemas/microsoft.graph.sharepointIds'
system:
$ref: '#/components/schemas/microsoft.graph.systemFacet'
bundles:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.driveItem'
description: Collection of bundles (albums and multi-select-shared sets of items). Only in personal OneDrive.
x-ms-navigationProperty: true
following:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.driveItem'
description: The list of items the user is following. Only in OneDrive for Business.
x-ms-navigationProperty: true
items:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.driveItem'
description: All items contained in the drive. Read-only. Nullable.
x-ms-navigationProperty: true
list:
$ref: '#/components/schemas/microsoft.graph.list'
root:
$ref: '#/components/schemas/microsoft.graph.driveItem'
special:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.driveItem'
description: Collection of common folders available in OneDrive. Read-only. Nullable.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.employeeExperienceUser:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: employeeExperienceUser
type: object
properties:
assignedRoles:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.engagementRole'
description: Represents the collection of Viva Engage roles assigned to a user.
x-ms-navigationProperty: true
learningCourseActivities:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.learningCourseActivity'
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.extension:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: extension
type: object
additionalProperties:
type: object
microsoft.graph.site:
allOf:
- $ref: '#/components/schemas/microsoft.graph.baseItem'
- title: site
type: object
properties:
displayName:
type: string
description: The full title for the site. Read-only.
nullable: true
error:
$ref: '#/components/schemas/microsoft.graph.publicError'
isPersonalSite:
type: boolean
description: Identifies whether the site is personal or not. Read-only.
nullable: true
root:
$ref: '#/components/schemas/microsoft.graph.root'
sharepointIds:
$ref: '#/components/schemas/microsoft.graph.sharepointIds'
siteCollection:
$ref: '#/components/schemas/microsoft.graph.siteCollection'
analytics:
$ref: '#/components/schemas/microsoft.graph.itemAnalytics'
columns:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.columnDefinition'
description: The collection of column definitions reusable across lists under this site.
x-ms-navigationProperty: true
contentTypes:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.contentType'
description: The collection of content types defined for this site.
x-ms-navigationProperty: true
drive:
$ref: '#/components/schemas/microsoft.graph.drive'
drives:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.drive'
description: The collection of drives (document libraries) under this site.
x-ms-navigationProperty: true
externalColumns:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.columnDefinition'
x-ms-navigationProperty: true
items:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.baseItem'
description: Used to address any item contained in this site. This collection can't be enumerated.
x-ms-navigationProperty: true
lists:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.list'
description: The collection of lists under this site.
x-ms-navigationProperty: true
onenote:
$ref: '#/components/schemas/microsoft.graph.onenote'
operations:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.richLongRunningOperation'
description: The collection of long-running operations on the site.
x-ms-navigationProperty: true
pages:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.baseSitePage'
description: The collection of pages in the baseSitePages list in this site.
x-ms-navigationProperty: true
permissions:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.permission'
description: The permissions associated with the site. Nullable.
x-ms-navigationProperty: true
sites:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.site'
description: The collection of the sub-sites under this site.
x-ms-navigationProperty: true
termStore:
$ref: '#/components/schemas/microsoft.graph.termStore.store'
termStores:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.termStore.store'
description: The collection of termStores under this site.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.inferenceClassification:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: inferenceClassification
type: object
properties:
overrides:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.inferenceClassificationOverride'
description: 'A set of overrides for a user to always classify messages from specific senders in certain ways: focused, or other. Read-only. Nullable.'
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.itemInsights:
allOf:
- $ref: '#/components/schemas/microsoft.graph.officeGraphInsights'
- title: itemInsights
type: object
additionalProperties:
type: object
microsoft.graph.team:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: team
type: object
properties:
classification:
type: string
description: An optional label. Typically describes the data or business sensitivity of the team. Must match one of a preconfigured set in the tenant's directory.
nullable: true
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: Timestamp at which the team was created.
format: date-time
nullable: true
description:
type: string
description: 'An optional description for the team. Maximum length: 1,024 characters.'
nullable: true
displayName:
type: string
description: The name of the team.
nullable: true
firstChannelName:
type: string
description: 'The name of the first channel in the team. This is an optional property, only used during team creation and isn''t returned in methods to get and list teams.'
nullable: true
funSettings:
$ref: '#/components/schemas/microsoft.graph.teamFunSettings'
guestSettings:
$ref: '#/components/schemas/microsoft.graph.teamGuestSettings'
internalId:
type: string
description: A unique ID for the team that was used in a few places such as the audit log/Office 365 Management Activity API.
nullable: true
isArchived:
type: boolean
description: Whether this team is in read-only mode.
nullable: true
memberSettings:
$ref: '#/components/schemas/microsoft.graph.teamMemberSettings'
messagingSettings:
$ref: '#/components/schemas/microsoft.graph.teamMessagingSettings'
specialization:
$ref: '#/components/schemas/microsoft.graph.teamSpecialization'
summary:
$ref: '#/components/schemas/microsoft.graph.teamSummary'
tenantId:
type: string
description: The ID of the Microsoft Entra tenant.
nullable: true
visibility:
$ref: '#/components/schemas/microsoft.graph.teamVisibilityType'
webUrl:
type: string
description: 'A hyperlink that goes to the team in the Microsoft Teams client. You get this URL when you right-click a team in the Microsoft Teams client and select Get link to team. This URL should be treated as an opaque blob, and not parsed.'
nullable: true
allChannels:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.channel'
description: List of channels either hosted in or shared with the team (incoming channels).
x-ms-navigationProperty: true
channels:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.channel'
description: The collection of channels and messages associated with the team.
x-ms-navigationProperty: true
group:
$ref: '#/components/schemas/microsoft.graph.group'
incomingChannels:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.channel'
description: List of channels shared with the team.
x-ms-navigationProperty: true
installedApps:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.teamsAppInstallation'
description: The apps installed in this team.
x-ms-navigationProperty: true
members:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.conversationMember'
description: Members and owners of the team.
x-ms-navigationProperty: true
operations:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.teamsAsyncOperation'
description: The async operations that ran or are running on this team.
x-ms-navigationProperty: true
permissionGrants:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.resourceSpecificPermissionGrant'
description: A collection of permissions granted to apps to access the team.
x-ms-navigationProperty: true
photo:
$ref: '#/components/schemas/microsoft.graph.profilePhoto'
primaryChannel:
$ref: '#/components/schemas/microsoft.graph.channel'
schedule:
$ref: '#/components/schemas/microsoft.graph.schedule'
tags:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.teamworkTag'
description: The tags associated with the team.
x-ms-navigationProperty: true
template:
$ref: '#/components/schemas/microsoft.graph.teamsTemplate'
additionalProperties:
type: object
microsoft.graph.licenseDetails:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: licenseDetails
type: object
properties:
servicePlans:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.servicePlanInfo'
description: Information about the service plans assigned with the license. Read-only. Not nullable.
skuId:
pattern: '^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$'
type: string
description: Unique identifier (GUID) for the service SKU. Equal to the skuId property on the related subscribedSku object. Read-only.
format: uuid
nullable: true
skuPartNumber:
type: string
description: 'Unique SKU display name. Equal to the skuPartNumber on the related subscribedSku object; for example, AAD_Premium. Read-only.'
nullable: true
additionalProperties:
type: object
microsoft.graph.mailFolder:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: mailFolder
type: object
properties:
childFolderCount:
maximum: 2147483647
minimum: -2147483648
type: number
description: The number of immediate child mailFolders in the current mailFolder.
format: int32
nullable: true
displayName:
type: string
description: The mailFolder's display name.
nullable: true
isHidden:
type: boolean
description: Indicates whether the mailFolder is hidden. This property can be set only when creating the folder. Find more information in Hidden mail folders.
nullable: true
parentFolderId:
type: string
description: The unique identifier for the mailFolder's parent mailFolder.
nullable: true
totalItemCount:
maximum: 2147483647
minimum: -2147483648
type: number
description: The number of items in the mailFolder.
format: int32
nullable: true
unreadItemCount:
maximum: 2147483647
minimum: -2147483648
type: number
description: The number of items in the mailFolder marked as unread.
format: int32
nullable: true
childFolders:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.mailFolder'
description: The collection of child folders in the mailFolder.
x-ms-navigationProperty: true
messageRules:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.messageRule'
description: The collection of rules that apply to the user's Inbox folder.
x-ms-navigationProperty: true
messages:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.message'
description: The collection of messages in the mailFolder.
x-ms-navigationProperty: true
multiValueExtendedProperties:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.multiValueLegacyExtendedProperty'
description: The collection of multi-value extended properties defined for the mailFolder. Read-only. Nullable.
x-ms-navigationProperty: true
singleValueExtendedProperties:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.singleValueLegacyExtendedProperty'
description: The collection of single-value extended properties defined for the mailFolder. Read-only. Nullable.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.managedAppRegistration:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: managedAppRegistration
type: object
properties:
appIdentifier:
$ref: '#/components/schemas/microsoft.graph.mobileAppIdentifier'
applicationVersion:
type: string
description: App version
nullable: true
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: Date and time of creation
format: date-time
deviceName:
type: string
description: Host device name
nullable: true
deviceTag:
type: string
description: 'App management SDK generated tag, which helps relate apps hosted on the same device. Not guaranteed to relate apps in all conditions.'
nullable: true
deviceType:
type: string
description: Host device type
nullable: true
flaggedReasons:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.managedAppFlaggedReason'
description: Zero or more reasons an app registration is flagged. E.g. app running on rooted device
lastSyncDateTime:
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: Date and time of last the app synced with management service.
format: date-time
managementSdkVersion:
type: string
description: App management SDK version
nullable: true
platformVersion:
type: string
description: Operating System version
nullable: true
userId:
type: string
description: The user Id to who this app registration belongs.
nullable: true
version:
type: string
description: Version of the entity.
nullable: true
appliedPolicies:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.managedAppPolicy'
description: Zero or more policys already applied on the registered app when it last synchronized with managment service.
x-ms-navigationProperty: true
intendedPolicies:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.managedAppPolicy'
description: Zero or more policies admin intended for the app as of now.
x-ms-navigationProperty: true
operations:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.managedAppOperation'
description: Zero or more long running operations triggered on the app registration.
x-ms-navigationProperty: true
additionalProperties:
type: object
description: The ManagedAppEntity is the base entity type for all other entity types under app management workflow.
microsoft.graph.managedDevice:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: managedDevice
type: object
properties:
activationLockBypassCode:
type: string
description: 'The code that allows the Activation Lock on managed device to be bypassed. Default, is Null (Non-Default property) for this property when returned as part of managedDevice entity in LIST call. To retrieve actual values GET call needs to be made, with device id and included in select parameter. Supports: $select. $Search is not supported. Read-only. This property is read-only.'
nullable: true
readOnly: true
androidSecurityPatchLevel:
type: string
description: Android security patch level. This property is read-only.
nullable: true
readOnly: true
azureADDeviceId:
type: string
description: The unique identifier for the Azure Active Directory device. Read only. This property is read-only.
nullable: true
readOnly: true
azureADRegistered:
type: boolean
description: Whether the device is Azure Active Directory registered. This property is read-only.
nullable: true
readOnly: true
complianceGracePeriodExpirationDateTime:
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 DateTime when device compliance grace period expires. This property is read-only.
format: date-time
readOnly: true
complianceState:
$ref: '#/components/schemas/microsoft.graph.complianceState'
configurationManagerClientEnabledFeatures:
$ref: '#/components/schemas/microsoft.graph.configurationManagerClientEnabledFeatures'
deviceActionResults:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.deviceActionResult'
description: List of ComplexType deviceActionResult objects. This property is read-only.
readOnly: true
deviceCategoryDisplayName:
type: string
description: Device category display name. Default is an empty string. Supports $filter operator 'eq' and 'or'. This property is read-only.
nullable: true
readOnly: true
deviceEnrollmentType:
$ref: '#/components/schemas/microsoft.graph.deviceEnrollmentType'
deviceHealthAttestationState:
$ref: '#/components/schemas/microsoft.graph.deviceHealthAttestationState'
deviceName:
type: string
description: Name of the device. This property is read-only.
nullable: true
readOnly: true
deviceRegistrationState:
$ref: '#/components/schemas/microsoft.graph.deviceRegistrationState'
easActivated:
type: boolean
description: Whether the device is Exchange ActiveSync activated. This property is read-only.
readOnly: true
easActivationDateTime:
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: Exchange ActivationSync activation time of the device. This property is read-only.
format: date-time
readOnly: true
easDeviceId:
type: string
description: Exchange ActiveSync Id of the device. This property is read-only.
nullable: true
readOnly: true
emailAddress:
type: string
description: Email(s) for the user associated with the device. This property is read-only.
nullable: true
readOnly: true
enrolledDateTime:
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: Enrollment time of the device. Supports $filter operator 'lt' and 'gt'. This property is read-only.
format: date-time
readOnly: true
enrollmentProfileName:
type: string
description: 'Name of the enrollment profile assigned to the device. Default value is empty string, indicating no enrollment profile was assgined. This property is read-only.'
nullable: true
readOnly: true
ethernetMacAddress:
type: string
description: 'Indicates Ethernet MAC Address of the device. Default, is Null (Non-Default property) for this property when returned as part of managedDevice entity. Individual get call with select query options is needed to retrieve actual values. Example: deviceManagement/managedDevices({managedDeviceId})?$select=ethernetMacAddress Supports: $select. $Search is not supported. Read-only. This property is read-only.'
nullable: true
readOnly: true
exchangeAccessState:
$ref: '#/components/schemas/microsoft.graph.deviceManagementExchangeAccessState'
exchangeAccessStateReason:
$ref: '#/components/schemas/microsoft.graph.deviceManagementExchangeAccessStateReason'
exchangeLastSuccessfulSyncDateTime:
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: Last time the device contacted Exchange. This property is read-only.
format: date-time
readOnly: true
freeStorageSpaceInBytes:
type: number
description: Free Storage in Bytes. Default value is 0. Read-only. This property is read-only.
format: int64
readOnly: true
iccid:
type: string
description: 'Integrated Circuit Card Identifier, it is A SIM card''s unique identification number. Default is an empty string. To retrieve actual values GET call needs to be made, with device id and included in select parameter. Supports: $select. $Search is not supported. Read-only. This property is read-only.'
nullable: true
readOnly: true
imei:
type: string
description: IMEI. This property is read-only.
nullable: true
readOnly: true
isEncrypted:
type: boolean
description: Device encryption status. This property is read-only.
readOnly: true
isSupervised:
type: boolean
description: Device supervised status. This property is read-only.
readOnly: true
jailBroken:
type: string
description: Whether the device is jail broken or rooted. Default is an empty string. Supports $filter operator 'eq' and 'or'. This property is read-only.
nullable: true
readOnly: true
lastSyncDateTime:
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 that the device last completed a successful sync with Intune. Supports $filter operator 'lt' and 'gt'. This property is read-only.
format: date-time
readOnly: true
managedDeviceName:
type: string
description: Automatically generated name to identify a device. Can be overwritten to a user friendly name.
nullable: true
managedDeviceOwnerType:
$ref: '#/components/schemas/microsoft.graph.managedDeviceOwnerType'
managementAgent:
$ref: '#/components/schemas/microsoft.graph.managementAgentType'
managementCertificateExpirationDate:
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: Reports device management certificate expiration date. This property is read-only.
format: date-time
readOnly: true
managementState:
$ref: '#/components/schemas/microsoft.graph.managementState'
manufacturer:
type: string
description: Manufacturer of the device. This property is read-only.
nullable: true
readOnly: true
meid:
type: string
description: MEID. This property is read-only.
nullable: true
readOnly: true
model:
type: string
description: Model of the device. This property is read-only.
nullable: true
readOnly: true
notes:
type: string
description: 'Notes on the device created by IT Admin. Default is null. To retrieve actual values GET call needs to be made, with device id and included in select parameter. Supports: $select. $Search is not supported.'
nullable: true
operatingSystem:
type: string
description: 'Operating system of the device. Windows, iOS, etc. This property is read-only.'
nullable: true
readOnly: true
osVersion:
type: string
description: Operating system version of the device. This property is read-only.
nullable: true
readOnly: true
partnerReportedThreatState:
$ref: '#/components/schemas/microsoft.graph.managedDevicePartnerReportedHealthState'
phoneNumber:
type: string
description: Phone number of the device. This property is read-only.
nullable: true
readOnly: true
physicalMemoryInBytes:
type: number
description: 'Total Memory in Bytes. Default is 0. To retrieve actual values GET call needs to be made, with device id and included in select parameter. Supports: $select. Read-only. This property is read-only.'
format: int64
readOnly: true
remoteAssistanceSessionErrorDetails:
type: string
description: An error string that identifies issues when creating Remote Assistance session objects. This property is read-only.
nullable: true
readOnly: true
remoteAssistanceSessionUrl:
type: string
description: 'Url that allows a Remote Assistance session to be established with the device. Default is an empty string. To retrieve actual values GET call needs to be made, with device id and included in select parameter. This property is read-only.'
nullable: true
readOnly: true
requireUserEnrollmentApproval:
type: boolean
description: Reports if the managed iOS device is user approval enrollment. This property is read-only.
nullable: true
readOnly: true
serialNumber:
type: string
description: SerialNumber. This property is read-only.
nullable: true
readOnly: true
subscriberCarrier:
type: string
description: Subscriber Carrier. This property is read-only.
nullable: true
readOnly: true
totalStorageSpaceInBytes:
type: number
description: Total Storage in Bytes. This property is read-only.
format: int64
readOnly: true
udid:
type: string
description: 'Unique Device Identifier for iOS and macOS devices. Default is an empty string. To retrieve actual values GET call needs to be made, with device id and included in select parameter. Supports: $select. $Search is not supported. Read-only. This property is read-only.'
nullable: true
readOnly: true
userDisplayName:
type: string
description: User display name. This property is read-only.
nullable: true
readOnly: true
userId:
type: string
description: Unique Identifier for the user associated with the device. This property is read-only.
nullable: true
readOnly: true
userPrincipalName:
type: string
description: Device user principal name. This property is read-only.
nullable: true
readOnly: true
wiFiMacAddress:
type: string
description: Wi-Fi MAC. This property is read-only.
nullable: true
readOnly: true
deviceCategory:
$ref: '#/components/schemas/microsoft.graph.deviceCategory'
deviceCompliancePolicyStates:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.deviceCompliancePolicyState'
description: Device compliance policy states for this device.
x-ms-navigationProperty: true
deviceConfigurationStates:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.deviceConfigurationState'
description: Device configuration states for this device.
x-ms-navigationProperty: true
logCollectionRequests:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.deviceLogCollectionResponse'
description: List of log collection requests
x-ms-navigationProperty: true
users:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.user'
description: The primary users associated with the managed device.
x-ms-navigationProperty: true
windowsProtectionState:
$ref: '#/components/schemas/microsoft.graph.windowsProtectionState'
additionalProperties:
type: object
description: 'Devices that are managed or pre-enrolled through Intune. Limited support for $filter: Only properties whose descriptions mention support for $filter may be used, and combinations of those filtered properties must use ''and'', not ''or''.'
microsoft.graph.message:
allOf:
- $ref: '#/components/schemas/microsoft.graph.outlookItem'
- title: message
type: object
properties:
bccRecipients:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.recipient'
description: 'The Bcc: recipients for the message.'
body:
$ref: '#/components/schemas/microsoft.graph.itemBody'
bodyPreview:
type: string
description: The first 255 characters of the message body. It is in text format.
nullable: true
ccRecipients:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.recipient'
description: 'The Cc: recipients for the message.'
conversationId:
type: string
description: The ID of the conversation the email belongs to.
nullable: true
conversationIndex:
type: string
description: Indicates the position of the message within the conversation.
format: base64url
nullable: true
flag:
$ref: '#/components/schemas/microsoft.graph.followupFlag'
from:
$ref: '#/components/schemas/microsoft.graph.recipient'
hasAttachments:
type: boolean
description: 'Indicates whether the message has attachments. This property doesn''t include inline attachments, so if a message contains only inline attachments, this property is false. To verify the existence of inline attachments, parse the body property to look for a src attribute, such as
.'
nullable: true
importance:
$ref: '#/components/schemas/microsoft.graph.importance'
inferenceClassification:
$ref: '#/components/schemas/microsoft.graph.inferenceClassificationType'
internetMessageHeaders:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.internetMessageHeader'
description: A collection of message headers defined by RFC5322. The set includes message headers indicating the network path taken by a message from the sender to the recipient. It can also contain custom message headers that hold app data for the message. Requires $select to retrieve. Read-only.
internetMessageId:
type: string
description: The message ID in the format specified by RFC2822.
nullable: true
isDeliveryReceiptRequested:
type: boolean
description: Indicates whether a read receipt is requested for the message.
nullable: true
isDraft:
type: boolean
description: Indicates whether the message is a draft. A message is a draft if it hasn't been sent yet.
nullable: true
isRead:
type: boolean
description: Indicates whether the message has been read.
nullable: true
isReadReceiptRequested:
type: boolean
description: Indicates whether a read receipt is requested for the message.
nullable: true
parentFolderId:
type: string
description: The unique identifier for the message's parent mailFolder.
nullable: true
receivedDateTime:
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 the message was received. The date and time information uses 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
replyTo:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.recipient'
description: The email addresses to use when replying.
sender:
$ref: '#/components/schemas/microsoft.graph.recipient'
sentDateTime:
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 the message was sent. The date and time information uses 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
subject:
type: string
description: The subject of the message.
nullable: true
toRecipients:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.recipient'
description: 'The To: recipients for the message.'
uniqueBody:
$ref: '#/components/schemas/microsoft.graph.itemBody'
webLink:
type: string
description: 'The URL to open the message in Outlook on the web.You can append an ispopout argument to the end of the URL to change how the message is displayed. If ispopout is not present or if it is set to 1, then the message is shown in a popout window. If ispopout is set to 0, the browser shows the message in the Outlook on the web review pane.The message opens in the browser if you are signed in to your mailbox via Outlook on the web. You are prompted to sign in if you are not already signed in with the browser.This URL cannot be accessed from within an iFrame.NOTE: When using this URL to access a message from a mailbox with delegate permissions, both the signed-in user and the target mailbox must be in the same database region. For example, an error is returned when a user with a mailbox in the EUR (Europe) region attempts to access messages from a mailbox in the NAM (North America) region.'
nullable: true
attachments:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.attachment'
description: The fileAttachment and itemAttachment attachments for the message.
x-ms-navigationProperty: true
extensions:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.extension'
description: The collection of open extensions defined for the message. Nullable.
x-ms-navigationProperty: true
multiValueExtendedProperties:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.multiValueLegacyExtendedProperty'
description: The collection of multi-value extended properties defined for the message. Nullable.
x-ms-navigationProperty: true
singleValueExtendedProperties:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.singleValueLegacyExtendedProperty'
description: The collection of single-value extended properties defined for the message. Nullable.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.onenote:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: onenote
type: object
properties:
notebooks:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.notebook'
description: The collection of OneNote notebooks that are owned by the user or group. Read-only. Nullable.
x-ms-navigationProperty: true
operations:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.onenoteOperation'
description: 'The status of OneNote operations. Getting an operations collection isn''t supported, but you can get the status of long-running operations if the Operation-Location header is returned in the response. Read-only. Nullable.'
x-ms-navigationProperty: true
pages:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.onenotePage'
description: The pages in all OneNote notebooks that are owned by the user or group. Read-only. Nullable.
x-ms-navigationProperty: true
resources:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.onenoteResource'
description: 'The image and other file resources in OneNote pages. Getting a resources collection isn''t supported, but you can get the binary content of a specific resource. Read-only. Nullable.'
x-ms-navigationProperty: true
sectionGroups:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.sectionGroup'
description: The section groups in all OneNote notebooks that are owned by the user or group. Read-only. Nullable.
x-ms-navigationProperty: true
sections:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.onenoteSection'
description: The sections in all OneNote notebooks that are owned by the user or group. Read-only. Nullable.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.onlineMeeting:
allOf:
- $ref: '#/components/schemas/microsoft.graph.onlineMeetingBase'
- title: onlineMeeting
type: object
properties:
attendeeReport:
type: string
description: The content stream of the attendee report of a Microsoft Teams live event. Read-only.
format: base64url
nullable: true
broadcastSettings:
$ref: '#/components/schemas/microsoft.graph.broadcastMeetingSettings'
creationDateTime:
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 meeting creation time in UTC. Read-only.
format: date-time
nullable: true
endDateTime:
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 meeting end time in UTC. Required when you create an online meeting.
format: date-time
nullable: true
externalId:
type: string
description: The external ID that is a custom identifier. Optional.
nullable: true
isBroadcast:
type: boolean
description: Indicates whether this meeting is a Teams live event.
nullable: true
meetingTemplateId:
type: string
description: The ID of the meeting template.
nullable: true
participants:
$ref: '#/components/schemas/microsoft.graph.meetingParticipants'
startDateTime:
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 meeting start time in UTC.
format: date-time
nullable: true
recordings:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.callRecording'
description: The recordings of an online meeting. Read-only.
x-ms-navigationProperty: true
transcripts:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.callTranscript'
description: The transcripts of an online meeting. Read-only.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.onPremisesSyncBehavior:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: onPremisesSyncBehavior
type: object
properties:
isCloudManaged:
type: boolean
additionalProperties:
type: object
microsoft.graph.outlookUser:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: outlookUser
type: object
properties:
masterCategories:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.outlookCategory'
description: A list of categories defined for the user.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.person:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: person
type: object
properties:
birthday:
type: string
description: The person's birthday.
nullable: true
companyName:
type: string
description: The name of the person's company.
nullable: true
department:
type: string
description: The person's department.
nullable: true
displayName:
type: string
description: The person's display name.
nullable: true
givenName:
type: string
description: The person's given name.
nullable: true
imAddress:
type: string
description: The instant message voice over IP (VOIP) session initiation protocol (SIP) address for the user. Read-only.
nullable: true
isFavorite:
type: boolean
description: True if the user has flagged this person as a favorite.
nullable: true
jobTitle:
type: string
description: The person's job title.
nullable: true
officeLocation:
type: string
description: The location of the person's office.
nullable: true
personNotes:
type: string
description: Free-form notes that the user has taken about this person.
nullable: true
personType:
$ref: '#/components/schemas/microsoft.graph.personType'
phones:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.phone'
description: The person's phone numbers.
postalAddresses:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.location'
description: The person's addresses.
profession:
type: string
description: The person's profession.
nullable: true
scoredEmailAddresses:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.scoredEmailAddress'
description: The person's email addresses.
surname:
type: string
description: The person's surname.
nullable: true
userPrincipalName:
type: string
description: 'The user principal name (UPN) of the person. The UPN is an Internet-style login name for the person based on the Internet standard RFC 822. By convention, this should map to the person''s email name. The general format is alias@domain.'
nullable: true
websites:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.website'
description: The person's websites.
yomiCompany:
type: string
description: The phonetic Japanese name of the person's company.
nullable: true
additionalProperties:
type: object
microsoft.graph.resourceSpecificPermissionGrant:
allOf:
- $ref: '#/components/schemas/microsoft.graph.directoryObject'
- title: resourceSpecificPermissionGrant
type: object
properties:
clientAppId:
type: string
description: ID of the service principal of the Microsoft Entra app that has been granted access. Read-only.
nullable: true
clientId:
type: string
description: ID of the Microsoft Entra app that has been granted access. Read-only.
nullable: true
permission:
type: string
description: The name of the resource-specific permission. Read-only.
nullable: true
permissionType:
type: string
description: 'The type of permission. The possible values are: Application, Delegated. Read-only.'
nullable: true
resourceAppId:
type: string
description: ID of the Microsoft Entra app that is hosting the resource. Read-only.
nullable: true
additionalProperties:
type: object
microsoft.graph.profilePhoto:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: profilePhoto
type: object
properties:
height:
maximum: 2147483647
minimum: -2147483648
type: number
description: The height of the photo. Read-only.
format: int32
nullable: true
width:
maximum: 2147483647
minimum: -2147483648
type: number
description: The width of the photo. Read-only.
format: int32
nullable: true
additionalProperties:
type: object
microsoft.graph.plannerUser:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: plannerUser
type: object
properties:
plans:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.plannerPlan'
description: Read-only. Nullable. Returns the plannerTasks assigned to the user.
x-ms-navigationProperty: true
tasks:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.plannerTask'
description: Read-only. Nullable. Returns the plannerPlans shared with the user.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.presence:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: presence
type: object
properties:
activity:
type: string
description: 'The supplemental information to a user''s availability. Possible values are available, away, beRightBack, busy, doNotDisturb, offline, outOfOffice, presenceUnknown.'
nullable: true
availability:
type: string
description: 'The base presence information for a user. Possible values are available, away, beRightBack, busy, doNotDisturb, focusing, inACall, inAMeeting, offline, presenting, presenceUnknown.'
nullable: true
outOfOfficeSettings:
$ref: '#/components/schemas/microsoft.graph.outOfOfficeSettings'
sequenceNumber:
type: string
description: The lexicographically sortable String stamp that represents the version of a presence object.
nullable: true
readOnly: true
statusMessage:
$ref: '#/components/schemas/microsoft.graph.presenceStatusMessage'
workLocation:
$ref: '#/components/schemas/microsoft.graph.userWorkLocation'
additionalProperties:
type: object
microsoft.graph.scopedRoleMembership:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: scopedRoleMembership
type: object
properties:
administrativeUnitId:
type: string
description: Unique identifier for the administrative unit that the directory role is scoped to
roleId:
type: string
description: Unique identifier for the directory role that the member is in.
roleMemberInfo:
$ref: '#/components/schemas/microsoft.graph.identity'
additionalProperties:
type: object
microsoft.graph.userSettings:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: userSettings
type: object
properties:
contributionToContentDiscoveryAsOrganizationDisabled:
type: boolean
description: 'Reflects the organization level setting controlling delegate access to the trending API. When set to true, the organization doesn''t have access to Office Delve. The relevancy of the content displayed in Microsoft 365, for example in Suggested sites in SharePoint Home and the Discover view in OneDrive for work or school is affected for the whole organization. This setting is read-only and can only be changed by administrators in the SharePoint admin center.'
contributionToContentDiscoveryDisabled:
type: boolean
description: 'When set to true, the delegate access to the user''s trending API is disabled. When set to true, documents in the user''s Office Delve are disabled. When set to true, the relevancy of the content displayed in Microsoft 365, for example in Suggested sites in SharePoint Home and the Discover view in OneDrive for work or school is affected. Users can control this setting in Office Delve.'
exchange:
$ref: '#/components/schemas/microsoft.graph.exchangeSettings'
itemInsights:
$ref: '#/components/schemas/microsoft.graph.userInsightsSettings'
shiftPreferences:
$ref: '#/components/schemas/microsoft.graph.shiftPreferences'
storage:
$ref: '#/components/schemas/microsoft.graph.userStorage'
windows:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.windowsSetting'
description: The Windows settings of the user stored in the cloud.
x-ms-navigationProperty: true
workHoursAndLocations:
$ref: '#/components/schemas/microsoft.graph.workHoursAndLocationsSetting'
additionalProperties:
type: object
microsoft.graph.userSolutionRoot:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: userSolutionRoot
type: object
properties:
workingTimeSchedule:
$ref: '#/components/schemas/microsoft.graph.workingTimeSchedule'
additionalProperties:
type: object
microsoft.graph.userTeamwork:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: userTeamwork
type: object
properties:
locale:
type: string
description: 'Represents the location that a user selected in Microsoft Teams and doesn''t follow the Office''s locale setting. A user''s locale is represented by their preferred language and country or region. For example, en-us. The language component follows two-letter codes as defined in ISO 639-1, and the country component follows two-letter codes as defined in ISO 3166-1 alpha-2.'
nullable: true
region:
type: string
description: 'Represents the region of the organization or the user. For users with multigeo licenses, the property contains the user''s region (if available). For users without multigeo licenses, the property contains the organization''s region.The region value can be any region supported by the Teams payload. The possible values are: Americas, Europe and MiddleEast, Asia Pacific, UAE, Australia, Brazil, Canada, Switzerland, Germany, France, India, Japan, South Korea, Norway, Singapore, United Kingdom, South Africa, Sweden, Qatar, Poland, Italy, Israel, Spain, Mexico, USGov Community Cloud, USGov Community Cloud High, USGov Department of Defense, and China.'
nullable: true
associatedTeams:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.associatedTeamInfo'
description: The list of associatedTeamInfo objects that a user is associated with.
x-ms-navigationProperty: true
installedApps:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.userScopeTeamsAppInstallation'
description: The apps installed in the personal scope of this user.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.todo:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: todo
type: object
properties:
lists:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.todoTaskList'
description: The task lists in the users mailbox.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.synchronizationSchedule:
title: synchronizationSchedule
type: object
properties:
expiration:
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: 'Date and time when this job expires. 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
interval:
pattern: '^-?P([0-9]+D)?(T([0-9]+H)?([0-9]+M)?([0-9]+([.][0-9]+)?S)?)?$'
type: string
description: 'The interval between synchronization iterations. The value is represented in ISO 8601 format for durations. For example, P1M represents a period of one month and PT1M represents a period of one minute.'
format: duration
state:
$ref: '#/components/schemas/microsoft.graph.synchronizationScheduleState'
additionalProperties:
type: object
microsoft.graph.synchronizationStatus:
title: synchronizationStatus
type: object
properties:
code:
$ref: '#/components/schemas/microsoft.graph.synchronizationStatusCode'
countSuccessiveCompleteFailures:
type: number
description: Number of consecutive times this job failed.
format: int64
escrowsPruned:
type: boolean
description: 'true if the job''s escrows (object-level errors) were pruned during initial synchronization. Escrows can be pruned if during the initial synchronization, you reach the threshold of errors that would normally put the job in quarantine. Instead of going into quarantine, the synchronization process clears the job''s errors and continues until the initial synchronization is completed. When the initial synchronization is completed, the job will pause and wait for the customer to clean up the errors.'
lastExecution:
$ref: '#/components/schemas/microsoft.graph.synchronizationTaskExecution'
lastSuccessfulExecution:
$ref: '#/components/schemas/microsoft.graph.synchronizationTaskExecution'
lastSuccessfulExecutionWithExports:
$ref: '#/components/schemas/microsoft.graph.synchronizationTaskExecution'
progress:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.synchronizationProgress'
description: Details of the progress of a job toward completion.
quarantine:
$ref: '#/components/schemas/microsoft.graph.synchronizationQuarantine'
steadyStateFirstAchievedTime:
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 time when steady state (no more changes to the process) was first achieved. 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
steadyStateLastAchievedTime:
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 time when steady state (no more changes to the process) was last achieved. 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
synchronizedEntryCountByType:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.stringKeyLongValuePair'
description: 'Count of synchronized objects, listed by object type.'
troubleshootingUrl:
type: string
description: 'In the event of an error, the URL with the troubleshooting steps for the issue.'
nullable: true
additionalProperties:
type: object
microsoft.graph.keyValuePair:
title: keyValuePair
type: object
properties:
name:
type: string
description: Name for this key-value pair
value:
type: string
description: Value for this key-value pair
nullable: true
additionalProperties:
type: object
microsoft.graph.synchronizationJobSubject:
title: synchronizationJobSubject
type: object
properties:
links:
$ref: '#/components/schemas/microsoft.graph.synchronizationLinkedObjects'
objectId:
type: string
description: 'The identifier of an object to which a synchronizationJob is to be applied. Can be one of the following: An onPremisesDistinguishedName for synchronization from Active Directory to Azure AD.The user ID for synchronization from Microsoft Entra ID to a third-party.The Worker ID of the Workday worker for synchronization from Workday to either Active Directory or Microsoft Entra ID.'
nullable: true
objectTypeName:
type: string
description: 'The type of the object to which a synchronizationJob is to be applied. Can be one of the following: user for synchronizing between Active Directory and Azure AD.User for synchronizing a user between Microsoft Entra ID and a third-party application. Worker for synchronization a user between Workday and either Active Directory or Microsoft Entra ID.Group for synchronizing a group between Microsoft Entra ID and a third-party application.'
nullable: true
additionalProperties:
type: object
microsoft.graph.synchronizationJobRestartScope:
title: synchronizationJobRestartScope
enum:
- None
- ConnectorDataStore
- Escrows
- Watermark
- QuarantineState
- Full
- ForceDeletes
type: string
x-ms-enum-flags:
isFlags: true
microsoft.graph.synchronizationSecret:
title: synchronizationSecret
enum:
- None
- UserName
- Password
- SecretToken
- AppKey
- BaseAddress
- ClientIdentifier
- ClientSecret
- SingleSignOnType
- Sandbox
- Url
- Domain
- ConsumerKey
- ConsumerSecret
- TokenKey
- TokenExpiration
- Oauth2AccessToken
- Oauth2AccessTokenCreationTime
- Oauth2RefreshToken
- SyncAll
- InstanceName
- Oauth2ClientId
- Oauth2ClientSecret
- CompanyId
- UpdateKeyOnSoftDelete
- SynchronizationSchedule
- SystemOfRecord
- SandboxName
- EnforceDomain
- SyncNotificationSettings
- SkipOutOfScopeDeletions
- Oauth2AuthorizationCode
- Oauth2RedirectUri
- ApplicationTemplateIdentifier
- Oauth2TokenExchangeUri
- Oauth2AuthorizationUri
- AuthenticationType
- Server
- PerformInboundEntitlementGrants
- HardDeletesEnabled
- SyncAgentCompatibilityKey
- SyncAgentADContainer
- ValidateDomain
- TestReferences
- ConnectionString
type: string
microsoft.graph.synchronizationRule:
title: synchronizationRule
type: object
properties:
containerFilter:
$ref: '#/components/schemas/microsoft.graph.containerFilter'
editable:
type: boolean
description: true if the synchronization rule can be customized; false if this rule is read-only and shouldn't be changed.
groupFilter:
$ref: '#/components/schemas/microsoft.graph.groupFilter'
id:
type: string
description: Synchronization rule identifier. Must be one of the identifiers recognized by the synchronization engine. Supported rule identifiers can be found in the synchronization template returned by the API.
nullable: true
metadata:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.stringKeyStringValuePair'
description: 'Additional extension properties. Unless instructed explicitly by the support team, metadata values shouldn''t be changed.'
name:
type: string
description: Human-readable name of the synchronization rule. Not nullable.
nullable: true
objectMappings:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.objectMapping'
description: Collection of object mappings supported by the rule. Tells the synchronization engine which objects should be synchronized.
priority:
maximum: 2147483647
minimum: -2147483648
type: number
description: Priority relative to other rules in the synchronizationSchema. Rules with the lowest priority number will be processed first.
format: int32
sourceDirectoryName:
type: string
description: Name of the source directory. Must match one of the directory definitions in synchronizationSchema.
nullable: true
targetDirectoryName:
type: string
description: Name of the target directory. Must match one of the directory definitions in synchronizationSchema.
nullable: true
additionalProperties:
type: object
microsoft.graph.directoryDefinitionDiscoverabilities:
title: directoryDefinitionDiscoverabilities
enum:
- None
- AttributeNames
- AttributeDataTypes
- AttributeReadOnly
- ReferenceAttributes
- UnknownFutureValue
type: string
x-ms-enum-flags:
isFlags: true
microsoft.graph.objectDefinition:
title: objectDefinition
type: object
properties:
attributes:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.attributeDefinition'
description: Defines attributes of the object.
metadata:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.objectDefinitionMetadataEntry'
description: Metadata for the given object.
name:
type: string
description: Name of the object. Must be unique within a directory definition. Not nullable.
nullable: true
supportedApis:
type: array
items:
type: string
nullable: true
description: The API that the provisioning service queries to retrieve data for synchronization.
additionalProperties:
type: object
microsoft.graph.scopeOperatorType:
title: scopeOperatorType
enum:
- Binary
- Unary
type: string
microsoft.graph.scopeOperatorMultiValuedComparisonType:
title: scopeOperatorMultiValuedComparisonType
enum:
- All
- Any
type: string
microsoft.graph.attributeType:
title: attributeType
enum:
- String
- Integer
- Reference
- Binary
- Boolean
- DateTime
type: string
microsoft.graph.attributeMappingParameterSchema:
title: attributeMappingParameterSchema
type: object
properties:
allowMultipleOccurrences:
type: boolean
description: 'The given parameter can be provided multiple times (for example, multiple input strings in the Concatenate(string,string,...) function).'
name:
type: string
description: Parameter name.
nullable: true
required:
type: boolean
description: true if the parameter is required; otherwise false.
type:
$ref: '#/components/schemas/microsoft.graph.attributeType'
additionalProperties:
type: object
microsoft.graph.stringKeyObjectValuePair:
title: stringKeyObjectValuePair
type: object
properties:
key:
type: string
description: Key.
nullable: true
additionalProperties:
type: object
microsoft.graph.attributeDefinitionMetadataEntry:
title: attributeDefinitionMetadataEntry
type: object
properties:
key:
$ref: '#/components/schemas/microsoft.graph.attributeDefinitionMetadata'
value:
type: string
description: Value of the metadata property.
nullable: true
additionalProperties:
type: object
microsoft.graph.mutability:
title: mutability
enum:
- ReadWrite
- ReadOnly
- Immutable
- WriteOnly
type: string
microsoft.graph.referencedObject:
title: referencedObject
type: object
properties:
referencedObjectName:
type: string
description: Name of the referenced object. Must match one of the objects in the directory definition.
nullable: true
referencedProperty:
type: string
description: 'Currently not supported. Name of the property in the referenced object, the value for which is used as the reference.'
nullable: true
additionalProperties:
type: object
microsoft.graph.publicError:
title: publicError
type: object
properties:
code:
type: string
description: Represents the error code.
nullable: true
details:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.publicErrorDetail'
description: Details of the error.
innerError:
$ref: '#/components/schemas/microsoft.graph.publicInnerError'
message:
type: string
description: A non-localized message for the developer.
nullable: true
target:
type: string
description: The target of the error.
nullable: true
additionalProperties:
type: object
microsoft.graph.attributeMappingSource:
title: attributeMappingSource
type: object
properties:
expression:
type: string
description: Equivalent expression representation of this attributeMappingSource object.
nullable: true
name:
type: string
description: 'Name parameter of the mapping source. Depending on the type property value, this can be the name of the function, the name of the source attribute, or a constant value to be used.'
nullable: true
parameters:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.stringKeyAttributeMappingSourceValuePair'
description: 'If this object represents a function, lists function parameters. Parameters consist of attributeMappingSource objects themselves, allowing for complex expressions. If type isn''t Function, this property is null/empty array.'
type:
$ref: '#/components/schemas/microsoft.graph.attributeMappingSourceType'
additionalProperties:
type: object
microsoft.graph.synchronizationMetadataEntry:
title: synchronizationMetadataEntry
type: object
properties:
key:
$ref: '#/components/schemas/microsoft.graph.synchronizationMetadata'
value:
type: string
description: Value of the metadata property.
nullable: true
additionalProperties:
type: object
microsoft.graph.applicationRiskFactors:
title: applicationRiskFactors
type: object
properties:
compliance:
$ref: '#/components/schemas/microsoft.graph.applicationSecurityCompliance'
general:
$ref: '#/components/schemas/microsoft.graph.applicationRiskFactorGeneralInfo'
legal:
$ref: '#/components/schemas/microsoft.graph.applicationRiskFactorLegalInfo'
security:
$ref: '#/components/schemas/microsoft.graph.applicationRiskFactorSecurityInfo'
additionalProperties:
type: object
microsoft.graph.applicationRiskScore:
title: applicationRiskScore
type: object
properties:
compliance:
type: number
description: 'Specifies the compliance risk score based on the application''s alignment with regulatory standards and industry certifications such as HIPAA, CSA, and PCI-DSS.'
format: float
nullable: true
legal:
type: number
description: 'Specifies the legal risk score based on data protection practices, privacy policy transparency, and jurisdictional compliance to regulations and policies such as DMCA and data retention policy.'
format: float
nullable: true
provider:
type: number
description: 'Specifies the provider risk score based on vendor credibility, operational maturity, and trustworthiness.'
format: float
nullable: true
security:
type: number
description: 'Specifies the security risk score based on authentication strength, encryption, vulnerability management, and overall security hygiene.'
format: float
nullable: true
total:
type: number
description: Represents the composite risk score derived from all risk categories.
format: float
nullable: true
additionalProperties:
type: object
microsoft.graph.policyBase:
allOf:
- $ref: '#/components/schemas/microsoft.graph.directoryObject'
- title: policyBase
type: object
properties:
description:
type: string
description: Description for this policy. Required.
nullable: true
displayName:
type: string
description: Display name for this policy. Required.
nullable: true
additionalProperties:
type: object
microsoft.graph.customAppManagementConfiguration:
allOf:
- $ref: '#/components/schemas/microsoft.graph.appManagementConfiguration'
- title: customAppManagementConfiguration
type: object
properties:
applicationRestrictions:
$ref: '#/components/schemas/microsoft.graph.customAppManagementApplicationConfiguration'
additionalProperties:
type: object
microsoft.graph.permissionClassificationType:
title: permissionClassificationType
enum:
- low
- medium
- high
- unknownFutureValue
type: string
microsoft.graph.groupAccessType:
title: groupAccessType
enum:
- none
- private
- secret
- public
- unknownFutureValue
type: string
microsoft.graph.assignedLabel:
title: assignedLabel
type: object
properties:
displayName:
type: string
description: The display name of the label. Read-only.
nullable: true
labelId:
type: string
description: The unique identifier of the label.
nullable: true
additionalProperties:
type: object
microsoft.graph.licenseProcessingState:
title: licenseProcessingState
type: object
properties:
state:
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.conversation:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: conversation
type: object
properties:
hasAttachments:
type: boolean
description: 'Indicates whether any of the posts within this Conversation has at least one attachment. Supports $filter (eq, ne) and $search.'
lastDeliveredDateTime:
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
preview:
type: string
description: 'A short summary from the body of the latest post in this conversation. Supports $filter (eq, ne, le, ge).'
topic:
type: string
description: 'The topic of the conversation. This property can be set when the conversation is created, but it cannot be updated.'
uniqueSenders:
type: array
items:
type: string
description: All the users that sent a message to this Conversation.
threads:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.conversationThread'
description: A collection of all the conversation threads in the conversation. A navigation property. Read-only. Nullable.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.groupLifecyclePolicy:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: groupLifecyclePolicy
type: object
properties:
alternateNotificationEmails:
type: string
description: List of email address to send notifications for groups without owners. Multiple email address can be defined by separating email address with a semicolon.
nullable: true
groupLifetimeInDays:
maximum: 2147483647
minimum: -2147483648
type: number
description: 'Number of days before a group expires and needs to be renewed. Once renewed, the group expiration is extended by the number of days defined.'
format: int32
nullable: true
managedGroupTypes:
type: string
description: 'The group type for which the expiration policy applies. Possible values are All, Selected or None.'
nullable: true
additionalProperties:
type: object
microsoft.graph.plannerGroup:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: plannerGroup
type: object
properties:
plans:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.plannerPlan'
description: Read-only. Nullable. Returns the plannerPlans owned by the group.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.groupSetting:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: groupSetting
type: object
properties:
displayName:
type: string
description: 'Display name of this group of settings, which comes from the associated template.'
nullable: true
templateId:
type: string
description: Unique identifier for the tenant-level groupSettingTemplates object that's been customized for this group-level settings object. Read-only.
nullable: true
values:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.settingValue'
description: Collection of name-value pairs corresponding to the name and defaultValue properties in the referenced groupSettingTemplates object.
additionalProperties:
type: object
microsoft.graph.conversationThread:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: conversationThread
type: object
properties:
ccRecipients:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.recipient'
description: 'The Cc: recipients for the thread. Requires $select to retrieve.'
hasAttachments:
type: boolean
description: Indicates whether any of the posts within this thread has at least one attachment. Returned by default.
isLocked:
type: boolean
description: Indicates if the thread is locked. Returned by default.
lastDeliveredDateTime:
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.Returned by default.'
format: date-time
preview:
type: string
description: A short summary from the body of the latest post in this conversation. Returned by default.
topic:
type: string
description: 'The topic of the conversation. This property can be set when the conversation is created, but it cannot be updated. Returned by default.'
toRecipients:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.recipient'
description: 'The To: recipients for the thread. Requires $select to retrieve.'
uniqueSenders:
type: array
items:
type: string
description: All the users that sent a message to this thread. Returned by default.
posts:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.post'
x-ms-navigationProperty: true
additionalProperties:
type: object
ReferenceCreate:
type: object
properties:
'@odata.id':
type: string
additionalProperties:
type: object
microsoft.graph.applicationCollectionResponse:
title: Collection of application
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.application'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.ODataErrors.ODataError:
required:
- error
type: object
properties:
error:
$ref: '#/components/schemas/microsoft.graph.ODataErrors.MainError'
additionalProperties:
type: object
microsoft.graph.appManagementPolicyCollectionResponse:
title: Collection of appManagementPolicy
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.appManagementPolicy'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
ODataCountResponse:
type: integer
format: int32
StringCollectionResponse:
title: Collection of string
type: object
properties:
value:
type: array
items:
type: string
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.extensionPropertyCollectionResponse:
title: Collection of extensionProperty
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.extensionProperty'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.federatedIdentityCredentialCollectionResponse:
title: Collection of federatedIdentityCredential
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.federatedIdentityCredential'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.homeRealmDiscoveryPolicyCollectionResponse:
title: Collection of homeRealmDiscoveryPolicy
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.homeRealmDiscoveryPolicy'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.directoryObjectCollectionResponse:
title: Collection of directoryObject
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.appRoleAssignmentCollectionResponse:
title: Collection of appRoleAssignment
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.appRoleAssignment'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.endpointCollectionResponse:
title: Collection of endpoint
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.endpoint'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.servicePrincipalCollectionResponse:
title: Collection of servicePrincipal
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.servicePrincipal'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.userCollectionResponse:
title: Collection of user
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.user'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.synchronizationJobCollectionResponse:
title: Collection of synchronizationJob
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.synchronizationJob'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.directoryDefinitionCollectionResponse:
title: Collection of directoryDefinition
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryDefinition'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.synchronizationTemplateCollectionResponse:
title: Collection of synchronizationTemplate
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.synchronizationTemplate'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.tokenIssuancePolicyCollectionResponse:
title: Collection of tokenIssuancePolicy
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.tokenIssuancePolicy'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.tokenLifetimePolicyCollectionResponse:
title: Collection of tokenLifetimePolicy
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.tokenLifetimePolicy'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.applicationTemplateCollectionResponse:
title: Collection of applicationTemplate
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.applicationTemplate'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.claimsMappingPolicyCollectionResponse:
title: Collection of claimsMappingPolicy
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.claimsMappingPolicy'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.delegatedPermissionClassificationCollectionResponse:
title: Collection of delegatedPermissionClassification
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.delegatedPermissionClassification'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.administrativeUnitCollectionResponse:
title: Collection of administrativeUnit
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.administrativeUnit'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.directoryRoleCollectionResponse:
title: Collection of directoryRole
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryRole'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.groupCollectionResponse:
title: Collection of group
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.group'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.oAuth2PermissionGrantCollectionResponse:
title: Collection of oAuth2PermissionGrant
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.oAuth2PermissionGrant'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.approvedClientAppCollectionResponse:
title: Collection of approvedClientApp
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.approvedClientApp'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.targetDeviceGroupCollectionResponse:
title: Collection of targetDeviceGroup
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.targetDeviceGroup'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.keyValue:
title: keyValue
type: object
properties:
key:
type: string
description: Key for the key-value pair.
nullable: true
value:
type: string
description: Value for the key-value pair.
nullable: true
additionalProperties:
type: object
microsoft.graph.preAuthorizedApplication:
title: preAuthorizedApplication
type: object
properties:
appId:
type: string
description: The unique identifier for the application.
nullable: true
delegatedPermissionIds:
type: array
items:
type: string
description: The unique identifier for the oauth2PermissionScopes the application requires.
additionalProperties:
type: object
microsoft.graph.optionalClaim:
title: optionalClaim
type: object
properties:
additionalProperties:
type: array
items:
type: string
nullable: true
description: 'Additional properties of the claim. If a property exists in this collection, it modifies the behavior of the optional claim specified in the name property.'
essential:
type: boolean
description: 'If the value is true, the claim specified by the client is necessary to ensure a smooth authorization experience for the specific task requested by the end user. The default value is false.'
name:
type: string
description: The name of the optional claim.
source:
type: string
description: 'The source (directory object) of the claim. There are predefined claims and user-defined claims from extension properties. If the source value is null, the claim is a predefined optional claim. If the source value is user, the value in the name property is the extension property from the user object.'
nullable: true
additionalProperties:
type: object
microsoft.graph.weakAlgorithms:
title: weakAlgorithms
enum:
- rsaSha1
- unknownFutureValue
type: string
x-ms-enum-flags:
isFlags: true
microsoft.graph.resourceAccess:
title: resourceAccess
type: object
properties:
id:
pattern: '^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$'
type: string
description: 'The unique identifier of an app role or delegated permission exposed by the resource application. For delegated permissions, this should match the id property of one of the delegated permissions in the oauth2PermissionScopes collection of the resource application''s service principal. For app roles (application permissions), this should match the id property of an app role in the appRoles collection of the resource application''s service principal.'
format: uuid
type:
type: string
description: 'Specifies whether the id property references a delegated permission or an app role (application permission). The possible values are: Scope (for delegated permissions) or Role (for app roles).'
nullable: true
additionalProperties:
type: object
microsoft.graph.implicitGrantSettings:
title: implicitGrantSettings
type: object
properties:
enableAccessTokenIssuance:
type: boolean
description: Specifies whether this web application can request an access token using the OAuth 2.0 implicit flow.
nullable: true
enableIdTokenIssuance:
type: boolean
description: Specifies whether this web application can request an ID token using the OAuth 2.0 implicit flow.
nullable: true
additionalProperties:
type: object
microsoft.graph.redirectUriSettings:
title: redirectUriSettings
type: object
properties:
index:
maximum: 2147483647
minimum: -2147483648
type: number
format: int32
nullable: true
uri:
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.automaticRepliesSetting:
title: automaticRepliesSetting
type: object
properties:
externalAudience:
$ref: '#/components/schemas/microsoft.graph.externalAudienceScope'
externalReplyMessage:
type: string
description: 'The automatic reply to send to the specified external audience, if Status is AlwaysEnabled or Scheduled.'
nullable: true
internalReplyMessage:
type: string
description: 'The automatic reply to send to the audience internal to the signed-in user''s organization, if Status is AlwaysEnabled or Scheduled.'
nullable: true
scheduledEndDateTime:
$ref: '#/components/schemas/microsoft.graph.dateTimeTimeZone'
scheduledStartDateTime:
$ref: '#/components/schemas/microsoft.graph.dateTimeTimeZone'
status:
$ref: '#/components/schemas/microsoft.graph.automaticRepliesStatus'
additionalProperties:
type: object
microsoft.graph.delegateMeetingMessageDeliveryOptions:
title: delegateMeetingMessageDeliveryOptions
enum:
- sendToDelegateAndInformationToPrincipal
- sendToDelegateAndPrincipal
- sendToDelegateOnly
type: string
microsoft.graph.localeInfo:
title: localeInfo
type: object
properties:
displayName:
type: string
description: 'A name representing the user''s locale in natural language, for example, ''English (United States)''.'
nullable: true
locale:
type: string
description: 'A locale representation for the user, which includes the user''s preferred language and country/region. For example, ''en-us''. The language component follows 2-letter codes as defined in ISO 639-1, and the country component follows 2-letter codes as defined in ISO 3166-1 alpha-2.'
nullable: true
additionalProperties:
type: object
microsoft.graph.userPurpose:
title: userPurpose
enum:
- user
- linked
- shared
- room
- equipment
- others
- unknownFutureValue
type: string
microsoft.graph.workingHours:
title: workingHours
type: object
properties:
daysOfWeek:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.dayOfWeek'
description: The days of the week on which the user works.
endTime:
pattern: '^([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?$'
type: string
description: The time of the day that the user stops working.
format: time
nullable: true
startTime:
pattern: '^([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?$'
type: string
description: The time of the day that the user starts working.
format: time
nullable: true
timeZone:
$ref: '#/components/schemas/microsoft.graph.timeZoneBase'
additionalProperties:
type: object
microsoft.graph.printerShare:
allOf:
- $ref: '#/components/schemas/microsoft.graph.printerBase'
- title: printerShare
type: object
properties:
allowAllUsers:
type: boolean
description: 'If true, all users and groups will be granted access to this printer share. This supersedes the allow lists defined by the allowedUsers and allowedGroups navigation 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 DateTimeOffset when the printer share was created. Read-only.
format: date-time
viewPoint:
$ref: '#/components/schemas/microsoft.graph.printerShareViewpoint'
allowedGroups:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.group'
description: The groups whose users have access to print using the printer.
x-ms-navigationProperty: true
allowedUsers:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.user'
description: The users who have access to print using the printer.
x-ms-navigationProperty: true
printer:
$ref: '#/components/schemas/microsoft.graph.printer'
additionalProperties:
type: object
microsoft.graph.Json:
title: Json
type: object
additionalProperties:
type: object
description: Standard way to represent a Json blob on Graph.
microsoft.graph.status:
title: status
enum:
- active
- updated
- deleted
- ignored
- unknownFutureValue
type: string
microsoft.graph.visualInfo:
title: visualInfo
type: object
properties:
attribution:
$ref: '#/components/schemas/microsoft.graph.imageInfo'
backgroundColor:
type: string
description: Optional. Background color used to render the activity in the UI - brand color for the application source of the activity. Must be a valid hex color
nullable: true
content:
$ref: '#/components/schemas/microsoft.graph.Json'
description:
type: string
description: 'Optional. Longer text description of the user''s unique activity (example: document name, first sentence, and/or metadata)'
nullable: true
displayText:
type: string
description: 'Required. Short text description of the user''s unique activity (for example, document name in cases where an activity refers to document creation)'
additionalProperties:
type: object
microsoft.graph.activityHistoryItem:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: activityHistoryItem
type: object
properties:
activeDurationSeconds:
maximum: 2147483647
minimum: -2147483648
type: number
description: 'Optional. The duration of active user engagement. if not supplied, this is calculated from the startedDateTime and lastActiveDateTime.'
format: int32
nullable: true
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: Set by the server. DateTime in UTC when the object was created on the server.
format: date-time
nullable: true
expirationDateTime:
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: Optional. UTC DateTime when the activityHistoryItem will undergo hard-delete. Can be set by the client.
format: date-time
nullable: true
lastActiveDateTime:
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: 'Optional. UTC DateTime when the activityHistoryItem (activity session) was last understood as active or finished - if null, activityHistoryItem status should be Ongoing.'
format: date-time
nullable: true
lastModifiedDateTime:
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: Set by the server. DateTime in UTC when the object was modified on the server.
format: date-time
nullable: true
startedDateTime:
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: Required. UTC DateTime when the activityHistoryItem (activity session) was started. Required for timeline history.
format: date-time
status:
$ref: '#/components/schemas/microsoft.graph.status'
userTimezone:
type: string
description: Optional. The timezone in which the user's device used to generate the activity was located at activity creation time. Values supplied as Olson IDs in order to support cross-platform representation.
nullable: true
activity:
$ref: '#/components/schemas/microsoft.graph.userActivity'
additionalProperties:
type: object
microsoft.graph.callRecording:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: callRecording
type: object
properties:
callId:
type: string
description: The unique identifier for the call that is related to this recording. Read-only.
nullable: true
content:
type: string
description: The content of the recording. Read-only.
format: base64url
nullable: true
contentCorrelationId:
type: string
description: The unique identifier that links the transcript with its corresponding recording. Read-only.
nullable: true
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: 'Date and time at which the recording was created. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.'
format: date-time
nullable: true
endDateTime:
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: 'Date and time at which the recording ends. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.'
format: date-time
nullable: true
meetingId:
type: string
description: The unique identifier of the onlineMeeting related to this recording. Read-only.
nullable: true
meetingOrganizer:
$ref: '#/components/schemas/microsoft.graph.identitySet'
recordingContentUrl:
type: string
description: The URL that can be used to access the content of the recording. Read-only.
nullable: true
additionalProperties:
type: object
microsoft.graph.callTranscript:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: callTranscript
type: object
properties:
callId:
type: string
description: The unique identifier for the call that is related to this transcript. Read-only.
nullable: true
content:
type: string
description: The content of the transcript. Read-only.
format: base64url
nullable: true
contentCorrelationId:
type: string
description: The unique identifier that links the transcript with its corresponding recording. Read-only.
nullable: true
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: 'Date and time at which the transcript was created. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.'
format: date-time
nullable: true
endDateTime:
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: 'Date and time at which the transcription ends. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.'
format: date-time
nullable: true
meetingId:
type: string
description: The unique identifier of the online meeting related to this transcript. Read-only.
nullable: true
meetingOrganizer:
$ref: '#/components/schemas/microsoft.graph.identitySet'
metadataContent:
type: string
description: The time-aligned metadata of the utterances in the transcript. Read-only.
format: base64url
nullable: true
transcriptContentUrl:
type: string
description: The URL that can be used to access the content of the transcript. Read-only.
nullable: true
additionalProperties:
type: object
microsoft.graph.agreementAcceptanceState:
title: agreementAcceptanceState
enum:
- accepted
- declined
- unknownFutureValue
type: string
microsoft.graph.emailAuthenticationMethod:
allOf:
- $ref: '#/components/schemas/microsoft.graph.authenticationMethod'
- title: emailAuthenticationMethod
type: object
properties:
emailAddress:
type: string
description: The email address registered to this user.
nullable: true
additionalProperties:
type: object
microsoft.graph.externalAuthenticationMethod:
allOf:
- $ref: '#/components/schemas/microsoft.graph.authenticationMethod'
- title: externalAuthenticationMethod
type: object
properties:
configurationId:
type: string
description: A unique identifier used to manage the external auth method within Microsoft Entra ID.
displayName:
type: string
description: Custom name given to the registered external MFA.
additionalProperties:
type: object
microsoft.graph.fido2AuthenticationMethod:
allOf:
- $ref: '#/components/schemas/microsoft.graph.authenticationMethod'
- title: fido2AuthenticationMethod
type: object
properties:
aaGuid:
type: string
description: 'Authenticator Attestation GUID, an identifier that indicates the type (such as make and model) of the authenticator.'
nullable: true
attestationCertificates:
type: array
items:
type: string
nullable: true
description: The attestation certificate or certificates attached to this passkey.
attestationLevel:
$ref: '#/components/schemas/microsoft.graph.attestationLevel'
displayName:
type: string
description: The display name of the key as given by the user.
nullable: true
model:
type: string
description: The manufacturer-assigned model of the FIDO2 passkey.
nullable: true
passkeyType:
$ref: '#/components/schemas/microsoft.graph.passkeyType'
publicKeyCredential:
$ref: '#/components/schemas/microsoft.graph.webauthnPublicKeyCredential'
additionalProperties:
type: object
microsoft.graph.authenticationMethod:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: authenticationMethod
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: Represents the date and time when an entity was created. Read-only.
format: date-time
nullable: true
additionalProperties:
type: object
microsoft.graph.microsoftAuthenticatorAuthenticationMethod:
allOf:
- $ref: '#/components/schemas/microsoft.graph.authenticationMethod'
- title: microsoftAuthenticatorAuthenticationMethod
type: object
properties:
deviceTag:
type: string
description: Tags containing app metadata.
nullable: true
displayName:
type: string
description: The name of the device on which this app is registered.
nullable: true
phoneAppVersion:
type: string
description: Numerical version of this instance of the Authenticator app.
nullable: true
device:
$ref: '#/components/schemas/microsoft.graph.device'
additionalProperties:
type: object
microsoft.graph.longRunningOperation:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: longRunningOperation
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 start time of the operation. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.'
format: date-time
nullable: true
lastActionDateTime:
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 time of the last action in the operation. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.'
format: date-time
nullable: true
resourceLocation:
type: string
description: URI of the resource that the operation is performed on.
nullable: true
status:
$ref: '#/components/schemas/microsoft.graph.longRunningOperationStatus'
statusDetail:
type: string
description: Details about the status of the operation.
nullable: true
additionalProperties:
type: object
description: The status of a long-running operation.
microsoft.graph.passwordAuthenticationMethod:
allOf:
- $ref: '#/components/schemas/microsoft.graph.authenticationMethod'
- title: passwordAuthenticationMethod
type: object
properties:
password:
type: string
description: 'For security, the password is always returned as null from a LIST or GET operation.'
nullable: true
additionalProperties:
type: object
microsoft.graph.phoneAuthenticationMethod:
allOf:
- $ref: '#/components/schemas/microsoft.graph.authenticationMethod'
- title: phoneAuthenticationMethod
type: object
properties:
phoneNumber:
type: string
description: 'The phone number to text or call for authentication. Phone numbers use the format +{country code} {number}x{extension}, with extension optional. For example, +1 5555551234 or +1 5555551234x123 are valid. Numbers are rejected when creating or updating if they don''t match the required format.'
nullable: true
phoneType:
$ref: '#/components/schemas/microsoft.graph.authenticationPhoneType'
smsSignInState:
$ref: '#/components/schemas/microsoft.graph.authenticationMethodSignInState'
additionalProperties:
type: object
microsoft.graph.platformCredentialAuthenticationMethod:
allOf:
- $ref: '#/components/schemas/microsoft.graph.authenticationMethod'
- title: platformCredentialAuthenticationMethod
type: object
properties:
displayName:
type: string
description: The name of the device on which Platform Credential is registered.
nullable: true
keyStrength:
$ref: '#/components/schemas/microsoft.graph.authenticationMethodKeyStrength'
platform:
$ref: '#/components/schemas/microsoft.graph.authenticationMethodPlatform'
device:
$ref: '#/components/schemas/microsoft.graph.device'
additionalProperties:
type: object
microsoft.graph.softwareOathAuthenticationMethod:
allOf:
- $ref: '#/components/schemas/microsoft.graph.authenticationMethod'
- title: softwareOathAuthenticationMethod
type: object
properties:
secretKey:
type: string
description: The secret key of the method. Always returns null.
nullable: true
additionalProperties:
type: object
microsoft.graph.temporaryAccessPassAuthenticationMethod:
allOf:
- $ref: '#/components/schemas/microsoft.graph.authenticationMethod'
- title: temporaryAccessPassAuthenticationMethod
type: object
properties:
isUsable:
type: boolean
description: The state of the authentication method that indicates whether it's currently usable by the user.
nullable: true
isUsableOnce:
type: boolean
description: 'Determines whether the pass is limited to a one-time use. If true, the pass can be used once; if false, the pass can be used multiple times within the Temporary Access Pass lifetime.'
nullable: true
lifetimeInMinutes:
maximum: 2147483647
minimum: -2147483648
type: number
description: The lifetime of the Temporary Access Pass in minutes starting at startDateTime. Must be between 10 and 43200 inclusive (equivalent to 30 days).
format: int32
nullable: true
methodUsabilityReason:
type: string
description: 'Details about the usability state (isUsable). Reasons can include: EnabledByPolicy, DisabledByPolicy, Expired, NotYetValid, OneTimeUsed.'
nullable: true
startDateTime:
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 Temporary Access Pass becomes available to use and when isUsable is true is enforced.
format: date-time
nullable: true
temporaryAccessPass:
type: string
description: The Temporary Access Pass used to authenticate. Returned only on creation of a new temporaryAccessPassAuthenticationMethod object; Hidden in subsequent read operations and returned as null with GET.
nullable: true
additionalProperties:
type: object
microsoft.graph.windowsHelloForBusinessAuthenticationMethod:
allOf:
- $ref: '#/components/schemas/microsoft.graph.authenticationMethod'
- title: windowsHelloForBusinessAuthenticationMethod
type: object
properties:
displayName:
type: string
description: The name of the device on which Windows Hello for Business is registered
nullable: true
keyStrength:
$ref: '#/components/schemas/microsoft.graph.authenticationMethodKeyStrength'
device:
$ref: '#/components/schemas/microsoft.graph.device'
additionalProperties:
type: object
microsoft.graph.onlineMeetingProviderType:
title: onlineMeetingProviderType
enum:
- unknown
- skypeForBusiness
- skypeForConsumer
- teamsForBusiness
type: string
microsoft.graph.calendarColor:
title: calendarColor
enum:
- auto
- lightBlue
- lightGreen
- lightOrange
- lightGray
- lightYellow
- lightTeal
- lightPink
- lightBrown
- lightRed
- maxColor
type: string
microsoft.graph.emailAddress:
title: emailAddress
type: object
properties:
address:
type: string
description: The email address of the person or entity.
nullable: true
name:
type: string
description: The display name of the person or entity.
nullable: true
additionalProperties:
type: object
microsoft.graph.calendarPermission:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: calendarPermission
type: object
properties:
allowedRoles:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.calendarRoleType'
description: 'List of allowed sharing or delegating permission levels for the calendar. The possible values are: none, freeBusyRead, limitedRead, read, write, delegateWithoutPrivateEventAccess, delegateWithPrivateEventAccess, custom.'
emailAddress:
$ref: '#/components/schemas/microsoft.graph.emailAddress'
isInsideOrganization:
type: boolean
description: True if the user in context (recipient or delegate) is inside the same organization as the calendar owner.
nullable: true
isRemovable:
type: boolean
description: 'True if the user can be removed from the list of recipients or delegates for the specified calendar, false otherwise. The ''My organization'' user determines the permissions other people within your organization have to the given calendar. You can''t remove ''My organization'' as a share recipient to a calendar.'
nullable: true
role:
$ref: '#/components/schemas/microsoft.graph.calendarRoleType'
additionalProperties:
type: object
microsoft.graph.multiValueLegacyExtendedProperty:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: multiValueLegacyExtendedProperty
type: object
properties:
value:
type: array
items:
type: string
nullable: true
description: A collection of property values.
additionalProperties:
type: object
microsoft.graph.singleValueLegacyExtendedProperty:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: singleValueLegacyExtendedProperty
type: object
properties:
value:
type: string
description: A property value.
nullable: true
additionalProperties:
type: object
microsoft.graph.outlookItem:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: outlookItem
type: object
properties:
categories:
type: array
items:
type: string
nullable: true
description: The categories associated with the item
changeKey:
type: string
description: 'Identifies the version of the item. Every time the item is changed, changeKey changes as well. This allows Exchange to apply changes to the correct version of the object. Read-only.'
nullable: true
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
lastModifiedDateTime:
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
additionalProperties:
type: object
microsoft.graph.attendee:
allOf:
- $ref: '#/components/schemas/microsoft.graph.attendeeBase'
- title: attendee
type: object
properties:
proposedNewTime:
$ref: '#/components/schemas/microsoft.graph.timeSlot'
status:
$ref: '#/components/schemas/microsoft.graph.responseStatus'
additionalProperties:
type: object
microsoft.graph.itemBody:
title: itemBody
type: object
properties:
content:
type: string
description: The content of the item.
nullable: true
contentType:
$ref: '#/components/schemas/microsoft.graph.bodyType'
additionalProperties:
type: object
microsoft.graph.dateTimeTimeZone:
title: dateTimeTimeZone
type: object
properties:
dateTime:
type: string
description: 'A single point of time in a combined date and time representation ({date}T{time}; for example, 2017-08-29T04:00:00.0000000).'
timeZone:
type: string
description: 'Represents a time zone, for example, ''Pacific Standard Time''. See below for more possible values.'
nullable: true
additionalProperties:
type: object
microsoft.graph.importance:
title: importance
enum:
- low
- normal
- high
type: string
microsoft.graph.location:
title: location
type: object
properties:
address:
$ref: '#/components/schemas/microsoft.graph.physicalAddress'
coordinates:
$ref: '#/components/schemas/microsoft.graph.outlookGeoCoordinates'
displayName:
type: string
description: The name associated with the location.
nullable: true
locationEmailAddress:
type: string
description: Optional email address of the location.
nullable: true
locationType:
$ref: '#/components/schemas/microsoft.graph.locationType'
locationUri:
type: string
description: Optional URI representing the location.
nullable: true
uniqueId:
type: string
description: For internal use only.
nullable: true
uniqueIdType:
$ref: '#/components/schemas/microsoft.graph.locationUniqueIdType'
additionalProperties:
type: object
microsoft.graph.onlineMeetingInfo:
title: onlineMeetingInfo
type: object
properties:
conferenceId:
type: string
description: The ID of the conference.
nullable: true
joinUrl:
type: string
description: The external link that launches the online meeting. This is a URL that clients launch into a browser and will redirect the user to join the meeting.
nullable: true
phones:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.phone'
description: All of the phone numbers associated with this conference.
quickDial:
type: string
description: The preformatted quick dial for this call.
nullable: true
tollFreeNumbers:
type: array
items:
type: string
nullable: true
description: The toll free numbers that can be used to join the conference.
tollNumber:
type: string
description: The toll number that can be used to join the conference.
nullable: true
additionalProperties:
type: object
microsoft.graph.recipient:
title: recipient
type: object
properties:
emailAddress:
$ref: '#/components/schemas/microsoft.graph.emailAddress'
additionalProperties:
type: object
microsoft.graph.patternedRecurrence:
title: patternedRecurrence
type: object
properties:
pattern:
$ref: '#/components/schemas/microsoft.graph.recurrencePattern'
range:
$ref: '#/components/schemas/microsoft.graph.recurrenceRange'
additionalProperties:
type: object
microsoft.graph.responseStatus:
title: responseStatus
type: object
properties:
response:
$ref: '#/components/schemas/microsoft.graph.responseType'
time:
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 response was returned. It uses 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
additionalProperties:
type: object
microsoft.graph.sensitivity:
title: sensitivity
enum:
- normal
- personal
- private
- confidential
type: string
microsoft.graph.freeBusyStatus:
title: freeBusyStatus
enum:
- unknown
- free
- tentative
- busy
- oof
- workingElsewhere
type: string
microsoft.graph.eventType:
title: eventType
enum:
- singleInstance
- occurrence
- exception
- seriesMaster
type: string
microsoft.graph.attachment:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: attachment
type: object
properties:
contentType:
type: string
description: The MIME type.
nullable: true
isInline:
type: boolean
description: 'true if the attachment is an inline attachment; otherwise, false.'
lastModifiedDateTime:
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
name:
type: string
description: The attachment's file name.
nullable: true
size:
maximum: 2147483647
minimum: -2147483648
type: number
description: The length of the attachment in bytes.
format: int32
additionalProperties:
type: object
microsoft.graph.chatType:
title: chatType
enum:
- oneOnOne
- group
- meeting
- unknownFutureValue
type: string
microsoft.graph.migrationMode:
title: migrationMode
enum:
- inProgress
- completed
- unknownFutureValue
type: string
microsoft.graph.teamworkOnlineMeetingInfo:
title: teamworkOnlineMeetingInfo
type: object
properties:
calendarEventId:
type: string
description: The identifier of the calendar event associated with the meeting.
nullable: true
joinWebUrl:
type: string
description: The URL that users click to join or uniquely identify the meeting.
nullable: true
organizer:
$ref: '#/components/schemas/microsoft.graph.teamworkUserIdentity'
additionalProperties:
type: object
microsoft.graph.chatViewpoint:
title: chatViewpoint
type: object
properties:
isHidden:
type: boolean
description: Indicates whether the chat is hidden for the current user.
nullable: true
lastMessageReadDateTime:
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: Represents the dateTime up until which the current user has read chatMessages in a specific chat.
format: date-time
nullable: true
additionalProperties:
type: object
microsoft.graph.teamsAppInstallation:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: teamsAppInstallation
type: object
properties:
consentedPermissionSet:
$ref: '#/components/schemas/microsoft.graph.teamsAppPermissionSet'
teamsApp:
$ref: '#/components/schemas/microsoft.graph.teamsApp'
teamsAppDefinition:
$ref: '#/components/schemas/microsoft.graph.teamsAppDefinition'
additionalProperties:
type: object
microsoft.graph.chatMessageInfo:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: chatMessageInfo
type: object
properties:
body:
$ref: '#/components/schemas/microsoft.graph.itemBody'
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: Date time object representing the time at which message was created.
format: date-time
nullable: true
eventDetail:
$ref: '#/components/schemas/microsoft.graph.eventMessageDetail'
from:
$ref: '#/components/schemas/microsoft.graph.chatMessageFromIdentitySet'
isDeleted:
type: boolean
description: 'If set to true, the original message has been deleted.'
nullable: true
messageType:
$ref: '#/components/schemas/microsoft.graph.chatMessageType'
additionalProperties:
type: object
microsoft.graph.conversationMember:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: conversationMember
type: object
properties:
displayName:
type: string
description: The display name of the user.
nullable: true
roles:
type: array
items:
type: string
nullable: true
description: 'The roles for that user. This property contains more qualifiers only when relevant - for example, if the member has owner privileges, the roles property contains owner as one of the values. Similarly, if the member is an in-tenant guest, the roles property contains guest as one of the values. A basic member shouldn''t have any values specified in the roles property. An Out-of-tenant external member is assigned the owner role.'
visibleHistoryStartDateTime:
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 denoting how far back a conversation's history is shared with the conversation member. This property is settable only for members of a chat.
format: date-time
nullable: true
additionalProperties:
type: object
microsoft.graph.chatMessage:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: chatMessage
type: object
properties:
attachments:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.chatMessageAttachment'
description: 'References to attached objects like files, tabs, meetings etc.'
body:
$ref: '#/components/schemas/microsoft.graph.itemBody'
channelIdentity:
$ref: '#/components/schemas/microsoft.graph.channelIdentity'
chatId:
type: string
description: 'If the message was sent in a chat, represents the identity of the chat.'
nullable: true
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: Timestamp of when the chat message was created.
format: date-time
nullable: true
deletedDateTime:
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: 'Read-only. Timestamp at which the chat message was deleted, or null if not deleted.'
format: date-time
nullable: true
etag:
type: string
description: Read-only. Version number of the chat message.
nullable: true
eventDetail:
$ref: '#/components/schemas/microsoft.graph.eventMessageDetail'
from:
$ref: '#/components/schemas/microsoft.graph.chatMessageFromIdentitySet'
importance:
$ref: '#/components/schemas/microsoft.graph.chatMessageImportance'
lastEditedDateTime:
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: Read-only. Timestamp when edits to the chat message were made. Triggers an 'Edited' flag in the Teams UI. If no edits are made the value is null.
format: date-time
nullable: true
lastModifiedDateTime:
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: 'Read-only. Timestamp when the chat message is created (initial setting) or modified, including when a reaction is added or removed.'
format: date-time
nullable: true
locale:
type: string
description: Locale of the chat message set by the client. Always set to en-us.
mentions:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.chatMessageMention'
description: 'List of entities mentioned in the chat message. Supported entities are: user, bot, team, channel, chat, and tag.'
messageHistory:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.chatMessageHistoryItem'
description: 'List of activity history of a message item, including modification time and actions, such as reactionAdded, reactionRemoved, or reaction changes, on the message.'
messageType:
$ref: '#/components/schemas/microsoft.graph.chatMessageType'
policyViolation:
$ref: '#/components/schemas/microsoft.graph.chatMessagePolicyViolation'
reactions:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.chatMessageReaction'
description: 'Reactions for this chat message (for example, Like).'
replyToId:
type: string
description: 'Read-only. ID of the parent chat message or root chat message of the thread. (Only applies to chat messages in channels, not chats.)'
nullable: true
subject:
type: string
description: 'The subject of the chat message, in plaintext.'
nullable: true
summary:
type: string
description: 'Summary text of the chat message that could be used for push notifications and summary views or fall back views. Only applies to channel chat messages, not chat messages in a chat.'
nullable: true
webUrl:
type: string
description: Read-only. Link to the message in Microsoft Teams.
nullable: true
hostedContents:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.chatMessageHostedContent'
description: 'Content in a message hosted by Microsoft Teams - for example, images or code snippets.'
x-ms-navigationProperty: true
replies:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.chatMessage'
description: Replies for a specified message. Supports $expand for channel messages.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.pinnedChatMessageInfo:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: pinnedChatMessageInfo
type: object
properties:
message:
$ref: '#/components/schemas/microsoft.graph.chatMessage'
additionalProperties:
type: object
microsoft.graph.teamsTab:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: teamsTab
type: object
properties:
configuration:
$ref: '#/components/schemas/microsoft.graph.teamsTabConfiguration'
displayName:
type: string
description: Name of the tab.
nullable: true
webUrl:
type: string
description: Deep link URL of the tab instance. Read-only.
nullable: true
teamsApp:
$ref: '#/components/schemas/microsoft.graph.teamsApp'
additionalProperties:
type: object
microsoft.graph.targetedChatMessage:
allOf:
- $ref: '#/components/schemas/microsoft.graph.chatMessage'
- title: targetedChatMessage
type: object
properties:
recipient:
$ref: '#/components/schemas/microsoft.graph.identity'
additionalProperties:
type: object
microsoft.graph.cloudClipboardItem:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: cloudClipboardItem
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: Set by the server. DateTime in UTC when the object was created on the server.
format: date-time
expirationDateTime:
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: 'Set by the server. DateTime in UTC when the object expires and after that the object is no longer available. The default and also maximum TTL is 12 hours after the creation, but it might change for performance optimization.'
format: date-time
lastModifiedDateTime:
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: Set by the server if not provided in the client's request. DateTime in UTC when the object was modified by the client.
format: date-time
nullable: true
payloads:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.cloudClipboardItemPayload'
description: A cloudClipboardItem can have multiple cloudClipboardItemPayload objects in the payloads. A window can place more than one clipboard object on the clipboard. Each one represents the same information in a different clipboard format.
additionalProperties:
type: object
microsoft.graph.cloudPcProvisioningType:
title: cloudPcProvisioningType
enum:
- dedicated
- shared
- unknownFutureValue
type: string
microsoft.graph.physicalAddress:
title: physicalAddress
type: object
properties:
city:
type: string
description: The city.
nullable: true
countryOrRegion:
type: string
description: 'The country or region. It''s a free-format string value, for example, ''United States''.'
nullable: true
postalCode:
type: string
description: The postal code.
nullable: true
state:
type: string
description: The state.
nullable: true
street:
type: string
description: The street.
nullable: true
additionalProperties:
type: object
microsoft.graph.dataSecurityAndGovernance:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: dataSecurityAndGovernance
type: object
properties:
sensitivityLabels:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.sensitivityLabel'
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.activitiesContainer:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: activitiesContainer
type: object
properties:
contentActivities:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.contentActivity'
description: Collection of activity logs related to content processing.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.userProtectionScopeContainer:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: userProtectionScopeContainer
type: object
additionalProperties:
type: object
microsoft.graph.baseItem:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: baseItem
type: object
properties:
createdBy:
$ref: '#/components/schemas/microsoft.graph.identitySet'
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: Date and time of item creation. Read-only.
format: date-time
description:
type: string
description: Provides a user-visible description of the item. Optional.
nullable: true
eTag:
type: string
description: ETag for the item. Read-only.
nullable: true
lastModifiedBy:
$ref: '#/components/schemas/microsoft.graph.identitySet'
lastModifiedDateTime:
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: Date and time the item was last modified. Read-only.
format: date-time
name:
type: string
description: The name of the item. Read-write.
nullable: true
parentReference:
$ref: '#/components/schemas/microsoft.graph.itemReference'
webUrl:
type: string
description: 'URL that either displays the resource in the browser (for Office file formats), or is a direct link to the file (for other formats). Read-only.'
nullable: true
createdByUser:
$ref: '#/components/schemas/microsoft.graph.user'
lastModifiedByUser:
$ref: '#/components/schemas/microsoft.graph.user'
additionalProperties:
type: object
microsoft.graph.identitySet:
title: identitySet
type: object
properties:
application:
$ref: '#/components/schemas/microsoft.graph.identity'
device:
$ref: '#/components/schemas/microsoft.graph.identity'
user:
$ref: '#/components/schemas/microsoft.graph.identity'
additionalProperties:
type: object
microsoft.graph.quota:
title: quota
type: object
properties:
deleted:
type: number
description: 'Total space consumed by files in the recycle bin, in bytes. Read-only.'
format: int64
nullable: true
remaining:
type: number
description: 'Total space remaining before reaching the capacity limit, in bytes. Read-only.'
format: int64
nullable: true
state:
type: string
description: Enumeration value that indicates the state of the storage space. Read-only.
nullable: true
storagePlanInformation:
$ref: '#/components/schemas/microsoft.graph.storagePlanInformation'
total:
type: number
description: 'Total allowed storage space, in bytes. Read-only.'
format: int64
nullable: true
used:
type: number
description: 'Total space used, in bytes. Read-only.'
format: int64
nullable: true
additionalProperties:
type: object
microsoft.graph.sharepointIds:
title: sharepointIds
type: object
properties:
listId:
type: string
description: The unique identifier (guid) for the item's list in SharePoint.
nullable: true
listItemId:
type: string
description: An integer identifier for the item within the containing list.
nullable: true
listItemUniqueId:
type: string
description: The unique identifier (guid) for the item within OneDrive for Business or a SharePoint site.
nullable: true
siteId:
type: string
description: The unique identifier (guid) for the item's site collection (SPSite).
nullable: true
siteUrl:
type: string
description: The SharePoint URL for the site that contains the item.
nullable: true
tenantId:
type: string
description: The unique identifier (guid) for the tenancy.
nullable: true
webId:
type: string
description: The unique identifier (guid) for the item's site (SPWeb).
nullable: true
additionalProperties:
type: object
microsoft.graph.systemFacet:
title: systemFacet
type: object
additionalProperties:
type: object
microsoft.graph.driveItem:
allOf:
- $ref: '#/components/schemas/microsoft.graph.baseItem'
- title: driveItem
type: object
properties:
audio:
$ref: '#/components/schemas/microsoft.graph.audio'
bundle:
$ref: '#/components/schemas/microsoft.graph.bundle'
content:
type: string
description: 'The content stream, if the item represents a file.'
format: base64url
nullable: true
cTag:
type: string
description: An eTag for the content of the item. This eTag isn't changed if only the metadata is changed. Note This property isn't returned if the item is a folder. Read-only.
nullable: true
deleted:
$ref: '#/components/schemas/microsoft.graph.deleted'
file:
$ref: '#/components/schemas/microsoft.graph.file'
fileSystemInfo:
$ref: '#/components/schemas/microsoft.graph.fileSystemInfo'
folder:
$ref: '#/components/schemas/microsoft.graph.folder'
image:
$ref: '#/components/schemas/microsoft.graph.image'
location:
$ref: '#/components/schemas/microsoft.graph.geoCoordinates'
malware:
$ref: '#/components/schemas/microsoft.graph.malware'
package:
$ref: '#/components/schemas/microsoft.graph.package'
pendingOperations:
$ref: '#/components/schemas/microsoft.graph.pendingOperations'
photo:
$ref: '#/components/schemas/microsoft.graph.photo'
publication:
$ref: '#/components/schemas/microsoft.graph.publicationFacet'
remoteItem:
$ref: '#/components/schemas/microsoft.graph.remoteItem'
root:
$ref: '#/components/schemas/microsoft.graph.root'
searchResult:
$ref: '#/components/schemas/microsoft.graph.searchResult'
shared:
$ref: '#/components/schemas/microsoft.graph.shared'
sharepointIds:
$ref: '#/components/schemas/microsoft.graph.sharepointIds'
size:
type: number
description: Size of the item in bytes. Read-only.
format: int64
nullable: true
specialFolder:
$ref: '#/components/schemas/microsoft.graph.specialFolder'
video:
$ref: '#/components/schemas/microsoft.graph.video'
webDavUrl:
type: string
description: WebDAV compatible URL for the item.
nullable: true
analytics:
$ref: '#/components/schemas/microsoft.graph.itemAnalytics'
children:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.driveItem'
description: Collection containing Item objects for the immediate children of Item. Only items representing folders have children. Read-only. Nullable.
x-ms-navigationProperty: true
listItem:
$ref: '#/components/schemas/microsoft.graph.listItem'
permissions:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.permission'
description: The set of permissions for the item. Read-only. Nullable.
x-ms-navigationProperty: true
retentionLabel:
$ref: '#/components/schemas/microsoft.graph.itemRetentionLabel'
subscriptions:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.subscription'
description: The set of subscriptions on the item. Only supported on the root of a drive.
x-ms-navigationProperty: true
thumbnails:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.thumbnailSet'
description: 'Collection of thumbnailSet objects associated with the item. For more information, see getting thumbnails. Read-only. Nullable.'
x-ms-navigationProperty: true
versions:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.driveItemVersion'
description: 'The list of previous versions of the item. For more info, see getting previous versions. Read-only. Nullable.'
x-ms-navigationProperty: true
workbook:
$ref: '#/components/schemas/microsoft.graph.workbook'
additionalProperties:
type: object
microsoft.graph.list:
allOf:
- $ref: '#/components/schemas/microsoft.graph.baseItem'
- title: list
type: object
properties:
displayName:
type: string
description: The displayable title of the list.
nullable: true
list:
$ref: '#/components/schemas/microsoft.graph.listInfo'
sharepointIds:
$ref: '#/components/schemas/microsoft.graph.sharepointIds'
system:
$ref: '#/components/schemas/microsoft.graph.systemFacet'
columns:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.columnDefinition'
description: The collection of field definitions for this list.
x-ms-navigationProperty: true
contentTypes:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.contentType'
description: The collection of content types present in this list.
x-ms-navigationProperty: true
drive:
$ref: '#/components/schemas/microsoft.graph.drive'
items:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.listItem'
description: All items contained in the list.
x-ms-navigationProperty: true
operations:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.richLongRunningOperation'
description: The collection of long-running operations on the list.
x-ms-navigationProperty: true
permissions:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.permission'
description: The set of permissions for the item. Read-only. Nullable.
x-ms-navigationProperty: true
subscriptions:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.subscription'
description: The set of subscriptions on the list.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.engagementRole:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: engagementRole
type: object
properties:
displayName:
type: string
description: The name of the role.
members:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.engagementRoleMember'
description: Users that have this role assigned.
x-ms-navigationProperty: true
additionalProperties:
type: object
description: Represents a Viva Engage role and its members
microsoft.graph.learningCourseActivity:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: learningCourseActivity
type: object
properties:
completedDateTime:
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: Date and time when the assignment was completed. Optional.
format: date-time
nullable: true
completionPercentage:
maximum: 2147483647
minimum: -2147483648
type: number
description: The percentage completion value of the course activity. Optional.
format: int32
nullable: true
externalcourseActivityId:
type: string
nullable: true
learnerUserId:
type: string
description: The user ID of the learner to whom the activity is assigned. Required.
learningContentId:
type: string
description: The ID of the learning content created in Viva Learning. Required.
learningProviderId:
type: string
description: The registration ID of the provider. Required.
nullable: true
status:
$ref: '#/components/schemas/microsoft.graph.courseStatus'
additionalProperties:
type: object
microsoft.graph.root:
title: root
type: object
additionalProperties:
type: object
microsoft.graph.siteCollection:
title: siteCollection
type: object
properties:
archivalDetails:
$ref: '#/components/schemas/microsoft.graph.siteArchivalDetails'
dataLocationCode:
type: string
description: The geographic region code for where this site collection resides. Only present for multi-geo tenants. Read-only.
nullable: true
hostname:
type: string
description: The hostname for the site collection. Read-only.
nullable: true
root:
$ref: '#/components/schemas/microsoft.graph.root'
additionalProperties:
type: object
microsoft.graph.itemAnalytics:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: itemAnalytics
type: object
properties:
allTime:
$ref: '#/components/schemas/microsoft.graph.itemActivityStat'
itemActivityStats:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.itemActivityStat'
x-ms-navigationProperty: true
lastSevenDays:
$ref: '#/components/schemas/microsoft.graph.itemActivityStat'
additionalProperties:
type: object
microsoft.graph.columnDefinition:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: columnDefinition
type: object
properties:
boolean:
$ref: '#/components/schemas/microsoft.graph.booleanColumn'
calculated:
$ref: '#/components/schemas/microsoft.graph.calculatedColumn'
choice:
$ref: '#/components/schemas/microsoft.graph.choiceColumn'
columnGroup:
type: string
description: 'For site columns, the name of the group this column belongs to. Helps organize related columns.'
nullable: true
contentApprovalStatus:
$ref: '#/components/schemas/microsoft.graph.contentApprovalStatusColumn'
currency:
$ref: '#/components/schemas/microsoft.graph.currencyColumn'
dateTime:
$ref: '#/components/schemas/microsoft.graph.dateTimeColumn'
defaultValue:
$ref: '#/components/schemas/microsoft.graph.defaultColumnValue'
description:
type: string
description: The user-facing description of the column.
nullable: true
displayName:
type: string
description: The user-facing name of the column.
nullable: true
enforceUniqueValues:
type: boolean
description: 'If true, no two list items may have the same value for this column.'
nullable: true
geolocation:
$ref: '#/components/schemas/microsoft.graph.geolocationColumn'
hidden:
type: boolean
description: Specifies whether the column is displayed in the user interface.
nullable: true
hyperlinkOrPicture:
$ref: '#/components/schemas/microsoft.graph.hyperlinkOrPictureColumn'
indexed:
type: boolean
description: Specifies whether the column values can be used for sorting and searching.
nullable: true
isDeletable:
type: boolean
description: Indicates whether this column can be deleted.
nullable: true
isReorderable:
type: boolean
description: Indicates whether values in the column can be reordered. Read-only.
nullable: true
isSealed:
type: boolean
description: Specifies whether the column can be changed.
nullable: true
lookup:
$ref: '#/components/schemas/microsoft.graph.lookupColumn'
name:
type: string
description: 'The API-facing name of the column as it appears in the fields on a listItem. For the user-facing name, see displayName.'
nullable: true
number:
$ref: '#/components/schemas/microsoft.graph.numberColumn'
personOrGroup:
$ref: '#/components/schemas/microsoft.graph.personOrGroupColumn'
propagateChanges:
type: boolean
description: 'If ''true'', changes to this column will be propagated to lists that implement the column.'
nullable: true
readOnly:
type: boolean
description: Specifies whether the column values can be modified.
nullable: true
required:
type: boolean
description: Specifies whether the column value isn't optional.
nullable: true
sourceContentType:
$ref: '#/components/schemas/microsoft.graph.contentTypeInfo'
term:
$ref: '#/components/schemas/microsoft.graph.termColumn'
text:
$ref: '#/components/schemas/microsoft.graph.textColumn'
thumbnail:
$ref: '#/components/schemas/microsoft.graph.thumbnailColumn'
type:
$ref: '#/components/schemas/microsoft.graph.columnTypes'
validation:
$ref: '#/components/schemas/microsoft.graph.columnValidation'
sourceColumn:
$ref: '#/components/schemas/microsoft.graph.columnDefinition'
additionalProperties:
type: object
microsoft.graph.contentType:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: contentType
type: object
properties:
associatedHubsUrls:
type: array
items:
type: string
nullable: true
description: List of canonical URLs for hub sites with which this content type is associated to. This will contain all hub sites where this content type is queued to be enforced or is already enforced. Enforcing a content type means that the content type is applied to the lists in the enforced sites.
description:
type: string
description: The descriptive text for the item.
nullable: true
documentSet:
$ref: '#/components/schemas/microsoft.graph.documentSet'
documentTemplate:
$ref: '#/components/schemas/microsoft.graph.documentSetContent'
group:
type: string
description: The name of the group this content type belongs to. Helps organize related content types.
nullable: true
hidden:
type: boolean
description: Indicates whether the content type is hidden in the list's 'New' menu.
nullable: true
inheritedFrom:
$ref: '#/components/schemas/microsoft.graph.itemReference'
isBuiltIn:
type: boolean
description: Specifies if a content type is a built-in content type.
nullable: true
name:
type: string
description: The name of the content type.
nullable: true
order:
$ref: '#/components/schemas/microsoft.graph.contentTypeOrder'
parentId:
type: string
description: The unique identifier of the content type.
nullable: true
propagateChanges:
type: boolean
description: 'If true, any changes made to the content type are pushed to inherited content types and lists that implement the content type.'
nullable: true
readOnly:
type: boolean
description: 'If true, the content type can''t be modified unless this value is first set to false.'
nullable: true
sealed:
type: boolean
description: 'If true, the content type can''t be modified by users or through push-down operations. Only site collection administrators can seal or unseal content types.'
nullable: true
base:
$ref: '#/components/schemas/microsoft.graph.contentType'
baseTypes:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.contentType'
description: The collection of content types that are ancestors of this content type.
x-ms-navigationProperty: true
columnLinks:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.columnLink'
description: The collection of columns that are required by this content type.
x-ms-navigationProperty: true
columnPositions:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.columnDefinition'
description: Column order information in a content type.
x-ms-navigationProperty: true
columns:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.columnDefinition'
description: The collection of column definitions for this content type.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.richLongRunningOperation:
allOf:
- $ref: '#/components/schemas/microsoft.graph.longRunningOperation'
- title: richLongRunningOperation
type: object
properties:
error:
$ref: '#/components/schemas/microsoft.graph.publicError'
percentageComplete:
maximum: 2147483647
minimum: -2147483648
type: number
description: A value between 0 and 100 that indicates the progress of the operation.
format: int32
nullable: true
resourceId:
type: string
description: The unique identifier for the result.
nullable: true
type:
type: string
description: The type of the operation.
nullable: true
additionalProperties:
type: object
description: The status of a long-running operation.
microsoft.graph.baseSitePage:
allOf:
- $ref: '#/components/schemas/microsoft.graph.baseItem'
- title: baseSitePage
type: object
properties:
pageLayout:
$ref: '#/components/schemas/microsoft.graph.pageLayoutType'
publishingState:
$ref: '#/components/schemas/microsoft.graph.publicationFacet'
title:
type: string
description: Title of the sitePage.
nullable: true
additionalProperties:
type: object
microsoft.graph.permission:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: permission
type: object
properties:
expirationDateTime:
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: A format of yyyy-MM-ddTHH:mm:ssZ of DateTimeOffset indicates the expiration time of the permission. DateTime.MinValue indicates there's no expiration set for this permission. Optional.
format: date-time
nullable: true
grantedTo:
$ref: '#/components/schemas/microsoft.graph.identitySet'
grantedToIdentities:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.identitySet'
description: 'For type permissions, the details of the users to whom permission was granted. Read-only.'
grantedToIdentitiesV2:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.sharePointIdentitySet'
description: 'For link type permissions, the details of the users to whom permission was granted. Read-only.'
grantedToV2:
$ref: '#/components/schemas/microsoft.graph.sharePointIdentitySet'
hasPassword:
type: boolean
description: Indicates whether the password is set for this permission. This property only appears in the response. Optional. Read-only. For OneDrive Personal only..
nullable: true
inheritedFrom:
$ref: '#/components/schemas/microsoft.graph.itemReference'
invitation:
$ref: '#/components/schemas/microsoft.graph.sharingInvitation'
link:
$ref: '#/components/schemas/microsoft.graph.sharingLink'
roles:
type: array
items:
type: string
nullable: true
description: 'The type of permission, for example, read. See below for the full list of roles. Read-only.'
shareId:
type: string
description: A unique token that can be used to access this shared item via the shares API. Read-only.
nullable: true
additionalProperties:
type: object
microsoft.graph.termStore.store:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: store
type: object
properties:
defaultLanguageTag:
type: string
description: Default language of the term store.
languageTags:
type: array
items:
type: string
description: List of languages for the term store.
groups:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.termStore.group'
description: Collection of all groups available in the term store.
x-ms-navigationProperty: true
sets:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.termStore.set'
description: Collection of all sets available in the term store. This relationship can only be used to load a specific term set.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.inferenceClassificationOverride:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: inferenceClassificationOverride
type: object
properties:
classifyAs:
$ref: '#/components/schemas/microsoft.graph.inferenceClassificationType'
senderEmailAddress:
$ref: '#/components/schemas/microsoft.graph.emailAddress'
additionalProperties:
type: object
microsoft.graph.officeGraphInsights:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: officeGraphInsights
type: object
properties:
shared:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.sharedInsight'
description: 'Calculated relationship that identifies documents shared with or by the user. This includes URLs, file attachments, and reference attachments to OneDrive for work or school and SharePoint files found in Outlook messages and meetings. This also includes URLs and reference attachments to Teams conversations. Ordered by recency of share.'
x-ms-navigationProperty: true
trending:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.trending'
description: 'Calculated relationship that identifies documents trending around a user. Trending documents are calculated based on activity of the user''s closest network of people and include files stored in OneDrive for work or school and SharePoint. Trending insights help the user to discover potentially useful content that the user has access to, but has never viewed before.'
x-ms-navigationProperty: true
used:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.usedInsight'
description: 'Calculated relationship that identifies the latest documents viewed or modified by a user, including OneDrive for work or school and SharePoint documents, ranked by recency of use.'
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.teamFunSettings:
title: teamFunSettings
type: object
properties:
allowCustomMemes:
type: boolean
description: 'If set to true, enables users to include custom memes.'
nullable: true
allowGiphy:
type: boolean
description: 'If set to true, enables Giphy use.'
nullable: true
allowStickersAndMemes:
type: boolean
description: 'If set to true, enables users to include stickers and memes.'
nullable: true
giphyContentRating:
$ref: '#/components/schemas/microsoft.graph.giphyRatingType'
additionalProperties:
type: object
microsoft.graph.teamGuestSettings:
title: teamGuestSettings
type: object
properties:
allowCreateUpdateChannels:
type: boolean
description: 'If set to true, guests can add and update channels.'
nullable: true
allowDeleteChannels:
type: boolean
description: 'If set to true, guests can delete channels.'
nullable: true
additionalProperties:
type: object
microsoft.graph.teamMemberSettings:
title: teamMemberSettings
type: object
properties:
allowAddRemoveApps:
type: boolean
description: 'If set to true, members can add and remove apps.'
nullable: true
allowCreatePrivateChannels:
type: boolean
description: 'If set to true, members can add and update private channels.'
nullable: true
allowCreateUpdateChannels:
type: boolean
description: 'If set to true, members can add and update channels.'
nullable: true
allowCreateUpdateRemoveConnectors:
type: boolean
description: 'If set to true, members can add, update, and remove connectors.'
nullable: true
allowCreateUpdateRemoveTabs:
type: boolean
description: 'If set to true, members can add, update, and remove tabs.'
nullable: true
allowDeleteChannels:
type: boolean
description: 'If set to true, members can delete channels.'
nullable: true
additionalProperties:
type: object
microsoft.graph.teamMessagingSettings:
title: teamMessagingSettings
type: object
properties:
allowChannelMentions:
type: boolean
description: 'If set to true, @channel mentions are allowed.'
nullable: true
allowOwnerDeleteMessages:
type: boolean
description: 'If set to true, owners can delete any message.'
nullable: true
allowTeamMentions:
type: boolean
description: 'If set to true, @team mentions are allowed.'
nullable: true
allowUserDeleteMessages:
type: boolean
description: 'If set to true, users can delete their messages.'
nullable: true
allowUserEditMessages:
type: boolean
description: 'If set to true, users can edit their messages.'
nullable: true
additionalProperties:
type: object
microsoft.graph.teamSpecialization:
title: teamSpecialization
enum:
- none
- educationStandard
- educationClass
- educationProfessionalLearningCommunity
- educationStaff
- healthcareStandard
- healthcareCareCoordination
- unknownFutureValue
type: string
microsoft.graph.teamSummary:
title: teamSummary
type: object
properties:
guestsCount:
maximum: 2147483647
minimum: -2147483648
type: number
description: Count of guests in a team.
format: int32
nullable: true
membersCount:
maximum: 2147483647
minimum: -2147483648
type: number
description: Count of members in a team.
format: int32
nullable: true
ownersCount:
maximum: 2147483647
minimum: -2147483648
type: number
description: Count of owners in a team.
format: int32
nullable: true
additionalProperties:
type: object
microsoft.graph.teamVisibilityType:
title: teamVisibilityType
enum:
- private
- public
- hiddenMembership
- unknownFutureValue
type: string
microsoft.graph.channel:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: channel
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: Read-only. Timestamp at which the channel was created.
format: date-time
nullable: true
description:
type: string
description: Optional textual description for the channel.
nullable: true
displayName:
type: string
description: Channel name as it will appear to the user in Microsoft Teams. The maximum length is 50 characters.
email:
type: string
description: The email address for sending messages to the channel. Read-only.
nullable: true
isArchived:
type: boolean
description: Indicates whether the channel is archived. Read-only.
nullable: true
isFavoriteByDefault:
type: boolean
description: 'Indicates whether the channel should be marked as recommended for all members of the team to show in their channel list. Note: All recommended channels automatically show in the channels list for education and frontline worker users. The property can only be set programmatically via the Create team method. The default value is false.'
nullable: true
layoutType:
$ref: '#/components/schemas/microsoft.graph.channelLayoutType'
membershipType:
$ref: '#/components/schemas/microsoft.graph.channelMembershipType'
migrationMode:
$ref: '#/components/schemas/microsoft.graph.migrationMode'
originalCreatedDateTime:
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: Timestamp of the original creation time for the channel. The value is null if the channel never entered migration mode.
format: date-time
nullable: true
summary:
$ref: '#/components/schemas/microsoft.graph.channelSummary'
tenantId:
type: string
description: The ID of the Microsoft Entra tenant.
nullable: true
webUrl:
type: string
description: 'A hyperlink that will go to the channel in Microsoft Teams. This is the URL that you get when you right-click a channel in Microsoft Teams and select Get link to channel. This URL should be treated as an opaque blob, and not parsed. Read-only.'
nullable: true
allMembers:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.conversationMember'
description: 'A collection of membership records associated with the channel, including both direct and indirect members of shared channels.'
x-ms-navigationProperty: true
enabledApps:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.teamsApp'
description: A collection of enabled apps in the channel.
x-ms-navigationProperty: true
filesFolder:
$ref: '#/components/schemas/microsoft.graph.driveItem'
members:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.conversationMember'
description: A collection of membership records associated with the channel.
x-ms-navigationProperty: true
messages:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.chatMessage'
description: A collection of all the messages in the channel. A navigation property. Nullable.
x-ms-navigationProperty: true
sharedWithTeams:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.sharedWithChannelTeamInfo'
description: A collection of teams with which a channel is shared.
x-ms-navigationProperty: true
tabs:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.teamsTab'
description: A collection of all the tabs in the channel. A navigation property.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.teamsAsyncOperation:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: teamsAsyncOperation
type: object
properties:
attemptsCount:
maximum: 2147483647
minimum: -2147483648
type: number
description: Number of times the operation was attempted before being marked successful or failed.
format: int32
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: Time when the operation was created.
format: date-time
error:
$ref: '#/components/schemas/microsoft.graph.operationError'
lastActionDateTime:
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: Time when the async operation was last updated.
format: date-time
operationType:
$ref: '#/components/schemas/microsoft.graph.teamsAsyncOperationType'
status:
$ref: '#/components/schemas/microsoft.graph.teamsAsyncOperationStatus'
targetResourceId:
type: string
description: 'The ID of the object that''s created or modified as result of this async operation, typically a team.'
nullable: true
targetResourceLocation:
type: string
description: The location of the object that's created or modified as result of this async operation. This URL should be treated as an opaque value and not parsed into its component paths.
nullable: true
additionalProperties:
type: object
microsoft.graph.schedule:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: schedule
type: object
properties:
enabled:
type: boolean
description: Indicates whether the schedule is enabled for the team. Required.
nullable: true
isActivitiesIncludedWhenCopyingShiftsEnabled:
type: boolean
description: Indicates whether copied shifts include activities from the original shift.
nullable: true
offerShiftRequestsEnabled:
type: boolean
description: Indicates whether offer shift requests are enabled for the schedule.
nullable: true
openShiftsEnabled:
type: boolean
description: Indicates whether open shifts are enabled for the schedule.
nullable: true
provisionStatus:
$ref: '#/components/schemas/microsoft.graph.operationStatus'
provisionStatusCode:
type: string
description: Additional information about why schedule provisioning failed.
nullable: true
readOnly: true
startDayOfWeek:
$ref: '#/components/schemas/microsoft.graph.dayOfWeek'
swapShiftsRequestsEnabled:
type: boolean
description: Indicates whether swap shifts requests are enabled for the schedule.
nullable: true
timeClockEnabled:
type: boolean
description: Indicates whether time clock is enabled for the schedule.
nullable: true
timeClockSettings:
$ref: '#/components/schemas/microsoft.graph.timeClockSettings'
timeOffRequestsEnabled:
type: boolean
description: Indicates whether time off requests are enabled for the schedule.
nullable: true
timeZone:
type: string
description: 'The time zone of the schedule team as an IANA time zone database (tz database) name; for example, America/Chicago. For the full list of valid values, see List of tz database time zones. Required.'
nullable: true
workforceIntegrationIds:
type: array
items:
type: string
nullable: true
description: The IDs for the workforce integrations associated with this schedule.
dayNotes:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.dayNote'
description: The day notes in the schedule.
x-ms-navigationProperty: true
offerShiftRequests:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.offerShiftRequest'
description: The offer requests for shifts in the schedule.
x-ms-navigationProperty: true
openShiftChangeRequests:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.openShiftChangeRequest'
description: The open shift requests in the schedule.
x-ms-navigationProperty: true
openShifts:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.openShift'
description: The set of open shifts in a scheduling group in the schedule.
x-ms-navigationProperty: true
schedulingGroups:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.schedulingGroup'
description: The logical grouping of users in the schedule (usually by role).
x-ms-navigationProperty: true
shifts:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.shift'
description: The shifts in the schedule.
x-ms-navigationProperty: true
swapShiftsChangeRequests:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.swapShiftsChangeRequest'
description: The swap requests for shifts in the schedule.
x-ms-navigationProperty: true
timeCards:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.timeCard'
description: The time cards in the schedule.
x-ms-navigationProperty: true
timeOffReasons:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.timeOffReason'
description: The set of reasons for a time off in the schedule.
x-ms-navigationProperty: true
timeOffRequests:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.timeOffRequest'
description: The time off requests in the schedule.
x-ms-navigationProperty: true
timesOff:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.timeOff'
description: The instances of times off in the schedule.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.teamworkTag:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: teamworkTag
type: object
properties:
description:
type: string
description: The description of the tag as it appears to the user in Microsoft Teams. A teamworkTag can't have more than 200 teamworkTagMembers.
nullable: true
displayName:
type: string
description: The name of the tag as it appears to the user in Microsoft Teams.
nullable: true
memberCount:
maximum: 2147483647
minimum: -2147483648
type: number
description: The number of users assigned to the tag.
format: int32
nullable: true
tagType:
$ref: '#/components/schemas/microsoft.graph.teamworkTagType'
teamId:
type: string
description: ID of the team in which the tag is defined.
nullable: true
members:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.teamworkTagMember'
description: Users assigned to the tag.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.teamsTemplate:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: teamsTemplate
type: object
additionalProperties:
type: object
microsoft.graph.servicePlanInfo:
title: servicePlanInfo
type: object
properties:
appliesTo:
type: string
description: The object the service plan can be assigned to. The possible values are:User - service plan can be assigned to individual users.Company - service plan can be assigned to the entire tenant.
nullable: true
provisioningStatus:
type: string
description: 'The provisioning status of the service plan. The possible values are:Success - Service is fully provisioned.Disabled - Service is disabled.Error - The service plan isn''t provisioned and is in an error state.PendingInput - The service isn''t provisioned and is awaiting service confirmation.PendingActivation - The service is provisioned but requires explicit activation by an administrator (for example, Intune_O365 service plan)PendingProvisioning - Microsoft has added a new service to the product SKU and it isn''t activated in the tenant.'
nullable: true
servicePlanId:
pattern: '^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$'
type: string
description: The unique identifier of the service plan.
format: uuid
nullable: true
servicePlanName:
type: string
description: The name of the service plan.
nullable: true
additionalProperties:
type: object
microsoft.graph.messageRule:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: messageRule
type: object
properties:
actions:
$ref: '#/components/schemas/microsoft.graph.messageRuleActions'
conditions:
$ref: '#/components/schemas/microsoft.graph.messageRulePredicates'
displayName:
type: string
description: The display name of the rule.
nullable: true
exceptions:
$ref: '#/components/schemas/microsoft.graph.messageRulePredicates'
hasError:
type: boolean
description: Indicates whether the rule is in an error condition. Read-only.
nullable: true
isEnabled:
type: boolean
description: Indicates whether the rule is enabled to be applied to messages.
nullable: true
isReadOnly:
type: boolean
description: Indicates if the rule is read-only and cannot be modified or deleted by the rules REST API.
nullable: true
sequence:
maximum: 2147483647
minimum: -2147483648
type: number
description: 'Indicates the order in which the rule is executed, among other rules.'
format: int32
nullable: true
additionalProperties:
type: object
microsoft.graph.mobileAppIdentifier:
title: mobileAppIdentifier
type: object
additionalProperties:
type: object
description: The identifier for a mobile app.
microsoft.graph.managedAppFlaggedReason:
title: managedAppFlaggedReason
enum:
- none
- rootedDevice
type: string
description: The reason for which a user has been flagged
x-ms-enum:
name: managedAppFlaggedReason
modelAsString: false
values:
- value: none
description: No issue.
name: none
- value: rootedDevice
description: The app registration is running on a rooted/unlocked device.
name: rootedDevice
microsoft.graph.managedAppPolicy:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: managedAppPolicy
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 the policy was created.
format: date-time
description:
type: string
description: The policy's description.
nullable: true
displayName:
type: string
description: Policy display name.
lastModifiedDateTime:
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: Last time the policy was modified.
format: date-time
version:
type: string
description: Version of the entity.
nullable: true
additionalProperties:
type: object
description: The ManagedAppPolicy resource represents a base type for platform specific policies.
microsoft.graph.managedAppOperation:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: managedAppOperation
type: object
properties:
displayName:
type: string
description: The operation name.
nullable: true
lastModifiedDateTime:
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 last time the app operation was modified.
format: date-time
state:
type: string
description: The current state of the operation
nullable: true
version:
type: string
description: Version of the entity.
nullable: true
additionalProperties:
type: object
description: Represents an operation applied against an app registration.
microsoft.graph.complianceState:
title: complianceState
enum:
- unknown
- compliant
- noncompliant
- conflict
- error
- inGracePeriod
- configManager
type: string
description: Compliance state.
x-ms-enum:
name: complianceState
modelAsString: false
values:
- value: unknown
description: Unknown.
name: unknown
- value: compliant
description: Compliant.
name: compliant
- value: noncompliant
description: Device is non-compliant and is blocked from corporate resources.
name: noncompliant
- value: conflict
description: Conflict with other rules.
name: conflict
- value: error
description: Error.
name: error
- value: inGracePeriod
description: Device is non-compliant but still has access to corporate resources
name: inGracePeriod
- value: configManager
description: Managed by Config Manager
name: configManager
microsoft.graph.configurationManagerClientEnabledFeatures:
title: configurationManagerClientEnabledFeatures
type: object
properties:
compliancePolicy:
type: boolean
description: Whether compliance policy is managed by Intune
deviceConfiguration:
type: boolean
description: Whether device configuration is managed by Intune
inventory:
type: boolean
description: Whether inventory is managed by Intune
modernApps:
type: boolean
description: Whether modern application is managed by Intune
resourceAccess:
type: boolean
description: Whether resource access is managed by Intune
windowsUpdateForBusiness:
type: boolean
description: Whether Windows Update for Business is managed by Intune
additionalProperties:
type: object
description: configuration Manager client enabled features
microsoft.graph.deviceActionResult:
title: deviceActionResult
type: object
properties:
actionName:
type: string
description: Action name
nullable: true
actionState:
$ref: '#/components/schemas/microsoft.graph.actionState'
lastUpdatedDateTime:
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: Time the action state was last updated
format: date-time
startDateTime:
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: Time the action was initiated
format: date-time
additionalProperties:
type: object
description: Device action result
microsoft.graph.deviceEnrollmentType:
title: deviceEnrollmentType
enum:
- unknown
- userEnrollment
- deviceEnrollmentManager
- appleBulkWithUser
- appleBulkWithoutUser
- windowsAzureADJoin
- windowsBulkUserless
- windowsAutoEnrollment
- windowsBulkAzureDomainJoin
- windowsCoManagement
- windowsAzureADJoinUsingDeviceAuth
- appleUserEnrollment
- appleUserEnrollmentWithServiceAccount
- unknownFutureValue
type: string
description: Possible ways of adding a mobile device to management.
x-ms-enum:
name: deviceEnrollmentType
modelAsString: false
values:
- value: unknown
description: 'Default value, enrollment type was not collected.'
name: unknown
- value: userEnrollment
description: User driven enrollment through BYOD channel.
name: userEnrollment
- value: deviceEnrollmentManager
description: User enrollment with a device enrollment manager account.
name: deviceEnrollmentManager
- value: appleBulkWithUser
description: 'Apple bulk enrollment with user challenge. (DEP, Apple Configurator)'
name: appleBulkWithUser
- value: appleBulkWithoutUser
description: 'Apple bulk enrollment without user challenge. (DEP, Apple Configurator, Mobile Config)'
name: appleBulkWithoutUser
- value: windowsAzureADJoin
description: Windows 10 Entra ID (Azure AD) Join.
name: windowsAzureADJoin
- value: windowsBulkUserless
description: Windows 10 Bulk enrollment through ICD with certificate.
name: windowsBulkUserless
- value: windowsAutoEnrollment
description: Windows 10 automatic enrollment. (Add work account)
name: windowsAutoEnrollment
- value: windowsBulkAzureDomainJoin
description: Windows 10 bulk Entra ID (Azure AD) Join.
name: windowsBulkAzureDomainJoin
- value: windowsCoManagement
description: Windows 10 Co-Management triggered by AutoPilot or Group Policy.
name: windowsCoManagement
- value: windowsAzureADJoinUsingDeviceAuth
description: Windows 10 Entra ID (Azure AD) Join using Device Auth.
name: windowsAzureADJoinUsingDeviceAuth
- value: appleUserEnrollment
description: Indicates the device is enrolled via Apple User Enrollment with Company Portal. It results in an enrollment with a new partition for managed apps and data and which supports a limited set of management capabilities
name: appleUserEnrollment
- value: appleUserEnrollmentWithServiceAccount
description: Indicates the device is enrolled via Apple User Enrollment with Company Portal using a device enrollment manager user. It results in an enrollment with a new partition for managed apps and data and which supports a limited set of management capabilities
name: appleUserEnrollmentWithServiceAccount
- value: unknownFutureValue
description: Evolvable enumeration sentinel value. Do not use.
name: unknownFutureValue
microsoft.graph.deviceHealthAttestationState:
title: deviceHealthAttestationState
type: object
properties:
attestationIdentityKey:
type: string
description: 'TWhen an Attestation Identity Key (AIK) is present on a device, it indicates that the device has an endorsement key (EK) certificate.'
nullable: true
bitLockerStatus:
type: string
description: On or Off of BitLocker Drive Encryption
nullable: true
bootAppSecurityVersion:
type: string
description: The security version number of the Boot Application
nullable: true
bootDebugging:
type: string
description: 'When bootDebugging is enabled, the device is used in development and testing'
nullable: true
bootManagerSecurityVersion:
type: string
description: The security version number of the Boot Application
nullable: true
bootManagerVersion:
type: string
description: The version of the Boot Manager
nullable: true
bootRevisionListInfo:
type: string
description: The Boot Revision List that was loaded during initial boot on the attested device
nullable: true
codeIntegrity:
type: string
description: 'When code integrity is enabled, code execution is restricted to integrity verified code'
nullable: true
codeIntegrityCheckVersion:
type: string
description: The version of the Boot Manager
nullable: true
codeIntegrityPolicy:
type: string
description: The Code Integrity policy that is controlling the security of the boot environment
nullable: true
contentNamespaceUrl:
type: string
description: The DHA report version. (Namespace version)
nullable: true
contentVersion:
type: string
description: The HealthAttestation state schema version
nullable: true
dataExcutionPolicy:
type: string
description: DEP Policy defines a set of hardware and software technologies that perform additional checks on memory
nullable: true
deviceHealthAttestationStatus:
type: string
description: The DHA report version. (Namespace version)
nullable: true
earlyLaunchAntiMalwareDriverProtection:
type: string
description: ELAM provides protection for the computers in your network when they start up
nullable: true
healthAttestationSupportedStatus:
type: string
description: This attribute indicates if DHA is supported for the device
nullable: true
healthStatusMismatchInfo:
type: string
description: This attribute appears if DHA-Service detects an integrity issue
nullable: true
issuedDateTime:
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 DateTime when device was evaluated or issued to MDM
format: date-time
lastUpdateDateTime:
type: string
description: The Timestamp of the last update.
nullable: true
operatingSystemKernelDebugging:
type: string
description: 'When operatingSystemKernelDebugging is enabled, the device is used in development and testing'
nullable: true
operatingSystemRevListInfo:
type: string
description: The Operating System Revision List that was loaded during initial boot on the attested device
nullable: true
pcr0:
type: string
description: 'The measurement that is captured in PCR[0]'
nullable: true
pcrHashAlgorithm:
type: string
description: Informational attribute that identifies the HASH algorithm that was used by TPM
nullable: true
resetCount:
type: number
description: The number of times a PC device has hibernated or resumed
format: int64
restartCount:
type: number
description: The number of times a PC device has rebooted
format: int64
safeMode:
type: string
description: Safe mode is a troubleshooting option for Windows that starts your computer in a limited state
nullable: true
secureBoot:
type: string
description: 'When Secure Boot is enabled, the core components must have the correct cryptographic signatures'
nullable: true
secureBootConfigurationPolicyFingerPrint:
type: string
description: Fingerprint of the Custom Secure Boot Configuration Policy
nullable: true
testSigning:
type: string
description: 'When test signing is allowed, the device does not enforce signature validation during boot'
nullable: true
tpmVersion:
type: string
description: The security version number of the Boot Application
nullable: true
virtualSecureMode:
type: string
description: 'Indicates whether the device has Virtual Secure Mode (VSM) enabled. Virtual Secure Mode (VSM) is a container that protects high value assets from a compromised kernel. This property will be deprecated in beta from August 2023. Support for this property will end in August 2025 for v1.0 API. A new property virtualizationBasedSecurity is added and used instead. The value used for virtualSecureMode will be passed by virtualizationBasedSecurity during the deprecation process. Possible values are ''enabled'', ''disabled'' and ''notApplicable''. ''enabled'' indicates Virtual Secure Mode (VSM) is enabled. ''disabled'' indicates Virtual Secure Mode (VSM) is disabled. ''notApplicable'' indicates the device is not a Windows 11 device. Default value is ''notApplicable''.'
nullable: true
windowsPE:
type: string
description: Operating system running with limited services that is used to prepare a computer for Windows
nullable: true
additionalProperties:
type: object
microsoft.graph.deviceRegistrationState:
title: deviceRegistrationState
enum:
- notRegistered
- registered
- revoked
- keyConflict
- approvalPending
- certificateReset
- notRegisteredPendingEnrollment
- unknown
type: string
description: Device registration status.
x-ms-enum:
name: deviceRegistrationState
modelAsString: false
values:
- value: notRegistered
description: The device is not registered.
name: notRegistered
- value: registered
description: The device is registered.
name: registered
- value: revoked
description: 'The device has been blocked, wiped or retired.'
name: revoked
- value: keyConflict
description: The device has a key conflict.
name: keyConflict
- value: approvalPending
description: The device is pending approval.
name: approvalPending
- value: certificateReset
description: The device certificate has been reset.
name: certificateReset
- value: notRegisteredPendingEnrollment
description: The device is not registered and pending enrollment.
name: notRegisteredPendingEnrollment
- value: unknown
description: The device registration status is unknown.
name: unknown
microsoft.graph.deviceManagementExchangeAccessState:
title: deviceManagementExchangeAccessState
enum:
- none
- unknown
- allowed
- blocked
- quarantined
type: string
description: Device Exchange Access State.
x-ms-enum:
name: deviceManagementExchangeAccessState
modelAsString: false
values:
- value: none
description: No access state discovered from Exchange
name: none
- value: unknown
description: Device access state to Exchange is unknown
name: unknown
- value: allowed
description: Device has access to Exchange
name: allowed
- value: blocked
description: Device is Blocked in Exchange
name: blocked
- value: quarantined
description: Device is Quarantined in Exchange
name: quarantined
microsoft.graph.deviceManagementExchangeAccessStateReason:
title: deviceManagementExchangeAccessStateReason
enum:
- none
- unknown
- exchangeGlobalRule
- exchangeIndividualRule
- exchangeDeviceRule
- exchangeUpgrade
- exchangeMailboxPolicy
- other
- compliant
- notCompliant
- notEnrolled
- unknownLocation
- mfaRequired
- azureADBlockDueToAccessPolicy
- compromisedPassword
- deviceNotKnownWithManagedApp
type: string
description: Device Exchange Access State Reason.
x-ms-enum:
name: deviceManagementExchangeAccessStateReason
modelAsString: false
values:
- value: none
description: No access state reason discovered from Exchange
name: none
- value: unknown
description: Unknown access state reason
name: unknown
- value: exchangeGlobalRule
description: Access state determined by Exchange Global rule
name: exchangeGlobalRule
- value: exchangeIndividualRule
description: Access state determined by Exchange Individual rule
name: exchangeIndividualRule
- value: exchangeDeviceRule
description: Access state determined by Exchange Device rule
name: exchangeDeviceRule
- value: exchangeUpgrade
description: Access state due to Exchange upgrade
name: exchangeUpgrade
- value: exchangeMailboxPolicy
description: Access state determined by Exchange Mailbox Policy
name: exchangeMailboxPolicy
- value: other
description: Access state determined by Exchange
name: other
- value: compliant
description: Access state granted by compliance challenge
name: compliant
- value: notCompliant
description: Access state revoked by compliance challenge
name: notCompliant
- value: notEnrolled
description: Access state revoked by management challenge
name: notEnrolled
- value: unknownLocation
description: Access state due to unknown location
name: unknownLocation
- value: mfaRequired
description: Access state due to MFA challenge
name: mfaRequired
- value: azureADBlockDueToAccessPolicy
description: Access State revoked by AAD Access Policy
name: azureADBlockDueToAccessPolicy
- value: compromisedPassword
description: Access State revoked by compromised password
name: compromisedPassword
- value: deviceNotKnownWithManagedApp
description: Access state revoked by managed application challenge
name: deviceNotKnownWithManagedApp
microsoft.graph.managedDeviceOwnerType:
title: managedDeviceOwnerType
enum:
- unknown
- company
- personal
- unknownFutureValue
type: string
description: Owner type of device.
x-ms-enum:
name: managedDeviceOwnerType
modelAsString: false
values:
- value: unknown
description: Unknown device owner type.
name: unknown
- value: company
description: Corporate device owner type.
name: company
- value: personal
description: Personal device owner type.
name: personal
- value: unknownFutureValue
description: Evolvable enumeration sentinel value. Do not use.
name: unknownFutureValue
microsoft.graph.managementAgentType:
title: managementAgentType
enum:
- eas
- mdm
- easMdm
- intuneClient
- easIntuneClient
- configurationManagerClient
- configurationManagerClientMdm
- configurationManagerClientMdmEas
- unknown
- jamf
- googleCloudDevicePolicyController
- microsoft365ManagedMdm
- msSense
type: string
x-ms-enum:
name: managementAgentType
modelAsString: false
values:
- value: eas
description: The device is managed by Exchange server.
name: eas
- value: mdm
description: The device is managed by Intune MDM.
name: mdm
- value: easMdm
description: The device is managed by both Exchange server and Intune MDM.
name: easMdm
- value: intuneClient
description: Intune client managed.
name: intuneClient
- value: easIntuneClient
description: The device is EAS and Intune client dual managed.
name: easIntuneClient
- value: configurationManagerClient
description: The device is managed by Configuration Manager.
name: configurationManagerClient
- value: configurationManagerClientMdm
description: The device is managed by Configuration Manager and MDM.
name: configurationManagerClientMdm
- value: configurationManagerClientMdmEas
description: 'The device is managed by Configuration Manager, MDM and Eas.'
name: configurationManagerClientMdmEas
- value: unknown
description: Unknown management agent type.
name: unknown
- value: jamf
description: The device attributes are fetched from Jamf.
name: jamf
- value: googleCloudDevicePolicyController
description: The device is managed by Google's CloudDPC.
name: googleCloudDevicePolicyController
- value: microsoft365ManagedMdm
description: This device is managed by Microsoft 365 through Intune.
name: microsoft365ManagedMdm
microsoft.graph.managementState:
title: managementState
enum:
- managed
- retirePending
- retireFailed
- wipePending
- wipeFailed
- unhealthy
- deletePending
- retireIssued
- wipeIssued
- wipeCanceled
- retireCanceled
- discovered
- unknownFutureValue
type: string
description: Management state of device in Microsoft Intune.
x-ms-enum:
name: managementState
modelAsString: false
values:
- value: managed
description: The device is under management
name: managed
- value: retirePending
description: A retire command is occuring on the device and in the process of unenrolling from management
name: retirePending
- value: retireFailed
description: Retire command failed on the device
name: retireFailed
- value: wipePending
description: A wipe command is occuring on the device and in the process of unenrolling from management
name: wipePending
- value: wipeFailed
description: Wipe command failed on the device
name: wipeFailed
- value: unhealthy
description: The device is unhealthy.
name: unhealthy
- value: deletePending
description: 'A delete command is occuring on the device '
name: deletePending
- value: retireIssued
description: A retire command was issued for the device
name: retireIssued
- value: wipeIssued
description: A wipe command was issued for the device
name: wipeIssued
- value: wipeCanceled
description: A wipe command for this device has been canceled
name: wipeCanceled
- value: retireCanceled
description: A retire command for this device has been canceled
name: retireCanceled
- value: discovered
description: The device is discovered but not fully enrolled.
name: discovered
- value: unknownFutureValue
description: Evolvable enumeration sentinel value. Do not use.
name: unknownFutureValue
microsoft.graph.managedDevicePartnerReportedHealthState:
title: managedDevicePartnerReportedHealthState
enum:
- unknown
- activated
- deactivated
- secured
- lowSeverity
- mediumSeverity
- highSeverity
- unresponsive
- compromised
- misconfigured
type: string
description: Available health states for the Device Health API
x-ms-enum:
name: managedDevicePartnerReportedHealthState
modelAsString: false
values:
- value: unknown
description: Device health state is not yet reported
name: unknown
- value: activated
description: 'Device has been activated by a mobile threat defense partner, but has not yet reported health.'
name: activated
- value: deactivated
description: Device has been deactivated by a mobile threat defense partner. The device health is not known.
name: deactivated
- value: secured
description: Device is considered secured by the mobile threat defense partner.
name: secured
- value: lowSeverity
description: Device is considered low threat by the mobile threat defense partner.
name: lowSeverity
- value: mediumSeverity
description: Device is considered medium threat by the mobile threat defense partner.
name: mediumSeverity
- value: highSeverity
description: Device is considered high threat by the mobile threat defense partner.
name: highSeverity
- value: unresponsive
description: Device is considered unresponsive by the mobile threat defense partner. The device health is not known.
name: unresponsive
- value: compromised
description: Device is considered compromised by the Threat Defense partner. This means the device has an active Threat or Risk which cannot be easily remediated by the end user and the user should contact their IT Admin.
name: compromised
- value: misconfigured
description: Device is considered misconfigured with the Threat Defense partner. This means the device is missing a required profile or configuration for the Threat Defense Partner to function properly and is thus threat or risk analysis is not able to complete.
name: misconfigured
microsoft.graph.deviceCategory:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: deviceCategory
type: object
properties:
description:
type: string
description: Optional description for the device category.
nullable: true
displayName:
type: string
description: Display name for the device category.
nullable: true
additionalProperties:
type: object
description: 'Device categories provides a way to organize your devices. Using device categories, company administrators can define their own categories that make sense to their company. These categories can then be applied to a device in the Intune Azure console or selected by a user during device enrollment. You can filter reports and create dynamic Azure Active Directory device groups based on device categories.'
microsoft.graph.deviceCompliancePolicyState:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: deviceCompliancePolicyState
type: object
properties:
displayName:
type: string
description: The name of the policy for this policyBase
nullable: true
platformType:
$ref: '#/components/schemas/microsoft.graph.policyPlatformType'
settingCount:
maximum: 2147483647
minimum: -2147483648
type: number
description: Count of how many setting a policy holds
format: int32
settingStates:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.deviceCompliancePolicySettingState'
state:
$ref: '#/components/schemas/microsoft.graph.complianceStatus'
version:
maximum: 2147483647
minimum: -2147483648
type: number
description: The version of the policy
format: int32
additionalProperties:
type: object
description: Device Compliance Policy State for a given device.
microsoft.graph.deviceConfigurationState:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: deviceConfigurationState
type: object
properties:
displayName:
type: string
description: The name of the policy for this policyBase
nullable: true
platformType:
$ref: '#/components/schemas/microsoft.graph.policyPlatformType'
settingCount:
maximum: 2147483647
minimum: -2147483648
type: number
description: Count of how many setting a policy holds
format: int32
settingStates:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.deviceConfigurationSettingState'
state:
$ref: '#/components/schemas/microsoft.graph.complianceStatus'
version:
maximum: 2147483647
minimum: -2147483648
type: number
description: The version of the policy
format: int32
additionalProperties:
type: object
description: Support for this Entity is being deprecated starting May 2026 & will no longer be supported.
microsoft.graph.deviceLogCollectionResponse:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: deviceLogCollectionResponse
type: object
properties:
enrolledByUser:
type: string
description: The User Principal Name (UPN) of the user that enrolled the device.
nullable: true
expirationDateTimeUTC:
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 DateTime of the expiration of the logs.
format: date-time
nullable: true
initiatedByUserPrincipalName:
type: string
description: The UPN for who initiated the request.
nullable: true
managedDeviceId:
pattern: '^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$'
type: string
description: Indicates Intune device unique identifier.
format: uuid
receivedDateTimeUTC:
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 DateTime the request was received.
format: date-time
nullable: true
requestedDateTimeUTC:
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 DateTime of the request.
format: date-time
nullable: true
sizeInKB:
type: number
description: The size of the logs in KB. Valid values -1.79769313486232E+308 to 1.79769313486232E+308
format: double
nullable: true
status:
$ref: '#/components/schemas/microsoft.graph.appLogUploadState'
additionalProperties:
type: object
description: Windows Log Collection request entity.
microsoft.graph.windowsProtectionState:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: windowsProtectionState
type: object
properties:
antiMalwareVersion:
type: string
description: Current anti malware version
nullable: true
controlledConfigurationEnabled:
type: boolean
description: 'When TRUE indicates the Windows Defender controlled configuration feature is enabled, when FALSE indicates the Windows Defender controlled configuration feature is not enabled. Defaults to setting on client device.'
nullable: true
deviceState:
$ref: '#/components/schemas/microsoft.graph.windowsDeviceHealthState'
engineVersion:
type: string
description: Current endpoint protection engine's version
nullable: true
fullScanOverdue:
type: boolean
description: 'When TRUE indicates full scan is overdue, when FALSE indicates full scan is not overdue. Defaults to setting on client device.'
nullable: true
fullScanRequired:
type: boolean
description: 'When TRUE indicates full scan is required, when FALSE indicates full scan is not required. Defaults to setting on client device.'
nullable: true
isVirtualMachine:
type: boolean
description: 'When TRUE indicates the device is a virtual machine, when FALSE indicates the device is not a virtual machine. Defaults to setting on client device.'
nullable: true
lastFullScanDateTime:
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: Last quick scan datetime
format: date-time
nullable: true
lastFullScanSignatureVersion:
type: string
description: Last full scan signature version
nullable: true
lastQuickScanDateTime:
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: Last quick scan datetime
format: date-time
nullable: true
lastQuickScanSignatureVersion:
type: string
description: Last quick scan signature version
nullable: true
lastReportedDateTime:
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: Last device health status reported time
format: date-time
nullable: true
malwareProtectionEnabled:
type: boolean
description: When TRUE indicates anti malware is enabled when FALSE indicates anti malware is not enabled.
nullable: true
networkInspectionSystemEnabled:
type: boolean
description: 'When TRUE indicates network inspection system enabled, when FALSE indicates network inspection system is not enabled. Defaults to setting on client device.'
nullable: true
productStatus:
$ref: '#/components/schemas/microsoft.graph.windowsDefenderProductStatus'
quickScanOverdue:
type: boolean
description: 'When TRUE indicates quick scan is overdue, when FALSE indicates quick scan is not overdue. Defaults to setting on client device.'
nullable: true
realTimeProtectionEnabled:
type: boolean
description: 'When TRUE indicates real time protection is enabled, when FALSE indicates real time protection is not enabled. Defaults to setting on client device.'
nullable: true
rebootRequired:
type: boolean
description: 'When TRUE indicates reboot is required, when FALSE indicates when TRUE indicates reboot is not required. Defaults to setting on client device.'
nullable: true
signatureUpdateOverdue:
type: boolean
description: 'When TRUE indicates signature is out of date, when FALSE indicates signature is not out of date. Defaults to setting on client device.'
nullable: true
signatureVersion:
type: string
description: Current malware definitions version
nullable: true
tamperProtectionEnabled:
type: boolean
description: 'When TRUE indicates the Windows Defender tamper protection feature is enabled, when FALSE indicates the Windows Defender tamper protection feature is not enabled. Defaults to setting on client device.'
nullable: true
detectedMalwareState:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.windowsDeviceMalwareState'
description: Device malware list
x-ms-navigationProperty: true
additionalProperties:
type: object
description: Device protection status entity.
microsoft.graph.followupFlag:
title: followupFlag
type: object
properties:
completedDateTime:
$ref: '#/components/schemas/microsoft.graph.dateTimeTimeZone'
dueDateTime:
$ref: '#/components/schemas/microsoft.graph.dateTimeTimeZone'
flagStatus:
$ref: '#/components/schemas/microsoft.graph.followupFlagStatus'
startDateTime:
$ref: '#/components/schemas/microsoft.graph.dateTimeTimeZone'
additionalProperties:
type: object
microsoft.graph.inferenceClassificationType:
title: inferenceClassificationType
enum:
- focused
- other
type: string
microsoft.graph.internetMessageHeader:
title: internetMessageHeader
type: object
properties:
name:
type: string
description: Represents the key in a key-value pair.
nullable: true
value:
type: string
description: The value in a key-value pair.
nullable: true
additionalProperties:
type: object
microsoft.graph.notebook:
allOf:
- $ref: '#/components/schemas/microsoft.graph.onenoteEntityHierarchyModel'
- title: notebook
type: object
properties:
isDefault:
type: boolean
description: Indicates whether this is the user's default notebook. Read-only.
nullable: true
isShared:
type: boolean
description: 'Indicates whether the notebook is shared. If true, the contents of the notebook can be seen by people other than the owner. Read-only.'
nullable: true
links:
$ref: '#/components/schemas/microsoft.graph.notebookLinks'
sectionGroupsUrl:
type: string
description: 'The URL for the sectionGroups navigation property, which returns all the section groups in the notebook. Read-only.'
nullable: true
sectionsUrl:
type: string
description: 'The URL for the sections navigation property, which returns all the sections in the notebook. Read-only.'
nullable: true
userRole:
$ref: '#/components/schemas/microsoft.graph.onenoteUserRole'
sectionGroups:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.sectionGroup'
description: The section groups in the notebook. Read-only. Nullable.
x-ms-navigationProperty: true
sections:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.onenoteSection'
description: The sections in the notebook. Read-only. Nullable.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.onenoteOperation:
allOf:
- $ref: '#/components/schemas/microsoft.graph.operation'
- title: onenoteOperation
type: object
properties:
error:
$ref: '#/components/schemas/microsoft.graph.onenoteOperationError'
percentComplete:
type: string
description: The operation percent complete if the operation is still in running status.
nullable: true
resourceId:
type: string
description: The resource id.
nullable: true
resourceLocation:
type: string
description: 'The resource URI for the object. For example, the resource URI for a copied page or section.'
nullable: true
additionalProperties:
type: object
microsoft.graph.onenotePage:
allOf:
- $ref: '#/components/schemas/microsoft.graph.onenoteEntitySchemaObjectModel'
- title: onenotePage
type: object
properties:
content:
type: string
description: The page's HTML content.
format: base64url
nullable: true
contentUrl:
type: string
description: The URL for the page's HTML content. Read-only.
nullable: true
createdByAppId:
type: string
description: The unique identifier of the application that created the page. Read-only.
nullable: true
lastModifiedDateTime:
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 page was last modified. The timestamp 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. Read-only.'
format: date-time
nullable: true
level:
maximum: 2147483647
minimum: -2147483648
type: number
description: The indentation level of the page. Read-only.
format: int32
nullable: true
links:
$ref: '#/components/schemas/microsoft.graph.pageLinks'
order:
maximum: 2147483647
minimum: -2147483648
type: number
description: The order of the page within its parent section. Read-only.
format: int32
nullable: true
title:
type: string
description: The title of the page.
nullable: true
userTags:
type: array
items:
type: string
nullable: true
parentNotebook:
$ref: '#/components/schemas/microsoft.graph.notebook'
parentSection:
$ref: '#/components/schemas/microsoft.graph.onenoteSection'
additionalProperties:
type: object
microsoft.graph.onenoteResource:
allOf:
- $ref: '#/components/schemas/microsoft.graph.onenoteEntityBaseModel'
- title: onenoteResource
type: object
properties:
content:
type: string
description: The content stream
format: base64url
nullable: true
contentUrl:
type: string
description: The URL for downloading the content
nullable: true
additionalProperties:
type: object
microsoft.graph.sectionGroup:
allOf:
- $ref: '#/components/schemas/microsoft.graph.onenoteEntityHierarchyModel'
- title: sectionGroup
type: object
properties:
sectionGroupsUrl:
type: string
description: 'The URL for the sectionGroups navigation property, which returns all the section groups in the section group. Read-only.'
nullable: true
sectionsUrl:
type: string
description: 'The URL for the sections navigation property, which returns all the sections in the section group. Read-only.'
nullable: true
parentNotebook:
$ref: '#/components/schemas/microsoft.graph.notebook'
parentSectionGroup:
$ref: '#/components/schemas/microsoft.graph.sectionGroup'
sectionGroups:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.sectionGroup'
description: The section groups in the section. Read-only. Nullable.
x-ms-navigationProperty: true
sections:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.onenoteSection'
description: The sections in the section group. Read-only. Nullable.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.onenoteSection:
allOf:
- $ref: '#/components/schemas/microsoft.graph.onenoteEntityHierarchyModel'
- title: onenoteSection
type: object
properties:
isDefault:
type: boolean
description: Indicates whether this is the user's default section. Read-only.
nullable: true
links:
$ref: '#/components/schemas/microsoft.graph.sectionLinks'
pagesUrl:
type: string
description: The pages endpoint where you can get details for all the pages in the section. Read-only.
nullable: true
pages:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.onenotePage'
description: The collection of pages in the section. Read-only. Nullable.
x-ms-navigationProperty: true
parentNotebook:
$ref: '#/components/schemas/microsoft.graph.notebook'
parentSectionGroup:
$ref: '#/components/schemas/microsoft.graph.sectionGroup'
additionalProperties:
type: object
microsoft.graph.onlineMeetingBase:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: onlineMeetingBase
type: object
properties:
allowAttendeeToEnableCamera:
type: boolean
description: Indicates whether attendees can turn on their camera.
nullable: true
allowAttendeeToEnableMic:
type: boolean
description: Indicates whether attendees can turn on their microphone.
nullable: true
allowBreakoutRooms:
type: boolean
description: Indicates whether breakout rooms are enabled for the meeting.
nullable: true
allowCopyingAndSharingMeetingContent:
type: boolean
description: Indicates whether the ability to copy and share meeting content is enabled for the meeting.
nullable: true
allowedLobbyAdmitters:
$ref: '#/components/schemas/microsoft.graph.allowedLobbyAdmitterRoles'
allowedPresenters:
$ref: '#/components/schemas/microsoft.graph.onlineMeetingPresenters'
allowLiveShare:
$ref: '#/components/schemas/microsoft.graph.meetingLiveShareOptions'
allowMeetingChat:
$ref: '#/components/schemas/microsoft.graph.meetingChatMode'
allowParticipantsToChangeName:
type: boolean
description: Specifies if participants are allowed to rename themselves in an instance of the meeting.
nullable: true
allowPowerPointSharing:
type: boolean
description: Indicates whether PowerPoint live is enabled for the meeting.
nullable: true
allowRecording:
type: boolean
description: Indicates whether recording is enabled for the meeting.
nullable: true
allowTeamworkReactions:
type: boolean
description: Indicates if Teams reactions are enabled for the meeting.
nullable: true
allowTranscription:
type: boolean
description: Indicates whether transcription is enabled for the meeting.
nullable: true
allowWhiteboard:
type: boolean
description: Indicates whether whiteboard is enabled for the meeting.
nullable: true
audioConferencing:
$ref: '#/components/schemas/microsoft.graph.audioConferencing'
chatInfo:
$ref: '#/components/schemas/microsoft.graph.chatInfo'
chatRestrictions:
$ref: '#/components/schemas/microsoft.graph.chatRestrictions'
cloudVideoInteropInfo:
$ref: '#/components/schemas/microsoft.graph.cloudVideoInteropInfo'
expiryDateTime:
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: 'Indicates the date and time when the meeting resource expires. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.'
format: date-time
nullable: true
isEndToEndEncryptionEnabled:
type: boolean
description: Indicates whether end-to-end encryption (E2EE) is enabled for the online meeting.
nullable: true
isEntryExitAnnounced:
type: boolean
description: Indicates whether to announce when callers join or leave.
nullable: true
joinInformation:
$ref: '#/components/schemas/microsoft.graph.itemBody'
joinMeetingIdSettings:
$ref: '#/components/schemas/microsoft.graph.joinMeetingIdSettings'
joinWebUrl:
type: string
description: The join URL of the online meeting. Read-only.
nullable: true
lobbyBypassSettings:
$ref: '#/components/schemas/microsoft.graph.lobbyBypassSettings'
meetingOptionsWebUrl:
type: string
description: Provides the URL to the Teams meeting options page for the specified meeting. This link allows only the organizer to configure meeting settings.
nullable: true
meetingSpokenLanguageTag:
type: string
description: Specifies the spoken language used during the meeting for recording and transcription purposes.
nullable: true
meetingType:
$ref: '#/components/schemas/microsoft.graph.onlineMeetingType'
recordAutomatically:
type: boolean
description: Indicates whether to record the meeting automatically.
nullable: true
sensitivityLabelAssignment:
$ref: '#/components/schemas/microsoft.graph.onlineMeetingSensitivityLabelAssignment'
shareMeetingChatHistoryDefault:
$ref: '#/components/schemas/microsoft.graph.meetingChatHistoryDefaultMode'
subject:
type: string
description: The subject of the online meeting.
nullable: true
videoTeleconferenceId:
type: string
description: The video teleconferencing ID. Read-only.
nullable: true
watermarkProtection:
$ref: '#/components/schemas/microsoft.graph.watermarkProtectionValues'
attendanceReports:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.meetingAttendanceReport'
description: The attendance reports of an online meeting. Read-only.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.broadcastMeetingSettings:
title: broadcastMeetingSettings
type: object
properties:
allowedAudience:
$ref: '#/components/schemas/microsoft.graph.broadcastMeetingAudience'
captions:
$ref: '#/components/schemas/microsoft.graph.broadcastMeetingCaptionSettings'
isAttendeeReportEnabled:
type: boolean
description: Indicates whether attendee report is enabled for this Teams live event. Default value is false.
nullable: true
isQuestionAndAnswerEnabled:
type: boolean
description: Indicates whether Q&A is enabled for this Teams live event. Default value is false.
nullable: true
isRecordingEnabled:
type: boolean
description: Indicates whether recording is enabled for this Teams live event. Default value is false.
nullable: true
isVideoOnDemandEnabled:
type: boolean
description: Indicates whether video on demand is enabled for this Teams live event. Default value is false.
nullable: true
additionalProperties:
type: object
microsoft.graph.meetingParticipants:
title: meetingParticipants
type: object
properties:
attendees:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.meetingParticipantInfo'
description: Information about the meeting attendees.
organizer:
$ref: '#/components/schemas/microsoft.graph.meetingParticipantInfo'
additionalProperties:
type: object
microsoft.graph.outlookCategory:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: outlookCategory
type: object
properties:
color:
$ref: '#/components/schemas/microsoft.graph.categoryColor'
displayName:
type: string
description: 'A unique name that identifies a category in the user''s mailbox. After a category is created, the name cannot be changed. Read-only.'
nullable: true
additionalProperties:
type: object
microsoft.graph.personType:
title: personType
type: object
properties:
class:
type: string
description: 'The type of data source, such as Person.'
nullable: true
subclass:
type: string
description: 'The secondary type of data source, such as OrganizationUser.'
nullable: true
additionalProperties:
type: object
microsoft.graph.phone:
title: phone
type: object
properties:
language:
type: string
nullable: true
number:
type: string
description: The phone number.
nullable: true
region:
type: string
nullable: true
type:
$ref: '#/components/schemas/microsoft.graph.phoneType'
additionalProperties:
type: object
microsoft.graph.scoredEmailAddress:
title: scoredEmailAddress
type: object
properties:
address:
type: string
description: The email address.
nullable: true
itemId:
type: string
nullable: true
relevanceScore:
type: number
description: 'The relevance score of the email address. A relevance score is used as a sort key, in relation to the other returned results. A higher relevance score value corresponds to a more relevant result. Relevance is determined by the user’s communication and collaboration patterns and business relationships.'
format: double
nullable: true
selectionLikelihood:
$ref: '#/components/schemas/microsoft.graph.selectionLikelihoodInfo'
additionalProperties:
type: object
microsoft.graph.website:
title: website
type: object
properties:
address:
type: string
description: The URL of the website.
nullable: true
displayName:
type: string
description: The display name of the web site.
nullable: true
type:
$ref: '#/components/schemas/microsoft.graph.websiteType'
additionalProperties:
type: object
microsoft.graph.plannerPlan:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: plannerPlan
type: object
properties:
container:
$ref: '#/components/schemas/microsoft.graph.plannerPlanContainer'
createdBy:
$ref: '#/components/schemas/microsoft.graph.identitySet'
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: 'Read-only. Date and time at which the plan is created. 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
owner:
type: string
description: 'Use the container property instead. ID of the group that owns the plan. After it''s set, this property can’t be updated. This property won''t return a valid group ID if the container of the plan isn''t a group.'
nullable: true
title:
type: string
description: Required. Title of the plan.
buckets:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.plannerBucket'
description: Read-only. Nullable. Collection of buckets in the plan.
x-ms-navigationProperty: true
details:
$ref: '#/components/schemas/microsoft.graph.plannerPlanDetails'
tasks:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.plannerTask'
description: Read-only. Nullable. Collection of tasks in the plan.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.plannerTask:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: plannerTask
type: object
properties:
activeChecklistItemCount:
maximum: 2147483647
minimum: -2147483648
type: number
description: 'Number of checklist items with value set to false, representing incomplete items.'
format: int32
nullable: true
appliedCategories:
$ref: '#/components/schemas/microsoft.graph.plannerAppliedCategories'
assigneePriority:
type: string
description: Hint used to order items of this type in a list view. The format is defined as outlined here.
nullable: true
assignments:
$ref: '#/components/schemas/microsoft.graph.plannerAssignments'
bucketId:
type: string
description: Bucket ID to which the task belongs. The bucket needs to be in the plan that the task is in. It's 28 characters long and case-sensitive. Format validation is done on the service.
nullable: true
checklistItemCount:
maximum: 2147483647
minimum: -2147483648
type: number
description: Number of checklist items that are present on the task.
format: int32
nullable: true
completedBy:
$ref: '#/components/schemas/microsoft.graph.identitySet'
completedDateTime:
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: 'Read-only. Date and time at which the ''percentComplete'' of the task is set to ''100''. 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
conversationThreadId:
type: string
description: Thread ID of the conversation on the task. This is the ID of the conversation thread object created in the group.
nullable: true
createdBy:
$ref: '#/components/schemas/microsoft.graph.identitySet'
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: 'Read-only. Date and time at which the task is created. 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
dueDateTime:
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: 'Date and time at which the task is due. 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
hasDescription:
type: boolean
description: Read-only. Value is true if the details object of the task has a nonempty description and false otherwise.
nullable: true
orderHint:
type: string
description: Hint used to order items of this type in a list view. The format is defined as outlined here.
nullable: true
percentComplete:
maximum: 2147483647
minimum: -2147483648
type: number
description: 'Percentage of task completion. When set to 100, the task is considered completed.'
format: int32
nullable: true
planId:
type: string
description: Plan ID to which the task belongs.
nullable: true
previewType:
$ref: '#/components/schemas/microsoft.graph.plannerPreviewType'
priority:
maximum: 2147483647
minimum: -2147483648
type: number
description: 'Priority of the task. The valid range of values is between 0 and 10, with the increasing value being lower priority (0 has the highest priority and 10 has the lowest priority). Currently, Planner interprets values 0 and 1 as ''urgent'', 2, 3 and 4 as ''important'', 5, 6, and 7 as ''medium'', and 8, 9, and 10 as ''low''. Additionally, Planner sets the value 1 for ''urgent'', 3 for ''important'', 5 for ''medium'', and 9 for ''low''.'
format: int32
nullable: true
referenceCount:
maximum: 2147483647
minimum: -2147483648
type: number
description: Number of external references that exist on the task.
format: int32
nullable: true
startDateTime:
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: 'Date and time at which the task starts. 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
title:
type: string
description: Title of the task.
assignedToTaskBoardFormat:
$ref: '#/components/schemas/microsoft.graph.plannerAssignedToTaskBoardTaskFormat'
bucketTaskBoardFormat:
$ref: '#/components/schemas/microsoft.graph.plannerBucketTaskBoardTaskFormat'
details:
$ref: '#/components/schemas/microsoft.graph.plannerTaskDetails'
progressTaskBoardFormat:
$ref: '#/components/schemas/microsoft.graph.plannerProgressTaskBoardTaskFormat'
additionalProperties:
type: object
microsoft.graph.outOfOfficeSettings:
title: outOfOfficeSettings
type: object
properties:
isOutOfOffice:
type: boolean
description: 'If true, either of the following is met:The current time falls within the out-of-office window configured in Outlook or Teams.An event marked as ''Show as Out of Office'' appears on the user''s calendar.Otherwise, false.'
nullable: true
message:
type: string
description: The out-of-office message configured by the user in the Outlook client (Automatic replies) or the Teams client (Schedule out of office).
nullable: true
additionalProperties:
type: object
microsoft.graph.presenceStatusMessage:
title: presenceStatusMessage
type: object
properties:
expiryDateTime:
$ref: '#/components/schemas/microsoft.graph.dateTimeTimeZone'
message:
$ref: '#/components/schemas/microsoft.graph.itemBody'
publishedDateTime:
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: Time in which the status message was published.Read-only.publishedDateTime isn't available when you request the presence of another user.
format: date-time
nullable: true
additionalProperties:
type: object
microsoft.graph.userWorkLocation:
title: userWorkLocation
type: object
properties:
placeId:
type: string
description: 'Identifier of the place, if applicable.'
nullable: true
source:
$ref: '#/components/schemas/microsoft.graph.workLocationSource'
workLocationType:
$ref: '#/components/schemas/microsoft.graph.workLocationType'
additionalProperties:
type: object
microsoft.graph.identity:
title: identity
type: object
properties:
displayName:
type: string
description: 'The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don''t show up as changed when using delta.'
nullable: true
id:
type: string
description: 'Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that''s subject to review.'
nullable: true
additionalProperties:
type: object
microsoft.graph.exchangeSettings:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: exchangeSettings
type: object
properties:
primaryMailboxId:
type: string
description: The unique identifier for the user's primary mailbox.
nullable: true
additionalProperties:
type: object
microsoft.graph.userInsightsSettings:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: userInsightsSettings
type: object
properties:
isEnabled:
type: boolean
description: True if the user's itemInsights and meeting hours insights are enabled; false if the user's itemInsights and meeting hours insights are disabled. The default value is true. Optional.
additionalProperties:
type: object
microsoft.graph.shiftPreferences:
allOf:
- $ref: '#/components/schemas/microsoft.graph.changeTrackedEntity'
- title: shiftPreferences
type: object
properties:
availability:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.shiftAvailability'
description: Availability of the user to be scheduled for work and its recurrence pattern.
additionalProperties:
type: object
microsoft.graph.userStorage:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: userStorage
type: object
properties:
quota:
$ref: '#/components/schemas/microsoft.graph.unifiedStorageQuota'
additionalProperties:
type: object
microsoft.graph.windowsSetting:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: windowsSetting
type: object
properties:
payloadType:
type: string
description: The type of setting payloads contained in the instances navigation property.
nullable: true
settingType:
$ref: '#/components/schemas/microsoft.graph.windowsSettingType'
windowsDeviceId:
type: string
description: A unique identifier for the device the setting might belong to if it is of the settingType backup.
nullable: true
instances:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.windowsSettingInstance'
description: A collection of setting values for a given windowsSetting.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.workHoursAndLocationsSetting:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: workHoursAndLocationsSetting
type: object
properties:
maxSharedWorkLocationDetails:
$ref: '#/components/schemas/microsoft.graph.maxWorkLocationDetails'
occurrences:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.workPlanOccurrence'
description: Collection of work plan occurrences.
x-ms-navigationProperty: true
recurrences:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.workPlanRecurrence'
description: Collection of recurring work plans defined by the user.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.workingTimeSchedule:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: workingTimeSchedule
type: object
additionalProperties:
type: object
microsoft.graph.associatedTeamInfo:
allOf:
- $ref: '#/components/schemas/microsoft.graph.teamInfo'
- title: associatedTeamInfo
type: object
additionalProperties:
type: object
microsoft.graph.userScopeTeamsAppInstallation:
allOf:
- $ref: '#/components/schemas/microsoft.graph.teamsAppInstallation'
- title: userScopeTeamsAppInstallation
type: object
properties:
chat:
$ref: '#/components/schemas/microsoft.graph.chat'
additionalProperties:
type: object
microsoft.graph.todoTaskList:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: todoTaskList
type: object
properties:
displayName:
type: string
description: The name of the task list.
nullable: true
isOwner:
type: boolean
description: True if the user is owner of the given task list.
isShared:
type: boolean
description: True if the task list is shared with other users
wellknownListName:
$ref: '#/components/schemas/microsoft.graph.wellknownListName'
extensions:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.extension'
description: The collection of open extensions defined for the task list. Nullable.
x-ms-navigationProperty: true
tasks:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.todoTask'
description: The tasks in this task list. Read-only. Nullable.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.synchronizationScheduleState:
title: synchronizationScheduleState
enum:
- Active
- Disabled
- Paused
type: string
microsoft.graph.synchronizationStatusCode:
title: synchronizationStatusCode
enum:
- NotConfigured
- NotRun
- Active
- Paused
- Quarantine
type: string
microsoft.graph.synchronizationTaskExecution:
title: synchronizationTaskExecution
type: object
properties:
activityIdentifier:
type: string
description: Identifier of the job run.
nullable: true
countEntitled:
type: number
description: Count of processed entries that were assigned for this application.
format: int64
countEntitledForProvisioning:
type: number
description: Count of processed entries that were assigned for provisioning.
format: int64
countEscrowed:
type: number
description: Count of entries that were escrowed (errors).
format: int64
countEscrowedRaw:
type: number
description: 'Count of entries that were escrowed, including system-generated escrows.'
format: int64
countExported:
type: number
description: Count of exported entries.
format: int64
countExports:
type: number
description: Count of entries that were expected to be exported.
format: int64
countImported:
type: number
description: Count of imported entries.
format: int64
countImportedDeltas:
type: number
description: Count of imported delta-changes.
format: int64
countImportedReferenceDeltas:
type: number
description: Count of imported delta-changes pertaining to reference changes.
format: int64
error:
$ref: '#/components/schemas/microsoft.graph.synchronizationError'
state:
$ref: '#/components/schemas/microsoft.graph.synchronizationTaskExecutionResult'
timeBegan:
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: 'Time when this job run began. 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
timeEnded:
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: 'Time when this job run ended. 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
additionalProperties:
type: object
microsoft.graph.synchronizationProgress:
title: synchronizationProgress
type: object
properties:
completedUnits:
type: number
description: The numerator of a progress ratio; the number of units of changes already processed.
format: int64
progressObservationDateTime:
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 time of a progress observation as an offset in minutes from UTC.
format: date-time
totalUnits:
type: number
description: The denominator of a progress ratio; a number of units of changes to be processed to accomplish synchronization.
format: int64
units:
type: string
description: An optional description of the units.
nullable: true
additionalProperties:
type: object
microsoft.graph.synchronizationQuarantine:
title: synchronizationQuarantine
type: object
properties:
currentBegan:
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: 'Date and time when the quarantine was last evaluated and imposed. 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
error:
$ref: '#/components/schemas/microsoft.graph.synchronizationError'
nextAttempt:
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: 'Date and time when the next attempt to re-evaluate the quarantine will be made. 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
reason:
$ref: '#/components/schemas/microsoft.graph.quarantineReason'
seriesBegan:
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: 'Date and time when the quarantine was first imposed in this series (a series starts when a quarantine is first imposed, and is reset as soon as the quarantine is lifted). 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
seriesCount:
type: number
description: 'Number of times in this series the quarantine was re-evaluated and left in effect (a series starts when quarantine is first imposed, and is reset as soon as quarantine is lifted).'
format: int64
additionalProperties:
type: object
microsoft.graph.stringKeyLongValuePair:
title: stringKeyLongValuePair
type: object
properties:
key:
type: string
description: The mapping of the user type from the source system to the target system. For example:User to User - For Microsoft Entra ID to Microsoft Entra ID synchronization worker to user - For Workday to Microsoft Entra synchronization.
nullable: true
value:
type: number
description: Total number of synchronized objects.
format: int64
additionalProperties:
type: object
microsoft.graph.synchronizationLinkedObjects:
title: synchronizationLinkedObjects
type: object
properties:
manager:
$ref: '#/components/schemas/microsoft.graph.synchronizationJobSubject'
members:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.synchronizationJobSubject'
description: All group members that you would like to provision.
owners:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.synchronizationJobSubject'
additionalProperties:
type: object
microsoft.graph.containerFilter:
title: containerFilter
type: object
properties:
includedContainers:
type: array
items:
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.groupFilter:
title: groupFilter
type: object
properties:
includedGroups:
type: array
items:
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.objectMapping:
title: objectMapping
type: object
properties:
attributeMappings:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.attributeMapping'
description: Attribute mappings define which attributes to map from the source object into the target object and how they should flow. A number of functions are available to support the transformation of the original source values.
enabled:
type: boolean
description: 'When true, this object mapping will be processed during synchronization. When false, this object mapping will be skipped.'
flowTypes:
$ref: '#/components/schemas/microsoft.graph.objectFlowTypes'
metadata:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.objectMappingMetadataEntry'
description: 'Additional extension properties. Unless mentioned explicitly, metadata values should not be changed.'
name:
type: string
description: Human-friendly name of the object mapping.
nullable: true
scope:
$ref: '#/components/schemas/microsoft.graph.filter'
sourceObjectName:
type: string
description: Name of the object in the source directory. Must match the object name from the source directory definition.
nullable: true
targetObjectName:
type: string
description: Name of the object in target directory. Must match the object name from the target directory definition.
nullable: true
additionalProperties:
type: object
microsoft.graph.objectDefinitionMetadataEntry:
title: objectDefinitionMetadataEntry
type: object
properties:
key:
$ref: '#/components/schemas/microsoft.graph.objectDefinitionMetadata'
value:
type: string
description: Value of the metadata property.
nullable: true
additionalProperties:
type: object
microsoft.graph.attributeDefinitionMetadata:
title: attributeDefinitionMetadata
enum:
- BaseAttributeName
- ComplexObjectDefinition
- IsContainer
- IsCustomerDefined
- IsDomainQualified
- LinkPropertyNames
- LinkTypeName
- MaximumLength
- ReferencedProperty
type: string
microsoft.graph.publicErrorDetail:
title: publicErrorDetail
type: object
properties:
code:
type: string
description: The error code.
nullable: true
message:
type: string
description: The error message.
nullable: true
target:
type: string
description: The target of the error.
nullable: true
additionalProperties:
type: object
microsoft.graph.publicInnerError:
title: publicInnerError
type: object
properties:
code:
type: string
description: The error code.
nullable: true
details:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.publicErrorDetail'
description: A collection of error details.
message:
type: string
description: The error message.
nullable: true
target:
type: string
description: The target of the error.
nullable: true
additionalProperties:
type: object
microsoft.graph.stringKeyAttributeMappingSourceValuePair:
title: stringKeyAttributeMappingSourceValuePair
type: object
properties:
key:
type: string
description: The name of the parameter.
nullable: true
value:
$ref: '#/components/schemas/microsoft.graph.attributeMappingSource'
additionalProperties:
type: object
microsoft.graph.attributeMappingSourceType:
title: attributeMappingSourceType
enum:
- Attribute
- Constant
- Function
type: string
microsoft.graph.synchronizationMetadata:
title: synchronizationMetadata
enum:
- GalleryApplicationIdentifier
- GalleryApplicationKey
- IsOAuthEnabled
- IsSynchronizationAgentAssignmentRequired
- IsSynchronizationAgentRequired
- IsSynchronizationInPreview
- OAuthSettings
- SynchronizationLearnMoreIbizaFwLink
- ConfigurationFields
type: string
microsoft.graph.applicationSecurityCompliance:
title: applicationSecurityCompliance
type: object
properties:
cobit:
type: boolean
description: Indicates whether the application adheres to the Control Objectives for Information and Related Technologies (COBIT) framework.
nullable: true
coppa:
type: boolean
description: Indicates whether the application complies with the Children’s Online Privacy Protection Act (COPPA).
nullable: true
csaStar:
$ref: '#/components/schemas/microsoft.graph.csaStarLevel'
fedRamp:
$ref: '#/components/schemas/microsoft.graph.fedRampLevel'
ferpa:
type: boolean
description: Indicates whether the application complies with the Family Educational Rights and Privacy Act (FERPA).
nullable: true
ffiec:
type: boolean
description: Indicates whether the application meets Federal Financial Institutions Examination Council (FFIEC) requirements.
nullable: true
finra:
type: boolean
description: Indicates whether the application complies with Financial Industry Regulatory Authority (FINRA) standards.
nullable: true
fisma:
type: boolean
description: Indicates whether the application complies with the Federal Information Security Management Act (FISMA).
nullable: true
gaap:
type: boolean
description: Indicates whether the application provider adheres to Generally Accepted Accounting Principles (GAAP).
nullable: true
gapp:
type: boolean
description: Indicates whether the application adheres to Generally Accepted Privacy Principles (GAPP).
nullable: true
glba:
type: boolean
description: Indicates whether the application complies with the Gramm–Leach–Bliley Act (GLBA) for financial data protection.
nullable: true
hipaa:
type: boolean
description: Indicates whether the application complies with the Health Insurance Portability and Accountability Act (HIPAA).
nullable: true
hitrust:
type: boolean
description: 'Indicates whether the application holds HITRUST certification, demonstrating alignment with healthcare and data security standards.'
nullable: true
isae3402:
type: boolean
description: Indicates whether the application complies with International Standard on Assurance Engagements (ISAE) 3402 requirements.
nullable: true
iso27001:
type: boolean
description: Indicates whether the application is certified against ISO/IEC 27001 for information security management systems (ISMS).
nullable: true
iso27002:
type: boolean
description: Indicates whether the application follows ISO/IEC 27002 security control best practices.
nullable: true
iso27017:
type: boolean
description: Indicates whether the application complies with ISO/IEC 27017 standards for cloud security controls.
nullable: true
iso27018:
type: boolean
description: Indicates whether the application complies with ISO/IEC 27018 standards for protecting personally identifiable information (PII) in cloud environments.
nullable: true
itar:
type: boolean
description: Indicates whether the application complies with International Traffic in Arms Regulations (ITAR).
nullable: true
jerichoForumCommandments:
type: boolean
description: Indicates whether the application aligns with Jericho Forum security principles for deperimeterized environments.
nullable: true
pci:
$ref: '#/components/schemas/microsoft.graph.pciVersion'
privacyShield:
type: boolean
description: Indicates whether the application complies with the EU–U.S. Privacy Shield framework for cross-border data transfers.
nullable: true
safeHarbor:
type: boolean
description: Indicates whether the application previously adhered to the U.S.–EU Safe Harbor data transfer framework.
nullable: true
soc1:
type: boolean
description: Indicates whether the application provider undergoes a Service Organization Control (SOC) one audit report.
nullable: true
soc2:
type: boolean
description: Indicates whether the application provider undergoes a Service Organization Control (SOC) two audit report.
nullable: true
soc3:
type: boolean
description: Indicates whether the application provider undergoes a Service Organization Control (SOC) three audit report.
nullable: true
sox:
type: boolean
description: Indicates whether the application complies with the Sarbanes–Oxley Act (SOX) financial reporting requirements.
nullable: true
sp800_53:
type: boolean
description: Indicates whether the application aligns with National Institute of Standards and Technology (NIST) Special Publication 800-53 security and privacy controls.
nullable: true
ssae16:
type: boolean
description: Indicates whether the application adheres to Statement on Standards for Attestation Engagements (SSAE) No. 16.
nullable: true
ustr:
type: boolean
description: Indicates whether the application complies with U.S. Trade Representative (USTR) data and trade protection requirements.
nullable: true
additionalProperties:
type: object
microsoft.graph.applicationRiskFactorGeneralInfo:
title: applicationRiskFactorGeneralInfo
type: object
properties:
consumerPopularity:
maximum: 2147483647
minimum: -2147483648
type: number
description: Indicates the relative popularity or adoption of the application based on the user or tenant usage metrics.
format: int32
nullable: true
domainRegistrationDate:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$'
type: string
description: 'Specifies the date when the application''s primary domain was registered, used to assess domain maturity and legitimacy.'
format: date
nullable: true
founded:
maximum: 2147483647
minimum: -2147483648
type: number
description: Year the company or organization behind the application was founded.
format: int32
nullable: true
hasDisasterRecoveryPlan:
type: boolean
description: Indicates whether the application provider maintains a disaster recovery or business continuity plan.
nullable: true
hold:
$ref: '#/components/schemas/microsoft.graph.holdType'
hostingCompanyName:
type: string
description: Specifies the name of the company or provider that hosts the application's infrastructure.
nullable: true
location:
$ref: '#/components/schemas/microsoft.graph.applicationLocation'
privacyPolicy:
type: string
description: Specifies the URL of the application's privacy policy.
nullable: true
processedDataTypes:
$ref: '#/components/schemas/microsoft.graph.applicationDataType'
termsOfService:
type: string
description: Specifies the URL of the application's terms of service.
nullable: true
additionalProperties:
type: object
microsoft.graph.applicationRiskFactorLegalInfo:
title: applicationRiskFactorLegalInfo
type: object
properties:
dataRetention:
$ref: '#/components/schemas/microsoft.graph.dataRetentionLevel'
gdpr:
$ref: '#/components/schemas/microsoft.graph.applicationRiskFactorLegalInfoGdpr'
hasDataOwnership:
type: boolean
description: Indicates whether customers maintain ownership and control of their data processed or stored by the application.
nullable: true
hasDmca:
type: boolean
description: Indicates whether the application or organization complies with the Digital Millennium Copyright Act (DMCA) or equivalent copyright protection frameworks.
nullable: true
additionalProperties:
type: object
microsoft.graph.applicationRiskFactorSecurityInfo:
title: applicationRiskFactorSecurityInfo
type: object
properties:
certificate:
$ref: '#/components/schemas/microsoft.graph.applicationRiskFactorCertificateInfo'
domainToCheck:
type: string
description: Specifies the domain or hostname evaluated during the security assessment.
nullable: true
hasAdminAuditTrail:
type: boolean
description: Indicates whether the application maintains an audit trail for administrative actions.
nullable: true
hasAnonymousUsage:
type: boolean
description: Indicates whether the application allows anonymous or unauthenticated usage.
nullable: true
hasDataAuditTrail:
type: boolean
description: Indicates whether the application logs access or modification of customer data for audit purposes.
nullable: true
hasDataClassification:
type: boolean
description: Indicates whether the application classifies and labels data based on sensitivity levels.
nullable: true
hasDataEncrypted:
type: boolean
description: Indicates whether data at rest and in transit are encrypted using approved algorithms.
nullable: true
hasEnforceTransportEnc:
type: boolean
description: Indicates whether HTTPS or equivalent secure transport is enforced for all communication channels.
nullable: true
hasIpRestriction:
type: boolean
description: Indicates whether access to the application can be restricted based on IP address or network range.
nullable: true
hasMFA:
type: boolean
description: Indicates whether the application supports or enforces multi-factor authentication (MFA).
nullable: true
hasPenTest:
type: boolean
description: Indicates whether the application undergoes periodic penetration testing or external security reviews.
nullable: true
hasRememberPassword:
type: boolean
description: 'Indicates whether the application supports password-saving functionality, which may pose a security risk.'
nullable: true
hasSamlSupport:
type: boolean
description: Indicates whether the application supports SAML-based single sign-on (SSO).
nullable: true
hasUserAuditLogs:
type: boolean
description: Indicates whether user activity is logged for security or compliance monitoring.
nullable: true
hasUserDataUpload:
type: boolean
description: Indicates whether users can upload or store personal or organizational data within the application.
nullable: true
hasUserRolesSupport:
type: boolean
description: Indicates whether the application supports role-based access control (RBAC).
nullable: true
hasValidCertName:
type: boolean
description: Indicates whether the certificate’s common name matches the application’s verified domain.
nullable: true
httpsSecurityHeaders:
type: array
items:
type: string
description: 'Lists the HTTP security headers detected for the application (for example, HSTS, X-Frame-Options, or CSP).'
isCertTrusted:
type: boolean
description: Indicates whether the application’s certificate is signed by a trusted certificate authority (CA).
nullable: true
isDrownVulnerable:
type: boolean
description: Indicates whether the application is vulnerable to the DROWN (Decrypting RSA with Obsolete and Weakened eNcryption) attack.
nullable: true
isHeartbleedProof:
type: boolean
description: Indicates whether the application’s SSL implementation is protected from the Heartbleed vulnerability.
nullable: true
lastBreachDate:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$'
type: string
description: 'Specifies the date of the last publicly reported data breach or security incident related to the application, if known.'
format: date
nullable: true
latestValidSSL:
$ref: '#/components/schemas/microsoft.graph.sslVersion'
passwordPolicy:
$ref: '#/components/schemas/microsoft.graph.passwordPolicy'
restEncryptionType:
$ref: '#/components/schemas/microsoft.graph.restEncryptionType'
additionalProperties:
type: object
ReferenceNumeric:
enum:
- '-INF'
- INF
- NaN
type: string
nullable: true
microsoft.graph.appManagementConfiguration:
title: appManagementConfiguration
type: object
properties:
keyCredentials:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.keyCredentialConfiguration'
description: Collection of keyCredential restrictions settings to be applied to an application or service principal.
passwordCredentials:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.passwordCredentialConfiguration'
description: Collection of password restrictions settings to be applied to an application or service principal.
additionalProperties:
type: object
microsoft.graph.customAppManagementApplicationConfiguration:
title: customAppManagementApplicationConfiguration
type: object
properties:
identifierUris:
$ref: '#/components/schemas/microsoft.graph.identifierUriConfiguration'
additionalProperties:
type: object
microsoft.graph.settingValue:
title: settingValue
type: object
properties:
name:
type: string
description: Name of the setting (as defined by the groupSettingTemplate).
nullable: true
value:
type: string
description: Value of the setting.
nullable: true
additionalProperties:
type: object
microsoft.graph.post:
allOf:
- $ref: '#/components/schemas/microsoft.graph.outlookItem'
- title: post
type: object
properties:
body:
$ref: '#/components/schemas/microsoft.graph.itemBody'
conversationId:
type: string
description: Unique ID of the conversation. Read-only.
nullable: true
conversationThreadId:
type: string
description: Unique ID of the conversation thread. Read-only.
nullable: true
from:
$ref: '#/components/schemas/microsoft.graph.recipient'
hasAttachments:
type: boolean
description: Indicates whether the post has at least one attachment. This is a default property.
newParticipants:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.recipient'
description: Conversation participants that were added to the thread as part of this post.
receivedDateTime:
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: 'Specifies when the post was received. The DateTimeOffset 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
sender:
$ref: '#/components/schemas/microsoft.graph.recipient'
attachments:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.attachment'
description: Read-only. Nullable. Supports $expand.
x-ms-navigationProperty: true
extensions:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.extension'
description: The collection of open extensions defined for the post. Read-only. Nullable. Supports $expand.
x-ms-navigationProperty: true
inReplyTo:
$ref: '#/components/schemas/microsoft.graph.post'
multiValueExtendedProperties:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.multiValueLegacyExtendedProperty'
description: The collection of multi-value extended properties defined for the post. Read-only. Nullable.
x-ms-navigationProperty: true
singleValueExtendedProperties:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.singleValueLegacyExtendedProperty'
description: The collection of single-value extended properties defined for the post. Read-only. Nullable.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.ODataErrors.MainError:
required:
- code
- message
type: object
properties:
code:
type: string
message:
type: string
x-ms-primary-error-message: true
target:
type: string
nullable: true
details:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.ODataErrors.ErrorDetails'
innerError:
$ref: '#/components/schemas/microsoft.graph.ODataErrors.InnerError'
additionalProperties:
type: object
microsoft.graph.externalAudienceScope:
title: externalAudienceScope
enum:
- none
- contactsOnly
- all
type: string
microsoft.graph.automaticRepliesStatus:
title: automaticRepliesStatus
enum:
- disabled
- alwaysEnabled
- scheduled
type: string
microsoft.graph.dayOfWeek:
title: dayOfWeek
enum:
- sunday
- monday
- tuesday
- wednesday
- thursday
- friday
- saturday
type: string
microsoft.graph.timeZoneBase:
title: timeZoneBase
type: object
properties:
name:
type: string
description: 'The name of a time zone. It can be a standard time zone name such as ''Hawaii-Aleutian Standard Time'', or ''Customized Time Zone'' for a custom time zone.'
nullable: true
additionalProperties:
type: object
microsoft.graph.printerBase:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: printerBase
type: object
properties:
capabilities:
$ref: '#/components/schemas/microsoft.graph.printerCapabilities'
defaults:
$ref: '#/components/schemas/microsoft.graph.printerDefaults'
displayName:
type: string
description: The name of the printer/printerShare.
isAcceptingJobs:
type: boolean
description: Specifies whether the printer/printerShare is currently accepting new print jobs.
nullable: true
location:
$ref: '#/components/schemas/microsoft.graph.printerLocation'
manufacturer:
type: string
description: The manufacturer of the printer/printerShare.
nullable: true
model:
type: string
description: The model name of the printer/printerShare.
nullable: true
status:
$ref: '#/components/schemas/microsoft.graph.printerStatus'
jobs:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.printJob'
description: The list of jobs that are queued for printing by the printer/printerShare.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.printerShareViewpoint:
title: printerShareViewpoint
type: object
properties:
lastUsedDateTime:
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: 'Date and time when the printer was last used by the signed-in user. 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
additionalProperties:
type: object
microsoft.graph.printer:
allOf:
- $ref: '#/components/schemas/microsoft.graph.printerBase'
- title: printer
type: object
properties:
hasPhysicalDevice:
type: boolean
description: True if the printer has a physical device for printing. Read-only.
isShared:
type: boolean
description: True if the printer is shared; false otherwise. Read-only.
lastSeenDateTime:
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 most recent dateTimeOffset when a printer interacted with Universal Print. Read-only.
format: date-time
nullable: true
registeredDateTime:
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 DateTimeOffset when the printer was registered. Read-only.
format: date-time
connectors:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.printConnector'
description: The connectors that are associated with the printer.
x-ms-navigationProperty: true
shares:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.printerShare'
description: 'The list of printerShares that are associated with the printer. Currently, only one printerShare can be associated with the printer. Read-only. Nullable.'
x-ms-navigationProperty: true
taskTriggers:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.printTaskTrigger'
description: A list of task triggers that are associated with the printer.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.imageInfo:
title: imageInfo
type: object
properties:
addImageQuery:
type: boolean
description: Optional; parameter used to indicate the server is able to render image dynamically in response to parameterization. For example – a high contrast image
nullable: true
alternateText:
type: string
description: Optional; alt-text accessible content for the image
nullable: true
alternativeText:
type: string
nullable: true
iconUrl:
type: string
description: Optional; URI that points to an icon which represents the application used to generate the activity
nullable: true
additionalProperties:
type: object
microsoft.graph.attestationLevel:
title: attestationLevel
enum:
- attested
- notAttested
- unknownFutureValue
type: string
microsoft.graph.passkeyType:
title: passkeyType
enum:
- deviceBound
- synced
- unknownFutureValue
type: string
microsoft.graph.webauthnPublicKeyCredential:
title: webauthnPublicKeyCredential
type: object
properties:
clientExtensionResults:
$ref: '#/components/schemas/microsoft.graph.webauthnAuthenticationExtensionsClientOutputs'
id:
type: string
description: The credential ID created by the WebAuthn Authenticator. This value is Base64URL-encoded without padding.
nullable: true
response:
$ref: '#/components/schemas/microsoft.graph.webauthnAuthenticatorAttestationResponse'
additionalProperties:
type: object
microsoft.graph.device:
allOf:
- $ref: '#/components/schemas/microsoft.graph.directoryObject'
- title: device
type: object
properties:
accountEnabled:
type: boolean
description: 'true if the account is enabled; otherwise, false. Required. Default is true. Supports $filter (eq, ne, not, in). Only callers with at least the Cloud Device Administrator role can set this property.'
nullable: true
alternativeSecurityIds:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.alternativeSecurityId'
description: 'For internal use only. Not nullable. Supports $filter (eq, not, ge, le).'
approximateLastSignInDateTime:
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. Read-only. Supports $filter (eq, ne, not, ge, le, and eq on null values) and $orderby.'
format: date-time
nullable: true
complianceExpirationDateTime:
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 when the device is no longer deemed compliant. 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. Read-only.'
format: date-time
nullable: true
deviceCategory:
type: string
description: User-defined property set by Intune to automatically add devices to groups and simplify managing devices.
nullable: true
deviceId:
type: string
description: 'Unique identifier set by Azure Device Registration Service at the time of registration. This alternate key can be used to reference the device object. Supports $filter (eq, ne, not, startsWith).'
nullable: true
deviceMetadata:
type: string
description: For internal use only. Set to null.
nullable: true
deviceOwnership:
type: string
description: 'Ownership of the device. Intune sets this property. The possible values are: unknown, company, personal.'
nullable: true
deviceVersion:
maximum: 2147483647
minimum: -2147483648
type: number
description: For internal use only.
format: int32
nullable: true
displayName:
type: string
description: 'The display name for the device. Maximum length is 256 characters. Required. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values), $search, and $orderby.'
nullable: true
enrollmentProfileName:
type: string
description: 'Enrollment profile applied to the device. For example, Apple Device Enrollment Profile, Device enrollment - Corporate device identifiers, or Windows Autopilot profile name. This property is set by Intune.'
nullable: true
enrollmentType:
type: string
description: 'Enrollment type of the device. Intune sets this property. The possible values are: unknown, userEnrollment, deviceEnrollmentManager, appleBulkWithUser, appleBulkWithoutUser, windowsAzureADJoin, windowsBulkUserless, windowsAutoEnrollment, windowsBulkAzureDomainJoin, windowsCoManagement, windowsAzureADJoinUsingDeviceAuth,appleUserEnrollment, appleUserEnrollmentWithServiceAccount. NOTE: This property might return other values apart from those listed.'
nullable: true
isCompliant:
type: boolean
description: 'true if the device complies with Mobile Device Management (MDM) policies; otherwise, false. Read-only. This can only be updated by Intune for any device OS type or by an approved MDM app for Windows OS devices. Supports $filter (eq, ne, not).'
nullable: true
isManaged:
type: boolean
description: 'true if the device is managed by a Mobile Device Management (MDM) app; otherwise, false. This can only be updated by Intune for any device OS type or by an approved MDM app for Windows OS devices. Supports $filter (eq, ne, not).'
nullable: true
isManagementRestricted:
type: boolean
description: 'Indicates whether the device is a member of a restricted management administrative unit. If not set, the default value is null and the default behavior is false. Read-only. To manage a device that''s a member of a restricted management administrative unit, the administrator or calling app must be assigned a Microsoft Entra role at the scope of the restricted management administrative unit. Requires $select to retrieve.'
nullable: true
isRooted:
type: boolean
description: true if the device is rooted or jail-broken. This property can only be updated by Intune.
nullable: true
managementType:
type: string
description: 'The management channel of the device. This property is set by Intune. The possible values are: eas, mdm, easMdm, intuneClient, easIntuneClient, configurationManagerClient, configurationManagerClientMdm, configurationManagerClientMdmEas, unknown, jamf, googleCloudDevicePolicyController.'
nullable: true
manufacturer:
type: string
description: Manufacturer of the device. Read-only.
nullable: true
mdmAppId:
type: string
description: 'Application identifier used to register device into MDM. Read-only. Supports $filter (eq, ne, not, startsWith).'
nullable: true
model:
type: string
description: Model of the device. Read-only.
nullable: true
onPremisesLastSyncDateTime:
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 last time at which the object was synced with the on-premises directory. 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 Read-only. Supports $filter (eq, ne, not, ge, le, in).'
format: date-time
nullable: true
onPremisesSecurityIdentifier:
type: string
description: The on-premises security identifier (SID) for the user who was synchronized from on-premises to the cloud. Read-only. Requires $select to retrieve. Supports $filter (eq).
nullable: true
onPremisesSyncEnabled:
type: boolean
description: 'true if this object is synced from an on-premises directory; false if this object was originally synced from an on-premises directory but is no longer synced; null if this object has never been synced from an on-premises directory (default). Read-only. Supports $filter (eq, ne, not, in, and eq on null values).'
nullable: true
operatingSystem:
type: string
description: 'The type of operating system on the device. Required. Supports $filter (eq, ne, not, ge, le, startsWith, and eq on null values).'
nullable: true
operatingSystemVersion:
type: string
description: 'The version of the operating system on the device. Required. Supports $filter (eq, ne, not, ge, le, startsWith, and eq on null values).'
nullable: true
physicalIds:
type: array
items:
type: string
description: 'For internal use only. Not nullable. Supports $filter (eq, not, ge, le, startsWith,/$count eq 0, /$count ne 0).'
profileType:
type: string
description: 'The profile type of the device. Possible values: RegisteredDevice (default), SecureVM, Printer, Shared, IoT.'
nullable: true
registrationDateTime:
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: 'Date and time of when the device was registered. 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. Read-only.'
format: date-time
nullable: true
systemLabels:
type: array
items:
type: string
description: 'List of labels applied to the device by the system. Supports $filter (/$count eq 0, /$count ne 0).'
trustType:
type: string
description: 'Type of trust for the joined device. Read-only. Possible values: Workplace (indicates bring your own personal devices), AzureAd (Cloud-only joined devices), ServerAd (on-premises domain joined devices joined to Microsoft Entra ID). For more information, see Introduction to device management in Microsoft Entra ID. Supports $filter (eq, ne, not, in).'
nullable: true
extensions:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.extension'
description: The collection of open extensions defined for the device. Read-only. Nullable.
x-ms-navigationProperty: true
memberOf:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
description: Groups and administrative units that this device is a member of. Read-only. Nullable. Supports $expand.
x-ms-navigationProperty: true
registeredOwners:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
description: The user that cloud joined the device or registered their personal device. The registered owner is set at the time of registration. Read-only. Nullable. Supports $expand.
x-ms-navigationProperty: true
registeredUsers:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
description: 'Collection of registered users of the device. For cloud joined devices and registered personal devices, registered users are set to the same value as registered owners at the time of registration. Read-only. Nullable. Supports $expand.'
x-ms-navigationProperty: true
transitiveMemberOf:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
description: Groups and administrative units that the device is a member of. This operation is transitive. Supports $expand.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.longRunningOperationStatus:
title: longRunningOperationStatus
enum:
- notStarted
- running
- succeeded
- failed
- unknownFutureValue
type: string
microsoft.graph.authenticationPhoneType:
title: authenticationPhoneType
enum:
- mobile
- alternateMobile
- office
- unknownFutureValue
type: string
microsoft.graph.authenticationMethodSignInState:
title: authenticationMethodSignInState
enum:
- notSupported
- notAllowedByPolicy
- notEnabled
- phoneNumberNotUnique
- ready
- notConfigured
- unknownFutureValue
type: string
microsoft.graph.authenticationMethodKeyStrength:
title: authenticationMethodKeyStrength
enum:
- normal
- weak
- unknown
type: string
microsoft.graph.authenticationMethodPlatform:
title: authenticationMethodPlatform
enum:
- unknown
- windows
- macOS
- iOS
- android
- linux
- unknownFutureValue
type: string
microsoft.graph.calendarRoleType:
title: calendarRoleType
enum:
- none
- freeBusyRead
- limitedRead
- read
- write
- delegateWithoutPrivateEventAccess
- delegateWithPrivateEventAccess
- custom
type: string
microsoft.graph.attendeeBase:
allOf:
- $ref: '#/components/schemas/microsoft.graph.recipient'
- title: attendeeBase
type: object
properties:
type:
$ref: '#/components/schemas/microsoft.graph.attendeeType'
additionalProperties:
type: object
microsoft.graph.timeSlot:
title: timeSlot
type: object
properties:
end:
$ref: '#/components/schemas/microsoft.graph.dateTimeTimeZone'
start:
$ref: '#/components/schemas/microsoft.graph.dateTimeTimeZone'
additionalProperties:
type: object
microsoft.graph.bodyType:
title: bodyType
enum:
- text
- html
type: string
microsoft.graph.outlookGeoCoordinates:
title: outlookGeoCoordinates
type: object
properties:
accuracy:
type: number
description: 'The accuracy of the latitude and longitude. As an example, the accuracy can be measured in meters, such as the latitude and longitude are accurate to within 50 meters.'
format: double
nullable: true
altitude:
type: number
description: The altitude of the location.
format: double
nullable: true
altitudeAccuracy:
type: number
description: The accuracy of the altitude.
format: double
nullable: true
latitude:
type: number
description: The latitude of the location.
format: double
nullable: true
longitude:
type: number
description: The longitude of the location.
format: double
nullable: true
additionalProperties:
type: object
microsoft.graph.locationType:
title: locationType
enum:
- default
- conferenceRoom
- homeAddress
- businessAddress
- geoCoordinates
- streetAddress
- hotel
- restaurant
- localBusiness
- postalAddress
type: string
microsoft.graph.locationUniqueIdType:
title: locationUniqueIdType
enum:
- unknown
- locationStore
- directory
- private
- bing
type: string
microsoft.graph.recurrencePattern:
title: recurrencePattern
type: object
properties:
dayOfMonth:
maximum: 2147483647
minimum: -2147483648
type: number
description: The day of the month on which the event occurs. Required if type is absoluteMonthly or absoluteYearly.
format: int32
daysOfWeek:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.dayOfWeek'
description: 'A collection of the days of the week on which the event occurs. The possible values are: sunday, monday, tuesday, wednesday, thursday, friday, saturday. If type is relativeMonthly or relativeYearly, and daysOfWeek specifies more than one day, the event falls on the first day that satisfies the pattern. Required if type is weekly, relativeMonthly, or relativeYearly.'
firstDayOfWeek:
$ref: '#/components/schemas/microsoft.graph.dayOfWeek'
index:
$ref: '#/components/schemas/microsoft.graph.weekIndex'
interval:
maximum: 2147483647
minimum: -2147483648
type: number
description: 'The number of units between occurrences, where units can be in days, weeks, months, or years, depending on the type. Required.'
format: int32
month:
maximum: 2147483647
minimum: -2147483648
type: number
description: The month in which the event occurs. This is a number from 1 to 12.
format: int32
type:
$ref: '#/components/schemas/microsoft.graph.recurrencePatternType'
additionalProperties:
type: object
microsoft.graph.recurrenceRange:
title: recurrenceRange
type: object
properties:
endDate:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$'
type: string
description: 'The date to stop applying the recurrence pattern. Depending on the recurrence pattern of the event, the last occurrence of the meeting may not be this date. Required if type is endDate.'
format: date
nullable: true
numberOfOccurrences:
maximum: 2147483647
minimum: -2147483648
type: number
description: The number of times to repeat the event. Required and must be positive if type is numbered.
format: int32
recurrenceTimeZone:
type: string
description: 'Time zone for the startDate and endDate properties. Optional. If not specified, the time zone of the event is used.'
nullable: true
startDate:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$'
type: string
description: 'The date to start applying the recurrence pattern. The first occurrence of the meeting may be this date or later, depending on the recurrence pattern of the event. Must be the same value as the start property of the recurring event. Required.'
format: date
nullable: true
type:
$ref: '#/components/schemas/microsoft.graph.recurrenceRangeType'
additionalProperties:
type: object
microsoft.graph.responseType:
title: responseType
enum:
- none
- organizer
- tentativelyAccepted
- accepted
- declined
- notResponded
type: string
microsoft.graph.teamworkUserIdentity:
allOf:
- $ref: '#/components/schemas/microsoft.graph.identity'
- title: teamworkUserIdentity
type: object
properties:
userIdentityType:
$ref: '#/components/schemas/microsoft.graph.teamworkUserIdentityType'
additionalProperties:
type: object
microsoft.graph.teamsAppPermissionSet:
title: teamsAppPermissionSet
type: object
properties:
resourceSpecificPermissions:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.teamsAppResourceSpecificPermission'
description: A collection of resource-specific permissions.
additionalProperties:
type: object
microsoft.graph.teamsApp:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: teamsApp
type: object
properties:
displayName:
type: string
description: The name of the catalog app provided by the app developer in the Microsoft Teams zip app package.
nullable: true
distributionMethod:
$ref: '#/components/schemas/microsoft.graph.teamsAppDistributionMethod'
externalId:
type: string
description: The ID of the catalog provided by the app developer in the Microsoft Teams zip app package.
nullable: true
appDefinitions:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.teamsAppDefinition'
description: The details for each version of the app.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.teamsAppDefinition:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: teamsAppDefinition
type: object
properties:
authorization:
$ref: '#/components/schemas/microsoft.graph.teamsAppAuthorization'
createdBy:
$ref: '#/components/schemas/microsoft.graph.identitySet'
description:
type: string
description: Verbose description of the application.
nullable: true
displayName:
type: string
description: The name of the app provided by the app developer.
nullable: true
lastModifiedDateTime:
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
format: date-time
nullable: true
publishingState:
$ref: '#/components/schemas/microsoft.graph.teamsAppPublishingState'
shortDescription:
type: string
description: Short description of the application.
nullable: true
teamsAppId:
type: string
description: The ID from the Teams app manifest.
nullable: true
version:
type: string
description: The version number of the application.
nullable: true
bot:
$ref: '#/components/schemas/microsoft.graph.teamworkBot'
additionalProperties:
type: object
microsoft.graph.eventMessageDetail:
title: eventMessageDetail
type: object
additionalProperties:
type: object
microsoft.graph.chatMessageFromIdentitySet:
allOf:
- $ref: '#/components/schemas/microsoft.graph.identitySet'
- title: chatMessageFromIdentitySet
type: object
additionalProperties:
type: object
microsoft.graph.chatMessageType:
title: chatMessageType
enum:
- message
- chatEvent
- typing
- unknownFutureValue
- systemEventMessage
type: string
microsoft.graph.chatMessageAttachment:
title: chatMessageAttachment
type: object
properties:
content:
type: string
description: 'The content of the attachment. If the attachment is a rich card, set the property to the rich card object. This property and contentUrl are mutually exclusive.'
nullable: true
contentType:
type: string
description: 'The media type of the content attachment. The possible values are: reference: The attachment is a link to another file. Populate the contentURL with the link to the object.forwardedMessageReference: The attachment is a reference to a forwarded message. Populate the content with the original message context.Any contentType that is supported by the Bot Framework''s Attachment object.application/vnd.microsoft.card.codesnippet: A code snippet. application/vnd.microsoft.card.announcement: An announcement header.'
nullable: true
contentUrl:
type: string
description: The URL for the content of the attachment.
nullable: true
id:
type: string
description: Read-only. The unique ID of the attachment.
nullable: true
name:
type: string
description: The name of the attachment.
nullable: true
teamsAppId:
type: string
description: The ID of the Teams app that is associated with the attachment. The property is used to attribute a Teams message card to the specified app.
nullable: true
thumbnailUrl:
type: string
description: 'The URL to a thumbnail image that the channel can use if it supports using an alternative, smaller form of content or contentUrl. For example, if you set contentType to application/word and set contentUrl to the location of the Word document, you might include a thumbnail image that represents the document. The channel could display the thumbnail image instead of the document. When the user selects the image, the channel would open the document.'
nullable: true
additionalProperties:
type: object
microsoft.graph.channelIdentity:
title: channelIdentity
type: object
properties:
channelId:
type: string
description: The identity of the channel in which the message was posted.
nullable: true
teamId:
type: string
description: The identity of the team in which the message was posted.
nullable: true
additionalProperties:
type: object
microsoft.graph.chatMessageImportance:
title: chatMessageImportance
enum:
- normal
- high
- urgent
- unknownFutureValue
type: string
microsoft.graph.chatMessageMention:
title: chatMessageMention
type: object
properties:
id:
maximum: 2147483647
minimum: -2147483648
type: number
description: 'Index of an entity being mentioned in the specified chatMessage. Matches the {index} value in the corresponding tag in the message body.'
format: int32
nullable: true
mentioned:
$ref: '#/components/schemas/microsoft.graph.chatMessageMentionedIdentitySet'
mentionText:
type: string
description: 'String used to represent the mention. For example, a user''s display name, a team name.'
nullable: true
additionalProperties:
type: object
microsoft.graph.chatMessageHistoryItem:
title: chatMessageHistoryItem
type: object
properties:
actions:
$ref: '#/components/schemas/microsoft.graph.chatMessageActions'
modifiedDateTime:
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 message was modified.
format: date-time
reaction:
$ref: '#/components/schemas/microsoft.graph.chatMessageReaction'
additionalProperties:
type: object
microsoft.graph.chatMessagePolicyViolation:
title: chatMessagePolicyViolation
type: object
properties:
dlpAction:
$ref: '#/components/schemas/microsoft.graph.chatMessagePolicyViolationDlpActionTypes'
justificationText:
type: string
description: Justification text provided by the sender of the message when overriding a policy violation.
nullable: true
policyTip:
$ref: '#/components/schemas/microsoft.graph.chatMessagePolicyViolationPolicyTip'
userAction:
$ref: '#/components/schemas/microsoft.graph.chatMessagePolicyViolationUserActionTypes'
verdictDetails:
$ref: '#/components/schemas/microsoft.graph.chatMessagePolicyViolationVerdictDetailsTypes'
additionalProperties:
type: object
microsoft.graph.chatMessageReaction:
title: chatMessageReaction
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. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.'
format: date-time
displayName:
type: string
description: The name of the reaction.
nullable: true
reactionContentUrl:
type: string
description: The hosted content URL for the custom reaction type.
nullable: true
reactionType:
type: string
description: 'The reaction type. Supported values include Unicode characters, custom, and some backward-compatible reaction types, such as like, angry, sad, laugh, heart, and surprised.'
user:
$ref: '#/components/schemas/microsoft.graph.chatMessageReactionIdentitySet'
additionalProperties:
type: object
microsoft.graph.chatMessageHostedContent:
allOf:
- $ref: '#/components/schemas/microsoft.graph.teamworkHostedContent'
- title: chatMessageHostedContent
type: object
additionalProperties:
type: object
microsoft.graph.teamsTabConfiguration:
title: teamsTabConfiguration
type: object
properties:
contentUrl:
type: string
description: Url used for rendering tab contents in Teams. Required.
nullable: true
entityId:
type: string
description: Identifier for the entity hosted by the tab provider.
nullable: true
removeUrl:
type: string
description: Url called by Teams client when a Tab is removed using the Teams Client.
nullable: true
websiteUrl:
type: string
description: Url for showing tab contents outside of Teams.
nullable: true
additionalProperties:
type: object
microsoft.graph.cloudClipboardItemPayload:
title: cloudClipboardItemPayload
type: object
properties:
content:
type: string
description: The formatName version of the value of a cloud clipboard encoded in base64.
formatName:
type: string
description: For a list of possible values see formatName values.
additionalProperties:
type: object
microsoft.graph.sensitivityLabel:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: sensitivityLabel
type: object
properties:
actionSource:
$ref: '#/components/schemas/microsoft.graph.labelActionSource'
autoTooltip:
type: string
nullable: true
description:
type: string
nullable: true
displayName:
type: string
nullable: true
hasProtection:
type: boolean
nullable: true
isDefault:
type: boolean
nullable: true
isEndpointProtectionEnabled:
type: boolean
nullable: true
isScopedToUser:
type: boolean
nullable: true
locale:
type: string
nullable: true
name:
type: string
nullable: true
priority:
maximum: 2147483647
minimum: -2147483648
type: number
format: int32
nullable: true
toolTip:
type: string
nullable: true
rights:
$ref: '#/components/schemas/microsoft.graph.usageRightsIncluded'
sublabels:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.sensitivityLabel'
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.contentActivity:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: contentActivity
type: object
properties:
contentMetadata:
$ref: '#/components/schemas/microsoft.graph.processContentRequest'
scopeIdentifier:
type: string
description: The scope identified from computed protection scopes.
nullable: true
userId:
type: string
description: ID of the user.
nullable: true
additionalProperties:
type: object
microsoft.graph.itemReference:
title: itemReference
type: object
properties:
driveId:
type: string
description: Unique identifier of the drive instance that contains the driveItem. Only returned if the item is located in a drive. Read-only.
nullable: true
driveType:
type: string
description: Identifies the type of drive. Only returned if the item is located in a drive. See drive resource for values.
nullable: true
id:
type: string
description: Unique identifier of the driveItem in the drive or a listItem in a list. Read-only.
nullable: true
name:
type: string
description: The name of the item being referenced. Read-only.
nullable: true
path:
type: string
description: Percent-encoded path that can be used to navigate to the item. Read-only.
nullable: true
shareId:
type: string
description: A unique identifier for a shared resource that can be accessed via the Shares API.
nullable: true
sharepointIds:
$ref: '#/components/schemas/microsoft.graph.sharepointIds'
siteId:
type: string
description: 'For OneDrive for Business and SharePoint, this property represents the ID of the site that contains the parent document library of the driveItem resource or the parent list of the listItem resource. The value is the same as the id property of that site resource. It is an opaque string that consists of three identifiers of the site. For OneDrive, this property is not populated.'
nullable: true
additionalProperties:
type: object
microsoft.graph.storagePlanInformation:
title: storagePlanInformation
type: object
properties:
upgradeAvailable:
type: boolean
description: Indicates whether there are higher storage quota plans available. Read-only.
nullable: true
additionalProperties:
type: object
microsoft.graph.audio:
title: audio
type: object
properties:
album:
type: string
description: The title of the album for this audio file.
nullable: true
albumArtist:
type: string
description: The artist named on the album for the audio file.
nullable: true
artist:
type: string
description: The performing artist for the audio file.
nullable: true
bitrate:
type: number
description: Bitrate expressed in kbps.
format: int64
nullable: true
composers:
type: string
description: The name of the composer of the audio file.
nullable: true
copyright:
type: string
description: Copyright information for the audio file.
nullable: true
disc:
maximum: 32767
minimum: -32768
type: number
description: The number of the disc this audio file came from.
format: int16
nullable: true
discCount:
maximum: 32767
minimum: -32768
type: number
description: The total number of discs in this album.
format: int16
nullable: true
duration:
type: number
description: 'Duration of the audio file, expressed in milliseconds'
format: int64
nullable: true
genre:
type: string
description: The genre of this audio file.
nullable: true
hasDrm:
type: boolean
description: Indicates if the file is protected with digital rights management.
nullable: true
isVariableBitrate:
type: boolean
description: Indicates if the file is encoded with a variable bitrate.
nullable: true
title:
type: string
description: The title of the audio file.
nullable: true
track:
maximum: 2147483647
minimum: -2147483648
type: number
description: The number of the track on the original disc for this audio file.
format: int32
nullable: true
trackCount:
maximum: 2147483647
minimum: -2147483648
type: number
description: The total number of tracks on the original disc for this audio file.
format: int32
nullable: true
year:
maximum: 2147483647
minimum: -2147483648
type: number
description: The year the audio file was recorded.
format: int32
nullable: true
additionalProperties:
type: object
microsoft.graph.bundle:
title: bundle
type: object
properties:
album:
$ref: '#/components/schemas/microsoft.graph.album'
childCount:
maximum: 2147483647
minimum: -2147483648
type: number
description: Number of children contained immediately within this container.
format: int32
nullable: true
additionalProperties:
type: object
microsoft.graph.deleted:
title: deleted
type: object
properties:
state:
type: string
description: Represents the state of the deleted item.
nullable: true
additionalProperties:
type: object
microsoft.graph.file:
title: file
type: object
properties:
hashes:
$ref: '#/components/schemas/microsoft.graph.hashes'
mimeType:
type: string
description: The MIME type for the file. This is determined by logic on the server and might not be the value provided when the file was uploaded. Read-only.
nullable: true
processingMetadata:
type: boolean
nullable: true
additionalProperties:
type: object
microsoft.graph.fileSystemInfo:
title: fileSystemInfo
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 UTC date and time the file was created on a client.
format: date-time
nullable: true
lastAccessedDateTime:
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 UTC date and time the file was last accessed. Available for the recent file list only.
format: date-time
nullable: true
lastModifiedDateTime:
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 UTC date and time the file was last modified on a client.
format: date-time
nullable: true
additionalProperties:
type: object
microsoft.graph.folder:
title: folder
type: object
properties:
childCount:
maximum: 2147483647
minimum: -2147483648
type: number
description: Number of children contained immediately within this container.
format: int32
nullable: true
view:
$ref: '#/components/schemas/microsoft.graph.folderView'
additionalProperties:
type: object
microsoft.graph.image:
title: image
type: object
properties:
height:
maximum: 2147483647
minimum: -2147483648
type: number
description: 'Optional. Height of the image, in pixels. Read-only.'
format: int32
nullable: true
width:
maximum: 2147483647
minimum: -2147483648
type: number
description: 'Optional. Width of the image, in pixels. Read-only.'
format: int32
nullable: true
additionalProperties:
type: object
microsoft.graph.geoCoordinates:
title: geoCoordinates
type: object
properties:
altitude:
type: number
description: 'Optional. The altitude (height), in feet, above sea level for the item. Read-only.'
format: double
nullable: true
latitude:
type: number
description: 'Optional. The latitude, in decimal, for the item. Read-only.'
format: double
nullable: true
longitude:
type: number
description: 'Optional. The longitude, in decimal, for the item. Read-only.'
format: double
nullable: true
additionalProperties:
type: object
microsoft.graph.malware:
title: malware
type: object
properties:
description:
type: string
description: Contains the virus details for the malware facet.
nullable: true
additionalProperties:
type: object
microsoft.graph.package:
title: package
type: object
properties:
type:
type: string
description: 'A string indicating the type of package. While oneNote is the only currently defined value, you should expect other package types to be returned and handle them accordingly.'
nullable: true
additionalProperties:
type: object
microsoft.graph.pendingOperations:
title: pendingOperations
type: object
properties:
pendingContentUpdate:
$ref: '#/components/schemas/microsoft.graph.pendingContentUpdate'
additionalProperties:
type: object
microsoft.graph.photo:
title: photo
type: object
properties:
cameraMake:
type: string
description: Camera manufacturer. Read-only.
nullable: true
cameraModel:
type: string
description: Camera model. Read-only.
nullable: true
exposureDenominator:
type: number
description: The denominator for the exposure time fraction from the camera. Read-only.
format: double
nullable: true
exposureNumerator:
type: number
description: The numerator for the exposure time fraction from the camera. Read-only.
format: double
nullable: true
fNumber:
type: number
description: The F-stop value from the camera. Read-only.
format: double
nullable: true
focalLength:
type: number
description: The focal length from the camera. Read-only.
format: double
nullable: true
iso:
maximum: 2147483647
minimum: -2147483648
type: number
description: The ISO value from the camera. Read-only.
format: int32
nullable: true
orientation:
maximum: 32767
minimum: -32768
type: number
description: The orientation value from the camera. Writable on OneDrive Personal.
format: int16
nullable: true
takenDateTime:
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: Represents the date and time the photo was taken. Read-only.
format: date-time
nullable: true
additionalProperties:
type: object
microsoft.graph.publicationFacet:
title: publicationFacet
type: object
properties:
checkedOutBy:
$ref: '#/components/schemas/microsoft.graph.identitySet'
level:
type: string
description: The state of publication for this document. Either published or checkout. Read-only.
nullable: true
versionId:
type: string
description: The unique identifier for the version that is visible to the current caller. Read-only.
nullable: true
additionalProperties:
type: object
microsoft.graph.remoteItem:
title: remoteItem
type: object
properties:
createdBy:
$ref: '#/components/schemas/microsoft.graph.identitySet'
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: Date and time of item creation. Read-only.
format: date-time
nullable: true
file:
$ref: '#/components/schemas/microsoft.graph.file'
fileSystemInfo:
$ref: '#/components/schemas/microsoft.graph.fileSystemInfo'
folder:
$ref: '#/components/schemas/microsoft.graph.folder'
id:
type: string
description: Unique identifier for the remote item in its drive. Read-only.
nullable: true
image:
$ref: '#/components/schemas/microsoft.graph.image'
lastModifiedBy:
$ref: '#/components/schemas/microsoft.graph.identitySet'
lastModifiedDateTime:
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: Date and time the item was last modified. Read-only.
format: date-time
nullable: true
name:
type: string
description: Optional. Filename of the remote item. Read-only.
nullable: true
package:
$ref: '#/components/schemas/microsoft.graph.package'
parentReference:
$ref: '#/components/schemas/microsoft.graph.itemReference'
shared:
$ref: '#/components/schemas/microsoft.graph.shared'
sharepointIds:
$ref: '#/components/schemas/microsoft.graph.sharepointIds'
size:
type: number
description: Size of the remote item. Read-only.
format: int64
nullable: true
specialFolder:
$ref: '#/components/schemas/microsoft.graph.specialFolder'
video:
$ref: '#/components/schemas/microsoft.graph.video'
webDavUrl:
type: string
description: DAV compatible URL for the item.
nullable: true
webUrl:
type: string
description: URL that displays the resource in the browser. Read-only.
nullable: true
additionalProperties:
type: object
microsoft.graph.searchResult:
title: searchResult
type: object
properties:
onClickTelemetryUrl:
type: string
description: A callback URL that can be used to record telemetry information. The application should issue a GET on this URL if the user interacts with this item to improve the quality of results.
nullable: true
additionalProperties:
type: object
microsoft.graph.shared:
title: shared
type: object
properties:
owner:
$ref: '#/components/schemas/microsoft.graph.identitySet'
scope:
type: string
description: 'Indicates the scope of how the item is shared. The possible values are: anonymous, organization, or users. Read-only.'
nullable: true
sharedBy:
$ref: '#/components/schemas/microsoft.graph.identitySet'
sharedDateTime:
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 UTC date and time when the item was shared. Read-only.
format: date-time
nullable: true
additionalProperties:
type: object
microsoft.graph.specialFolder:
title: specialFolder
type: object
properties:
name:
type: string
description: The unique identifier for this item in the /drive/special collection
nullable: true
additionalProperties:
type: object
microsoft.graph.video:
title: video
type: object
properties:
audioBitsPerSample:
maximum: 2147483647
minimum: -2147483648
type: number
description: Number of audio bits per sample.
format: int32
nullable: true
audioChannels:
maximum: 2147483647
minimum: -2147483648
type: number
description: Number of audio channels.
format: int32
nullable: true
audioFormat:
type: string
description: 'Name of the audio format (AAC, MP3, etc.).'
nullable: true
audioSamplesPerSecond:
maximum: 2147483647
minimum: -2147483648
type: number
description: Number of audio samples per second.
format: int32
nullable: true
bitrate:
maximum: 2147483647
minimum: -2147483648
type: number
description: Bit rate of the video in bits per second.
format: int32
nullable: true
duration:
type: number
description: Duration of the file in milliseconds.
format: int64
nullable: true
fourCC:
type: string
description: '''Four character code'' name of the video format.'
nullable: true
frameRate:
type: number
description: Frame rate of the video.
format: double
nullable: true
height:
maximum: 2147483647
minimum: -2147483648
type: number
description: 'Height of the video, in pixels.'
format: int32
nullable: true
width:
maximum: 2147483647
minimum: -2147483648
type: number
description: 'Width of the video, in pixels.'
format: int32
nullable: true
additionalProperties:
type: object
microsoft.graph.listItem:
allOf:
- $ref: '#/components/schemas/microsoft.graph.baseItem'
- title: listItem
type: object
properties:
contentType:
$ref: '#/components/schemas/microsoft.graph.contentTypeInfo'
deleted:
$ref: '#/components/schemas/microsoft.graph.deleted'
sharepointIds:
$ref: '#/components/schemas/microsoft.graph.sharepointIds'
analytics:
$ref: '#/components/schemas/microsoft.graph.itemAnalytics'
documentSetVersions:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.documentSetVersion'
description: Version information for a document set version created by a user.
x-ms-navigationProperty: true
driveItem:
$ref: '#/components/schemas/microsoft.graph.driveItem'
fields:
$ref: '#/components/schemas/microsoft.graph.fieldValueSet'
permissions:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.permission'
description: The set of permissions for the item. Read-only. Nullable.
x-ms-navigationProperty: true
versions:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.listItemVersion'
description: The list of previous versions of the list item.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.itemRetentionLabel:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: itemRetentionLabel
type: object
properties:
isLabelAppliedExplicitly:
type: boolean
description: 'Specifies whether the label is applied explicitly on the item. True indicates that the label is applied explicitly; otherwise, the label is inherited from its parent. Read-only.'
nullable: true
labelAppliedBy:
$ref: '#/components/schemas/microsoft.graph.identitySet'
labelAppliedDateTime:
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 label was applied on the item. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.'
format: date-time
nullable: true
name:
type: string
description: The retention label on the document. Read-write.
nullable: true
retentionSettings:
$ref: '#/components/schemas/microsoft.graph.retentionLabelSettings'
additionalProperties:
type: object
microsoft.graph.subscription:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: subscription
type: object
properties:
applicationId:
type: string
description: Optional. Identifier of the application used to create the subscription. Read-only.
nullable: true
changeType:
type: string
description: 'Required. Indicates the type of change in the subscribed resource that raises a change notification. The supported values are: created, updated, deleted. Multiple values can be combined using a comma-separated list. Note: Drive root item and list change notifications support only the updated changeType. User and group change notifications support updated and deleted changeType. Use updated to receive notifications when user or group is created, updated, or soft deleted. Use deleted to receive notifications when user or group is permanently deleted.'
clientState:
type: string
description: Optional. Specifies the value of the clientState property sent by the service in each change notification. The maximum length is 128 characters. The client can check that the change notification came from the service by comparing the value of the clientState property sent with the subscription with the value of the clientState property received with each change notification.
nullable: true
creatorId:
type: string
description: 'Optional. Identifier of the user or service principal that created the subscription. If the app used delegated permissions to create the subscription, this field contains the ID of the signed-in user the app called on behalf of. If the app used application permissions, this field contains the ID of the service principal corresponding to the app. Read-only.'
nullable: true
encryptionCertificate:
type: string
description: Optional. A base64-encoded representation of a certificate with a public key used to encrypt resource data in change notifications. Optional but required when includeResourceData is true.
nullable: true
encryptionCertificateId:
type: string
description: Optional. A custom app-provided identifier to help identify the certificate needed to decrypt resource data.
nullable: true
expirationDateTime:
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: 'Required. Specifies the date and time when the webhook subscription expires. The time is in UTC, and can be an amount of time from subscription creation that varies for the resource subscribed to. Any value under 45 minutes after the time of the request is automatically set to 45 minutes after the request time. For the maximum supported subscription length of time, see Subscription lifetime.'
format: date-time
includeResourceData:
type: boolean
description: 'Optional. When set to true, change notifications include resource data (such as content of a chat message).'
nullable: true
latestSupportedTlsVersion:
type: string
description: 'Optional. Specifies the latest version of Transport Layer Security (TLS) that the notification endpoint, specified by notificationUrl, supports. The possible values are: v10, v11, v12, v13. For subscribers whose notification endpoint supports a version lower than the currently recommended version (TLS 1.2), specifying this property by a set timeline allows them to temporarily use their deprecated version of TLS before completing their upgrade to TLS 1.2. For these subscribers, not setting this property per the timeline would result in subscription operations failing. For subscribers whose notification endpoint already supports TLS 1.2, setting this property is optional. In such cases, Microsoft Graph defaults the property to v1_2.'
nullable: true
lifecycleNotificationUrl:
type: string
description: 'Required for Teams resources if the expirationDateTime value is more than 1 hour from now; optional otherwise. The URL of the endpoint that receives lifecycle notifications, including subscriptionRemoved, reauthorizationRequired, and missed notifications. This URL must make use of the HTTPS protocol. For more information, see Reduce missing subscriptions and change notifications.'
nullable: true
notificationQueryOptions:
type: string
description: 'Optional. OData query options for specifying value for the targeting resource. Clients receive notifications when resource reaches the state matching the query options provided here. With this new property in the subscription creation payload along with all existing properties, Webhooks deliver notifications whenever a resource reaches the desired state mentioned in the notificationQueryOptions property. For example, when the print job is completed or when a print job resource isFetchable property value becomes true etc. Supported only for Universal Print Service. For more information, see Subscribe to change notifications from cloud printing APIs using Microsoft Graph.'
nullable: true
notificationUrl:
type: string
description: Required. The URL of the endpoint that receives the change notifications. This URL must make use of the HTTPS protocol. Any query string parameter included in the notificationUrl property is included in the HTTP POST request when Microsoft Graph sends the change notifications.
notificationUrlAppId:
type: string
description: Optional. The app ID that the subscription service can use to generate the validation token. The value allows the client to validate the authenticity of the notification received.
nullable: true
resource:
type: string
description: Required. Specifies the resource that is monitored for changes. Don't include the base URL (https://graph.microsoft.com/v1.0/). See the possible resource path values for each supported resource.
additionalProperties:
type: object
microsoft.graph.thumbnailSet:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: thumbnailSet
type: object
properties:
large:
$ref: '#/components/schemas/microsoft.graph.thumbnail'
medium:
$ref: '#/components/schemas/microsoft.graph.thumbnail'
small:
$ref: '#/components/schemas/microsoft.graph.thumbnail'
source:
$ref: '#/components/schemas/microsoft.graph.thumbnail'
additionalProperties:
type: object
microsoft.graph.driveItemVersion:
allOf:
- $ref: '#/components/schemas/microsoft.graph.baseItemVersion'
- title: driveItemVersion
type: object
properties:
content:
type: string
description: The content stream for this version of the item.
format: base64url
nullable: true
size:
type: number
description: Indicates the size of the content stream for this version of the item.
format: int64
nullable: true
additionalProperties:
type: object
microsoft.graph.workbook:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: workbook
type: object
properties:
application:
$ref: '#/components/schemas/microsoft.graph.workbookApplication'
comments:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.workbookComment'
description: Represents a collection of comments in a workbook.
x-ms-navigationProperty: true
functions:
$ref: '#/components/schemas/microsoft.graph.workbookFunctions'
names:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.workbookNamedItem'
description: Represents a collection of workbooks scoped named items (named ranges and constants). Read-only.
x-ms-navigationProperty: true
operations:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.workbookOperation'
description: 'The status of workbook operations. Getting an operation collection is not supported, but you can get the status of a long-running operation if the Location header is returned in the response. Read-only.'
x-ms-navigationProperty: true
tables:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.workbookTable'
description: Represents a collection of tables associated with the workbook. Read-only.
x-ms-navigationProperty: true
worksheets:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.workbookWorksheet'
description: Represents a collection of worksheets associated with the workbook. Read-only.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.listInfo:
title: listInfo
type: object
properties:
contentTypesEnabled:
type: boolean
description: 'If true, indicates that content types are enabled for this list.'
nullable: true
hidden:
type: boolean
description: 'If true, indicates that the list isn''t normally visible in the SharePoint user experience.'
nullable: true
template:
type: string
description: 'An enumerated value that represents the base list template used in creating the list. Possible values include documentLibrary, genericList, task, survey, announcements, contacts, and more.'
nullable: true
additionalProperties:
type: object
microsoft.graph.engagementRoleMember:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: engagementRoleMember
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 role was assigned to the user. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.'
format: date-time
readOnly: true
userId:
type: string
description: The Microsoft Entra ID of the user who has the role assigned.
nullable: true
readOnly: true
user:
$ref: '#/components/schemas/microsoft.graph.user'
additionalProperties:
type: object
description: Entity to represent the assignment of a role to a user.
microsoft.graph.courseStatus:
title: courseStatus
enum:
- notStarted
- inProgress
- completed
- unknownFutureValue
type: string
microsoft.graph.siteArchivalDetails:
title: siteArchivalDetails
type: object
properties:
archiveStatus:
$ref: '#/components/schemas/microsoft.graph.siteArchiveStatus'
additionalProperties:
type: object
microsoft.graph.itemActivityStat:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: itemActivityStat
type: object
properties:
access:
$ref: '#/components/schemas/microsoft.graph.itemActionStat'
create:
$ref: '#/components/schemas/microsoft.graph.itemActionStat'
delete:
$ref: '#/components/schemas/microsoft.graph.itemActionStat'
edit:
$ref: '#/components/schemas/microsoft.graph.itemActionStat'
endDateTime:
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: When the interval ends. Read-only.
format: date-time
nullable: true
incompleteData:
$ref: '#/components/schemas/microsoft.graph.incompleteData'
isTrending:
type: boolean
description: Indicates whether the item is 'trending.' Read-only.
nullable: true
move:
$ref: '#/components/schemas/microsoft.graph.itemActionStat'
startDateTime:
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: When the interval starts. Read-only.
format: date-time
nullable: true
activities:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.itemActivity'
description: Exposes the itemActivities represented in this itemActivityStat resource.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.booleanColumn:
title: booleanColumn
type: object
additionalProperties:
type: object
microsoft.graph.calculatedColumn:
title: calculatedColumn
type: object
properties:
format:
type: string
description: 'For dateTime output types, the format of the value. The possible values are: dateOnly or dateTime.'
nullable: true
formula:
type: string
description: The formula used to compute the value for this column.
nullable: true
outputType:
type: string
description: 'The output type used to format values in this column. The possible values are: boolean, currency, dateTime, number, or text.'
nullable: true
additionalProperties:
type: object
microsoft.graph.choiceColumn:
title: choiceColumn
type: object
properties:
allowTextEntry:
type: boolean
description: 'If true, allows custom values that aren''t in the configured choices.'
nullable: true
choices:
type: array
items:
type: string
nullable: true
description: The list of values available for this column.
displayAs:
type: string
description: 'How the choices are to be presented in the UX. Must be one of checkBoxes, dropDownMenu, or radioButtons'
nullable: true
additionalProperties:
type: object
microsoft.graph.contentApprovalStatusColumn:
title: contentApprovalStatusColumn
type: object
additionalProperties:
type: object
microsoft.graph.currencyColumn:
title: currencyColumn
type: object
properties:
locale:
type: string
description: Specifies the locale from which to infer the currency symbol.
nullable: true
additionalProperties:
type: object
microsoft.graph.dateTimeColumn:
title: dateTimeColumn
type: object
properties:
displayAs:
type: string
description: 'How the value should be presented in the UX. Must be one of default, friendly, or standard. See below for more details. If unspecified, treated as default.'
nullable: true
format:
type: string
description: Indicates whether the value should be presented as a date only or a date and time. Must be one of dateOnly or dateTime
nullable: true
additionalProperties:
type: object
microsoft.graph.defaultColumnValue:
title: defaultColumnValue
type: object
properties:
formula:
type: string
description: The formula used to compute the default value for the column.
nullable: true
value:
type: string
description: The direct value to use as the default value for the column.
nullable: true
additionalProperties:
type: object
microsoft.graph.geolocationColumn:
title: geolocationColumn
type: object
additionalProperties:
type: object
microsoft.graph.hyperlinkOrPictureColumn:
title: hyperlinkOrPictureColumn
type: object
properties:
isPicture:
type: boolean
description: Specifies whether the display format used for URL columns is an image or a hyperlink.
nullable: true
additionalProperties:
type: object
microsoft.graph.lookupColumn:
title: lookupColumn
type: object
properties:
allowMultipleValues:
type: boolean
description: Indicates whether multiple values can be selected from the source.
nullable: true
allowUnlimitedLength:
type: boolean
description: Indicates whether values in the column should be able to exceed the standard limit of 255 characters.
nullable: true
columnName:
type: string
description: The name of the lookup source column.
nullable: true
listId:
type: string
description: The unique identifier of the lookup source list.
nullable: true
primaryLookupColumnId:
type: string
description: 'If specified, this column is a secondary lookup, pulling an additional field from the list item looked up by the primary lookup. Use the list item looked up by the primary as the source for the column named here.'
nullable: true
additionalProperties:
type: object
microsoft.graph.numberColumn:
title: numberColumn
type: object
properties:
decimalPlaces:
type: string
description: How many decimal places to display. See below for information about the possible values.
nullable: true
displayAs:
type: string
description: 'How the value should be presented in the UX. Must be one of number or percentage. If unspecified, treated as number.'
nullable: true
maximum:
type: number
description: The maximum permitted value.
format: double
nullable: true
minimum:
type: number
description: The minimum permitted value.
format: double
nullable: true
additionalProperties:
type: object
microsoft.graph.personOrGroupColumn:
title: personOrGroupColumn
type: object
properties:
allowMultipleSelection:
type: boolean
description: Indicates whether multiple values can be selected from the source.
nullable: true
chooseFromType:
type: string
description: 'Whether to allow selection of people only, or people and groups. Must be one of peopleAndGroups or peopleOnly.'
nullable: true
displayAs:
type: string
description: How to display the information about the person or group chosen. See below.
nullable: true
additionalProperties:
type: object
microsoft.graph.contentTypeInfo:
title: contentTypeInfo
type: object
properties:
id:
type: string
description: The ID of the content type.
nullable: true
name:
type: string
description: The name of the content type.
nullable: true
additionalProperties:
type: object
microsoft.graph.termColumn:
title: termColumn
type: object
properties:
allowMultipleValues:
type: boolean
description: Specifies whether the column allows more than one value.
nullable: true
showFullyQualifiedName:
type: boolean
description: Specifies whether to display the entire term path or only the term label.
nullable: true
parentTerm:
$ref: '#/components/schemas/microsoft.graph.termStore.term'
termSet:
$ref: '#/components/schemas/microsoft.graph.termStore.set'
additionalProperties:
type: object
microsoft.graph.textColumn:
title: textColumn
type: object
properties:
allowMultipleLines:
type: boolean
description: Whether to allow multiple lines of text.
nullable: true
appendChangesToExistingText:
type: boolean
description: 'Whether updates to this column should replace existing text, or append to it.'
nullable: true
linesForEditing:
maximum: 2147483647
minimum: -2147483648
type: number
description: The size of the text box.
format: int32
nullable: true
maxLength:
maximum: 2147483647
minimum: -2147483648
type: number
description: The maximum number of characters for the value.
format: int32
nullable: true
textType:
type: string
description: The type of text being stored. Must be one of plain or richText
nullable: true
additionalProperties:
type: object
microsoft.graph.thumbnailColumn:
title: thumbnailColumn
type: object
additionalProperties:
type: object
microsoft.graph.columnTypes:
title: columnTypes
enum:
- note
- text
- choice
- multichoice
- number
- currency
- dateTime
- lookup
- boolean
- user
- url
- calculated
- location
- geolocation
- term
- multiterm
- thumbnail
- approvalStatus
- unknownFutureValue
type: string
microsoft.graph.columnValidation:
title: columnValidation
type: object
properties:
defaultLanguage:
type: string
description: Default BCP 47 language tag for the description.
nullable: true
descriptions:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.displayNameLocalization'
description: Localized messages that explain what is needed for this column's value to be considered valid. User will be prompted with this message if validation fails.
formula:
type: string
description: 'The formula to validate column value. For examples, see Examples of common formulas in lists.'
nullable: true
additionalProperties:
type: object
microsoft.graph.documentSet:
title: documentSet
type: object
properties:
allowedContentTypes:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.contentTypeInfo'
description: Content types allowed in document set.
defaultContents:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.documentSetContent'
description: Default contents of document set.
propagateWelcomePageChanges:
type: boolean
description: Specifies whether to push welcome page changes to inherited content types.
nullable: true
shouldPrefixNameToFile:
type: boolean
description: Indicates whether to add the name of the document set to each file name.
nullable: true
welcomePageUrl:
type: string
description: Welcome page absolute URL.
nullable: true
sharedColumns:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.columnDefinition'
x-ms-navigationProperty: true
welcomePageColumns:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.columnDefinition'
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.documentSetContent:
title: documentSetContent
type: object
properties:
contentType:
$ref: '#/components/schemas/microsoft.graph.contentTypeInfo'
fileName:
type: string
description: Name of the file in resource folder that should be added as a default content or a template in the document set.
nullable: true
folderName:
type: string
description: Folder name in which the file will be placed when a new document set is created in the library.
nullable: true
additionalProperties:
type: object
microsoft.graph.contentTypeOrder:
title: contentTypeOrder
type: object
properties:
default:
type: boolean
description: Indicates whether this is the default content type
nullable: true
position:
maximum: 2147483647
minimum: -2147483648
type: number
description: Specifies the position in which the content type appears in the selection UI.
format: int32
nullable: true
additionalProperties:
type: object
microsoft.graph.columnLink:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: columnLink
type: object
properties:
name:
type: string
description: The name of the column in this content type.
nullable: true
additionalProperties:
type: object
microsoft.graph.pageLayoutType:
title: pageLayoutType
enum:
- microsoftReserved
- article
- home
- unknownFutureValue
type: string
microsoft.graph.sharePointIdentitySet:
allOf:
- $ref: '#/components/schemas/microsoft.graph.identitySet'
- title: sharePointIdentitySet
type: object
properties:
group:
$ref: '#/components/schemas/microsoft.graph.identity'
sharePointGroup:
$ref: '#/components/schemas/microsoft.graph.sharePointGroupIdentity'
siteGroup:
$ref: '#/components/schemas/microsoft.graph.sharePointIdentity'
siteUser:
$ref: '#/components/schemas/microsoft.graph.sharePointIdentity'
additionalProperties:
type: object
microsoft.graph.sharingInvitation:
title: sharingInvitation
type: object
properties:
email:
type: string
description: The email address provided for the recipient of the sharing invitation. Read-only.
nullable: true
invitedBy:
$ref: '#/components/schemas/microsoft.graph.identitySet'
redeemedBy:
type: string
nullable: true
signInRequired:
type: boolean
description: If true the recipient of the invitation needs to sign in in order to access the shared item. Read-only.
nullable: true
additionalProperties:
type: object
microsoft.graph.sharingLink:
title: sharingLink
type: object
properties:
application:
$ref: '#/components/schemas/microsoft.graph.identity'
preventsDownload:
type: boolean
description: 'If true then the user can only use this link to view the item on the web, and cannot use it to download the contents of the item. Only for OneDrive for Business and SharePoint.'
nullable: true
scope:
type: string
description: 'The scope of the link represented by this permission. Value anonymous indicates the link is usable by anyone, organization indicates the link is only usable for users signed into the same tenant.'
nullable: true
type:
type: string
description: The type of the link created.
nullable: true
webHtml:
type: string
description: 'For embed links, this property contains the HTML code for an