openapi: 3.0.4
info:
title: Identity.SignIns
version: v1.0
servers:
- url: https://graph.microsoft.com/v1.0/
description: Core
paths:
/dataPolicyOperations:
get:
tags:
- dataPolicyOperations.dataPolicyOperation
summary: Get dataPolicyOperation
description: Retrieve the properties of a dataPolicyOperation object.
operationId: dataPolicyOperation_ListDataPolicyOperation
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.dataPolicyOperationCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- dataPolicyOperations.dataPolicyOperation
summary: Add new entity to dataPolicyOperations
operationId: dataPolicyOperation_CreateDataPolicyOperation
requestBody:
description: New entity
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.dataPolicyOperation'
required: true
responses:
2XX:
description: Created entity
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.dataPolicyOperation'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/dataPolicyOperations/{dataPolicyOperation-id}':
get:
tags:
- dataPolicyOperations.dataPolicyOperation
summary: Get dataPolicyOperation
description: Retrieve the properties of a dataPolicyOperation object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/datapolicyoperation-get?view=graph-rest-1.0
operationId: dataPolicyOperation_GetDataPolicyOperation
parameters:
- name: dataPolicyOperation-id
in: path
description: The unique identifier of dataPolicyOperation
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: dataPolicyOperation
- 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.dataPolicyOperation'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- dataPolicyOperations.dataPolicyOperation
summary: Update entity in dataPolicyOperations
operationId: dataPolicyOperation_UpdateDataPolicyOperation
parameters:
- name: dataPolicyOperation-id
in: path
description: The unique identifier of dataPolicyOperation
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: dataPolicyOperation
requestBody:
description: New property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.dataPolicyOperation'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.dataPolicyOperation'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- dataPolicyOperations.dataPolicyOperation
summary: Delete entity from dataPolicyOperations
operationId: dataPolicyOperation_DeleteDataPolicyOperation
parameters:
- name: dataPolicyOperation-id
in: path
description: The unique identifier of dataPolicyOperation
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: dataPolicyOperation
- 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
/dataPolicyOperations/$count:
get:
tags:
- dataPolicyOperations.dataPolicyOperation
summary: Get the number of the resource
operationId: dataPolicyOperation_GetCount
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
/identity:
get:
tags:
- identity.identityContainer
summary: Get identity
operationId: identity.identityContainer_GetIdentityContainer
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved entity
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.identityContainer'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identity.identityContainer
summary: Update identity
operationId: identity.identityContainer_UpdateIdentityContainer
requestBody:
description: New property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.identityContainer'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.identityContainer'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
/identity/apiConnectors:
get:
tags:
- identity.identityApiConnector
summary: List identityApiConnectors
description: Read the properties of an identityApiConnector object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/identityapiconnector-list?view=graph-rest-1.0
operationId: identity_ListApiConnector
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.identityApiConnectorCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identity.identityApiConnector
summary: Create identityApiConnector
description: Create a new identityApiConnector object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/identityapiconnector-create?view=graph-rest-1.0
operationId: identity_CreateApiConnector
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.identityApiConnector'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.identityApiConnector'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identity/apiConnectors/{identityApiConnector-id}':
get:
tags:
- identity.identityApiConnector
summary: Get identityApiConnector
description: Read the properties of an identityApiConnector object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/identityapiconnector-get?view=graph-rest-1.0
operationId: identity_GetApiConnector
parameters:
- name: identityApiConnector-id
in: path
description: The unique identifier of identityApiConnector
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: identityApiConnector
- 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.identityApiConnector'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identity.identityApiConnector
summary: Update identityApiConnector
description: Update the properties of an identityApiConnector object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/identityapiconnector-update?view=graph-rest-1.0
operationId: identity_UpdateApiConnector
parameters:
- name: identityApiConnector-id
in: path
description: The unique identifier of identityApiConnector
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: identityApiConnector
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.identityApiConnector'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.identityApiConnector'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identity.identityApiConnector
summary: Delete identityApiConnector
description: Delete an identityApiConnector object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/identityapiconnector-delete?view=graph-rest-1.0
operationId: identity_DeleteApiConnector
parameters:
- name: identityApiConnector-id
in: path
description: The unique identifier of identityApiConnector
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: identityApiConnector
- 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
'/identity/apiConnectors/{identityApiConnector-id}/microsoft.graph.uploadClientCertificate':
post:
tags:
- identity.identityApiConnector
summary: Invoke action uploadClientCertificate
description: Upload a PKCS 12 format key (.pfx) to an API connector's authentication configuration. The input is a base-64 encoded value of the PKCS 12 certificate contents. This method returns an apiConnector.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/identityapiconnector-uploadclientcertificate?view=graph-rest-1.0
operationId: identity.apiConnector_uploadClientCertificate
parameters:
- name: identityApiConnector-id
in: path
description: The unique identifier of identityApiConnector
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: identityApiConnector
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
pkcs12Value:
type: string
nullable: true
password:
type: string
nullable: true
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.identityApiConnector'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
/identity/apiConnectors/$count:
get:
tags:
- identity.identityApiConnector
summary: Get the number of the resource
operationId: identity.apiConnector_GetCount
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
/identity/authenticationEventListeners:
get:
tags:
- identity.authenticationEventListener
summary: List authenticationEventListeners
description: 'Get a list of the authenticationEventListener objects and their properties. The following derived types are supported:'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/identitycontainer-list-authenticationeventlisteners?view=graph-rest-1.0
operationId: identity_ListAuthenticationEventListener
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.authenticationEventListenerCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identity.authenticationEventListener
summary: Create authenticationEventListener
description: Create a new authenticationEventListener object. You can create one of the following subtypes that are derived from authenticationEventListener.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/identitycontainer-post-authenticationeventlisteners?view=graph-rest-1.0
operationId: identity_CreateAuthenticationEventListener
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.authenticationEventListener'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.authenticationEventListener'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identity/authenticationEventListeners/{authenticationEventListener-id}':
get:
tags:
- identity.authenticationEventListener
summary: Get authenticationEventListener
description: Read the properties and relationships of an authenticationEventListener object. The @odata.type property in the response object indicates the type of the authenticationEventListener object. The following derived types are currently supported.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/authenticationeventlistener-get?view=graph-rest-1.0
operationId: identity_GetAuthenticationEventListener
parameters:
- name: authenticationEventListener-id
in: path
description: The unique identifier of authenticationEventListener
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: authenticationEventListener
- 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.authenticationEventListener'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identity.authenticationEventListener
summary: Update authenticationEventListener
description: Update the properties of an authenticationEventListener object. You must specify the @odata.type property and the value of the authenticationEventListener object type to update. The following derived types are currently supported.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/authenticationeventlistener-update?view=graph-rest-1.0
operationId: identity_UpdateAuthenticationEventListener
parameters:
- name: authenticationEventListener-id
in: path
description: The unique identifier of authenticationEventListener
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: authenticationEventListener
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.authenticationEventListener'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.authenticationEventListener'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identity.authenticationEventListener
summary: Delete authenticationEventListener
description: Delete an authenticationEventListener object. The following derived types are currently supported.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/authenticationeventlistener-delete?view=graph-rest-1.0
operationId: identity_DeleteAuthenticationEventListener
parameters:
- name: authenticationEventListener-id
in: path
description: The unique identifier of authenticationEventListener
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: authenticationEventListener
- 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
/identity/authenticationEventListeners/$count:
get:
tags:
- identity.authenticationEventListener
summary: Get the number of the resource
operationId: identity.authenticationEventListener_GetCount
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
/identity/authenticationEventsFlows:
get:
tags:
- identity.authenticationEventsFlow
summary: List authenticationEventsFlows
description: "Get a collection of authentication events policies that are derived from authenticationEventsFlow. The following derived subtypes are supported: \r\n- externalUsersSelfServiceSignupEventsFlow"
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/identitycontainer-list-authenticationeventsflows?view=graph-rest-1.0
operationId: identity_ListAuthenticationEventsFlow
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.authenticationEventsFlowCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identity.authenticationEventsFlow
summary: Create authenticationEventsFlow
description: "Create a new authenticationEventsFlow object that is of the type specified in the request body. The following derived subtypes are supported:\r\n- externalUsersSelfServiceSignupEventsFlow object type."
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/identitycontainer-post-authenticationeventsflows?view=graph-rest-1.0
operationId: identity_CreateAuthenticationEventsFlow
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.authenticationEventsFlow'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.authenticationEventsFlow'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identity/authenticationEventsFlows/{authenticationEventsFlow-id}':
get:
tags:
- identity.authenticationEventsFlow
summary: Get authenticationEventsFlow
description: "Retrieve the properties and relationships of a specific authenticationEventsFlow object by ID. The @odata.type property in the response object indicates the type of the object, which can be one of the following derived subtypes:\r\n- externalUsersSelfServiceSignupEventsFlow"
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/authenticationeventsflow-get?view=graph-rest-1.0
operationId: identity_GetAuthenticationEventsFlow
parameters:
- name: authenticationEventsFlow-id
in: path
description: The unique identifier of authenticationEventsFlow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: authenticationEventsFlow
- 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.authenticationEventsFlow'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identity.authenticationEventsFlow
summary: Update authenticationEventsFlow
description: "Update the properties of an authenticationEventsFlow object by ID. You must specify the @odata.type property and the value of the authenticationEventsFlow object type to update. The following derived subtypes are supported:\r\n- externalUsersSelfServiceSignupEventsFlow"
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/authenticationeventsflow-update?view=graph-rest-1.0
operationId: identity_UpdateAuthenticationEventsFlow
parameters:
- name: authenticationEventsFlow-id
in: path
description: The unique identifier of authenticationEventsFlow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: authenticationEventsFlow
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.authenticationEventsFlow'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.authenticationEventsFlow'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identity.authenticationEventsFlow
summary: Delete authenticationEventsFlow
description: "Delete a specific authenticationEventsFlow resource by ID. This operation also removes or unlinks all applications from the flow, which disables the customized authentication experience defined for the application. The following derived subtypes are supported:\r\n- externalUsersSelfServiceSignupEventsFlow"
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/authenticationeventsflow-delete?view=graph-rest-1.0
operationId: identity_DeleteAuthenticationEventsFlow
parameters:
- name: authenticationEventsFlow-id
in: path
description: The unique identifier of authenticationEventsFlow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: authenticationEventsFlow
- 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
'/identity/authenticationEventsFlows/{authenticationEventsFlow-id}/conditions':
get:
tags:
- identity.authenticationEventsFlow
summary: Get conditions property value
description: The conditions representing the context of the authentication request that's used to decide whether the events policy is invoked. Supports $filter (eq). See support for filtering on user flows for syntax information.
operationId: identity.authenticationEventsFlow_GetCondition
parameters:
- name: authenticationEventsFlow-id
in: path
description: The unique identifier of authenticationEventsFlow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: authenticationEventsFlow
- 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.authenticationConditions'
default:
$ref: '#/components/responses/error'
'/identity/authenticationEventsFlows/{authenticationEventsFlow-id}/conditions/applications/includeApplications':
get:
tags:
- identity.authenticationEventsFlow
summary: List includeApplications (for a user flow)
description: 'List the applications linked to an external identities self-service sign up user flow that''s represented by an externalUsersSelfServiceSignupEventsFlow object. These are the applications for which the authentication experience that''s defined by the user flow is enabled. To find the user flow that''s linked to an application, see Example 4: List user flow associated with specific application ID.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/authenticationconditionsapplications-list-includeapplications?view=graph-rest-1.0
operationId: identity.authenticationEventsFlow_ListIncludeApplication
parameters:
- name: authenticationEventsFlow-id
in: path
description: The unique identifier of authenticationEventsFlow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: authenticationEventsFlow
- $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.authenticationConditionApplicationCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identity.authenticationEventsFlow
summary: Add includeApplication (to a user flow)
description: 'Add or link an application to a user flow, or authenticationEventsFlow. This enables the authentication experience defined by the user flow to be enabled for the application. An application can only be linked to one user flow. The app must have an associated service principal in the tenant.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/authenticationconditionsapplications-post-includeapplications?view=graph-rest-1.0
operationId: identity.authenticationEventsFlow_CreateIncludeApplication
parameters:
- name: authenticationEventsFlow-id
in: path
description: The unique identifier of authenticationEventsFlow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: authenticationEventsFlow
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.authenticationConditionApplication'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.authenticationConditionApplication'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identity/authenticationEventsFlows/{authenticationEventsFlow-id}/conditions/applications/includeApplications/{authenticationConditionApplication-appId}':
get:
tags:
- identity.authenticationEventsFlow
summary: Get includeApplications from identity
operationId: identity.authenticationEventsFlow_GetIncludeApplication
parameters:
- name: authenticationEventsFlow-id
in: path
description: The unique identifier of authenticationEventsFlow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: authenticationEventsFlow
- name: authenticationConditionApplication-appId
in: path
description: The unique identifier of authenticationConditionApplication
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: authenticationConditionApplication
- 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.authenticationConditionApplication'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identity.authenticationEventsFlow
summary: Update the navigation property includeApplications in identity
operationId: identity.authenticationEventsFlow_UpdateIncludeApplication
parameters:
- name: authenticationEventsFlow-id
in: path
description: The unique identifier of authenticationEventsFlow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: authenticationEventsFlow
- name: authenticationConditionApplication-appId
in: path
description: The unique identifier of authenticationConditionApplication
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: authenticationConditionApplication
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.authenticationConditionApplication'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.authenticationConditionApplication'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identity.authenticationEventsFlow
summary: Delete authenticationConditionApplication (from a user flow)
description: Remove or unlink an application from an authenticationEventsFlow object. This disables the customized authentication experience defined for the application.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/authenticationconditionapplication-delete?view=graph-rest-1.0
operationId: identity.authenticationEventsFlow_DeleteIncludeApplication
parameters:
- name: authenticationEventsFlow-id
in: path
description: The unique identifier of authenticationEventsFlow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: authenticationEventsFlow
- name: authenticationConditionApplication-appId
in: path
description: The unique identifier of authenticationConditionApplication
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: authenticationConditionApplication
- 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
'/identity/authenticationEventsFlows/{authenticationEventsFlow-id}/conditions/applications/includeApplications/$count':
get:
tags:
- identity.authenticationEventsFlow
summary: Get the number of the resource
operationId: identity.authenticationEventsFlow.includeApplication_GetCount
parameters:
- name: authenticationEventsFlow-id
in: path
description: The unique identifier of authenticationEventsFlow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: authenticationEventsFlow
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identity/authenticationEventsFlows/{authenticationEventsFlow-id}/microsoft.graph.externalUsersSelfServiceSignUpEventsFlow':
get:
tags:
- identity.authenticationEventsFlow
summary: Get the item of type microsoft.graph.authenticationEventsFlow as microsoft.graph.externalUsersSelfServiceSignUpEventsFlow
operationId: identity_GetAuthenticationEventsFlowAsExternalUsersSelfServiceSignUpEventsFlow
parameters:
- name: authenticationEventsFlow-id
in: path
description: The unique identifier of authenticationEventsFlow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: authenticationEventsFlow
- 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.externalUsersSelfServiceSignUpEventsFlow'
default:
$ref: '#/components/responses/error'
'/identity/authenticationEventsFlows/{authenticationEventsFlow-id}/microsoft.graph.externalUsersSelfServiceSignUpEventsFlow/conditions':
get:
tags:
- identity.authenticationEventsFlow
summary: Get conditions property value
description: The conditions representing the context of the authentication request that's used to decide whether the events policy is invoked. Supports $filter (eq). See support for filtering on user flows for syntax information.
operationId: identity.authenticationEventsFlowAsExternalUsersSelfServiceSignUpEventsFlow_GetCondition
parameters:
- name: authenticationEventsFlow-id
in: path
description: The unique identifier of authenticationEventsFlow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: authenticationEventsFlow
- 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.authenticationConditions'
default:
$ref: '#/components/responses/error'
'/identity/authenticationEventsFlows/{authenticationEventsFlow-id}/microsoft.graph.externalUsersSelfServiceSignUpEventsFlow/conditions/applications/includeApplications':
get:
tags:
- identity.authenticationEventsFlow
summary: Get includeApplications from identity
operationId: identity.authenticationEventsFlowAsExternalUsersSelfServiceSignUpEventsFlow_ListIncludeApplication
parameters:
- name: authenticationEventsFlow-id
in: path
description: The unique identifier of authenticationEventsFlow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: authenticationEventsFlow
- $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.authenticationConditionApplicationCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identity.authenticationEventsFlow
summary: Create new navigation property to includeApplications for identity
operationId: identity.authenticationEventsFlowAsExternalUsersSelfServiceSignUpEventsFlow_CreateIncludeApplication
parameters:
- name: authenticationEventsFlow-id
in: path
description: The unique identifier of authenticationEventsFlow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: authenticationEventsFlow
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.authenticationConditionApplication'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.authenticationConditionApplication'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identity/authenticationEventsFlows/{authenticationEventsFlow-id}/microsoft.graph.externalUsersSelfServiceSignUpEventsFlow/conditions/applications/includeApplications/{authenticationConditionApplication-appId}':
get:
tags:
- identity.authenticationEventsFlow
summary: Get includeApplications from identity
operationId: identity.authenticationEventsFlowAsExternalUsersSelfServiceSignUpEventsFlow_GetIncludeApplication
parameters:
- name: authenticationEventsFlow-id
in: path
description: The unique identifier of authenticationEventsFlow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: authenticationEventsFlow
- name: authenticationConditionApplication-appId
in: path
description: The unique identifier of authenticationConditionApplication
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: authenticationConditionApplication
- 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.authenticationConditionApplication'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identity.authenticationEventsFlow
summary: Update the navigation property includeApplications in identity
operationId: identity.authenticationEventsFlowAsExternalUsersSelfServiceSignUpEventsFlow_UpdateIncludeApplication
parameters:
- name: authenticationEventsFlow-id
in: path
description: The unique identifier of authenticationEventsFlow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: authenticationEventsFlow
- name: authenticationConditionApplication-appId
in: path
description: The unique identifier of authenticationConditionApplication
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: authenticationConditionApplication
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.authenticationConditionApplication'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.authenticationConditionApplication'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identity.authenticationEventsFlow
summary: Delete navigation property includeApplications for identity
operationId: identity.authenticationEventsFlowAsExternalUsersSelfServiceSignUpEventsFlow_DeleteIncludeApplication
parameters:
- name: authenticationEventsFlow-id
in: path
description: The unique identifier of authenticationEventsFlow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: authenticationEventsFlow
- name: authenticationConditionApplication-appId
in: path
description: The unique identifier of authenticationConditionApplication
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: authenticationConditionApplication
- 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
'/identity/authenticationEventsFlows/{authenticationEventsFlow-id}/microsoft.graph.externalUsersSelfServiceSignUpEventsFlow/conditions/applications/includeApplications/$count':
get:
tags:
- identity.authenticationEventsFlow
summary: Get the number of the resource
operationId: identity.authenticationEventsFlowAsExternalUsersSelfServiceSignUpEventsFlow.includeApplication_GetCount
parameters:
- name: authenticationEventsFlow-id
in: path
description: The unique identifier of authenticationEventsFlow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: authenticationEventsFlow
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identity/authenticationEventsFlows/{authenticationEventsFlow-id}/microsoft.graph.externalUsersSelfServiceSignUpEventsFlow/onAttributeCollection':
get:
tags:
- identity.authenticationEventsFlow
summary: Get onAttributeCollection property value
description: The configuration for what to invoke when attributes are ready to be collected from the user.
operationId: identity.authenticationEventsFlowAsExternalUsersSelfServiceSignUpEventsFlow_GetOnAttributeCollection
parameters:
- name: authenticationEventsFlow-id
in: path
description: The unique identifier of authenticationEventsFlow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: authenticationEventsFlow
- 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.onAttributeCollectionHandler'
default:
$ref: '#/components/responses/error'
'/identity/authenticationEventsFlows/{authenticationEventsFlow-id}/microsoft.graph.externalUsersSelfServiceSignUpEventsFlow/onAttributeCollection/microsoft.graph.onAttributeCollectionExternalUsersSelfServiceSignUp':
get:
tags:
- identity.authenticationEventsFlow
summary: Get the item of type microsoft.graph.onAttributeCollectionHandler as microsoft.graph.onAttributeCollectionExternalUsersSelfServiceSignUp
operationId: identity.authenticationEventsFlow_GetOnAttributeCollectionAsOnAttributeCollectionExternalUsersSelfServiceSignUp
parameters:
- name: authenticationEventsFlow-id
in: path
description: The unique identifier of authenticationEventsFlow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: authenticationEventsFlow
responses:
2XX:
description: Entity result.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.onAttributeCollectionExternalUsersSelfServiceSignUp'
default:
$ref: '#/components/responses/error'
'/identity/authenticationEventsFlows/{authenticationEventsFlow-id}/microsoft.graph.externalUsersSelfServiceSignUpEventsFlow/onAttributeCollection/microsoft.graph.onAttributeCollectionExternalUsersSelfServiceSignUp/attributes':
get:
tags:
- identity.authenticationEventsFlow
summary: List attributes (of a user flow)
description: Get an identityUserFlowAttribute collection associated with an external identities self-service user flow represented by an externalUsersSelfServiceSignupEventsFlow object. These attributes are collected from the user during the authentication experience defined by the user flow.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/onattributecollectionexternalusersselfservicesignup-list-attributes?view=graph-rest-1.0
operationId: identity.authenticationEventsFlowAsOnAttributeCollectionExternalUsersSelfServiceSignUp_ListAttribute
parameters:
- name: authenticationEventsFlow-id
in: path
description: The unique identifier of authenticationEventsFlow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: authenticationEventsFlow
- $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.identityUserFlowAttributeCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
'/identity/authenticationEventsFlows/{authenticationEventsFlow-id}/microsoft.graph.externalUsersSelfServiceSignUpEventsFlow/onAttributeCollection/microsoft.graph.onAttributeCollectionExternalUsersSelfServiceSignUp/attributes/{identityUserFlowAttribute-id}/$ref':
delete:
tags:
- identity.authenticationEventsFlow
summary: Delete ref of navigation property attributes for identity
operationId: identity.authenticationEventsFlowAsOnGraphAPretributeCollectionExternalUsersSelfServiceSignUp.attribute_DeleteIdentityUserFlowGraphAPretributeGraphBPreRef
parameters:
- name: authenticationEventsFlow-id
in: path
description: The unique identifier of authenticationEventsFlow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: authenticationEventsFlow
- name: identityUserFlowAttribute-id
in: path
description: The unique identifier of identityUserFlowAttribute
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: identityUserFlowAttribute
- 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
'/identity/authenticationEventsFlows/{authenticationEventsFlow-id}/microsoft.graph.externalUsersSelfServiceSignUpEventsFlow/onAttributeCollection/microsoft.graph.onAttributeCollectionExternalUsersSelfServiceSignUp/attributes/$count':
get:
tags:
- identity.authenticationEventsFlow
summary: Get the number of the resource
operationId: identity.authenticationEventsFlowAsOnAttributeCollectionExternalUsersSelfServiceSignUp.attribute_GetCount
parameters:
- name: authenticationEventsFlow-id
in: path
description: The unique identifier of authenticationEventsFlow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: authenticationEventsFlow
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identity/authenticationEventsFlows/{authenticationEventsFlow-id}/microsoft.graph.externalUsersSelfServiceSignUpEventsFlow/onAttributeCollection/microsoft.graph.onAttributeCollectionExternalUsersSelfServiceSignUp/attributes/$ref':
get:
tags:
- identity.authenticationEventsFlow
summary: List attributes (of a user flow)
description: Get an identityUserFlowAttribute collection associated with an external identities self-service user flow represented by an externalUsersSelfServiceSignupEventsFlow object. These attributes are collected from the user during the authentication experience defined by the user flow.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/onattributecollectionexternalusersselfservicesignup-list-attributes?view=graph-rest-1.0
operationId: identity.authenticationEventsFlowAsOnGraphAPretributeCollectionExternalUsersSelfServiceSignUp_ListGraphAPretributeGraphBPreRef
parameters:
- name: authenticationEventsFlow-id
in: path
description: The unique identifier of authenticationEventsFlow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: authenticationEventsFlow
- $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:
- identity.authenticationEventsFlow
summary: Add attribute (to user flow)
description: 'Add an attribute to an external identities self-service sign up user flow that''s represented by an externalUsersSelfServiceSignupEventsFlow object. You can add both custom and built-in attributes to a user flow. The attribute is added to both the attributeCollection> attributes and attributeCollection> attributeCollectionPage > views collections on the user flow. In the views collection, the attribute is assigned the default settings. You can PATCH the user flow to customize the settings of the attribute on the views object, for example, marking it as required or updating the allowed input types.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/onattributecollectionexternalusersselfservicesignup-post-attributes?view=graph-rest-1.0
operationId: identity.authenticationEventsFlowAsOnGraphAPretributeCollectionExternalUsersSelfServiceSignUp_CreateGraphAPretributeGraphBPreRef
parameters:
- name: authenticationEventsFlow-id
in: path
description: The unique identifier of authenticationEventsFlow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: authenticationEventsFlow
requestBody:
$ref: '#/components/requestBodies/refPostBody'
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identity.authenticationEventsFlow
summary: Delete ref of navigation property attributes for identity
operationId: identity.authenticationEventsFlowAsOnGraphAPretributeCollectionExternalUsersSelfServiceSignUp_DeleteGraphAPretributeGraphBPreRef
parameters:
- name: authenticationEventsFlow-id
in: path
description: The unique identifier of authenticationEventsFlow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: authenticationEventsFlow
- 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
'/identity/authenticationEventsFlows/{authenticationEventsFlow-id}/microsoft.graph.externalUsersSelfServiceSignUpEventsFlow/onAuthenticationMethodLoadStart':
get:
tags:
- identity.authenticationEventsFlow
summary: Get onAuthenticationMethodLoadStart property value
description: Required. The configuration for what to invoke when authentication methods are ready to be presented to the user. Must have at least one identity provider linked. Supports $filter (eq). See support for filtering on user flows for syntax information.
operationId: identity.authenticationEventsFlowAsExternalUsersSelfServiceSignUpEventsFlow_GetOnAuthenticationMethodLoadStart
parameters:
- name: authenticationEventsFlow-id
in: path
description: The unique identifier of authenticationEventsFlow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: authenticationEventsFlow
- 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.onAuthenticationMethodLoadStartHandler'
default:
$ref: '#/components/responses/error'
'/identity/authenticationEventsFlows/{authenticationEventsFlow-id}/microsoft.graph.externalUsersSelfServiceSignUpEventsFlow/onAuthenticationMethodLoadStart/microsoft.graph.onAuthenticationMethodLoadStartExternalUsersSelfServiceSignUp':
get:
tags:
- identity.authenticationEventsFlow
summary: Get the item of type microsoft.graph.onAuthenticationMethodLoadStartHandler as microsoft.graph.onAuthenticationMethodLoadStartExternalUsersSelfServiceSignUp
operationId: identity.authenticationEventsFlow_GetOnAuthenticationMethodLoadStartAsOnAuthenticationMethodLoadStartExternalUsersSelfServiceSignUp
parameters:
- name: authenticationEventsFlow-id
in: path
description: The unique identifier of authenticationEventsFlow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: authenticationEventsFlow
responses:
2XX:
description: Entity result.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.onAuthenticationMethodLoadStartExternalUsersSelfServiceSignUp'
default:
$ref: '#/components/responses/error'
'/identity/authenticationEventsFlows/{authenticationEventsFlow-id}/microsoft.graph.externalUsersSelfServiceSignUpEventsFlow/onAuthenticationMethodLoadStart/microsoft.graph.onAuthenticationMethodLoadStartExternalUsersSelfServiceSignUp/identityProviders':
get:
tags:
- identity.authenticationEventsFlow
summary: List identityProviders (in a user flow)
description: Get the identity providers that are defined for an external identities self-service sign up user flow that's represented by an externalUsersSelfServiceSignupEventsFlow object type.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/onauthenticationmethodloadstartexternalusersselfservicesignup-list-identityproviders?view=graph-rest-1.0
operationId: identity.authenticationEventsFlowAsOnAuthenticationMethodLoadStartExternalUsersSelfServiceSignUp_ListIdentityProvider
parameters:
- name: authenticationEventsFlow-id
in: path
description: The unique identifier of authenticationEventsFlow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: authenticationEventsFlow
- $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.identityProviderBaseCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
'/identity/authenticationEventsFlows/{authenticationEventsFlow-id}/microsoft.graph.externalUsersSelfServiceSignUpEventsFlow/onAuthenticationMethodLoadStart/microsoft.graph.onAuthenticationMethodLoadStartExternalUsersSelfServiceSignUp/identityProviders/{identityProviderBase-id}/$ref':
delete:
tags:
- identity.authenticationEventsFlow
summary: Delete ref of navigation property identityProviders for identity
operationId: identity.authenticationEventsFlowAsOnAuthenticationMethodLoadStartExternalUsersSelfServiceSignUp.identityProvider_DeleteIdentityProviderBaseGraphBPreRef
parameters:
- name: authenticationEventsFlow-id
in: path
description: The unique identifier of authenticationEventsFlow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: authenticationEventsFlow
- name: identityProviderBase-id
in: path
description: The unique identifier of identityProviderBase
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: identityProviderBase
- 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
'/identity/authenticationEventsFlows/{authenticationEventsFlow-id}/microsoft.graph.externalUsersSelfServiceSignUpEventsFlow/onAuthenticationMethodLoadStart/microsoft.graph.onAuthenticationMethodLoadStartExternalUsersSelfServiceSignUp/identityProviders/$count':
get:
tags:
- identity.authenticationEventsFlow
summary: Get the number of the resource
operationId: identity.authenticationEventsFlowAsOnAuthenticationMethodLoadStartExternalUsersSelfServiceSignUp.identityProvider_GetCount
parameters:
- name: authenticationEventsFlow-id
in: path
description: The unique identifier of authenticationEventsFlow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: authenticationEventsFlow
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identity/authenticationEventsFlows/{authenticationEventsFlow-id}/microsoft.graph.externalUsersSelfServiceSignUpEventsFlow/onAuthenticationMethodLoadStart/microsoft.graph.onAuthenticationMethodLoadStartExternalUsersSelfServiceSignUp/identityProviders/$ref':
get:
tags:
- identity.authenticationEventsFlow
summary: List identityProviders (in a user flow)
description: Get the identity providers that are defined for an external identities self-service sign up user flow that's represented by an externalUsersSelfServiceSignupEventsFlow object type.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/onauthenticationmethodloadstartexternalusersselfservicesignup-list-identityproviders?view=graph-rest-1.0
operationId: identity.authenticationEventsFlowAsOnAuthenticationMethodLoadStartExternalUsersSelfServiceSignUp_ListIdentityProviderGraphBPreRef
parameters:
- name: authenticationEventsFlow-id
in: path
description: The unique identifier of authenticationEventsFlow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: authenticationEventsFlow
- $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:
- identity.authenticationEventsFlow
summary: Add identityProvider (to a user flow)
description: Add an identity provider to an external identities self-service user flow represented by an externalUsersSelfServiceSignupEventsFlow object type. The identity provider must first be configured in the tenant.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/onauthenticationmethodloadstartexternalusersselfservicesignup-post-identityproviders?view=graph-rest-1.0
operationId: identity.authenticationEventsFlowAsOnAuthenticationMethodLoadStartExternalUsersSelfServiceSignUp_CreateIdentityProviderGraphBPreRef
parameters:
- name: authenticationEventsFlow-id
in: path
description: The unique identifier of authenticationEventsFlow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: authenticationEventsFlow
requestBody:
$ref: '#/components/requestBodies/refPostBody'
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identity.authenticationEventsFlow
summary: Delete ref of navigation property identityProviders for identity
operationId: identity.authenticationEventsFlowAsOnAuthenticationMethodLoadStartExternalUsersSelfServiceSignUp_DeleteIdentityProviderGraphBPreRef
parameters:
- name: authenticationEventsFlow-id
in: path
description: The unique identifier of authenticationEventsFlow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: authenticationEventsFlow
- 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
/identity/authenticationEventsFlows/$count:
get:
tags:
- identity.authenticationEventsFlow
summary: Get the number of the resource
operationId: identity.authenticationEventsFlow_GetCount
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
/identity/authenticationEventsFlows/microsoft.graph.externalUsersSelfServiceSignUpEventsFlow:
get:
tags:
- identity.authenticationEventsFlow
summary: Get the items of type microsoft.graph.externalUsersSelfServiceSignUpEventsFlow in the microsoft.graph.authenticationEventsFlow collection
operationId: identity_ListAuthenticationEventsFlowAsExternalUsersSelfServiceSignUpEventsFlow
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.externalUsersSelfServiceSignUpEventsFlowCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
/identity/authenticationEventsFlows/microsoft.graph.externalUsersSelfServiceSignUpEventsFlow/$count:
get:
tags:
- identity.authenticationEventsFlow
summary: Get the number of the resource
operationId: identity.AuthenticationEventsFlow_GetCountAsExternalUsersSelfServiceSignUpEventsFlow
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
/identity/b2xUserFlows:
get:
tags:
- identity.b2xIdentityUserFlow
summary: List b2xIdentityUserFlows
description: Retrieve a list of b2xIdentityUserFlow objects.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/identitycontainer-list-b2xuserflows?view=graph-rest-1.0
operationId: identity_ListB2xUserFlow
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.b2xIdentityUserFlowCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identity.b2xIdentityUserFlow
summary: Create b2xIdentityUserFlow
description: Create a new b2xIdentityUserFlow object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/identitycontainer-post-b2xuserflows?view=graph-rest-1.0
operationId: identity_CreateB2xUserFlow
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.b2xIdentityUserFlow'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.b2xIdentityUserFlow'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identity/b2xUserFlows/{b2xIdentityUserFlow-id}':
get:
tags:
- identity.b2xIdentityUserFlow
summary: Get b2xIdentityUserFlow
description: Retrieve the properties and relationships of a b2xIdentityUserFlow object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/b2xidentityuserflow-get?view=graph-rest-1.0
operationId: identity_GetB2xUserFlow
parameters:
- name: b2xIdentityUserFlow-id
in: path
description: The unique identifier of b2xIdentityUserFlow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: b2xIdentityUserFlow
- 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.b2xIdentityUserFlow'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identity.b2xIdentityUserFlow
summary: Update the navigation property b2xUserFlows in identity
operationId: identity_UpdateB2xUserFlow
parameters:
- name: b2xIdentityUserFlow-id
in: path
description: The unique identifier of b2xIdentityUserFlow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: b2xIdentityUserFlow
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.b2xIdentityUserFlow'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.b2xIdentityUserFlow'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identity.b2xIdentityUserFlow
summary: Delete b2xIdentityUserFlow
description: Delete a b2xIdentityUserFlow object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/b2xidentityuserflow-delete?view=graph-rest-1.0
operationId: identity_DeleteB2xUserFlow
parameters:
- name: b2xIdentityUserFlow-id
in: path
description: The unique identifier of b2xIdentityUserFlow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: b2xIdentityUserFlow
- 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
'/identity/b2xUserFlows/{b2xIdentityUserFlow-id}/apiConnectorConfiguration':
get:
tags:
- identity.b2xIdentityUserFlow
summary: Get userFlowApiConnectorConfiguration
description: Get the apiConnectorConfiguration property in a b2xIdentityUserFlow to detail the API connectors enabled for the user flow.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/b2xidentityuserflow-get-apiconnectorconfiguration?view=graph-rest-1.0
operationId: identity.b2xUserFlow_GetApiConnectorConfiguration
parameters:
- name: b2xIdentityUserFlow-id
in: path
description: The unique identifier of b2xIdentityUserFlow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: b2xIdentityUserFlow
- 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.userFlowApiConnectorConfiguration'
default:
$ref: '#/components/responses/error'
'/identity/b2xUserFlows/{b2xIdentityUserFlow-id}/apiConnectorConfiguration/postAttributeCollection':
get:
tags:
- identity.b2xIdentityUserFlow
summary: Get postAttributeCollection from identity
operationId: identity.b2xUserFlow_GetPostAttributeCollection
parameters:
- name: b2xIdentityUserFlow-id
in: path
description: The unique identifier of b2xIdentityUserFlow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: b2xIdentityUserFlow
- 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.identityApiConnector'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identity.b2xIdentityUserFlow
summary: Update the navigation property postAttributeCollection in identity
operationId: identity.b2xUserFlow_UpdatePostAttributeCollection
parameters:
- name: b2xIdentityUserFlow-id
in: path
description: The unique identifier of b2xIdentityUserFlow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: b2xIdentityUserFlow
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.identityApiConnector'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.identityApiConnector'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identity.b2xIdentityUserFlow
summary: Delete navigation property postAttributeCollection for identity
operationId: identity.b2xUserFlow_DeletePostAttributeCollection
parameters:
- name: b2xIdentityUserFlow-id
in: path
description: The unique identifier of b2xIdentityUserFlow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: b2xIdentityUserFlow
- 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
'/identity/b2xUserFlows/{b2xIdentityUserFlow-id}/apiConnectorConfiguration/postAttributeCollection/$ref':
get:
tags:
- identity.b2xIdentityUserFlow
summary: Get ref of postAttributeCollection from identity
operationId: identity.b2xUserFlow_GetPostGraphAPretributeCollectionGraphBPreRef
parameters:
- name: b2xIdentityUserFlow-id
in: path
description: The unique identifier of b2xIdentityUserFlow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: b2xIdentityUserFlow
responses:
2XX:
description: Retrieved navigation property link
content:
application/json:
schema:
type: string
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
put:
tags:
- identity.b2xIdentityUserFlow
summary: Update the ref of navigation property postAttributeCollection in identity
operationId: identity.b2xUserFlow_SetPostGraphAPretributeCollectionGraphBPreRef
parameters:
- name: b2xIdentityUserFlow-id
in: path
description: The unique identifier of b2xIdentityUserFlow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: b2xIdentityUserFlow
requestBody:
$ref: '#/components/requestBodies/refPutBody'
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identity.b2xIdentityUserFlow
summary: Delete ref of navigation property postAttributeCollection for identity
operationId: identity.b2xUserFlow_DeletePostGraphAPretributeCollectionGraphBPreRef
parameters:
- name: b2xIdentityUserFlow-id
in: path
description: The unique identifier of b2xIdentityUserFlow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: b2xIdentityUserFlow
- 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
'/identity/b2xUserFlows/{b2xIdentityUserFlow-id}/apiConnectorConfiguration/postAttributeCollection/microsoft.graph.uploadClientCertificate':
post:
tags:
- identity.b2xIdentityUserFlow
summary: Invoke action uploadClientCertificate
description: Upload a PKCS 12 format key (.pfx) to an API connector's authentication configuration. The input is a base-64 encoded value of the PKCS 12 certificate contents. This method returns an apiConnector.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/identityapiconnector-uploadclientcertificate?view=graph-rest-1.0
operationId: identity.b2xUserFlow.apiConnectorConfiguration.postAttributeCollection_uploadClientCertificate
parameters:
- name: b2xIdentityUserFlow-id
in: path
description: The unique identifier of b2xIdentityUserFlow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: b2xIdentityUserFlow
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
pkcs12Value:
type: string
nullable: true
password:
type: string
nullable: true
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.identityApiConnector'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/identity/b2xUserFlows/{b2xIdentityUserFlow-id}/apiConnectorConfiguration/postFederationSignup':
get:
tags:
- identity.b2xIdentityUserFlow
summary: Get postFederationSignup from identity
operationId: identity.b2xUserFlow_GetPostFederationSignup
parameters:
- name: b2xIdentityUserFlow-id
in: path
description: The unique identifier of b2xIdentityUserFlow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: b2xIdentityUserFlow
- 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.identityApiConnector'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identity.b2xIdentityUserFlow
summary: Update the navigation property postFederationSignup in identity
operationId: identity.b2xUserFlow_UpdatePostFederationSignup
parameters:
- name: b2xIdentityUserFlow-id
in: path
description: The unique identifier of b2xIdentityUserFlow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: b2xIdentityUserFlow
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.identityApiConnector'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.identityApiConnector'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identity.b2xIdentityUserFlow
summary: Delete navigation property postFederationSignup for identity
operationId: identity.b2xUserFlow_DeletePostFederationSignup
parameters:
- name: b2xIdentityUserFlow-id
in: path
description: The unique identifier of b2xIdentityUserFlow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: b2xIdentityUserFlow
- 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
'/identity/b2xUserFlows/{b2xIdentityUserFlow-id}/apiConnectorConfiguration/postFederationSignup/$ref':
get:
tags:
- identity.b2xIdentityUserFlow
summary: Get ref of postFederationSignup from identity
operationId: identity.b2xUserFlow_GetPostFederationSignupGraphBPreRef
parameters:
- name: b2xIdentityUserFlow-id
in: path
description: The unique identifier of b2xIdentityUserFlow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: b2xIdentityUserFlow
responses:
2XX:
description: Retrieved navigation property link
content:
application/json:
schema:
type: string
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
put:
tags:
- identity.b2xIdentityUserFlow
summary: Update the ref of navigation property postFederationSignup in identity
operationId: identity.b2xUserFlow_SetPostFederationSignupGraphBPreRef
parameters:
- name: b2xIdentityUserFlow-id
in: path
description: The unique identifier of b2xIdentityUserFlow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: b2xIdentityUserFlow
requestBody:
$ref: '#/components/requestBodies/refPutBody'
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identity.b2xIdentityUserFlow
summary: Delete ref of navigation property postFederationSignup for identity
operationId: identity.b2xUserFlow_DeletePostFederationSignupGraphBPreRef
parameters:
- name: b2xIdentityUserFlow-id
in: path
description: The unique identifier of b2xIdentityUserFlow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: b2xIdentityUserFlow
- 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
'/identity/b2xUserFlows/{b2xIdentityUserFlow-id}/apiConnectorConfiguration/postFederationSignup/microsoft.graph.uploadClientCertificate':
post:
tags:
- identity.b2xIdentityUserFlow
summary: Invoke action uploadClientCertificate
description: Upload a PKCS 12 format key (.pfx) to an API connector's authentication configuration. The input is a base-64 encoded value of the PKCS 12 certificate contents. This method returns an apiConnector.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/identityapiconnector-uploadclientcertificate?view=graph-rest-1.0
operationId: identity.b2xUserFlow.apiConnectorConfiguration.postFederationSignup_uploadClientCertificate
parameters:
- name: b2xIdentityUserFlow-id
in: path
description: The unique identifier of b2xIdentityUserFlow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: b2xIdentityUserFlow
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
pkcs12Value:
type: string
nullable: true
password:
type: string
nullable: true
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.identityApiConnector'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/identity/b2xUserFlows/{b2xIdentityUserFlow-id}/identityProviders':
get:
tags:
- identity.b2xIdentityUserFlow
summary: List identityProviders
description: Get the identity providers in a b2xIdentityUserFlow object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/b2xidentityuserflow-list-identityproviders?view=graph-rest-1.0
operationId: identity.b2xUserFlow_ListIdentityProvider
parameters:
- name: b2xIdentityUserFlow-id
in: path
description: The unique identifier of b2xIdentityUserFlow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: b2xIdentityUserFlow
- $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.identityProviderCollectionResponse'
default:
$ref: '#/components/responses/error'
deprecated: true
x-ms-deprecation:
removalDate: '2023-03-15'
date: '2021-08-24'
version: 2021-05/identityProvider
description: The identityProvider API is deprecated and will stop returning data on March 2023. Please use the new identityProviderBase API.
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
'/identity/b2xUserFlows/{b2xIdentityUserFlow-id}/identityProviders/{identityProvider-id}':
get:
tags:
- identity.b2xIdentityUserFlow
summary: Get identityProviders from identity
description: The identity providers included in the user flow.
operationId: identity.b2xUserFlow_GetIdentityProvider
parameters:
- name: b2xIdentityUserFlow-id
in: path
description: The unique identifier of b2xIdentityUserFlow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: b2xIdentityUserFlow
- name: identityProvider-id
in: path
description: The unique identifier of identityProvider
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: identityProvider
- 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.identityProvider'
default:
$ref: '#/components/responses/error'
deprecated: true
x-ms-deprecation:
removalDate: '2023-03-15'
date: '2021-08-24'
version: 2021-05/identityProvider
description: The identityProvider API is deprecated and will stop returning data on March 2023. Please use the new identityProviderBase API.
x-ms-docs-operation-type: operation
'/identity/b2xUserFlows/{b2xIdentityUserFlow-id}/identityProviders/$count':
get:
tags:
- identity.b2xIdentityUserFlow
summary: Get the number of the resource
operationId: identity.b2xUserFlow.identityProvider_GetCount
parameters:
- name: b2xIdentityUserFlow-id
in: path
description: The unique identifier of b2xIdentityUserFlow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: b2xIdentityUserFlow
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
deprecated: true
x-ms-deprecation:
removalDate: '2023-03-15'
date: '2021-08-24'
version: 2021-05/identityProvider
description: The identityProvider API is deprecated and will stop returning data on March 2023. Please use the new identityProviderBase API.
'/identity/b2xUserFlows/{b2xIdentityUserFlow-id}/languages':
get:
tags:
- identity.b2xIdentityUserFlow
summary: List languages
description: Retrieve a list of languages supported for customization in a B2X user flow.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/b2xidentityuserflow-list-languages?view=graph-rest-1.0
operationId: identity.b2xUserFlow_ListLanguage
parameters:
- name: b2xIdentityUserFlow-id
in: path
description: The unique identifier of b2xIdentityUserFlow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: b2xIdentityUserFlow
- $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.userFlowLanguageConfigurationCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identity.b2xIdentityUserFlow
summary: Create new navigation property to languages for identity
operationId: identity.b2xUserFlow_CreateLanguage
parameters:
- name: b2xIdentityUserFlow-id
in: path
description: The unique identifier of b2xIdentityUserFlow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: b2xIdentityUserFlow
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.userFlowLanguageConfiguration'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.userFlowLanguageConfiguration'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identity/b2xUserFlows/{b2xIdentityUserFlow-id}/languages/{userFlowLanguageConfiguration-id}':
get:
tags:
- identity.b2xIdentityUserFlow
summary: Get userFlowLanguageConfiguration
description: 'Read the properties and relationships of a userFlowLanguageConfiguration object. These objects represent a language available in a user flow. Note: Language customization is enabled by default in Microsoft Entra user flows.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/userflowlanguageconfiguration-get?view=graph-rest-1.0
operationId: identity.b2xUserFlow_GetLanguage
parameters:
- name: b2xIdentityUserFlow-id
in: path
description: The unique identifier of b2xIdentityUserFlow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: b2xIdentityUserFlow
- name: userFlowLanguageConfiguration-id
in: path
description: The unique identifier of userFlowLanguageConfiguration
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: userFlowLanguageConfiguration
- 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.userFlowLanguageConfiguration'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identity.b2xIdentityUserFlow
summary: Update the navigation property languages in identity
operationId: identity.b2xUserFlow_UpdateLanguage
parameters:
- name: b2xIdentityUserFlow-id
in: path
description: The unique identifier of b2xIdentityUserFlow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: b2xIdentityUserFlow
- name: userFlowLanguageConfiguration-id
in: path
description: The unique identifier of userFlowLanguageConfiguration
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: userFlowLanguageConfiguration
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.userFlowLanguageConfiguration'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.userFlowLanguageConfiguration'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identity.b2xIdentityUserFlow
summary: Delete navigation property languages for identity
operationId: identity.b2xUserFlow_DeleteLanguage
parameters:
- name: b2xIdentityUserFlow-id
in: path
description: The unique identifier of b2xIdentityUserFlow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: b2xIdentityUserFlow
- name: userFlowLanguageConfiguration-id
in: path
description: The unique identifier of userFlowLanguageConfiguration
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: userFlowLanguageConfiguration
- 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
'/identity/b2xUserFlows/{b2xIdentityUserFlow-id}/languages/{userFlowLanguageConfiguration-id}/defaultPages':
get:
tags:
- identity.b2xIdentityUserFlow
summary: Get userFlowLanguagePage
description: Read the values in a userFlowLanguagePage object for a language in a user flow. These values are shown to a user during a user journey defined by a user flow.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/userflowlanguagepage-get?view=graph-rest-1.0
operationId: identity.b2xUserFlow.language_ListDefaultPage
parameters:
- name: b2xIdentityUserFlow-id
in: path
description: The unique identifier of b2xIdentityUserFlow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: b2xIdentityUserFlow
- name: userFlowLanguageConfiguration-id
in: path
description: The unique identifier of userFlowLanguageConfiguration
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: userFlowLanguageConfiguration
- $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.userFlowLanguagePageCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identity.b2xIdentityUserFlow
summary: Create new navigation property to defaultPages for identity
operationId: identity.b2xUserFlow.language_CreateDefaultPage
parameters:
- name: b2xIdentityUserFlow-id
in: path
description: The unique identifier of b2xIdentityUserFlow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: b2xIdentityUserFlow
- name: userFlowLanguageConfiguration-id
in: path
description: The unique identifier of userFlowLanguageConfiguration
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: userFlowLanguageConfiguration
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.userFlowLanguagePage'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.userFlowLanguagePage'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identity/b2xUserFlows/{b2xIdentityUserFlow-id}/languages/{userFlowLanguageConfiguration-id}/defaultPages/{userFlowLanguagePage-id}':
get:
tags:
- identity.b2xIdentityUserFlow
summary: Get defaultPages from identity
description: Collection of pages with the default content to display in a user flow for a specified language. This collection doesn't allow any kind of modification.
operationId: identity.b2xUserFlow.language_GetDefaultPage
parameters:
- name: b2xIdentityUserFlow-id
in: path
description: The unique identifier of b2xIdentityUserFlow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: b2xIdentityUserFlow
- name: userFlowLanguageConfiguration-id
in: path
description: The unique identifier of userFlowLanguageConfiguration
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: userFlowLanguageConfiguration
- name: userFlowLanguagePage-id
in: path
description: The unique identifier of userFlowLanguagePage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: userFlowLanguagePage
- 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.userFlowLanguagePage'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identity.b2xIdentityUserFlow
summary: Update the navigation property defaultPages in identity
operationId: identity.b2xUserFlow.language_UpdateDefaultPage
parameters:
- name: b2xIdentityUserFlow-id
in: path
description: The unique identifier of b2xIdentityUserFlow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: b2xIdentityUserFlow
- name: userFlowLanguageConfiguration-id
in: path
description: The unique identifier of userFlowLanguageConfiguration
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: userFlowLanguageConfiguration
- name: userFlowLanguagePage-id
in: path
description: The unique identifier of userFlowLanguagePage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: userFlowLanguagePage
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.userFlowLanguagePage'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.userFlowLanguagePage'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identity.b2xIdentityUserFlow
summary: Delete navigation property defaultPages for identity
operationId: identity.b2xUserFlow.language_DeleteDefaultPage
parameters:
- name: b2xIdentityUserFlow-id
in: path
description: The unique identifier of b2xIdentityUserFlow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: b2xIdentityUserFlow
- name: userFlowLanguageConfiguration-id
in: path
description: The unique identifier of userFlowLanguageConfiguration
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: userFlowLanguageConfiguration
- name: userFlowLanguagePage-id
in: path
description: The unique identifier of userFlowLanguagePage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: userFlowLanguagePage
- 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
'/identity/b2xUserFlows/{b2xIdentityUserFlow-id}/languages/{userFlowLanguageConfiguration-id}/defaultPages/{userFlowLanguagePage-id}/$value':
get:
tags:
- identity.b2xIdentityUserFlow
summary: Get userFlowLanguagePage
description: Read the values in a userFlowLanguagePage object for a language in a user flow. These values are shown to a user during a user journey defined by a user flow.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/userflowlanguagepage-get?view=graph-rest-1.0
operationId: identity.b2xUserFlow.language_GetDefaultPagesContent
parameters:
- name: b2xIdentityUserFlow-id
in: path
description: The unique identifier of b2xIdentityUserFlow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: b2xIdentityUserFlow
- name: userFlowLanguageConfiguration-id
in: path
description: The unique identifier of userFlowLanguageConfiguration
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: userFlowLanguageConfiguration
- name: userFlowLanguagePage-id
in: path
description: The unique identifier of userFlowLanguagePage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: userFlowLanguagePage
responses:
2XX:
description: Retrieved media content
content:
application/octet-stream:
schema:
type: string
format: binary
default:
$ref: '#/components/responses/error'
put:
tags:
- identity.b2xIdentityUserFlow
summary: Update media content for the navigation property defaultPages in identity
description: The unique identifier for an entity. Read-only.
operationId: identity.b2xUserFlow.language_SetDefaultPagesContent
parameters:
- name: b2xIdentityUserFlow-id
in: path
description: The unique identifier of b2xIdentityUserFlow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: b2xIdentityUserFlow
- name: userFlowLanguageConfiguration-id
in: path
description: The unique identifier of userFlowLanguageConfiguration
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: userFlowLanguageConfiguration
- name: userFlowLanguagePage-id
in: path
description: The unique identifier of userFlowLanguagePage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: userFlowLanguagePage
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:
- identity.b2xIdentityUserFlow
summary: Delete media content for the navigation property defaultPages in identity
description: The unique identifier for an entity. Read-only.
operationId: identity.b2xUserFlow.language_DeleteDefaultPagesContent
parameters:
- name: b2xIdentityUserFlow-id
in: path
description: The unique identifier of b2xIdentityUserFlow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: b2xIdentityUserFlow
- name: userFlowLanguageConfiguration-id
in: path
description: The unique identifier of userFlowLanguageConfiguration
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: userFlowLanguageConfiguration
- name: userFlowLanguagePage-id
in: path
description: The unique identifier of userFlowLanguagePage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: userFlowLanguagePage
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
'/identity/b2xUserFlows/{b2xIdentityUserFlow-id}/languages/{userFlowLanguageConfiguration-id}/defaultPages/$count':
get:
tags:
- identity.b2xIdentityUserFlow
summary: Get the number of the resource
operationId: identity.b2xUserFlow.language.defaultPage_GetCount
parameters:
- name: b2xIdentityUserFlow-id
in: path
description: The unique identifier of b2xIdentityUserFlow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: b2xIdentityUserFlow
- name: userFlowLanguageConfiguration-id
in: path
description: The unique identifier of userFlowLanguageConfiguration
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: userFlowLanguageConfiguration
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identity/b2xUserFlows/{b2xIdentityUserFlow-id}/languages/{userFlowLanguageConfiguration-id}/overridesPages':
get:
tags:
- identity.b2xIdentityUserFlow
summary: List overridesPages
description: Get the userFlowLanguagePage resources from the overridesPages navigation property. These pages are used to customize the values shown to the user during a user journey in a user flow.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/userflowlanguageconfiguration-list-overridespages?view=graph-rest-1.0
operationId: identity.b2xUserFlow.language_ListOverridesPage
parameters:
- name: b2xIdentityUserFlow-id
in: path
description: The unique identifier of b2xIdentityUserFlow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: b2xIdentityUserFlow
- name: userFlowLanguageConfiguration-id
in: path
description: The unique identifier of userFlowLanguageConfiguration
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: userFlowLanguageConfiguration
- $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.userFlowLanguagePageCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identity.b2xIdentityUserFlow
summary: Create new navigation property to overridesPages for identity
operationId: identity.b2xUserFlow.language_CreateOverridesPage
parameters:
- name: b2xIdentityUserFlow-id
in: path
description: The unique identifier of b2xIdentityUserFlow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: b2xIdentityUserFlow
- name: userFlowLanguageConfiguration-id
in: path
description: The unique identifier of userFlowLanguageConfiguration
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: userFlowLanguageConfiguration
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.userFlowLanguagePage'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.userFlowLanguagePage'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identity/b2xUserFlows/{b2xIdentityUserFlow-id}/languages/{userFlowLanguageConfiguration-id}/overridesPages/{userFlowLanguagePage-id}':
get:
tags:
- identity.b2xIdentityUserFlow
summary: Get overridesPages from identity
description: 'Collection of pages with the overrides messages to display in a user flow for a specified language. This collection only allows you to modify the content of the page, any other modification isn''t allowed (creation or deletion of pages).'
operationId: identity.b2xUserFlow.language_GetOverridesPage
parameters:
- name: b2xIdentityUserFlow-id
in: path
description: The unique identifier of b2xIdentityUserFlow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: b2xIdentityUserFlow
- name: userFlowLanguageConfiguration-id
in: path
description: The unique identifier of userFlowLanguageConfiguration
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: userFlowLanguageConfiguration
- name: userFlowLanguagePage-id
in: path
description: The unique identifier of userFlowLanguagePage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: userFlowLanguagePage
- 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.userFlowLanguagePage'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identity.b2xIdentityUserFlow
summary: Update userFlowLanguagePage
description: 'Update the values in an userFlowLanguagePage object. You may only update the values in an overridesPage, which is used to customize the values shown to a user during a user journey defined by a user flow.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/userflowlanguagepage-put?view=graph-rest-1.0
operationId: identity.b2xUserFlow.language_UpdateOverridesPage
parameters:
- name: b2xIdentityUserFlow-id
in: path
description: The unique identifier of b2xIdentityUserFlow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: b2xIdentityUserFlow
- name: userFlowLanguageConfiguration-id
in: path
description: The unique identifier of userFlowLanguageConfiguration
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: userFlowLanguageConfiguration
- name: userFlowLanguagePage-id
in: path
description: The unique identifier of userFlowLanguagePage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: userFlowLanguagePage
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.userFlowLanguagePage'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.userFlowLanguagePage'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identity.b2xIdentityUserFlow
summary: Delete userFlowLanguagePage
description: 'Deletes the values in an userFlowLanguagePage object. You may only delete the values in an overridesPage, which is used to customize the values shown to a user during a user journey defined by a user flow.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/userflowlanguagepage-delete?view=graph-rest-1.0
operationId: identity.b2xUserFlow.language_DeleteOverridesPage
parameters:
- name: b2xIdentityUserFlow-id
in: path
description: The unique identifier of b2xIdentityUserFlow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: b2xIdentityUserFlow
- name: userFlowLanguageConfiguration-id
in: path
description: The unique identifier of userFlowLanguageConfiguration
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: userFlowLanguageConfiguration
- name: userFlowLanguagePage-id
in: path
description: The unique identifier of userFlowLanguagePage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: userFlowLanguagePage
- 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
'/identity/b2xUserFlows/{b2xIdentityUserFlow-id}/languages/{userFlowLanguageConfiguration-id}/overridesPages/{userFlowLanguagePage-id}/$value':
get:
tags:
- identity.b2xIdentityUserFlow
summary: List overridesPages
description: Get the userFlowLanguagePage resources from the overridesPages navigation property. These pages are used to customize the values shown to the user during a user journey in a user flow.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/userflowlanguageconfiguration-list-overridespages?view=graph-rest-1.0
operationId: identity.b2xUserFlow.language_GetOverridesPagesContent
parameters:
- name: b2xIdentityUserFlow-id
in: path
description: The unique identifier of b2xIdentityUserFlow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: b2xIdentityUserFlow
- name: userFlowLanguageConfiguration-id
in: path
description: The unique identifier of userFlowLanguageConfiguration
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: userFlowLanguageConfiguration
- name: userFlowLanguagePage-id
in: path
description: The unique identifier of userFlowLanguagePage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: userFlowLanguagePage
responses:
2XX:
description: Retrieved media content
content:
application/octet-stream:
schema:
type: string
format: binary
default:
$ref: '#/components/responses/error'
put:
tags:
- identity.b2xIdentityUserFlow
summary: Update userFlowLanguagePage
description: 'Update the values in an userFlowLanguagePage object. You may only update the values in an overridesPage, which is used to customize the values shown to a user during a user journey defined by a user flow.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/userflowlanguagepage-put?view=graph-rest-1.0
operationId: identity.b2xUserFlow.language_SetOverridesPagesContent
parameters:
- name: b2xIdentityUserFlow-id
in: path
description: The unique identifier of b2xIdentityUserFlow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: b2xIdentityUserFlow
- name: userFlowLanguageConfiguration-id
in: path
description: The unique identifier of userFlowLanguageConfiguration
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: userFlowLanguageConfiguration
- name: userFlowLanguagePage-id
in: path
description: The unique identifier of userFlowLanguagePage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: userFlowLanguagePage
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:
- identity.b2xIdentityUserFlow
summary: Delete userFlowLanguagePage
description: 'Deletes the values in an userFlowLanguagePage object. You may only delete the values in an overridesPage, which is used to customize the values shown to a user during a user journey defined by a user flow.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/userflowlanguagepage-delete?view=graph-rest-1.0
operationId: identity.b2xUserFlow.language_DeleteOverridesPagesContent
parameters:
- name: b2xIdentityUserFlow-id
in: path
description: The unique identifier of b2xIdentityUserFlow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: b2xIdentityUserFlow
- name: userFlowLanguageConfiguration-id
in: path
description: The unique identifier of userFlowLanguageConfiguration
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: userFlowLanguageConfiguration
- name: userFlowLanguagePage-id
in: path
description: The unique identifier of userFlowLanguagePage
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: userFlowLanguagePage
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
'/identity/b2xUserFlows/{b2xIdentityUserFlow-id}/languages/{userFlowLanguageConfiguration-id}/overridesPages/$count':
get:
tags:
- identity.b2xIdentityUserFlow
summary: Get the number of the resource
operationId: identity.b2xUserFlow.language.overridesPage_GetCount
parameters:
- name: b2xIdentityUserFlow-id
in: path
description: The unique identifier of b2xIdentityUserFlow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: b2xIdentityUserFlow
- name: userFlowLanguageConfiguration-id
in: path
description: The unique identifier of userFlowLanguageConfiguration
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: userFlowLanguageConfiguration
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identity/b2xUserFlows/{b2xIdentityUserFlow-id}/languages/$count':
get:
tags:
- identity.b2xIdentityUserFlow
summary: Get the number of the resource
operationId: identity.b2xUserFlow.language_GetCount
parameters:
- name: b2xIdentityUserFlow-id
in: path
description: The unique identifier of b2xIdentityUserFlow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: b2xIdentityUserFlow
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identity/b2xUserFlows/{b2xIdentityUserFlow-id}/userAttributeAssignments':
get:
tags:
- identity.b2xIdentityUserFlow
summary: List userAttributeAssignments
description: Get the identityUserFlowAttributeAssignment resources from the userAttributeAssignments navigation property in a b2xIdentityUserFlow.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/b2xidentityuserflow-list-userattributeassignments?view=graph-rest-1.0
operationId: identity.b2xUserFlow_ListUserAttributeAssignment
parameters:
- name: b2xIdentityUserFlow-id
in: path
description: The unique identifier of b2xIdentityUserFlow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: b2xIdentityUserFlow
- $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.identityUserFlowAttributeAssignmentCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identity.b2xIdentityUserFlow
summary: Create userAttributeAssignments
description: Create a new identityUserFlowAttributeAssignment object in a b2xIdentityUserFlow.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/b2xidentityuserflow-post-userattributeassignments?view=graph-rest-1.0
operationId: identity.b2xUserFlow_CreateUserAttributeAssignment
parameters:
- name: b2xIdentityUserFlow-id
in: path
description: The unique identifier of b2xIdentityUserFlow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: b2xIdentityUserFlow
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.identityUserFlowAttributeAssignment'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.identityUserFlowAttributeAssignment'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identity/b2xUserFlows/{b2xIdentityUserFlow-id}/userAttributeAssignments/{identityUserFlowAttributeAssignment-id}':
get:
tags:
- identity.b2xIdentityUserFlow
summary: Get identityUserFlowAttributeAssignment
description: Read the properties and relationships of an identityUserFlowAttributeAssignment object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/identityuserflowattributeassignment-get?view=graph-rest-1.0
operationId: identity.b2xUserFlow_GetUserAttributeAssignment
parameters:
- name: b2xIdentityUserFlow-id
in: path
description: The unique identifier of b2xIdentityUserFlow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: b2xIdentityUserFlow
- name: identityUserFlowAttributeAssignment-id
in: path
description: The unique identifier of identityUserFlowAttributeAssignment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: identityUserFlowAttributeAssignment
- 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.identityUserFlowAttributeAssignment'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identity.b2xIdentityUserFlow
summary: Update identityUserFlowAttributeAssignment
description: Update the properties of a identityUserFlowAttributeAssignment object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/identityuserflowattributeassignment-update?view=graph-rest-1.0
operationId: identity.b2xUserFlow_UpdateUserAttributeAssignment
parameters:
- name: b2xIdentityUserFlow-id
in: path
description: The unique identifier of b2xIdentityUserFlow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: b2xIdentityUserFlow
- name: identityUserFlowAttributeAssignment-id
in: path
description: The unique identifier of identityUserFlowAttributeAssignment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: identityUserFlowAttributeAssignment
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.identityUserFlowAttributeAssignment'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.identityUserFlowAttributeAssignment'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identity.b2xIdentityUserFlow
summary: Delete userAttributeAssignment
description: Delete an identityUserFlowAttributeAssignment object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/identityuserflowattributeassignment-delete?view=graph-rest-1.0
operationId: identity.b2xUserFlow_DeleteUserAttributeAssignment
parameters:
- name: b2xIdentityUserFlow-id
in: path
description: The unique identifier of b2xIdentityUserFlow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: b2xIdentityUserFlow
- name: identityUserFlowAttributeAssignment-id
in: path
description: The unique identifier of identityUserFlowAttributeAssignment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: identityUserFlowAttributeAssignment
- 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
'/identity/b2xUserFlows/{b2xIdentityUserFlow-id}/userAttributeAssignments/{identityUserFlowAttributeAssignment-id}/userAttribute':
get:
tags:
- identity.b2xIdentityUserFlow
summary: Get userAttribute from identity
description: The user attribute that you want to add to your user flow.
operationId: identity.b2xUserFlow.userAttributeAssignment_GetUserAttribute
parameters:
- name: b2xIdentityUserFlow-id
in: path
description: The unique identifier of b2xIdentityUserFlow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: b2xIdentityUserFlow
- name: identityUserFlowAttributeAssignment-id
in: path
description: The unique identifier of identityUserFlowAttributeAssignment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: identityUserFlowAttributeAssignment
- 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.identityUserFlowAttribute'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identity/b2xUserFlows/{b2xIdentityUserFlow-id}/userAttributeAssignments/$count':
get:
tags:
- identity.b2xIdentityUserFlow
summary: Get the number of the resource
operationId: identity.b2xUserFlow.userAttributeAssignment_GetCount
parameters:
- name: b2xIdentityUserFlow-id
in: path
description: The unique identifier of b2xIdentityUserFlow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: b2xIdentityUserFlow
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identity/b2xUserFlows/{b2xIdentityUserFlow-id}/userAttributeAssignments/microsoft.graph.getOrder()':
get:
tags:
- identity.b2xIdentityUserFlow
summary: Invoke function getOrder
description: Get the order of identityUserFlowAttributeAssignments being collected within a user flow.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/identityuserflowattributeassignment-getorder?view=graph-rest-1.0
operationId: identity.b2xUserFlow.userAttributeAssignment_getOrder
parameters:
- name: b2xIdentityUserFlow-id
in: path
description: The unique identifier of b2xIdentityUserFlow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: b2xIdentityUserFlow
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.assignmentOrder'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
'/identity/b2xUserFlows/{b2xIdentityUserFlow-id}/userAttributeAssignments/microsoft.graph.setOrder':
post:
tags:
- identity.b2xIdentityUserFlow
summary: Invoke action setOrder
description: Set the order of identityUserFlowAttributeAssignments being collected within a user flow.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/identityuserflowattributeassignment-setorder?view=graph-rest-1.0
operationId: identity.b2xUserFlow.userAttributeAssignment_setOrder
parameters:
- name: b2xIdentityUserFlow-id
in: path
description: The unique identifier of b2xIdentityUserFlow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: b2xIdentityUserFlow
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
newAssignmentOrder:
$ref: '#/components/schemas/microsoft.graph.assignmentOrder'
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/identity/b2xUserFlows/{b2xIdentityUserFlow-id}/userFlowIdentityProviders':
get:
tags:
- identity.b2xIdentityUserFlow
summary: Get userFlowIdentityProviders from identity
operationId: identity.b2xUserFlow_ListUserFlowIdentityProvider
parameters:
- name: b2xIdentityUserFlow-id
in: path
description: The unique identifier of b2xIdentityUserFlow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: b2xIdentityUserFlow
- $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.identityProviderBaseCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
'/identity/b2xUserFlows/{b2xIdentityUserFlow-id}/userFlowIdentityProviders/{identityProviderBase-id}/$ref':
delete:
tags:
- identity.b2xIdentityUserFlow
summary: Delete ref of navigation property userFlowIdentityProviders for identity
operationId: identity.b2xUserFlow.userFlowIdentityProvider_DeleteIdentityProviderBaseGraphBPreRef
parameters:
- name: b2xIdentityUserFlow-id
in: path
description: The unique identifier of b2xIdentityUserFlow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: b2xIdentityUserFlow
- name: identityProviderBase-id
in: path
description: The unique identifier of identityProviderBase
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: identityProviderBase
- 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
'/identity/b2xUserFlows/{b2xIdentityUserFlow-id}/userFlowIdentityProviders/$count':
get:
tags:
- identity.b2xIdentityUserFlow
summary: Get the number of the resource
operationId: identity.b2xUserFlow.userFlowIdentityProvider_GetCount
parameters:
- name: b2xIdentityUserFlow-id
in: path
description: The unique identifier of b2xIdentityUserFlow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: b2xIdentityUserFlow
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identity/b2xUserFlows/{b2xIdentityUserFlow-id}/userFlowIdentityProviders/$ref':
get:
tags:
- identity.b2xIdentityUserFlow
summary: Get ref of userFlowIdentityProviders from identity
operationId: identity.b2xUserFlow_ListUserFlowIdentityProviderGraphBPreRef
parameters:
- name: b2xIdentityUserFlow-id
in: path
description: The unique identifier of b2xIdentityUserFlow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: b2xIdentityUserFlow
- $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:
- identity.b2xIdentityUserFlow
summary: Create new navigation property ref to userFlowIdentityProviders for identity
operationId: identity.b2xUserFlow_CreateUserFlowIdentityProviderGraphBPreRef
parameters:
- name: b2xIdentityUserFlow-id
in: path
description: The unique identifier of b2xIdentityUserFlow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: b2xIdentityUserFlow
requestBody:
$ref: '#/components/requestBodies/refPostBody'
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identity.b2xIdentityUserFlow
summary: Delete ref of navigation property userFlowIdentityProviders for identity
operationId: identity.b2xUserFlow_DeleteUserFlowIdentityProviderGraphBPreRef
parameters:
- name: b2xIdentityUserFlow-id
in: path
description: The unique identifier of b2xIdentityUserFlow
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: b2xIdentityUserFlow
- 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
/identity/b2xUserFlows/$count:
get:
tags:
- identity.b2xIdentityUserFlow
summary: Get the number of the resource
operationId: identity.b2xUserFlow_GetCount
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
/identity/conditionalAccess/authenticationContextClassReferences:
get:
tags:
- identity.conditionalAccessRoot
summary: List authenticationContextClassReferences
description: Retrieve a list of authenticationContextClassReference objects.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/conditionalaccessroot-list-authenticationcontextclassreferences?view=graph-rest-1.0
operationId: identity.conditionalAccess_ListAuthenticationContextClassReference
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.authenticationContextClassReferenceCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identity.conditionalAccessRoot
summary: Create new navigation property to authenticationContextClassReferences for identity
operationId: identity.conditionalAccess_CreateAuthenticationContextClassReference
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.authenticationContextClassReference'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.authenticationContextClassReference'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identity/conditionalAccess/authenticationContextClassReferences/{authenticationContextClassReference-id}':
get:
tags:
- identity.conditionalAccessRoot
summary: Get authenticationContextClassReference
description: Retrieve the properties and relationships of a authenticationContextClassReference object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/authenticationcontextclassreference-get?view=graph-rest-1.0
operationId: identity.conditionalAccess_GetAuthenticationContextClassReference
parameters:
- name: authenticationContextClassReference-id
in: path
description: The unique identifier of authenticationContextClassReference
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: authenticationContextClassReference
- 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.authenticationContextClassReference'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identity.conditionalAccessRoot
summary: Create or Update authenticationContextClassReference
description: 'Create an authenticationContextClassReference object, if the ID has not been used. If ID has been used, this call updates the authenticationContextClassReference object.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/authenticationcontextclassreference-update?view=graph-rest-1.0
operationId: identity.conditionalAccess_UpdateAuthenticationContextClassReference
parameters:
- name: authenticationContextClassReference-id
in: path
description: The unique identifier of authenticationContextClassReference
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: authenticationContextClassReference
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.authenticationContextClassReference'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.authenticationContextClassReference'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identity.conditionalAccessRoot
summary: Delete authenticationContextClassReference
description: Delete an authenticationContextClassReference object that's not published or used by a conditional access policy.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/authenticationcontextclassreference-delete?view=graph-rest-1.0
operationId: identity.conditionalAccess_DeleteAuthenticationContextClassReference
parameters:
- name: authenticationContextClassReference-id
in: path
description: The unique identifier of authenticationContextClassReference
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: authenticationContextClassReference
- 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
/identity/conditionalAccess/authenticationContextClassReferences/$count:
get:
tags:
- identity.conditionalAccessRoot
summary: Get the number of the resource
operationId: identity.conditionalAccess.authenticationContextClassReference_GetCount
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
/identity/conditionalAccess/authenticationStrength:
get:
tags:
- identity.conditionalAccessRoot
summary: Get authenticationStrength from identity
operationId: identity.conditionalAccess_GetAuthenticationStrength
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.authenticationStrengthRoot'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identity.conditionalAccessRoot
summary: Update the navigation property authenticationStrength in identity
operationId: identity.conditionalAccess_UpdateAuthenticationStrength
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.authenticationStrengthRoot'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.authenticationStrengthRoot'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identity.conditionalAccessRoot
summary: Delete navigation property authenticationStrength for identity
operationId: identity.conditionalAccess_DeleteAuthenticationStrength
parameters:
- 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
/identity/conditionalAccess/authenticationStrength/authenticationMethodModes:
get:
tags:
- identity.conditionalAccessRoot
summary: List authenticationMethodModes
description: 'Get a list of all supported authentication methods, or all supported authentication method combinations as a list of authenticationMethodModes objects and their properties.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/authenticationstrengthroot-list-authenticationmethodmodes?view=graph-rest-1.0
operationId: identity.conditionalAccess.authenticationStrength_ListAuthenticationMethodMode
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.authenticationMethodModeDetailCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identity.conditionalAccessRoot
summary: Create new navigation property to authenticationMethodModes for identity
operationId: identity.conditionalAccess.authenticationStrength_CreateAuthenticationMethodMode
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.authenticationMethodModeDetail'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.authenticationMethodModeDetail'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identity/conditionalAccess/authenticationStrength/authenticationMethodModes/{authenticationMethodModeDetail-id}':
get:
tags:
- identity.conditionalAccessRoot
summary: Get authenticationMethodModes from identity
description: Names and descriptions of all valid authentication method modes in the system.
operationId: identity.conditionalAccess.authenticationStrength_GetAuthenticationMethodMode
parameters:
- name: authenticationMethodModeDetail-id
in: path
description: The unique identifier of authenticationMethodModeDetail
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: authenticationMethodModeDetail
- 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.authenticationMethodModeDetail'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identity.conditionalAccessRoot
summary: Update the navigation property authenticationMethodModes in identity
operationId: identity.conditionalAccess.authenticationStrength_UpdateAuthenticationMethodMode
parameters:
- name: authenticationMethodModeDetail-id
in: path
description: The unique identifier of authenticationMethodModeDetail
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: authenticationMethodModeDetail
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.authenticationMethodModeDetail'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.authenticationMethodModeDetail'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identity.conditionalAccessRoot
summary: Delete navigation property authenticationMethodModes for identity
operationId: identity.conditionalAccess.authenticationStrength_DeleteAuthenticationMethodMode
parameters:
- name: authenticationMethodModeDetail-id
in: path
description: The unique identifier of authenticationMethodModeDetail
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: authenticationMethodModeDetail
- 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
/identity/conditionalAccess/authenticationStrength/authenticationMethodModes/$count:
get:
tags:
- identity.conditionalAccessRoot
summary: Get the number of the resource
operationId: identity.conditionalAccess.authenticationStrength.authenticationMethodMode_GetCount
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
/identity/conditionalAccess/authenticationStrength/policies:
get:
tags:
- identity.conditionalAccessRoot
summary: Get policies from identity
description: 'A collection of authentication strength policies that exist for this tenant, including both built-in and custom policies.'
operationId: identity.conditionalAccess.authenticationStrength_ListPolicy
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.authenticationStrengthPolicyCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identity.conditionalAccessRoot
summary: Create new navigation property to policies for identity
operationId: identity.conditionalAccess.authenticationStrength_CreatePolicy
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.authenticationStrengthPolicy'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.authenticationStrengthPolicy'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identity/conditionalAccess/authenticationStrength/policies/{authenticationStrengthPolicy-id}':
get:
tags:
- identity.conditionalAccessRoot
summary: Get policies from identity
description: 'A collection of authentication strength policies that exist for this tenant, including both built-in and custom policies.'
operationId: identity.conditionalAccess.authenticationStrength_GetPolicy
parameters:
- name: authenticationStrengthPolicy-id
in: path
description: The unique identifier of authenticationStrengthPolicy
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: authenticationStrengthPolicy
- 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.authenticationStrengthPolicy'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identity.conditionalAccessRoot
summary: Update the navigation property policies in identity
operationId: identity.conditionalAccess.authenticationStrength_UpdatePolicy
parameters:
- name: authenticationStrengthPolicy-id
in: path
description: The unique identifier of authenticationStrengthPolicy
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: authenticationStrengthPolicy
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.authenticationStrengthPolicy'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.authenticationStrengthPolicy'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identity.conditionalAccessRoot
summary: Delete navigation property policies for identity
operationId: identity.conditionalAccess.authenticationStrength_DeletePolicy
parameters:
- name: authenticationStrengthPolicy-id
in: path
description: The unique identifier of authenticationStrengthPolicy
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: authenticationStrengthPolicy
- 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
'/identity/conditionalAccess/authenticationStrength/policies/{authenticationStrengthPolicy-id}/combinationConfigurations':
get:
tags:
- identity.conditionalAccessRoot
summary: List combinationConfigurations
description: "Get the authenticationCombinationConfiguration objects for an authentication strength policy. The objects can be of one or more of the following derived types:\r\n* fido2combinationConfigurations\r\n* x509certificatecombinationconfiguration authenticationCombinationConfiguration objects are supported only for custom authentication strengths."
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/authenticationstrengthpolicy-list-combinationconfigurations?view=graph-rest-1.0
operationId: identity.conditionalAccess.authenticationStrength.policy_ListCombinationConfiguration
parameters:
- name: authenticationStrengthPolicy-id
in: path
description: The unique identifier of authenticationStrengthPolicy
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: authenticationStrengthPolicy
- $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.authenticationCombinationConfigurationCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identity.conditionalAccessRoot
summary: Create authenticationCombinationConfiguration
description: "Create a new authenticationCombinationConfiguration object which can be of one of the following derived types:\r\n* fido2combinationConfiguration\r\n* x509certificatecombinationconfiguration"
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/authenticationstrengthpolicy-post-combinationconfigurations?view=graph-rest-1.0
operationId: identity.conditionalAccess.authenticationStrength.policy_CreateCombinationConfiguration
parameters:
- name: authenticationStrengthPolicy-id
in: path
description: The unique identifier of authenticationStrengthPolicy
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: authenticationStrengthPolicy
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.authenticationCombinationConfiguration'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.authenticationCombinationConfiguration'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identity/conditionalAccess/authenticationStrength/policies/{authenticationStrengthPolicy-id}/combinationConfigurations/{authenticationCombinationConfiguration-id}':
get:
tags:
- identity.conditionalAccessRoot
summary: Get authenticationCombinationConfiguration
description: Read the properties and relationships of an authenticationCombinationConfiguration object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/authenticationcombinationconfiguration-get?view=graph-rest-1.0
operationId: identity.conditionalAccess.authenticationStrength.policy_GetCombinationConfiguration
parameters:
- name: authenticationStrengthPolicy-id
in: path
description: The unique identifier of authenticationStrengthPolicy
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: authenticationStrengthPolicy
- name: authenticationCombinationConfiguration-id
in: path
description: The unique identifier of authenticationCombinationConfiguration
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: authenticationCombinationConfiguration
- 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.authenticationCombinationConfiguration'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identity.conditionalAccessRoot
summary: Update authenticationCombinationConfiguration
description: "Update the properties of an authenticationCombinationConfiguration object. \r\nThe properties can be for one of the following derived types:\r\n* fido2combinationConfigurations\r\n* x509certificatecombinationconfiguration"
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/authenticationcombinationconfiguration-update?view=graph-rest-1.0
operationId: identity.conditionalAccess.authenticationStrength.policy_UpdateCombinationConfiguration
parameters:
- name: authenticationStrengthPolicy-id
in: path
description: The unique identifier of authenticationStrengthPolicy
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: authenticationStrengthPolicy
- name: authenticationCombinationConfiguration-id
in: path
description: The unique identifier of authenticationCombinationConfiguration
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: authenticationCombinationConfiguration
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.authenticationCombinationConfiguration'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.authenticationCombinationConfiguration'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identity.conditionalAccessRoot
summary: Delete authenticationCombinationConfiguration
description: Delete an authenticationCombinationConfiguration for a custom authenticationStrengthPolicy object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/authenticationstrengthpolicy-delete-combinationconfigurations?view=graph-rest-1.0
operationId: identity.conditionalAccess.authenticationStrength.policy_DeleteCombinationConfiguration
parameters:
- name: authenticationStrengthPolicy-id
in: path
description: The unique identifier of authenticationStrengthPolicy
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: authenticationStrengthPolicy
- name: authenticationCombinationConfiguration-id
in: path
description: The unique identifier of authenticationCombinationConfiguration
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: authenticationCombinationConfiguration
- 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
'/identity/conditionalAccess/authenticationStrength/policies/{authenticationStrengthPolicy-id}/combinationConfigurations/$count':
get:
tags:
- identity.conditionalAccessRoot
summary: Get the number of the resource
operationId: identity.conditionalAccess.authenticationStrength.policy.combinationConfiguration_GetCount
parameters:
- name: authenticationStrengthPolicy-id
in: path
description: The unique identifier of authenticationStrengthPolicy
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: authenticationStrengthPolicy
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/identity/conditionalAccess/authenticationStrength/policies/{authenticationStrengthPolicy-id}/microsoft.graph.updateAllowedCombinations':
post:
tags:
- identity.conditionalAccessRoot
summary: Invoke action updateAllowedCombinations
description: 'Update the allowedCombinations property of an authenticationStrengthPolicy object. To update other properties of an authenticationStrengthPolicy object, use the Update authenticationStrengthPolicy method.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/authenticationstrengthpolicy-updateallowedcombinations?view=graph-rest-1.0
operationId: identity.conditionalAccess.authenticationStrength.policy_updateAllowedCombination
parameters:
- name: authenticationStrengthPolicy-id
in: path
description: The unique identifier of authenticationStrengthPolicy
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: authenticationStrengthPolicy
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
allowedCombinations:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.authenticationMethodModes'
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.updateAllowedCombinationsResult'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/identity/conditionalAccess/authenticationStrength/policies/{authenticationStrengthPolicy-id}/microsoft.graph.usage()':
get:
tags:
- identity.conditionalAccessRoot
summary: Invoke function usage
description: 'Allows the caller to see which Conditional Access policies reference a specified authentication strength policy. The policies are returned in two collections, one containing Conditional Access policies that require an MFA claim and the other containing Conditional Access policies that don''t require such a claim. Policies in the former category are restricted in what kinds of changes may be made to them to prevent undermining the MFA requirement of those policies.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/authenticationstrengthpolicy-usage?view=graph-rest-1.0
operationId: identity.conditionalAccess.authenticationStrength.policy_usage
parameters:
- name: authenticationStrengthPolicy-id
in: path
description: The unique identifier of authenticationStrengthPolicy
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: authenticationStrengthPolicy
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.authenticationStrengthUsage'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
/identity/conditionalAccess/authenticationStrength/policies/$count:
get:
tags:
- identity.conditionalAccessRoot
summary: Get the number of the resource
operationId: identity.conditionalAccess.authenticationStrength.policy_GetCount
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
/identity/conditionalAccess/deletedItems:
get:
tags:
- identity.conditionalAccessRoot
summary: Get deletedItems from identity
operationId: identity.conditionalAccess_GetDeletedItem
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.caPoliciesDeletableRoot'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identity.conditionalAccessRoot
summary: Update the navigation property deletedItems in identity
operationId: identity.conditionalAccess_UpdateDeletedItem
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.caPoliciesDeletableRoot'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.caPoliciesDeletableRoot'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identity.conditionalAccessRoot
summary: Delete navigation property deletedItems for identity
operationId: identity.conditionalAccess_DeleteDeletedItem
parameters:
- 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
/identity/conditionalAccess/deletedItems/namedLocations:
get:
tags:
- identity.conditionalAccessRoot
summary: Get namedLocations from identity
operationId: identity.conditionalAccess.deletedItem_ListNamedLocation
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.namedLocationCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identity.conditionalAccessRoot
summary: Create new navigation property to namedLocations for identity
operationId: identity.conditionalAccess.deletedItem_CreateNamedLocation
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.namedLocation'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.namedLocation'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identity/conditionalAccess/deletedItems/namedLocations/{namedLocation-id}':
get:
tags:
- identity.conditionalAccessRoot
summary: Get namedLocations from identity
operationId: identity.conditionalAccess.deletedItem_GetNamedLocation
parameters:
- name: namedLocation-id
in: path
description: The unique identifier of namedLocation
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: namedLocation
- 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.namedLocation'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identity.conditionalAccessRoot
summary: Update the navigation property namedLocations in identity
operationId: identity.conditionalAccess.deletedItem_UpdateNamedLocation
parameters:
- name: namedLocation-id
in: path
description: The unique identifier of namedLocation
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: namedLocation
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.namedLocation'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.namedLocation'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identity.conditionalAccessRoot
summary: Delete navigation property namedLocations for identity
operationId: identity.conditionalAccess.deletedItem_DeleteNamedLocation
parameters:
- name: namedLocation-id
in: path
description: The unique identifier of namedLocation
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: namedLocation
- 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
'/identity/conditionalAccess/deletedItems/namedLocations/{namedLocation-id}/microsoft.graph.restore':
post:
tags:
- identity.conditionalAccessRoot
summary: Invoke action restore
operationId: identity.conditionalAccess.deletedItem.namedLocation_restore
parameters:
- name: namedLocation-id
in: path
description: The unique identifier of namedLocation
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: namedLocation
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.namedLocation'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
/identity/conditionalAccess/deletedItems/namedLocations/$count:
get:
tags:
- identity.conditionalAccessRoot
summary: Get the number of the resource
operationId: identity.conditionalAccess.deletedItem.namedLocation_GetCount
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
/identity/conditionalAccess/deletedItems/policies:
get:
tags:
- identity.conditionalAccessRoot
summary: Get policies from identity
operationId: identity.conditionalAccess.deletedItem_ListPolicy
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.conditionalAccessPolicyCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identity.conditionalAccessRoot
summary: Create new navigation property to policies for identity
operationId: identity.conditionalAccess.deletedItem_CreatePolicy
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.conditionalAccessPolicy'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.conditionalAccessPolicy'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identity/conditionalAccess/deletedItems/policies/{conditionalAccessPolicy-id}':
get:
tags:
- identity.conditionalAccessRoot
summary: Get policies from identity
operationId: identity.conditionalAccess.deletedItem_GetPolicy
parameters:
- name: conditionalAccessPolicy-id
in: path
description: The unique identifier of conditionalAccessPolicy
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: conditionalAccessPolicy
- 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.conditionalAccessPolicy'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identity.conditionalAccessRoot
summary: Update the navigation property policies in identity
operationId: identity.conditionalAccess.deletedItem_UpdatePolicy
parameters:
- name: conditionalAccessPolicy-id
in: path
description: The unique identifier of conditionalAccessPolicy
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: conditionalAccessPolicy
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.conditionalAccessPolicy'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.conditionalAccessPolicy'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identity.conditionalAccessRoot
summary: Delete navigation property policies for identity
operationId: identity.conditionalAccess.deletedItem_DeletePolicy
parameters:
- name: conditionalAccessPolicy-id
in: path
description: The unique identifier of conditionalAccessPolicy
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: conditionalAccessPolicy
- 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
'/identity/conditionalAccess/deletedItems/policies/{conditionalAccessPolicy-id}/microsoft.graph.restore':
post:
tags:
- identity.conditionalAccessRoot
summary: Invoke action restore
operationId: identity.conditionalAccess.deletedItem.policy_restore
parameters:
- name: conditionalAccessPolicy-id
in: path
description: The unique identifier of conditionalAccessPolicy
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: conditionalAccessPolicy
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.conditionalAccessPolicy'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
/identity/conditionalAccess/deletedItems/policies/$count:
get:
tags:
- identity.conditionalAccessRoot
summary: Get the number of the resource
operationId: identity.conditionalAccess.deletedItem.policy_GetCount
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
/identity/conditionalAccess/microsoft.graph.evaluate:
post:
tags:
- identity.conditionalAccessRoot
summary: Invoke action evaluate
description: Evaluates the applicability of Conditional Access Policies in your tenant based on the provided sign-in properties.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/conditionalaccessroot-evaluate?view=graph-rest-1.0
operationId: identity.conditionalAccess_evaluate
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
signInIdentity:
$ref: '#/components/schemas/microsoft.graph.signInIdentity'
signInContext:
$ref: '#/components/schemas/microsoft.graph.signInContext'
signInConditions:
$ref: '#/components/schemas/microsoft.graph.signInConditions'
appliedPoliciesOnly:
type: boolean
default: false
nullable: true
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
title: Collection of whatIfAnalysisResult
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.whatIfAnalysisResult'
'@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
/identity/conditionalAccess/namedLocations:
get:
tags:
- identity.conditionalAccessRoot
summary: List namedLocations
description: Get a list of namedLocation objects.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/conditionalaccessroot-list-namedlocations?view=graph-rest-1.0
operationId: identity.conditionalAccess_ListNamedLocation
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.namedLocationCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identity.conditionalAccessRoot
summary: Create namedLocation
description: Create a new namedLocation object. Named locations can be either ipNamedLocation or countryNamedLocation objects.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/conditionalaccessroot-post-namedlocations?view=graph-rest-1.0
operationId: identity.conditionalAccess_CreateNamedLocation
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.namedLocation'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.namedLocation'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identity/conditionalAccess/namedLocations/{namedLocation-id}':
get:
tags:
- identity.conditionalAccessRoot
summary: Get countryNamedLocation
description: Retrieve the properties and relationships of a countryNamedLocation object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/countrynamedlocation-get?view=graph-rest-1.0
operationId: identity.conditionalAccess_GetNamedLocation
parameters:
- name: namedLocation-id
in: path
description: The unique identifier of namedLocation
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: namedLocation
- 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.namedLocation'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identity.conditionalAccessRoot
summary: Update countryNamedLocation
description: Update the properties of a countryNamedLocation object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/countrynamedlocation-update?view=graph-rest-1.0
operationId: identity.conditionalAccess_UpdateNamedLocation
parameters:
- name: namedLocation-id
in: path
description: The unique identifier of namedLocation
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: namedLocation
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.namedLocation'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.namedLocation'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identity.conditionalAccessRoot
summary: Delete countryNamedLocation
description: Delete a countryNamedLocation object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/countrynamedlocation-delete?view=graph-rest-1.0
operationId: identity.conditionalAccess_DeleteNamedLocation
parameters:
- name: namedLocation-id
in: path
description: The unique identifier of namedLocation
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: namedLocation
- 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
'/identity/conditionalAccess/namedLocations/{namedLocation-id}/microsoft.graph.restore':
post:
tags:
- identity.conditionalAccessRoot
summary: Invoke action restore
operationId: identity.conditionalAccess.namedLocation_restore
parameters:
- name: namedLocation-id
in: path
description: The unique identifier of namedLocation
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: namedLocation
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.namedLocation'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
/identity/conditionalAccess/namedLocations/$count:
get:
tags:
- identity.conditionalAccessRoot
summary: Get the number of the resource
operationId: identity.conditionalAccess.namedLocation_GetCount
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
/identity/conditionalAccess/policies:
get:
tags:
- identity.conditionalAccessRoot
summary: List policies
description: Retrieve a list of conditionalAccessPolicy objects.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/conditionalaccessroot-list-policies?view=graph-rest-1.0
operationId: identity.conditionalAccess_ListPolicy
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.conditionalAccessPolicyCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identity.conditionalAccessRoot
summary: Create conditionalAccessPolicy
description: Create a new conditionalAccessPolicy.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/conditionalaccessroot-post-policies?view=graph-rest-1.0
operationId: identity.conditionalAccess_CreatePolicy
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.conditionalAccessPolicy'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.conditionalAccessPolicy'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identity/conditionalAccess/policies/{conditionalAccessPolicy-id}':
get:
tags:
- identity.conditionalAccessRoot
summary: Get conditionalAccessPolicy
description: Retrieve the properties and relationships of a conditionalAccessPolicy object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/conditionalaccesspolicy-get?view=graph-rest-1.0
operationId: identity.conditionalAccess_GetPolicy
parameters:
- name: conditionalAccessPolicy-id
in: path
description: The unique identifier of conditionalAccessPolicy
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: conditionalAccessPolicy
- 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.conditionalAccessPolicy'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identity.conditionalAccessRoot
summary: Update conditionalaccesspolicy
description: Update the properties of a conditionalAccessPolicy object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/conditionalaccesspolicy-update?view=graph-rest-1.0
operationId: identity.conditionalAccess_UpdatePolicy
parameters:
- name: conditionalAccessPolicy-id
in: path
description: The unique identifier of conditionalAccessPolicy
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: conditionalAccessPolicy
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.conditionalAccessPolicy'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.conditionalAccessPolicy'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identity.conditionalAccessRoot
summary: Delete conditionalAccessPolicy
description: Delete a conditionalAccessPolicy object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/conditionalaccesspolicy-delete?view=graph-rest-1.0
operationId: identity.conditionalAccess_DeletePolicy
parameters:
- name: conditionalAccessPolicy-id
in: path
description: The unique identifier of conditionalAccessPolicy
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: conditionalAccessPolicy
- 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
'/identity/conditionalAccess/policies/{conditionalAccessPolicy-id}/microsoft.graph.restore':
post:
tags:
- identity.conditionalAccessRoot
summary: Invoke action restore
operationId: identity.conditionalAccess.policy_restore
parameters:
- name: conditionalAccessPolicy-id
in: path
description: The unique identifier of conditionalAccessPolicy
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: conditionalAccessPolicy
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.conditionalAccessPolicy'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
/identity/conditionalAccess/policies/$count:
get:
tags:
- identity.conditionalAccessRoot
summary: Get the number of the resource
operationId: identity.conditionalAccess.policy_GetCount
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
/identity/conditionalAccess/templates:
get:
tags:
- identity.conditionalAccessRoot
summary: List conditionalAccessTemplates
description: Get a list of the conditionalAccessTemplate objects and their properties.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/conditionalaccessroot-list-templates?view=graph-rest-1.0
operationId: identity.conditionalAccess_ListTemplate
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.conditionalAccessTemplateCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
'/identity/conditionalAccess/templates/{conditionalAccessTemplate-id}':
get:
tags:
- identity.conditionalAccessRoot
summary: Get conditionalAccessTemplate
description: Read the properties and relationships of a conditionalAccessTemplate object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/conditionalaccesstemplate-get?view=graph-rest-1.0
operationId: identity.conditionalAccess_GetTemplate
parameters:
- name: conditionalAccessTemplate-id
in: path
description: The unique identifier of conditionalAccessTemplate
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: conditionalAccessTemplate
- 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.conditionalAccessTemplate'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
/identity/conditionalAccess/templates/$count:
get:
tags:
- identity.conditionalAccessRoot
summary: Get the number of the resource
operationId: identity.conditionalAccess.template_GetCount
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
/identity/customAuthenticationExtensions:
get:
tags:
- identity.customAuthenticationExtension
summary: List customAuthenticationExtensions
description: Get a list of the customAuthenticationExtension objects and their properties. The following derived types are supported.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/identitycontainer-list-customauthenticationextensions?view=graph-rest-1.0
operationId: identity_ListCustomAuthenticationExtension
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.customAuthenticationExtensionCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identity.customAuthenticationExtension
summary: Create customAuthenticationExtension
description: Create a new customAuthenticationExtension object. The following derived types are currently supported.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/identitycontainer-post-customauthenticationextensions?view=graph-rest-1.0
operationId: identity_CreateCustomAuthenticationExtension
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customAuthenticationExtension'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customAuthenticationExtension'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identity/customAuthenticationExtensions/{customAuthenticationExtension-id}':
get:
tags:
- identity.customAuthenticationExtension
summary: Get customAuthenticationExtension
description: Read the properties and relationships of a customAuthenticationExtension object. The following derived types are currently supported.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/customauthenticationextension-get?view=graph-rest-1.0
operationId: identity_GetCustomAuthenticationExtension
parameters:
- name: customAuthenticationExtension-id
in: path
description: The unique identifier of customAuthenticationExtension
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customAuthenticationExtension
- 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.customAuthenticationExtension'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identity.customAuthenticationExtension
summary: Update customAuthenticationExtension
description: Update the properties of a customAuthenticationExtension object. The following derived types are currently supported.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/customauthenticationextension-update?view=graph-rest-1.0
operationId: identity_UpdateCustomAuthenticationExtension
parameters:
- name: customAuthenticationExtension-id
in: path
description: The unique identifier of customAuthenticationExtension
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customAuthenticationExtension
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customAuthenticationExtension'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.customAuthenticationExtension'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identity.customAuthenticationExtension
summary: Delete customAuthenticationExtension
description: Delete a customAuthenticationExtension object. The following derived types are currently supported.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/customauthenticationextension-delete?view=graph-rest-1.0
operationId: identity_DeleteCustomAuthenticationExtension
parameters:
- name: customAuthenticationExtension-id
in: path
description: The unique identifier of customAuthenticationExtension
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customAuthenticationExtension
- 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
'/identity/customAuthenticationExtensions/{customAuthenticationExtension-id}/microsoft.graph.validateAuthenticationConfiguration':
post:
tags:
- identity.customAuthenticationExtension
summary: Invoke action validateAuthenticationConfiguration
description: 'An API to check validity of the endpoint and and authentication configuration for a customAuthenticationExtension object, which can represent one of the following derived types:'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/customauthenticationextension-validateauthenticationconfiguration?view=graph-rest-1.0
operationId: identity.customAuthenticationExtension_validateAuthenticationConfiguration
parameters:
- name: customAuthenticationExtension-id
in: path
description: The unique identifier of customAuthenticationExtension
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: customAuthenticationExtension
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.authenticationConfigurationValidation'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
/identity/customAuthenticationExtensions/$count:
get:
tags:
- identity.customAuthenticationExtension
summary: Get the number of the resource
operationId: identity.customAuthenticationExtension_GetCount
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
/identity/customAuthenticationExtensions/microsoft.graph.validateAuthenticationConfiguration:
post:
tags:
- identity.customAuthenticationExtension
summary: Invoke action validateAuthenticationConfiguration
operationId: identity.customAuthenticationExtension_validateAuthenticationConfiguration
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
endpointConfiguration:
$ref: '#/components/schemas/microsoft.graph.customExtensionEndpointConfiguration'
authenticationConfiguration:
$ref: '#/components/schemas/microsoft.graph.customExtensionAuthenticationConfiguration'
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.authenticationConfigurationValidation'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
/identity/identityProviders:
get:
tags:
- identity.identityProviderBase
summary: List identityProviders
description: 'Get a collection of identity provider resources that are configured for a tenant, and that are derived from identityProviderBase. For a Microsoft Entra tenant, the providers can be socialIdentityProviders or builtinIdentityProviders objects. For an Azure AD B2C, the providers can be socialIdentityProvider, or appleManagedIdentityProvider objects.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/identitycontainer-list-identityproviders?view=graph-rest-1.0
operationId: identity_ListIdentityProvider
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.identityProviderBaseCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identity.identityProviderBase
summary: Create identityProvider
description: 'Create an identity provider object that is of the type specified in the request body. Among the types of providers derived from identityProviderBase, you can currently create a socialIdentityProvider resource in Microsoft Entra ID. In Azure AD B2C, this operation can currently create a socialIdentityProvider, or an appleManagedIdentityProvider resource.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/identitycontainer-post-identityproviders?view=graph-rest-1.0
operationId: identity_CreateIdentityProvider
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.identityProviderBase'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.identityProviderBase'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identity/identityProviders/{identityProviderBase-id}':
get:
tags:
- identity.identityProviderBase
summary: Get identityProvider
description: 'Get the properties and relationships of the specified identity provider configured in the tenant. Among the types of providers derived from identityProviderBase, you can currently get a socialIdentityProvider or a builtinIdentityProvider resource in Microsoft Entra ID. In Azure AD B2C, this operation can currently get a socialIdentityProvider, or an appleManagedIdentityProvider resource.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/identityproviderbase-get?view=graph-rest-1.0
operationId: identity_GetIdentityProvider
parameters:
- name: identityProviderBase-id
in: path
description: The unique identifier of identityProviderBase
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: identityProviderBase
- 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.identityProviderBase'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identity.identityProviderBase
summary: Update identityProvider
description: 'Update the properties of the specified identity provider configured in the tenant. Among the types of providers derived from identityProviderBase, you can currently update a socialIdentityProvider resource in Microsoft Entra ID. In Azure AD B2C, this operation can currently update a socialIdentityProvider, or an appleManagedIdentityProvider resource.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/identityproviderbase-update?view=graph-rest-1.0
operationId: identity_UpdateIdentityProvider
parameters:
- name: identityProviderBase-id
in: path
description: The unique identifier of identityProviderBase
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: identityProviderBase
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.identityProviderBase'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.identityProviderBase'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identity.identityProviderBase
summary: Delete identityProvider
description: 'Delete an identity provider resource that is of the type specified by the id in the request. Among the types of providers derived from identityProviderBase, you can currently delete a socialIdentityProvider resource in Microsoft Entra ID. In Azure AD B2C, this operation can currently delete a socialIdentityProvider, or an appleManagedIdentityProvider resource.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/identityproviderbase-delete?view=graph-rest-1.0
operationId: identity_DeleteIdentityProvider
parameters:
- name: identityProviderBase-id
in: path
description: The unique identifier of identityProviderBase
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: identityProviderBase
- 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
/identity/identityProviders/$count:
get:
tags:
- identity.identityProviderBase
summary: Get the number of the resource
operationId: identity.identityProvider_GetCount
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
/identity/identityProviders/microsoft.graph.availableProviderTypes():
get:
tags:
- identity.identityProviderBase
summary: Invoke function availableProviderTypes
description: Get all identity providers supported in a directory.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/identityproviderbase-availableprovidertypes?view=graph-rest-1.0
operationId: identity.identityProvider_availableProviderType
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
responses:
2XX:
description: Success
content:
application/json:
schema:
type: object
properties:
value:
type: array
items:
type: string
nullable: true
'@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
/identity/riskPrevention:
get:
tags:
- identity.riskPreventionContainer
summary: Get riskPrevention from identity
description: 'Represents the entry point for fraud and risk prevention configurations in Microsoft Entra External ID, including third-party provider settings.'
operationId: identity_GetRiskPrevention
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.riskPreventionContainer'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identity.riskPreventionContainer
summary: Update the navigation property riskPrevention in identity
operationId: identity_UpdateRiskPrevention
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.riskPreventionContainer'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.riskPreventionContainer'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identity.riskPreventionContainer
summary: Delete navigation property riskPrevention for identity
operationId: identity_DeleteRiskPrevention
parameters:
- 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
/identity/riskPrevention/fraudProtectionProviders:
get:
tags:
- identity.riskPreventionContainer
summary: List fraudProtectionProviders
description: 'Get a list of the fraudProtectionProvider object and their properties. The following derived types are supported:'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/riskpreventioncontainer-list-fraudprotectionproviders?view=graph-rest-1.0
operationId: identity.riskPrevention_ListFraudProtectionProvider
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.fraudProtectionProviderCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identity.riskPreventionContainer
summary: Create fraudProtectionProviders
description: Create a new fraudProtectionProvider object. You can create one of the following subtypes that are derived from fraudProtectionProvider.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/riskpreventioncontainer-post-fraudprotectionproviders?view=graph-rest-1.0
operationId: identity.riskPrevention_CreateFraudProtectionProvider
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.fraudProtectionProvider'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.fraudProtectionProvider'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identity/riskPrevention/fraudProtectionProviders/{fraudProtectionProvider-id}':
get:
tags:
- identity.riskPreventionContainer
summary: Get fraudProtectionProvider
description: Read the properties and relationships of fraudProtectionProvider object. The following derived types are currently supported.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/fraudprotectionprovider-get?view=graph-rest-1.0
operationId: identity.riskPrevention_GetFraudProtectionProvider
parameters:
- name: fraudProtectionProvider-id
in: path
description: The unique identifier of fraudProtectionProvider
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: fraudProtectionProvider
- 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.fraudProtectionProvider'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identity.riskPreventionContainer
summary: Update fraudProtectionProvider
description: Update the properties of a fraudProtectionProvider object. The following derived types are currently supported.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/fraudprotectionprovider-update?view=graph-rest-1.0
operationId: identity.riskPrevention_UpdateFraudProtectionProvider
parameters:
- name: fraudProtectionProvider-id
in: path
description: The unique identifier of fraudProtectionProvider
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: fraudProtectionProvider
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.fraudProtectionProvider'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.fraudProtectionProvider'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identity.riskPreventionContainer
summary: Delete fraudProtectionProviders
description: Delete a fraudProtectionProvider object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/riskpreventioncontainer-delete-fraudprotectionproviders?view=graph-rest-1.0
operationId: identity.riskPrevention_DeleteFraudProtectionProvider
parameters:
- name: fraudProtectionProvider-id
in: path
description: The unique identifier of fraudProtectionProvider
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: fraudProtectionProvider
- 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
/identity/riskPrevention/fraudProtectionProviders/$count:
get:
tags:
- identity.riskPreventionContainer
summary: Get the number of the resource
operationId: identity.riskPrevention.fraudProtectionProvider_GetCount
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
/identity/riskPrevention/webApplicationFirewallProviders:
get:
tags:
- identity.riskPreventionContainer
summary: List webApplicationFirewallProvider objects
description: Get a list of the webApplicationFirewallProvider objects and their properties.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/riskpreventioncontainer-list-webapplicationfirewallproviders?view=graph-rest-1.0
operationId: identity.riskPrevention_ListWebApplicationFirewallProvider
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.webApplicationFirewallProviderCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identity.riskPreventionContainer
summary: Create webApplicationFirewallProvider
description: Create a new webApplicationFirewallProvider object. You can create one of the following subtypes that are derived from webApplicationFirewallProvider.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/riskpreventioncontainer-post-webapplicationfirewallproviders?view=graph-rest-1.0
operationId: identity.riskPrevention_CreateWebApplicationFirewallProvider
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.webApplicationFirewallProvider'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.webApplicationFirewallProvider'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identity/riskPrevention/webApplicationFirewallProviders/{webApplicationFirewallProvider-id}':
get:
tags:
- identity.riskPreventionContainer
summary: Get webApplicationFirewallProvider
description: Read the properties and relationships of webApplicationFirewallProvider object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/webapplicationfirewallprovider-get?view=graph-rest-1.0
operationId: identity.riskPrevention_GetWebApplicationFirewallProvider
parameters:
- name: webApplicationFirewallProvider-id
in: path
description: The unique identifier of webApplicationFirewallProvider
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: webApplicationFirewallProvider
- 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.webApplicationFirewallProvider'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identity.riskPreventionContainer
summary: Update webApplicationFirewallProvider
description: Update the properties of a webApplicationFirewallProvider object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/webapplicationfirewallprovider-update?view=graph-rest-1.0
operationId: identity.riskPrevention_UpdateWebApplicationFirewallProvider
parameters:
- name: webApplicationFirewallProvider-id
in: path
description: The unique identifier of webApplicationFirewallProvider
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: webApplicationFirewallProvider
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.webApplicationFirewallProvider'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.webApplicationFirewallProvider'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identity.riskPreventionContainer
summary: Delete webApplicationFirewallProvider
description: Delete a webApplicationFirewallProvider object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/riskpreventioncontainer-delete-webapplicationfirewallproviders?view=graph-rest-1.0
operationId: identity.riskPrevention_DeleteWebApplicationFirewallProvider
parameters:
- name: webApplicationFirewallProvider-id
in: path
description: The unique identifier of webApplicationFirewallProvider
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: webApplicationFirewallProvider
- 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
'/identity/riskPrevention/webApplicationFirewallProviders/{webApplicationFirewallProvider-id}/microsoft.graph.verify':
post:
tags:
- identity.riskPreventionContainer
summary: Invoke action verify
description: Initiate a verification operation for a webApplicationFirewallProvider object. This API triggers provider-specific verification logic and returns a webApplicationFirewallVerificationModel object describing the verification result.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/webapplicationfirewallprovider-verify?view=graph-rest-1.0
operationId: identity.riskPrevention.webApplicationFirewallProvider_verify
parameters:
- name: webApplicationFirewallProvider-id
in: path
description: The unique identifier of webApplicationFirewallProvider
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: webApplicationFirewallProvider
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
hostName:
type: string
nullable: true
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.webApplicationFirewallVerificationModel'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
/identity/riskPrevention/webApplicationFirewallProviders/$count:
get:
tags:
- identity.riskPreventionContainer
summary: Get the number of the resource
operationId: identity.riskPrevention.webApplicationFirewallProvider_GetCount
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
/identity/riskPrevention/webApplicationFirewallVerifications:
get:
tags:
- identity.riskPreventionContainer
summary: List webApplicationFirewallVerificationModel objects
description: Get a list of the webApplicationFirewallVerificationModel objects and their properties.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/riskpreventioncontainer-list-webapplicationfirewallverifications?view=graph-rest-1.0
operationId: identity.riskPrevention_ListWebApplicationFirewallVerification
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.webApplicationFirewallVerificationModelCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identity.riskPreventionContainer
summary: Create new navigation property to webApplicationFirewallVerifications for identity
operationId: identity.riskPrevention_CreateWebApplicationFirewallVerification
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.webApplicationFirewallVerificationModel'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.webApplicationFirewallVerificationModel'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identity/riskPrevention/webApplicationFirewallVerifications/{webApplicationFirewallVerificationModel-id}':
get:
tags:
- identity.riskPreventionContainer
summary: Get webApplicationFirewallVerificationModel
description: Read the properties and relationships of webApplicationFirewallVerificationModel object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/webapplicationfirewallverificationmodel-get?view=graph-rest-1.0
operationId: identity.riskPrevention_GetWebApplicationFirewallVerification
parameters:
- name: webApplicationFirewallVerificationModel-id
in: path
description: The unique identifier of webApplicationFirewallVerificationModel
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: webApplicationFirewallVerificationModel
- 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.webApplicationFirewallVerificationModel'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identity.riskPreventionContainer
summary: Update the navigation property webApplicationFirewallVerifications in identity
operationId: identity.riskPrevention_UpdateWebApplicationFirewallVerification
parameters:
- name: webApplicationFirewallVerificationModel-id
in: path
description: The unique identifier of webApplicationFirewallVerificationModel
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: webApplicationFirewallVerificationModel
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.webApplicationFirewallVerificationModel'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.webApplicationFirewallVerificationModel'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identity.riskPreventionContainer
summary: Delete webApplicationFirewallVerificationModel
description: Delete a webApplicationFirewallVerificationModel object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/riskpreventioncontainer-delete-webapplicationfirewallverifications?view=graph-rest-1.0
operationId: identity.riskPrevention_DeleteWebApplicationFirewallVerification
parameters:
- name: webApplicationFirewallVerificationModel-id
in: path
description: The unique identifier of webApplicationFirewallVerificationModel
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: webApplicationFirewallVerificationModel
- 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
'/identity/riskPrevention/webApplicationFirewallVerifications/{webApplicationFirewallVerificationModel-id}/provider':
get:
tags:
- identity.riskPreventionContainer
summary: Get provider from identity
description: Reference to a provider resource associated with this verification model. Represents a WAF provider that can be used to verify or manage the host.
operationId: identity.riskPrevention.webApplicationFirewallVerification_GetProvider
parameters:
- name: webApplicationFirewallVerificationModel-id
in: path
description: The unique identifier of webApplicationFirewallVerificationModel
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: webApplicationFirewallVerificationModel
- 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.webApplicationFirewallProvider'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
/identity/riskPrevention/webApplicationFirewallVerifications/$count:
get:
tags:
- identity.riskPreventionContainer
summary: Get the number of the resource
operationId: identity.riskPrevention.webApplicationFirewallVerification_GetCount
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
/identity/userFlowAttributes:
get:
tags:
- identity.identityUserFlowAttribute
summary: List identityUserFlowAttributes
description: Retrieve a list of identityUserFlowAttribute objects.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/identityuserflowattribute-list?view=graph-rest-1.0
operationId: identity_ListUserFlowAttribute
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.identityUserFlowAttributeCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identity.identityUserFlowAttribute
summary: Create identityUserFlowAttribute
description: Create a new custom identityUserFlowAttribute object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/identityuserflowattribute-post?view=graph-rest-1.0
operationId: identity_CreateUserFlowAttribute
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.identityUserFlowAttribute'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.identityUserFlowAttribute'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identity/userFlowAttributes/{identityUserFlowAttribute-id}':
get:
tags:
- identity.identityUserFlowAttribute
summary: Get identityUserFlowAttribute
description: Retrieve the properties and relationships of a identityUserFlowAttribute object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/identityuserflowattribute-get?view=graph-rest-1.0
operationId: identity_GetUserFlowAttribute
parameters:
- name: identityUserFlowAttribute-id
in: path
description: The unique identifier of identityUserFlowAttribute
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: identityUserFlowAttribute
- 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.identityUserFlowAttribute'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identity.identityUserFlowAttribute
summary: Update identityUserFlowAttribute
description: Update the properties of a custom identityUserFlowAttribute object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/identityuserflowattribute-update?view=graph-rest-1.0
operationId: identity_UpdateUserFlowAttribute
parameters:
- name: identityUserFlowAttribute-id
in: path
description: The unique identifier of identityUserFlowAttribute
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: identityUserFlowAttribute
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.identityUserFlowAttribute'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.identityUserFlowAttribute'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identity.identityUserFlowAttribute
summary: Delete identityUserFlowAttribute
description: Delete a custom identityUserFlowAttribute.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/identityuserflowattribute-delete?view=graph-rest-1.0
operationId: identity_DeleteUserFlowAttribute
parameters:
- name: identityUserFlowAttribute-id
in: path
description: The unique identifier of identityUserFlowAttribute
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: identityUserFlowAttribute
- 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
/identity/userFlowAttributes/$count:
get:
tags:
- identity.identityUserFlowAttribute
summary: Get the number of the resource
operationId: identity.userFlowAttribute_GetCount
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
/identity/verifiedId:
get:
tags:
- identity.identityVerifiedIdRoot
summary: Get verifiedId from identity
description: Entry point for verified ID operations.
operationId: identity_GetVerifiedId
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.identityVerifiedIdRoot'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identity.identityVerifiedIdRoot
summary: Update the navigation property verifiedId in identity
operationId: identity_UpdateVerifiedId
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.identityVerifiedIdRoot'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.identityVerifiedIdRoot'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identity.identityVerifiedIdRoot
summary: Delete navigation property verifiedId for identity
operationId: identity_DeleteVerifiedId
parameters:
- 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
/identity/verifiedId/profiles:
get:
tags:
- identity.identityVerifiedIdRoot
summary: List profiles
description: Get a list of the verifiedIdProfile objects and their properties.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/identityverifiedidroot-list-profiles?view=graph-rest-1.0
operationId: identity.verifiedId_ListProfile
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.verifiedIdProfileCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identity.identityVerifiedIdRoot
summary: Create verifiedIdProfile
description: Create a new verifiedIdProfile object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/identityverifiedidroot-post-profiles?view=graph-rest-1.0
operationId: identity.verifiedId_CreateProfile
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.verifiedIdProfile'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.verifiedIdProfile'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identity/verifiedId/profiles/{verifiedIdProfile-id}':
get:
tags:
- identity.identityVerifiedIdRoot
summary: Get verifiedIdProfile
description: Read the properties and relationships of verifiedIdProfile object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/verifiedidprofile-get?view=graph-rest-1.0
operationId: identity.verifiedId_GetProfile
parameters:
- name: verifiedIdProfile-id
in: path
description: The unique identifier of verifiedIdProfile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: verifiedIdProfile
- 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.verifiedIdProfile'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identity.identityVerifiedIdRoot
summary: Update verifiedIdProfile
description: Update the properties of a verifiedIdProfile object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/verifiedidprofile-update?view=graph-rest-1.0
operationId: identity.verifiedId_UpdateProfile
parameters:
- name: verifiedIdProfile-id
in: path
description: The unique identifier of verifiedIdProfile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: verifiedIdProfile
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.verifiedIdProfile'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.verifiedIdProfile'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identity.identityVerifiedIdRoot
summary: Delete verifiedIdProfile
description: Delete a verifiedIdProfile object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/identityverifiedidroot-delete-profiles?view=graph-rest-1.0
operationId: identity.verifiedId_DeleteProfile
parameters:
- name: verifiedIdProfile-id
in: path
description: The unique identifier of verifiedIdProfile
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: verifiedIdProfile
- 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
/identity/verifiedId/profiles/$count:
get:
tags:
- identity.identityVerifiedIdRoot
summary: Get the number of the resource
operationId: identity.verifiedId.profile_GetCount
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
/identityProtection:
get:
tags:
- identityProtection.identityProtectionRoot
summary: Get identityProtection
operationId: identityProtection.identityProtectionRoot_GetIdentityProtectionRoot
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved entity
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.identityProtectionRoot'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityProtection.identityProtectionRoot
summary: Update identityProtection
operationId: identityProtection.identityProtectionRoot_UpdateIdentityProtectionRoot
requestBody:
description: New property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.identityProtectionRoot'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.identityProtectionRoot'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
/identityProtection/riskDetections:
get:
tags:
- identityProtection.riskDetection
summary: List riskDetections
description: Get a list of the riskDetection objects and their properties.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/riskdetection-list?view=graph-rest-1.0
operationId: identityProtection_ListRiskDetection
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.riskDetectionCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityProtection.riskDetection
summary: Create new navigation property to riskDetections for identityProtection
operationId: identityProtection_CreateRiskDetection
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.riskDetection'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.riskDetection'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityProtection/riskDetections/{riskDetection-id}':
get:
tags:
- identityProtection.riskDetection
summary: Get riskDetection
description: Read the properties and relationships of a riskDetection object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/riskdetection-get?view=graph-rest-1.0
operationId: identityProtection_GetRiskDetection
parameters:
- name: riskDetection-id
in: path
description: The unique identifier of riskDetection
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: riskDetection
- 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.riskDetection'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityProtection.riskDetection
summary: Update the navigation property riskDetections in identityProtection
operationId: identityProtection_UpdateRiskDetection
parameters:
- name: riskDetection-id
in: path
description: The unique identifier of riskDetection
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: riskDetection
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.riskDetection'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.riskDetection'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityProtection.riskDetection
summary: Delete navigation property riskDetections for identityProtection
operationId: identityProtection_DeleteRiskDetection
parameters:
- name: riskDetection-id
in: path
description: The unique identifier of riskDetection
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: riskDetection
- 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
/identityProtection/riskDetections/$count:
get:
tags:
- identityProtection.riskDetection
summary: Get the number of the resource
operationId: identityProtection.riskDetection_GetCount
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
/identityProtection/riskyServicePrincipals:
get:
tags:
- identityProtection.riskyServicePrincipal
summary: List riskyServicePrincipals
description: Retrieve the properties and relationships of riskyServicePrincipal objects.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/identityprotectionroot-list-riskyserviceprincipals?view=graph-rest-1.0
operationId: identityProtection_ListRiskyServicePrincipal
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.riskyServicePrincipalCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityProtection.riskyServicePrincipal
summary: Create new navigation property to riskyServicePrincipals for identityProtection
operationId: identityProtection_CreateRiskyServicePrincipal
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.riskyServicePrincipal'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.riskyServicePrincipal'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityProtection/riskyServicePrincipals/{riskyServicePrincipal-id}':
get:
tags:
- identityProtection.riskyServicePrincipal
summary: Get riskyServicePrincipal
description: Read the properties and relationships of a riskyServicePrincipal object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/riskyserviceprincipal-get?view=graph-rest-1.0
operationId: identityProtection_GetRiskyServicePrincipal
parameters:
- name: riskyServicePrincipal-id
in: path
description: The unique identifier of riskyServicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: riskyServicePrincipal
- 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.riskyServicePrincipal'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityProtection.riskyServicePrincipal
summary: Update the navigation property riskyServicePrincipals in identityProtection
operationId: identityProtection_UpdateRiskyServicePrincipal
parameters:
- name: riskyServicePrincipal-id
in: path
description: The unique identifier of riskyServicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: riskyServicePrincipal
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.riskyServicePrincipal'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.riskyServicePrincipal'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityProtection.riskyServicePrincipal
summary: Delete navigation property riskyServicePrincipals for identityProtection
operationId: identityProtection_DeleteRiskyServicePrincipal
parameters:
- name: riskyServicePrincipal-id
in: path
description: The unique identifier of riskyServicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: riskyServicePrincipal
- 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
'/identityProtection/riskyServicePrincipals/{riskyServicePrincipal-id}/history':
get:
tags:
- identityProtection.riskyServicePrincipal
summary: List history (risk history of riskyServicePrincipal)
description: Get the risk history of a riskyServicePrincipal object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/riskyserviceprincipal-list-history?view=graph-rest-1.0
operationId: identityProtection.riskyServicePrincipal_ListHistory
parameters:
- name: riskyServicePrincipal-id
in: path
description: The unique identifier of riskyServicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: riskyServicePrincipal
- $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.riskyServicePrincipalHistoryItemCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityProtection.riskyServicePrincipal
summary: Create new navigation property to history for identityProtection
operationId: identityProtection.riskyServicePrincipal_CreateHistory
parameters:
- name: riskyServicePrincipal-id
in: path
description: The unique identifier of riskyServicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: riskyServicePrincipal
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.riskyServicePrincipalHistoryItem'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.riskyServicePrincipalHistoryItem'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityProtection/riskyServicePrincipals/{riskyServicePrincipal-id}/history/{riskyServicePrincipalHistoryItem-id}':
get:
tags:
- identityProtection.riskyServicePrincipal
summary: Get history from identityProtection
description: Represents the risk history of Microsoft Entra service principals.
operationId: identityProtection.riskyServicePrincipal_GetHistory
parameters:
- name: riskyServicePrincipal-id
in: path
description: The unique identifier of riskyServicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: riskyServicePrincipal
- name: riskyServicePrincipalHistoryItem-id
in: path
description: The unique identifier of riskyServicePrincipalHistoryItem
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: riskyServicePrincipalHistoryItem
- 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.riskyServicePrincipalHistoryItem'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityProtection.riskyServicePrincipal
summary: Update the navigation property history in identityProtection
operationId: identityProtection.riskyServicePrincipal_UpdateHistory
parameters:
- name: riskyServicePrincipal-id
in: path
description: The unique identifier of riskyServicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: riskyServicePrincipal
- name: riskyServicePrincipalHistoryItem-id
in: path
description: The unique identifier of riskyServicePrincipalHistoryItem
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: riskyServicePrincipalHistoryItem
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.riskyServicePrincipalHistoryItem'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.riskyServicePrincipalHistoryItem'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityProtection.riskyServicePrincipal
summary: Delete navigation property history for identityProtection
operationId: identityProtection.riskyServicePrincipal_DeleteHistory
parameters:
- name: riskyServicePrincipal-id
in: path
description: The unique identifier of riskyServicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: riskyServicePrincipal
- name: riskyServicePrincipalHistoryItem-id
in: path
description: The unique identifier of riskyServicePrincipalHistoryItem
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: riskyServicePrincipalHistoryItem
- 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
'/identityProtection/riskyServicePrincipals/{riskyServicePrincipal-id}/history/$count':
get:
tags:
- identityProtection.riskyServicePrincipal
summary: Get the number of the resource
operationId: identityProtection.riskyServicePrincipal.history_GetCount
parameters:
- name: riskyServicePrincipal-id
in: path
description: The unique identifier of riskyServicePrincipal
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: riskyServicePrincipal
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
/identityProtection/riskyServicePrincipals/$count:
get:
tags:
- identityProtection.riskyServicePrincipal
summary: Get the number of the resource
operationId: identityProtection.riskyServicePrincipal_GetCount
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
/identityProtection/riskyServicePrincipals/microsoft.graph.confirmCompromised:
post:
tags:
- identityProtection.riskyServicePrincipal
summary: Invoke action confirmCompromised
description: Confirm one or more riskyServicePrincipal objects as compromised. This action sets the targeted service principal account's risk level to high.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/riskyserviceprincipal-confirmcompromised?view=graph-rest-1.0
operationId: identityProtection.riskyServicePrincipal_confirmCompromised
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
servicePrincipalIds:
type: array
items:
type: string
nullable: true
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
/identityProtection/riskyServicePrincipals/microsoft.graph.dismiss:
post:
tags:
- identityProtection.riskyServicePrincipal
summary: Invoke action dismiss
description: Dismiss the risk of one or more riskyServicePrincipal objects. This action sets the targeted service principal account's risk level to none. You can dismiss up to 60 service principal accounts in one request.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/riskyserviceprincipal-dismiss?view=graph-rest-1.0
operationId: identityProtection.riskyServicePrincipal_dismiss
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
servicePrincipalIds:
type: array
items:
type: string
nullable: true
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
/identityProtection/riskyUsers:
get:
tags:
- identityProtection.riskyUser
summary: List riskyUsers
description: Get a list of the riskyUser objects and their properties.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/riskyuser-list?view=graph-rest-1.0
operationId: identityProtection_ListRiskyUser
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.riskyUserCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityProtection.riskyUser
summary: Create new navigation property to riskyUsers for identityProtection
operationId: identityProtection_CreateRiskyUser
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.riskyUser'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.riskyUser'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityProtection/riskyUsers/{riskyUser-id}':
get:
tags:
- identityProtection.riskyUser
summary: Get riskyUser
description: Read the properties and relationships of a riskyUser object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/riskyuser-get?view=graph-rest-1.0
operationId: identityProtection_GetRiskyUser
parameters:
- name: riskyUser-id
in: path
description: The unique identifier of riskyUser
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: riskyUser
- 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.riskyUser'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityProtection.riskyUser
summary: Update the navigation property riskyUsers in identityProtection
operationId: identityProtection_UpdateRiskyUser
parameters:
- name: riskyUser-id
in: path
description: The unique identifier of riskyUser
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: riskyUser
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.riskyUser'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.riskyUser'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityProtection.riskyUser
summary: Delete navigation property riskyUsers for identityProtection
operationId: identityProtection_DeleteRiskyUser
parameters:
- name: riskyUser-id
in: path
description: The unique identifier of riskyUser
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: riskyUser
- 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
'/identityProtection/riskyUsers/{riskyUser-id}/history':
get:
tags:
- identityProtection.riskyUser
summary: List history of riskyUser
description: Get the riskyUserHistoryItems from the history navigation property.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/riskyuser-list-history?view=graph-rest-1.0
operationId: identityProtection.riskyUser_ListHistory
parameters:
- name: riskyUser-id
in: path
description: The unique identifier of riskyUser
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: riskyUser
- $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.riskyUserHistoryItemCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityProtection.riskyUser
summary: Create new navigation property to history for identityProtection
operationId: identityProtection.riskyUser_CreateHistory
parameters:
- name: riskyUser-id
in: path
description: The unique identifier of riskyUser
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: riskyUser
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.riskyUserHistoryItem'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.riskyUserHistoryItem'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityProtection/riskyUsers/{riskyUser-id}/history/{riskyUserHistoryItem-id}':
get:
tags:
- identityProtection.riskyUser
summary: Get history from identityProtection
description: The activity related to user risk level change
operationId: identityProtection.riskyUser_GetHistory
parameters:
- name: riskyUser-id
in: path
description: The unique identifier of riskyUser
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: riskyUser
- name: riskyUserHistoryItem-id
in: path
description: The unique identifier of riskyUserHistoryItem
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: riskyUserHistoryItem
- 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.riskyUserHistoryItem'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityProtection.riskyUser
summary: Update the navigation property history in identityProtection
operationId: identityProtection.riskyUser_UpdateHistory
parameters:
- name: riskyUser-id
in: path
description: The unique identifier of riskyUser
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: riskyUser
- name: riskyUserHistoryItem-id
in: path
description: The unique identifier of riskyUserHistoryItem
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: riskyUserHistoryItem
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.riskyUserHistoryItem'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.riskyUserHistoryItem'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityProtection.riskyUser
summary: Delete navigation property history for identityProtection
operationId: identityProtection.riskyUser_DeleteHistory
parameters:
- name: riskyUser-id
in: path
description: The unique identifier of riskyUser
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: riskyUser
- name: riskyUserHistoryItem-id
in: path
description: The unique identifier of riskyUserHistoryItem
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: riskyUserHistoryItem
- 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
'/identityProtection/riskyUsers/{riskyUser-id}/history/$count':
get:
tags:
- identityProtection.riskyUser
summary: Get the number of the resource
operationId: identityProtection.riskyUser.history_GetCount
parameters:
- name: riskyUser-id
in: path
description: The unique identifier of riskyUser
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: riskyUser
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
/identityProtection/riskyUsers/$count:
get:
tags:
- identityProtection.riskyUser
summary: Get the number of the resource
operationId: identityProtection.riskyUser_GetCount
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
/identityProtection/riskyUsers/microsoft.graph.confirmCompromised:
post:
tags:
- identityProtection.riskyUser
summary: Invoke action confirmCompromised
description: Confirm one or more riskyUser objects as compromised. This action sets the targeted user's risk level to high.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/riskyuser-confirmcompromised?view=graph-rest-1.0
operationId: identityProtection.riskyUser_confirmCompromised
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
userIds:
type: array
items:
type: string
nullable: true
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
/identityProtection/riskyUsers/microsoft.graph.confirmSafe:
post:
tags:
- identityProtection.riskyUser
summary: Invoke action confirmSafe
description: Confirm one or more riskyUser objects as safe. This action sets the targeted user's risk level to none.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/riskyuser-confirmsafe?view=graph-rest-1.0
operationId: identityProtection.riskyUser_confirmSafe
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
userIds:
type: array
items:
type: string
nullable: true
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
/identityProtection/riskyUsers/microsoft.graph.dismiss:
post:
tags:
- identityProtection.riskyUser
summary: Invoke action dismiss
description: Dismiss the risk of one or more riskyUser objects. This action sets the targeted user's risk level to none.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/riskyuser-dismiss?view=graph-rest-1.0
operationId: identityProtection.riskyUser_dismiss
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
userIds:
type: array
items:
type: string
nullable: true
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
/identityProtection/servicePrincipalRiskDetections:
get:
tags:
- identityProtection.servicePrincipalRiskDetection
summary: List servicePrincipalRiskDetections
description: Retrieve the properties of a collection of servicePrincipalRiskDetection objects.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/identityprotectionroot-list-serviceprincipalriskdetections?view=graph-rest-1.0
operationId: identityProtection_ListServicePrincipalRiskDetection
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.servicePrincipalRiskDetectionCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityProtection.servicePrincipalRiskDetection
summary: Create new navigation property to servicePrincipalRiskDetections for identityProtection
operationId: identityProtection_CreateServicePrincipalRiskDetection
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.servicePrincipalRiskDetection'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.servicePrincipalRiskDetection'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/identityProtection/servicePrincipalRiskDetections/{servicePrincipalRiskDetection-id}':
get:
tags:
- identityProtection.servicePrincipalRiskDetection
summary: Get servicePrincipalRiskDetection
description: Read the properties and relationships of a servicePrincipalRiskDetection object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/serviceprincipalriskdetection-get?view=graph-rest-1.0
operationId: identityProtection_GetServicePrincipalRiskDetection
parameters:
- name: servicePrincipalRiskDetection-id
in: path
description: The unique identifier of servicePrincipalRiskDetection
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipalRiskDetection
- 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.servicePrincipalRiskDetection'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- identityProtection.servicePrincipalRiskDetection
summary: Update the navigation property servicePrincipalRiskDetections in identityProtection
operationId: identityProtection_UpdateServicePrincipalRiskDetection
parameters:
- name: servicePrincipalRiskDetection-id
in: path
description: The unique identifier of servicePrincipalRiskDetection
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipalRiskDetection
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.servicePrincipalRiskDetection'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.servicePrincipalRiskDetection'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- identityProtection.servicePrincipalRiskDetection
summary: Delete navigation property servicePrincipalRiskDetections for identityProtection
operationId: identityProtection_DeleteServicePrincipalRiskDetection
parameters:
- name: servicePrincipalRiskDetection-id
in: path
description: The unique identifier of servicePrincipalRiskDetection
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: servicePrincipalRiskDetection
- 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
/identityProtection/servicePrincipalRiskDetections/$count:
get:
tags:
- identityProtection.servicePrincipalRiskDetection
summary: Get the number of the resource
operationId: identityProtection.servicePrincipalRiskDetection_GetCount
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
/identityProviders:
get:
tags:
- identityProviders.identityProvider
summary: List identityProviders (deprecated)
description: Retrieve all identityProviders in the directory.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/identityprovider-list?view=graph-rest-1.0
operationId: identityProvider_ListIdentityProvider
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.identityProviderCollectionResponse'
default:
$ref: '#/components/responses/error'
deprecated: true
x-ms-deprecation:
removalDate: '2023-03-15'
date: '2021-08-24'
version: 2021-05/identityProvider
description: The identityProvider API is deprecated and will stop returning data on March 2023. Please use the new identityProviderBase API.
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityProviders.identityProvider
summary: Create identityProvider (deprecated)
description: 'Create a new identityProvider by specifying display name, identityProvider type, client ID, and client secret.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/identityprovider-post-identityproviders?view=graph-rest-1.0
operationId: identityProvider_CreateIdentityProvider
requestBody:
description: New entity
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.identityProvider'
required: true
responses:
2XX:
description: Created entity
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.identityProvider'
default:
$ref: '#/components/responses/error'
deprecated: true
x-ms-deprecation:
removalDate: '2023-03-15'
date: '2021-08-24'
version: 2021-05/identityProvider
description: The identityProvider API is deprecated and will stop returning data on March 2023. Please use the new identityProviderBase API.
x-ms-docs-operation-type: operation
'/identityProviders/{identityProvider-id}':
get:
tags:
- identityProviders.identityProvider
summary: Get identityProvider (deprecated)
description: Retrieve the properties of an existing identityProvider.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/identityprovider-get?view=graph-rest-1.0
operationId: identityProvider_GetIdentityProvider
parameters:
- name: identityProvider-id
in: path
description: The unique identifier of identityProvider
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: identityProvider
- 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.identityProvider'
default:
$ref: '#/components/responses/error'
deprecated: true
x-ms-deprecation:
removalDate: '2023-03-15'
date: '2021-08-24'
version: 2021-05/identityProvider
description: The identityProvider API is deprecated and will stop returning data on March 2023. Please use the new identityProviderBase API.
x-ms-docs-operation-type: operation
patch:
tags:
- identityProviders.identityProvider
summary: Update identityProvider (deprecated)
description: Update properties in an existing identityProvider.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/identityprovider-update?view=graph-rest-1.0
operationId: identityProvider_UpdateIdentityProvider
parameters:
- name: identityProvider-id
in: path
description: The unique identifier of identityProvider
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: identityProvider
requestBody:
description: New property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.identityProvider'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.identityProvider'
default:
$ref: '#/components/responses/error'
deprecated: true
x-ms-deprecation:
removalDate: '2023-03-15'
date: '2021-08-24'
version: 2021-05/identityProvider
description: The identityProvider API is deprecated and will stop returning data on March 2023. Please use the new identityProviderBase API.
x-ms-docs-operation-type: operation
delete:
tags:
- identityProviders.identityProvider
summary: Delete identityProvider (deprecated)
description: Delete an existing identityProvider.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/identityprovider-delete?view=graph-rest-1.0
operationId: identityProvider_DeleteIdentityProvider
parameters:
- name: identityProvider-id
in: path
description: The unique identifier of identityProvider
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: identityProvider
- name: If-Match
in: header
description: ETag
style: simple
schema:
type: string
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
deprecated: true
x-ms-deprecation:
removalDate: '2023-03-15'
date: '2021-08-24'
version: 2021-05/identityProvider
description: The identityProvider API is deprecated and will stop returning data on March 2023. Please use the new identityProviderBase API.
x-ms-docs-operation-type: operation
/identityProviders/$count:
get:
tags:
- identityProviders.identityProvider
summary: Get the number of the resource
operationId: identityProvider_GetCount
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
deprecated: true
x-ms-deprecation:
removalDate: '2023-03-15'
date: '2021-08-24'
version: 2021-05/identityProvider
description: The identityProvider API is deprecated and will stop returning data on March 2023. Please use the new identityProviderBase API.
/identityProviders/microsoft.graph.availableProviderTypes():
get:
tags:
- identityProviders.identityProvider.Functions
summary: Invoke function availableProviderTypes
description: Retrieves all identity provider types available in a directory.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/identityprovider-list-availableprovidertypes?view=graph-rest-1.0
operationId: identityProvider_availableProviderType
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
responses:
2XX:
description: Success
content:
application/json:
schema:
type: object
properties:
value:
type: array
items:
type: string
nullable: true
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
default:
$ref: '#/components/responses/error'
deprecated: true
x-ms-deprecation:
removalDate: '2023-03-15'
date: '2021-08-24'
version: 2021-05/identityProvider
description: The identityProvider API is deprecated and will stop returning data on March 2023. Please use the new identityProviderBase API.
x-ms-docs-operation-type: function
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
/informationProtection:
get:
tags:
- informationProtection.informationProtection
summary: Get informationProtection
operationId: informationProtection_GetInformationProtection
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved entity
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.informationProtection'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- informationProtection.informationProtection
summary: Update informationProtection
operationId: informationProtection_UpdateInformationProtection
requestBody:
description: New property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.informationProtection'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.informationProtection'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
/informationProtection/bitlocker:
get:
tags:
- informationProtection.bitlocker
summary: Get bitlocker from informationProtection
operationId: informationProtection_GetBitlocker
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.bitlocker'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
/informationProtection/bitlocker/recoveryKeys:
get:
tags:
- informationProtection.bitlocker
summary: List recoveryKeys
description: 'Get a list of the bitlockerRecoveryKey objects and their properties. This operation doesn''t return the key property. For information about how to read the key property, see Get bitlockerRecoveryKey. You can use this API to programmatically iterate through the list of recovery keys in the tenant and identify devices with BitLocker enabled. For more information, see the sample PowerShell code in BitLocker recovery process.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/bitlocker-list-recoverykeys?view=graph-rest-1.0
operationId: informationProtection.bitlocker_ListRecoveryKey
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: '#/components/responses/microsoft.graph.bitlockerRecoveryKeyCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
'/informationProtection/bitlocker/recoveryKeys/{bitlockerRecoveryKey-id}':
get:
tags:
- informationProtection.bitlocker
summary: Get bitlockerRecoveryKey
description: 'Retrieve the properties and relationships of a bitlockerRecoveryKey object. By default, this operation doesn''t return the key property that represents the actual recovery key. To include the key property in the response, use the $select OData query parameter. Including the $select query parameter triggers a Microsoft Entra audit of the operation and generates an audit log. For more information on audit logs for bitlocker recovery keys, see the KeyManagement category filter of Microsoft Entra audit logs.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/bitlockerrecoverykey-get?view=graph-rest-1.0
operationId: informationProtection.bitlocker_GetRecoveryKey
parameters:
- name: bitlockerRecoveryKey-id
in: path
description: The unique identifier of bitlockerRecoveryKey
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: bitlockerRecoveryKey
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.bitlockerRecoveryKey'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
/informationProtection/bitlocker/recoveryKeys/$count:
get:
tags:
- informationProtection.bitlocker
summary: Get the number of the resource
operationId: informationProtection.bitlocker.recoveryKey_GetCount
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
/informationProtection/threatAssessmentRequests:
get:
tags:
- informationProtection.threatAssessmentRequest
summary: List threatAssessmentRequests
description: 'Retrieve a list of threatAssessmentRequest objects. A threat assessment request can be one of the following types:'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/informationprotection-list-threatassessmentrequests?view=graph-rest-1.0
operationId: informationProtection_ListThreatAssessmentRequest
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: '#/components/responses/microsoft.graph.threatAssessmentRequestCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- informationProtection.threatAssessmentRequest
summary: Create threatAssessmentRequest
description: 'Create a new threat assessment request. A threat assessment request can be one of the following types:'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/informationprotection-post-threatassessmentrequests?view=graph-rest-1.0
operationId: informationProtection_CreateThreatAssessmentRequest
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.threatAssessmentRequest'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.threatAssessmentRequest'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/informationProtection/threatAssessmentRequests/{threatAssessmentRequest-id}':
get:
tags:
- informationProtection.threatAssessmentRequest
summary: Get threatAssessmentRequest
description: 'Retrieve the properties and relationships of a specified threatAssessmentRequest object. A threat assessment request can be one of the following types:'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/threatassessmentrequest-get?view=graph-rest-1.0
operationId: informationProtection_GetThreatAssessmentRequest
parameters:
- name: threatAssessmentRequest-id
in: path
description: The unique identifier of threatAssessmentRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: threatAssessmentRequest
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.threatAssessmentRequest'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- informationProtection.threatAssessmentRequest
summary: Update the navigation property threatAssessmentRequests in informationProtection
operationId: informationProtection_UpdateThreatAssessmentRequest
parameters:
- name: threatAssessmentRequest-id
in: path
description: The unique identifier of threatAssessmentRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: threatAssessmentRequest
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.threatAssessmentRequest'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.threatAssessmentRequest'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- informationProtection.threatAssessmentRequest
summary: Delete navigation property threatAssessmentRequests for informationProtection
operationId: informationProtection_DeleteThreatAssessmentRequest
parameters:
- name: threatAssessmentRequest-id
in: path
description: The unique identifier of threatAssessmentRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: threatAssessmentRequest
- 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
'/informationProtection/threatAssessmentRequests/{threatAssessmentRequest-id}/results':
get:
tags:
- informationProtection.threatAssessmentRequest
summary: Get results from informationProtection
description: 'A collection of threat assessment results. Read-only. By default, a GET /threatAssessmentRequests/{id} does not return this property unless you apply $expand on it.'
operationId: informationProtection.threatAssessmentRequest_ListResult
parameters:
- name: threatAssessmentRequest-id
in: path
description: The unique identifier of threatAssessmentRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: threatAssessmentRequest
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: '#/components/responses/microsoft.graph.threatAssessmentResultCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- informationProtection.threatAssessmentRequest
summary: Create new navigation property to results for informationProtection
operationId: informationProtection.threatAssessmentRequest_CreateResult
parameters:
- name: threatAssessmentRequest-id
in: path
description: The unique identifier of threatAssessmentRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: threatAssessmentRequest
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.threatAssessmentResult'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.threatAssessmentResult'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/informationProtection/threatAssessmentRequests/{threatAssessmentRequest-id}/results/{threatAssessmentResult-id}':
get:
tags:
- informationProtection.threatAssessmentRequest
summary: Get results from informationProtection
description: 'A collection of threat assessment results. Read-only. By default, a GET /threatAssessmentRequests/{id} does not return this property unless you apply $expand on it.'
operationId: informationProtection.threatAssessmentRequest_GetResult
parameters:
- name: threatAssessmentRequest-id
in: path
description: The unique identifier of threatAssessmentRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: threatAssessmentRequest
- name: threatAssessmentResult-id
in: path
description: The unique identifier of threatAssessmentResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: threatAssessmentResult
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.threatAssessmentResult'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- informationProtection.threatAssessmentRequest
summary: Update the navigation property results in informationProtection
operationId: informationProtection.threatAssessmentRequest_UpdateResult
parameters:
- name: threatAssessmentRequest-id
in: path
description: The unique identifier of threatAssessmentRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: threatAssessmentRequest
- name: threatAssessmentResult-id
in: path
description: The unique identifier of threatAssessmentResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: threatAssessmentResult
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.threatAssessmentResult'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.threatAssessmentResult'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- informationProtection.threatAssessmentRequest
summary: Delete navigation property results for informationProtection
operationId: informationProtection.threatAssessmentRequest_DeleteResult
parameters:
- name: threatAssessmentRequest-id
in: path
description: The unique identifier of threatAssessmentRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: threatAssessmentRequest
- name: threatAssessmentResult-id
in: path
description: The unique identifier of threatAssessmentResult
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: threatAssessmentResult
- 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
'/informationProtection/threatAssessmentRequests/{threatAssessmentRequest-id}/results/$count':
get:
tags:
- informationProtection.threatAssessmentRequest
summary: Get the number of the resource
operationId: informationProtection.threatAssessmentRequest.result_GetCount
parameters:
- name: threatAssessmentRequest-id
in: path
description: The unique identifier of threatAssessmentRequest
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: threatAssessmentRequest
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
/informationProtection/threatAssessmentRequests/$count:
get:
tags:
- informationProtection.threatAssessmentRequest
summary: Get the number of the resource
operationId: informationProtection.threatAssessmentRequest_GetCount
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
/invitations:
get:
tags:
- invitations.invitation
summary: Get entities from invitations
operationId: invitation_ListInvitation
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.invitationCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- invitations.invitation
summary: Create invitation
description: 'Use this API to create a new invitation or reset the redemption status for a guest user who already redeemed their invitation. The invitation adds the external user to the organization as part of B2B collaboration. B2B collaboration is supported in both Microsoft Entra External ID in workforce and external tenants. When creating a new invitation, you have several options available:'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/invitation-post?view=graph-rest-1.0
operationId: invitation_CreateInvitation
requestBody:
description: New entity
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.invitation'
required: true
responses:
2XX:
description: Created entity
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.invitation'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
/invitations/$count:
get:
tags:
- invitations.invitation
summary: Get the number of the resource
operationId: invitation_GetCount
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
/invitations/invitedUser:
get:
tags:
- invitations.user
summary: Get invitedUser from invitations
description: The user created as part of the invitation creation. Read-only. The id property is required in the request body to reset a redemption status.
operationId: invitation_GetInvitedUser
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.user'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
/invitations/invitedUser/mailboxSettings:
get:
tags:
- invitations.user
summary: Get mailboxSettings property value
description: 'Settings for the primary mailbox of the signed-in user. You can get or update settings for sending automatic replies to incoming messages, locale, and time zone. Requires $select to retrieve.'
operationId: invitation.invitedUser_GetMailboxSetting
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Entity result.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.mailboxSettings'
default:
$ref: '#/components/responses/error'
patch:
tags:
- invitations.user
summary: Update property mailboxSettings value.
operationId: invitation.invitedUser_UpdateMailboxSetting
requestBody:
description: New property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.mailboxSettings'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.mailboxSettings'
default:
$ref: '#/components/responses/error'
/invitations/invitedUser/serviceProvisioningErrors:
get:
tags:
- invitations.user
summary: Get serviceProvisioningErrors property value
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).'
operationId: invitation.invitedUser_ListServiceProvisioningError
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.serviceProvisioningErrorCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
/invitations/invitedUser/serviceProvisioningErrors/$count:
get:
tags:
- invitations.user
summary: Get the number of the resource
operationId: invitation.invitedUser.ServiceProvisioningError_GetCount
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
/invitations/invitedUserSponsors:
get:
tags:
- invitations.directoryObject
summary: Get invitedUserSponsors from invitations
description: The users or groups who are sponsors of the invited user. Sponsors are users and groups that are responsible for guest users' privileges in the tenant and for keeping the guest users' information and access up to date.
operationId: invitation_ListInvitedUserSponsor
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.directoryObjectCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
'/invitations/invitedUserSponsors/{directoryObject-id}':
get:
tags:
- invitations.directoryObject
summary: Get invitedUserSponsors from invitations
description: The users or groups who are sponsors of the invited user. Sponsors are users and groups that are responsible for guest users' privileges in the tenant and for keeping the guest users' information and access up to date.
operationId: invitation_GetInvitedUserSponsor
parameters:
- 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
/invitations/invitedUserSponsors/$count:
get:
tags:
- invitations.directoryObject
summary: Get the number of the resource
operationId: invitation.invitedUserSponsor_GetCount
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
/oauth2PermissionGrants:
get:
tags:
- oauth2PermissionGrants.oAuth2PermissionGrant
summary: List oauth2PermissionGrants (delegated permission grants)
description: 'Retrieve a list of oAuth2PermissionGrant objects, representing delegated permissions which have been granted for client applications to access APIs on behalf of signed-in users.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/oauth2permissiongrant-list?view=graph-rest-1.0
operationId: oauth2PermissionGrant_ListOAuth2PermissionGrant
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.oAuth2PermissionGrantCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- oauth2PermissionGrants.oAuth2PermissionGrant
summary: Create oAuth2PermissionGrant (a delegated permission grant)
description: 'Create a delegated permission grant represented by an oAuth2PermissionGrant object. A delegated permission grant authorizes a client service principal (representing a client application) to access a resource service principal (representing an API), on behalf of a signed-in user, for the level of access limited by the delegated permissions which were granted.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/oauth2permissiongrant-post?view=graph-rest-1.0
operationId: oauth2PermissionGrant_CreateOAuth2PermissionGrant
requestBody:
description: New entity
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.oAuth2PermissionGrant'
required: true
responses:
2XX:
description: Created entity
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.oAuth2PermissionGrant'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/oauth2PermissionGrants/{oAuth2PermissionGrant-id}':
get:
tags:
- oauth2PermissionGrants.oAuth2PermissionGrant
summary: Get oAuth2PermissionGrant (a delegated permission grant)
description: Retrieve the properties of a single delegated permission grant represented by an oAuth2PermissionGrant object. An oAuth2PermissionGrant represents delegated permissions which have been granted for a client application to access an API on behalf of a signed-in user.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/oauth2permissiongrant-get?view=graph-rest-1.0
operationId: oauth2PermissionGrant_GetOAuth2PermissionGrant
parameters:
- 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 entity
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.oAuth2PermissionGrant'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- oauth2PermissionGrants.oAuth2PermissionGrant
summary: Update a delegated permission grant (oAuth2PermissionGrant)
description: 'Update the properties of oAuth2PermissionGrant object, representing a delegated permission grant. An oAuth2PermissionGrant can be updated to change which delegated permissions are granted, by adding or removing items from the list in scopes.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/oauth2permissiongrant-update?view=graph-rest-1.0
operationId: oauth2PermissionGrant_UpdateOAuth2PermissionGrant
parameters:
- name: oAuth2PermissionGrant-id
in: path
description: The unique identifier of oAuth2PermissionGrant
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: oAuth2PermissionGrant
requestBody:
description: New property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.oAuth2PermissionGrant'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.oAuth2PermissionGrant'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- oauth2PermissionGrants.oAuth2PermissionGrant
summary: Delete oAuth2PermissionGrant (a delegated permission grant)
description: 'Delete a delegated permission grant, represented by an oAuth2PermissionGrant object. When a delegated permission grant is deleted, the access it granted is revoked. Existing access tokens will continue to be valid for their lifetime, but new access tokens will not be granted for the delegated permissions identified in the deleted oAuth2PermissionGrant.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/oauth2permissiongrant-delete?view=graph-rest-1.0
operationId: oauth2PermissionGrant_DeleteOAuth2PermissionGrant
parameters:
- 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: 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
/oauth2PermissionGrants/$count:
get:
tags:
- oauth2PermissionGrants.oAuth2PermissionGrant
summary: Get the number of the resource
operationId: oauth2PermissionGrant_GetCount
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
/oauth2PermissionGrants/microsoft.graph.delta():
get:
tags:
- oauth2PermissionGrants.oAuth2PermissionGrant.Functions
summary: Invoke function delta
description: 'Get newly created, updated, or deleted oauth2permissiongrant objects 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/oauth2permissiongrant-delta?view=graph-rest-1.0
operationId: oauth2PermissionGrant_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 oAuth2PermissionGrant
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.oAuth2PermissionGrant'
'@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
'/organization/{organization-id}/certificateBasedAuthConfiguration':
get:
tags:
- organization.certificateBasedAuthConfiguration
summary: List certificateBasedAuthConfigurations
description: Get a list of certificateBasedAuthConfiguration objects.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/certificatebasedauthconfiguration-list?view=graph-rest-1.0
operationId: organization_ListCertificateBasedAuthConfiguration
parameters:
- name: organization-id
in: path
description: The unique identifier of organization
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: organization
- $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.certificateBasedAuthConfigurationCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- organization.certificateBasedAuthConfiguration
summary: Create certificateBasedAuthConfiguration
description: Create a new certificateBasedAuthConfiguration object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/certificatebasedauthconfiguration-post-certificatebasedauthconfiguration?view=graph-rest-1.0
operationId: organization_CreateCertificateBasedAuthConfiguration
parameters:
- name: organization-id
in: path
description: The unique identifier of organization
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: organization
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.certificateBasedAuthConfiguration'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.certificateBasedAuthConfiguration'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/organization/{organization-id}/certificateBasedAuthConfiguration/{certificateBasedAuthConfiguration-id}':
get:
tags:
- organization.certificateBasedAuthConfiguration
summary: Get certificateBasedAuthConfiguration
description: Get the properties of a certificateBasedAuthConfiguration object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/certificatebasedauthconfiguration-get?view=graph-rest-1.0
operationId: organization_GetCertificateBasedAuthConfiguration
parameters:
- name: organization-id
in: path
description: The unique identifier of organization
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: organization
- name: certificateBasedAuthConfiguration-id
in: path
description: The unique identifier of certificateBasedAuthConfiguration
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: certificateBasedAuthConfiguration
- 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.certificateBasedAuthConfiguration'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- organization.certificateBasedAuthConfiguration
summary: Delete certificateBasedAuthConfiguration
description: Delete a certificateBasedAuthConfiguration object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/certificatebasedauthconfiguration-delete?view=graph-rest-1.0
operationId: organization_DeleteCertificateBasedAuthConfiguration
parameters:
- name: organization-id
in: path
description: The unique identifier of organization
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: organization
- name: certificateBasedAuthConfiguration-id
in: path
description: The unique identifier of certificateBasedAuthConfiguration
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: certificateBasedAuthConfiguration
- 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
'/organization/{organization-id}/certificateBasedAuthConfiguration/$count':
get:
tags:
- organization.certificateBasedAuthConfiguration
summary: Get the number of the resource
operationId: organization.certificateBasedAuthConfiguration_GetCount
parameters:
- name: organization-id
in: path
description: The unique identifier of organization
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: organization
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
/policies:
get:
tags:
- policies.policyRoot
summary: Get policies
operationId: policy.policyRoot_GetPolicyRoot
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved entity
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.policyRoot'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- policies.policyRoot
summary: Update policies
operationId: policy.policyRoot_UpdatePolicyRoot
requestBody:
description: New property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.policyRoot'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.policyRoot'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
/policies/activityBasedTimeoutPolicies:
get:
tags:
- policies.activityBasedTimeoutPolicy
summary: List activityBasedTimeoutPolicies
description: Get a list of activityBasedTimeoutPolicy objects.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/activitybasedtimeoutpolicy-list?view=graph-rest-1.0
operationId: policy_ListActivityBasedTimeoutPolicy
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.activityBasedTimeoutPolicyCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- policies.activityBasedTimeoutPolicy
summary: Create activityBasedTimeoutPolicy
description: Create a new activityBasedTimeoutPolicy object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/activitybasedtimeoutpolicy-post-activitybasedtimeoutpolicies?view=graph-rest-1.0
operationId: policy_CreateActivityBasedTimeoutPolicy
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.activityBasedTimeoutPolicy'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.activityBasedTimeoutPolicy'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/policies/activityBasedTimeoutPolicies/{activityBasedTimeoutPolicy-id}':
get:
tags:
- policies.activityBasedTimeoutPolicy
summary: Get activityBasedTimeoutPolicy
description: Get the properties of an activityBasedTimeoutPolicy object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/activitybasedtimeoutpolicy-get?view=graph-rest-1.0
operationId: policy_GetActivityBasedTimeoutPolicy
parameters:
- name: activityBasedTimeoutPolicy-id
in: path
description: The unique identifier of activityBasedTimeoutPolicy
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: activityBasedTimeoutPolicy
- 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.activityBasedTimeoutPolicy'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- policies.activityBasedTimeoutPolicy
summary: Update activitybasedtimeoutpolicy
description: Update the properties of an activityBasedTimeoutPolicy object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/activitybasedtimeoutpolicy-update?view=graph-rest-1.0
operationId: policy_UpdateActivityBasedTimeoutPolicy
parameters:
- name: activityBasedTimeoutPolicy-id
in: path
description: The unique identifier of activityBasedTimeoutPolicy
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: activityBasedTimeoutPolicy
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.activityBasedTimeoutPolicy'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.activityBasedTimeoutPolicy'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- policies.activityBasedTimeoutPolicy
summary: Delete activityBasedTimeoutPolicy
description: Delete an activityBasedTimeoutPolicy object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/activitybasedtimeoutpolicy-delete?view=graph-rest-1.0
operationId: policy_DeleteActivityBasedTimeoutPolicy
parameters:
- name: activityBasedTimeoutPolicy-id
in: path
description: The unique identifier of activityBasedTimeoutPolicy
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: activityBasedTimeoutPolicy
- 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
'/policies/activityBasedTimeoutPolicies/{activityBasedTimeoutPolicy-id}/appliesTo':
get:
tags:
- policies.activityBasedTimeoutPolicy
summary: Get appliesTo from policies
operationId: policy.activityBasedTimeoutPolicy_ListAppliesTo
parameters:
- name: activityBasedTimeoutPolicy-id
in: path
description: The unique identifier of activityBasedTimeoutPolicy
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: activityBasedTimeoutPolicy
- $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
'/policies/activityBasedTimeoutPolicies/{activityBasedTimeoutPolicy-id}/appliesTo/{directoryObject-id}':
get:
tags:
- policies.activityBasedTimeoutPolicy
summary: Get appliesTo from policies
operationId: policy.activityBasedTimeoutPolicy_GetAppliesTo
parameters:
- name: activityBasedTimeoutPolicy-id
in: path
description: The unique identifier of activityBasedTimeoutPolicy
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: activityBasedTimeoutPolicy
- 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
'/policies/activityBasedTimeoutPolicies/{activityBasedTimeoutPolicy-id}/appliesTo/$count':
get:
tags:
- policies.activityBasedTimeoutPolicy
summary: Get the number of the resource
operationId: policy.activityBasedTimeoutPolicy.appliesTo_GetCount
parameters:
- name: activityBasedTimeoutPolicy-id
in: path
description: The unique identifier of activityBasedTimeoutPolicy
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: activityBasedTimeoutPolicy
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
/policies/activityBasedTimeoutPolicies/$count:
get:
tags:
- policies.activityBasedTimeoutPolicy
summary: Get the number of the resource
operationId: policy.activityBasedTimeoutPolicy_GetCount
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
/policies/adminConsentRequestPolicy:
get:
tags:
- policies.adminConsentRequestPolicy
summary: Get adminConsentRequestPolicy
description: Read the properties and relationships of an adminConsentRequestPolicy object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/adminconsentrequestpolicy-get?view=graph-rest-1.0
operationId: policy_GetAdminConsentRequestPolicy
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.adminConsentRequestPolicy'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- policies.adminConsentRequestPolicy
summary: Update adminConsentRequestPolicy
description: Update the properties of an adminConsentRequestPolicy object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/adminconsentrequestpolicy-update?view=graph-rest-1.0
operationId: policy_UpdateAdminConsentRequestPolicy
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.adminConsentRequestPolicy'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.adminConsentRequestPolicy'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- policies.adminConsentRequestPolicy
summary: Delete navigation property adminConsentRequestPolicy for policies
operationId: policy_DeleteAdminConsentRequestPolicy
parameters:
- 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
/policies/appManagementPolicies:
get:
tags:
- policies.appManagementPolicy
summary: List appManagementPolicies
description: Retrieve a list of appManagementPolicy objects.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/appmanagementpolicy-list?view=graph-rest-1.0
operationId: policy_ListAppManagementPolicy
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.appManagementPolicyCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- policies.appManagementPolicy
summary: Create appManagementPolicy
description: Create an appManagementPolicy object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/appmanagementpolicy-post?view=graph-rest-1.0
operationId: policy_CreateAppManagementPolicy
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.appManagementPolicy'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.appManagementPolicy'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/policies/appManagementPolicies/{appManagementPolicy-id}':
get:
tags:
- policies.appManagementPolicy
summary: Get appManagementPolicy
description: Read the properties of an appManagementPolicy object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/appmanagementpolicy-get?view=graph-rest-1.0
operationId: policy_GetAppManagementPolicy
parameters:
- 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
patch:
tags:
- policies.appManagementPolicy
summary: Update appManagementPolicy
description: Update an appManagementPolicy object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/appmanagementpolicy-update?view=graph-rest-1.0
operationId: policy_UpdateAppManagementPolicy
parameters:
- name: appManagementPolicy-id
in: path
description: The unique identifier of appManagementPolicy
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: appManagementPolicy
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.appManagementPolicy'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.appManagementPolicy'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- policies.appManagementPolicy
summary: Delete appManagementPolicy
description: Delete an appManagementPolicy object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/appmanagementpolicy-delete?view=graph-rest-1.0
operationId: policy_DeleteAppManagementPolicy
parameters:
- 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
'/policies/appManagementPolicies/{appManagementPolicy-id}/appliesTo':
get:
tags:
- policies.appManagementPolicy
summary: List appliesTo
description: List application and service principal objects that are assigned an appManagementPolicy policy object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/appmanagementpolicy-list-appliesto?view=graph-rest-1.0
operationId: policy.appManagementPolicy_ListAppliesTo
parameters:
- name: appManagementPolicy-id
in: path
description: The unique identifier of appManagementPolicy
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: appManagementPolicy
- $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
'/policies/appManagementPolicies/{appManagementPolicy-id}/appliesTo/{directoryObject-id}':
get:
tags:
- policies.appManagementPolicy
summary: Get appliesTo from policies
description: Collection of applications and service principals to which the policy is applied.
operationId: policy.appManagementPolicy_GetAppliesTo
parameters:
- 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: 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
'/policies/appManagementPolicies/{appManagementPolicy-id}/appliesTo/$count':
get:
tags:
- policies.appManagementPolicy
summary: Get the number of the resource
operationId: policy.appManagementPolicy.appliesTo_GetCount
parameters:
- name: appManagementPolicy-id
in: path
description: The unique identifier of appManagementPolicy
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: appManagementPolicy
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
/policies/appManagementPolicies/$count:
get:
tags:
- policies.appManagementPolicy
summary: Get the number of the resource
operationId: policy.appManagementPolicy_GetCount
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
/policies/authenticationFlowsPolicy:
get:
tags:
- policies.authenticationFlowsPolicy
summary: Get authenticationFlowsPolicy
description: Read the properties and relationships of an authenticationFlowsPolicy object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/authenticationflowspolicy-get?view=graph-rest-1.0
operationId: policy_GetAuthenticationFlowsPolicy
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.authenticationFlowsPolicy'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- policies.authenticationFlowsPolicy
summary: Update authenticationFlowsPolicy
description: 'Update the selfServiceSignUp property of an authenticationFlowsPolicy object. The properties id, type, and description cannot be modified.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/authenticationflowspolicy-update?view=graph-rest-1.0
operationId: policy_UpdateAuthenticationFlowsPolicy
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.authenticationFlowsPolicy'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.authenticationFlowsPolicy'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- policies.authenticationFlowsPolicy
summary: Delete navigation property authenticationFlowsPolicy for policies
operationId: policy_DeleteAuthenticationFlowsPolicy
parameters:
- 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
/policies/authenticationMethodsPolicy:
get:
tags:
- policies.authenticationMethodsPolicy
summary: Get authenticationMethodsPolicy
description: Read the properties and relationships of an authenticationMethodsPolicy object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/authenticationmethodspolicy-get?view=graph-rest-1.0
operationId: policy_GetAuthenticationMethodsPolicy
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.authenticationMethodsPolicy'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- policies.authenticationMethodsPolicy
summary: Update authenticationMethodsPolicy
description: Update the properties of an authenticationMethodsPolicy object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/authenticationmethodspolicy-update?view=graph-rest-1.0
operationId: policy_UpdateAuthenticationMethodsPolicy
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.authenticationMethodsPolicy'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.authenticationMethodsPolicy'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- policies.authenticationMethodsPolicy
summary: Delete navigation property authenticationMethodsPolicy for policies
operationId: policy_DeleteAuthenticationMethodsPolicy
parameters:
- 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
/policies/authenticationMethodsPolicy/authenticationMethodConfigurations:
get:
tags:
- policies.authenticationMethodsPolicy
summary: Get externalAuthenticationMethodConfiguration
description: Read the properties and relationships of an externalAuthenticationMethodConfiguration object.
operationId: policy.authenticationMethodsPolicy_ListAuthenticationMethodConfiguration
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.authenticationMethodConfigurationCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- policies.authenticationMethodsPolicy
summary: Create new navigation property to authenticationMethodConfigurations for policies
operationId: policy.authenticationMethodsPolicy_CreateAuthenticationMethodConfiguration
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.authenticationMethodConfiguration'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.authenticationMethodConfiguration'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/policies/authenticationMethodsPolicy/authenticationMethodConfigurations/{authenticationMethodConfiguration-id}':
get:
tags:
- policies.authenticationMethodsPolicy
summary: Get externalAuthenticationMethodConfiguration
description: Read the properties and relationships of an externalAuthenticationMethodConfiguration object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/externalauthenticationmethodconfiguration-get?view=graph-rest-1.0
operationId: policy.authenticationMethodsPolicy_GetAuthenticationMethodConfiguration
parameters:
- name: authenticationMethodConfiguration-id
in: path
description: The unique identifier of authenticationMethodConfiguration
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: authenticationMethodConfiguration
- 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.authenticationMethodConfiguration'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- policies.authenticationMethodsPolicy
summary: Update externalAuthenticationMethodConfiguration
description: Update the properties of an externalAuthenticationMethodConfiguration object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/externalauthenticationmethodconfiguration-update?view=graph-rest-1.0
operationId: policy.authenticationMethodsPolicy_UpdateAuthenticationMethodConfiguration
parameters:
- name: authenticationMethodConfiguration-id
in: path
description: The unique identifier of authenticationMethodConfiguration
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: authenticationMethodConfiguration
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.authenticationMethodConfiguration'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.authenticationMethodConfiguration'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- policies.authenticationMethodsPolicy
summary: Delete externalAuthenticationMethodConfiguration
description: Delete an externalAuthenticationMethodConfiguration object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/externalauthenticationmethodconfiguration-delete?view=graph-rest-1.0
operationId: policy.authenticationMethodsPolicy_DeleteAuthenticationMethodConfiguration
parameters:
- name: authenticationMethodConfiguration-id
in: path
description: The unique identifier of authenticationMethodConfiguration
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: authenticationMethodConfiguration
- 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
/policies/authenticationMethodsPolicy/authenticationMethodConfigurations/$count:
get:
tags:
- policies.authenticationMethodsPolicy
summary: Get the number of the resource
operationId: policy.authenticationMethodsPolicy.authenticationMethodConfiguration_GetCount
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
/policies/authenticationStrengthPolicies:
get:
tags:
- policies.authenticationStrengthPolicy
summary: List authenticationStrengthPolicies
description: Get a list of the authenticationStrengthPolicy objects and their properties. This API returns both built-in and custom policies.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/authenticationstrengthroot-list-policies?view=graph-rest-1.0
operationId: policy_ListAuthenticationStrengthPolicy
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.authenticationStrengthPolicyCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- policies.authenticationStrengthPolicy
summary: Create authenticationStrengthPolicy
description: Create a new custom authenticationStrengthPolicy object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/authenticationstrengthroot-post-policies?view=graph-rest-1.0
operationId: policy_CreateAuthenticationStrengthPolicy
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.authenticationStrengthPolicy'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.authenticationStrengthPolicy'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/policies/authenticationStrengthPolicies/{authenticationStrengthPolicy-id}':
get:
tags:
- policies.authenticationStrengthPolicy
summary: Get authenticationStrengthPolicy
description: Read the properties and relationships of an authenticationStrengthPolicy object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/authenticationstrengthpolicy-get?view=graph-rest-1.0
operationId: policy_GetAuthenticationStrengthPolicy
parameters:
- name: authenticationStrengthPolicy-id
in: path
description: The unique identifier of authenticationStrengthPolicy
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: authenticationStrengthPolicy
- 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.authenticationStrengthPolicy'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- policies.authenticationStrengthPolicy
summary: Update authenticationStrengthPolicy
description: 'Update the properties of an authenticationStrengthPolicy object. You cannot update the allowed auth method combinations using this request. To do so, use the Update allowed combinations action.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/authenticationstrengthpolicy-update?view=graph-rest-1.0
operationId: policy_UpdateAuthenticationStrengthPolicy
parameters:
- name: authenticationStrengthPolicy-id
in: path
description: The unique identifier of authenticationStrengthPolicy
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: authenticationStrengthPolicy
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.authenticationStrengthPolicy'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.authenticationStrengthPolicy'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- policies.authenticationStrengthPolicy
summary: Delete authenticationStrengthPolicy
description: Delete a custom authenticationStrengthPolicy object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/authenticationstrengthroot-delete-policies?view=graph-rest-1.0
operationId: policy_DeleteAuthenticationStrengthPolicy
parameters:
- name: authenticationStrengthPolicy-id
in: path
description: The unique identifier of authenticationStrengthPolicy
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: authenticationStrengthPolicy
- 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
'/policies/authenticationStrengthPolicies/{authenticationStrengthPolicy-id}/combinationConfigurations':
get:
tags:
- policies.authenticationStrengthPolicy
summary: Get combinationConfigurations from policies
description: Settings that may be used to require specific types or instances of an authentication method to be used when authenticating with a specified combination of authentication methods.
operationId: policy.authenticationStrengthPolicy_ListCombinationConfiguration
parameters:
- name: authenticationStrengthPolicy-id
in: path
description: The unique identifier of authenticationStrengthPolicy
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: authenticationStrengthPolicy
- $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.authenticationCombinationConfigurationCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- policies.authenticationStrengthPolicy
summary: Create new navigation property to combinationConfigurations for policies
operationId: policy.authenticationStrengthPolicy_CreateCombinationConfiguration
parameters:
- name: authenticationStrengthPolicy-id
in: path
description: The unique identifier of authenticationStrengthPolicy
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: authenticationStrengthPolicy
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.authenticationCombinationConfiguration'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.authenticationCombinationConfiguration'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/policies/authenticationStrengthPolicies/{authenticationStrengthPolicy-id}/combinationConfigurations/{authenticationCombinationConfiguration-id}':
get:
tags:
- policies.authenticationStrengthPolicy
summary: Get combinationConfigurations from policies
description: Settings that may be used to require specific types or instances of an authentication method to be used when authenticating with a specified combination of authentication methods.
operationId: policy.authenticationStrengthPolicy_GetCombinationConfiguration
parameters:
- name: authenticationStrengthPolicy-id
in: path
description: The unique identifier of authenticationStrengthPolicy
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: authenticationStrengthPolicy
- name: authenticationCombinationConfiguration-id
in: path
description: The unique identifier of authenticationCombinationConfiguration
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: authenticationCombinationConfiguration
- 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.authenticationCombinationConfiguration'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- policies.authenticationStrengthPolicy
summary: Update the navigation property combinationConfigurations in policies
operationId: policy.authenticationStrengthPolicy_UpdateCombinationConfiguration
parameters:
- name: authenticationStrengthPolicy-id
in: path
description: The unique identifier of authenticationStrengthPolicy
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: authenticationStrengthPolicy
- name: authenticationCombinationConfiguration-id
in: path
description: The unique identifier of authenticationCombinationConfiguration
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: authenticationCombinationConfiguration
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.authenticationCombinationConfiguration'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.authenticationCombinationConfiguration'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- policies.authenticationStrengthPolicy
summary: Delete navigation property combinationConfigurations for policies
operationId: policy.authenticationStrengthPolicy_DeleteCombinationConfiguration
parameters:
- name: authenticationStrengthPolicy-id
in: path
description: The unique identifier of authenticationStrengthPolicy
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: authenticationStrengthPolicy
- name: authenticationCombinationConfiguration-id
in: path
description: The unique identifier of authenticationCombinationConfiguration
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: authenticationCombinationConfiguration
- 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
'/policies/authenticationStrengthPolicies/{authenticationStrengthPolicy-id}/combinationConfigurations/$count':
get:
tags:
- policies.authenticationStrengthPolicy
summary: Get the number of the resource
operationId: policy.authenticationStrengthPolicy.combinationConfiguration_GetCount
parameters:
- name: authenticationStrengthPolicy-id
in: path
description: The unique identifier of authenticationStrengthPolicy
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: authenticationStrengthPolicy
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/policies/authenticationStrengthPolicies/{authenticationStrengthPolicy-id}/microsoft.graph.updateAllowedCombinations':
post:
tags:
- policies.authenticationStrengthPolicy
summary: Invoke action updateAllowedCombinations
description: 'Update the allowedCombinations property of an authenticationStrengthPolicy object. To update other properties of an authenticationStrengthPolicy object, use the Update authenticationStrengthPolicy method.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/authenticationstrengthpolicy-updateallowedcombinations?view=graph-rest-1.0
operationId: policy.authenticationStrengthPolicy_updateAllowedCombination
parameters:
- name: authenticationStrengthPolicy-id
in: path
description: The unique identifier of authenticationStrengthPolicy
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: authenticationStrengthPolicy
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
allowedCombinations:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.authenticationMethodModes'
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.updateAllowedCombinationsResult'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/policies/authenticationStrengthPolicies/{authenticationStrengthPolicy-id}/microsoft.graph.usage()':
get:
tags:
- policies.authenticationStrengthPolicy
summary: Invoke function usage
description: 'Allows the caller to see which Conditional Access policies reference a specified authentication strength policy. The policies are returned in two collections, one containing Conditional Access policies that require an MFA claim and the other containing Conditional Access policies that don''t require such a claim. Policies in the former category are restricted in what kinds of changes may be made to them to prevent undermining the MFA requirement of those policies.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/authenticationstrengthpolicy-usage?view=graph-rest-1.0
operationId: policy.authenticationStrengthPolicy_usage
parameters:
- name: authenticationStrengthPolicy-id
in: path
description: The unique identifier of authenticationStrengthPolicy
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: authenticationStrengthPolicy
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.authenticationStrengthUsage'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
/policies/authenticationStrengthPolicies/$count:
get:
tags:
- policies.authenticationStrengthPolicy
summary: Get the number of the resource
operationId: policy.authenticationStrengthPolicy_GetCount
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
/policies/authorizationPolicy:
get:
tags:
- policies.authorizationPolicy
summary: Get authorizationPolicy
description: Retrieve the properties of an authorizationPolicy object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/authorizationpolicy-get?view=graph-rest-1.0
operationId: policy_GetAuthorizationPolicy
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.authorizationPolicy'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- policies.authorizationPolicy
summary: Update authorizationPolicy
description: Update the properties of an authorizationPolicy object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/authorizationpolicy-update?view=graph-rest-1.0
operationId: policy_UpdateAuthorizationPolicy
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.authorizationPolicy'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.authorizationPolicy'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- policies.authorizationPolicy
summary: Delete navigation property authorizationPolicy for policies
operationId: policy_DeleteAuthorizationPolicy
parameters:
- 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
/policies/claimsMappingPolicies:
get:
tags:
- policies.claimsMappingPolicy
summary: List claimsMappingPolicies
description: Get a list of claimsMappingPolicy objects.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/claimsmappingpolicy-list?view=graph-rest-1.0
operationId: policy_ListClaimsMappingPolicy
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.claimsMappingPolicyCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- policies.claimsMappingPolicy
summary: Create claimsMappingPolicy
description: Create a new claimsMappingPolicy object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/claimsmappingpolicy-post-claimsmappingpolicies?view=graph-rest-1.0
operationId: policy_CreateClaimsMappingPolicy
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.claimsMappingPolicy'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.claimsMappingPolicy'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/policies/claimsMappingPolicies/{claimsMappingPolicy-id}':
get:
tags:
- policies.claimsMappingPolicy
summary: Get claimsMappingPolicy
description: Retrieve the properties and relationships of a claimsMappingPolicy object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/claimsmappingpolicy-get?view=graph-rest-1.0
operationId: policy_GetClaimsMappingPolicy
parameters:
- 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: $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.claimsMappingPolicy'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- policies.claimsMappingPolicy
summary: Update claimsmappingpolicy
description: Update the properties of a claimsMappingPolicy object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/claimsmappingpolicy-update?view=graph-rest-1.0
operationId: policy_UpdateClaimsMappingPolicy
parameters:
- name: claimsMappingPolicy-id
in: path
description: The unique identifier of claimsMappingPolicy
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: claimsMappingPolicy
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.claimsMappingPolicy'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.claimsMappingPolicy'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- policies.claimsMappingPolicy
summary: Delete claimsMappingPolicy
description: Delete a claimsMappingPolicy object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/claimsmappingpolicy-delete?view=graph-rest-1.0
operationId: policy_DeleteClaimsMappingPolicy
parameters:
- 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
'/policies/claimsMappingPolicies/{claimsMappingPolicy-id}/appliesTo':
get:
tags:
- policies.claimsMappingPolicy
summary: List appliesTo
description: Get a list of directoryObject objects that a claimsMappingPolicy object has been applied to. The claimsMappingPolicy can only be applied to application and servicePrincipal resources.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/claimsmappingpolicy-list-appliesto?view=graph-rest-1.0
operationId: policy.claimsMappingPolicy_ListAppliesTo
parameters:
- name: claimsMappingPolicy-id
in: path
description: The unique identifier of claimsMappingPolicy
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: claimsMappingPolicy
- $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
'/policies/claimsMappingPolicies/{claimsMappingPolicy-id}/appliesTo/{directoryObject-id}':
get:
tags:
- policies.claimsMappingPolicy
summary: Get appliesTo from policies
operationId: policy.claimsMappingPolicy_GetAppliesTo
parameters:
- 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: 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
'/policies/claimsMappingPolicies/{claimsMappingPolicy-id}/appliesTo/$count':
get:
tags:
- policies.claimsMappingPolicy
summary: Get the number of the resource
operationId: policy.claimsMappingPolicy.appliesTo_GetCount
parameters:
- name: claimsMappingPolicy-id
in: path
description: The unique identifier of claimsMappingPolicy
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: claimsMappingPolicy
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
/policies/claimsMappingPolicies/$count:
get:
tags:
- policies.claimsMappingPolicy
summary: Get the number of the resource
operationId: policy.claimsMappingPolicy_GetCount
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
/policies/conditionalAccessPolicies:
get:
tags:
- policies.conditionalAccessPolicy
summary: Get conditionalAccessPolicies from policies
description: The custom rules that define an access scenario.
operationId: policy_ListConditionalAccessPolicy
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.conditionalAccessPolicyCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- policies.conditionalAccessPolicy
summary: Create new navigation property to conditionalAccessPolicies for policies
operationId: policy_CreateConditionalAccessPolicy
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.conditionalAccessPolicy'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.conditionalAccessPolicy'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/policies/conditionalAccessPolicies/{conditionalAccessPolicy-id}':
get:
tags:
- policies.conditionalAccessPolicy
summary: Get conditionalAccessPolicies from policies
description: The custom rules that define an access scenario.
operationId: policy_GetConditionalAccessPolicy
parameters:
- name: conditionalAccessPolicy-id
in: path
description: The unique identifier of conditionalAccessPolicy
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: conditionalAccessPolicy
- 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.conditionalAccessPolicy'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- policies.conditionalAccessPolicy
summary: Update the navigation property conditionalAccessPolicies in policies
operationId: policy_UpdateConditionalAccessPolicy
parameters:
- name: conditionalAccessPolicy-id
in: path
description: The unique identifier of conditionalAccessPolicy
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: conditionalAccessPolicy
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.conditionalAccessPolicy'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.conditionalAccessPolicy'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- policies.conditionalAccessPolicy
summary: Delete navigation property conditionalAccessPolicies for policies
operationId: policy_DeleteConditionalAccessPolicy
parameters:
- name: conditionalAccessPolicy-id
in: path
description: The unique identifier of conditionalAccessPolicy
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: conditionalAccessPolicy
- 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
'/policies/conditionalAccessPolicies/{conditionalAccessPolicy-id}/microsoft.graph.restore':
post:
tags:
- policies.conditionalAccessPolicy
summary: Invoke action restore
operationId: policy.conditionalAccessPolicy_restore
parameters:
- name: conditionalAccessPolicy-id
in: path
description: The unique identifier of conditionalAccessPolicy
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: conditionalAccessPolicy
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.conditionalAccessPolicy'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
/policies/conditionalAccessPolicies/$count:
get:
tags:
- policies.conditionalAccessPolicy
summary: Get the number of the resource
operationId: policy.conditionalAccessPolicy_GetCount
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
/policies/crossTenantAccessPolicy:
get:
tags:
- policies.crossTenantAccessPolicy
summary: Get crossTenantAccessPolicy
description: Read the properties and relationships of a crossTenantAccessPolicy object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/crosstenantaccesspolicy-get?view=graph-rest-1.0
operationId: policy_GetCrossTenantAccessPolicy
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.crossTenantAccessPolicy'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- policies.crossTenantAccessPolicy
summary: Update crossTenantAccessPolicy
description: Update the properties of a cross-tenant access policy.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/crosstenantaccesspolicy-update?view=graph-rest-1.0
operationId: policy_UpdateCrossTenantAccessPolicy
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.crossTenantAccessPolicy'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.crossTenantAccessPolicy'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- policies.crossTenantAccessPolicy
summary: Delete navigation property crossTenantAccessPolicy for policies
operationId: policy_DeleteCrossTenantAccessPolicy
parameters:
- 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
/policies/crossTenantAccessPolicy/default:
get:
tags:
- policies.crossTenantAccessPolicy
summary: Get crossTenantAccessPolicyConfigurationDefault
description: Read the default configuration of a cross-tenant access policy. This default configuration may be the service default assigned by Microsoft Entra ID (isServiceDefault is true) or may be customized in your tenant (isServiceDefault is false).
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/crosstenantaccesspolicyconfigurationdefault-get?view=graph-rest-1.0
operationId: policy.crossTenantAccessPolicy_GetDefault
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.crossTenantAccessPolicyConfigurationDefault'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- policies.crossTenantAccessPolicy
summary: Update crossTenantAccessPolicyConfigurationDefault
description: Update the default configuration of a cross-tenant access policy.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/crosstenantaccesspolicyconfigurationdefault-update?view=graph-rest-1.0
operationId: policy.crossTenantAccessPolicy_UpdateDefault
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.crossTenantAccessPolicyConfigurationDefault'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.crossTenantAccessPolicyConfigurationDefault'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- policies.crossTenantAccessPolicy
summary: Delete navigation property default for policies
operationId: policy.crossTenantAccessPolicy_DeleteDefault
parameters:
- 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
/policies/crossTenantAccessPolicy/default/microsoft.graph.resetToSystemDefault:
post:
tags:
- policies.crossTenantAccessPolicy
summary: Invoke action resetToSystemDefault
description: Reset any changes made to the default configuration in a cross-tenant access policy back to the system default.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/crosstenantaccesspolicyconfigurationdefault-resettosystemdefault?view=graph-rest-1.0
operationId: policy.crossTenantAccessPolicy.default_resetToSystemDefault
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
/policies/crossTenantAccessPolicy/partners:
get:
tags:
- policies.crossTenantAccessPolicy
summary: List partners
description: Get a list of all partner configurations within a cross-tenant access policy. You can also use the $expand parameter to list the user synchronization policy for all partner configurations.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/crosstenantaccesspolicy-list-partners?view=graph-rest-1.0
operationId: policy.crossTenantAccessPolicy_ListPartner
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.crossTenantAccessPolicyConfigurationPartnerCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- policies.crossTenantAccessPolicy
summary: Create crossTenantAccessPolicyConfigurationPartner
description: Create a new partner configuration in a cross-tenant access policy.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/crosstenantaccesspolicy-post-partners?view=graph-rest-1.0
operationId: policy.crossTenantAccessPolicy_CreatePartner
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.crossTenantAccessPolicyConfigurationPartner'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.crossTenantAccessPolicyConfigurationPartner'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/policies/crossTenantAccessPolicy/partners/{crossTenantAccessPolicyConfigurationPartner-tenantId}':
get:
tags:
- policies.crossTenantAccessPolicy
summary: Get crossTenantAccessPolicyConfigurationPartner
description: Read the properties and relationships of a partner-specific configuration.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/crosstenantaccesspolicyconfigurationpartner-get?view=graph-rest-1.0
operationId: policy.crossTenantAccessPolicy_GetPartner
parameters:
- name: crossTenantAccessPolicyConfigurationPartner-tenantId
in: path
description: The unique identifier of crossTenantAccessPolicyConfigurationPartner
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: crossTenantAccessPolicyConfigurationPartner
- 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.crossTenantAccessPolicyConfigurationPartner'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- policies.crossTenantAccessPolicy
summary: Update crossTenantAccessPolicyConfigurationPartner
description: Update the properties of a partner-specific configuration.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/crosstenantaccesspolicyconfigurationpartner-update?view=graph-rest-1.0
operationId: policy.crossTenantAccessPolicy_UpdatePartner
parameters:
- name: crossTenantAccessPolicyConfigurationPartner-tenantId
in: path
description: The unique identifier of crossTenantAccessPolicyConfigurationPartner
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: crossTenantAccessPolicyConfigurationPartner
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.crossTenantAccessPolicyConfigurationPartner'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.crossTenantAccessPolicyConfigurationPartner'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- policies.crossTenantAccessPolicy
summary: Delete crossTenantAccessPolicyConfigurationPartner
description: 'Delete a partner-specific configuration in a cross-tenant access policy. If a configuration includes a user synchronization policy, you must first delete the user synchronization policy before you can delete the partner-specific configuration.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/crosstenantaccesspolicyconfigurationpartner-delete?view=graph-rest-1.0
operationId: policy.crossTenantAccessPolicy_DeletePartner
parameters:
- name: crossTenantAccessPolicyConfigurationPartner-tenantId
in: path
description: The unique identifier of crossTenantAccessPolicyConfigurationPartner
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: crossTenantAccessPolicyConfigurationPartner
- 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
'/policies/crossTenantAccessPolicy/partners/{crossTenantAccessPolicyConfigurationPartner-tenantId}/identitySynchronization':
get:
tags:
- policies.crossTenantAccessPolicy
summary: Get crossTenantIdentitySyncPolicyPartner
description: Get the user synchronization policy of a partner-specific configuration.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/crosstenantidentitysyncpolicypartner-get?view=graph-rest-1.0
operationId: policy.crossTenantAccessPolicy.partner_GetIdentitySynchronization
parameters:
- name: crossTenantAccessPolicyConfigurationPartner-tenantId
in: path
description: The unique identifier of crossTenantAccessPolicyConfigurationPartner
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: crossTenantAccessPolicyConfigurationPartner
- 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.crossTenantIdentitySyncPolicyPartner'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
put:
tags:
- policies.crossTenantAccessPolicy
summary: Create identitySynchronization
description: Create a cross-tenant user synchronization policy for a partner-specific configuration.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/crosstenantaccesspolicyconfigurationpartner-put-identitysynchronization?view=graph-rest-1.0
operationId: policy.crossTenantAccessPolicy.partner_SetIdentitySynchronization
parameters:
- name: crossTenantAccessPolicyConfigurationPartner-tenantId
in: path
description: The unique identifier of crossTenantAccessPolicyConfigurationPartner
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: crossTenantAccessPolicyConfigurationPartner
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.crossTenantIdentitySyncPolicyPartner'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.crossTenantIdentitySyncPolicyPartner'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- policies.crossTenantAccessPolicy
summary: Delete crossTenantIdentitySyncPolicyPartner
description: Delete the user synchronization policy for a partner-specific configuration.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/crosstenantidentitysyncpolicypartner-delete?view=graph-rest-1.0
operationId: policy.crossTenantAccessPolicy.partner_DeleteIdentitySynchronization
parameters:
- name: crossTenantAccessPolicyConfigurationPartner-tenantId
in: path
description: The unique identifier of crossTenantAccessPolicyConfigurationPartner
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: crossTenantAccessPolicyConfigurationPartner
- 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
'/policies/crossTenantAccessPolicy/partners/{crossTenantAccessPolicyConfigurationPartner-tenantId}/serviceProviderConstraints':
get:
tags:
- policies.crossTenantAccessPolicy
summary: Get serviceProviderConstraints from policies
operationId: policy.crossTenantAccessPolicy.partner_GetServiceProviderConstraint
parameters:
- name: crossTenantAccessPolicyConfigurationPartner-tenantId
in: path
description: The unique identifier of crossTenantAccessPolicyConfigurationPartner
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: crossTenantAccessPolicyConfigurationPartner
- 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.serviceProviderConstraints'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- policies.crossTenantAccessPolicy
summary: Update the navigation property serviceProviderConstraints in policies
operationId: policy.crossTenantAccessPolicy.partner_UpdateServiceProviderConstraint
parameters:
- name: crossTenantAccessPolicyConfigurationPartner-tenantId
in: path
description: The unique identifier of crossTenantAccessPolicyConfigurationPartner
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: crossTenantAccessPolicyConfigurationPartner
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.serviceProviderConstraints'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.serviceProviderConstraints'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- policies.crossTenantAccessPolicy
summary: Delete navigation property serviceProviderConstraints for policies
operationId: policy.crossTenantAccessPolicy.partner_DeleteServiceProviderConstraint
parameters:
- name: crossTenantAccessPolicyConfigurationPartner-tenantId
in: path
description: The unique identifier of crossTenantAccessPolicyConfigurationPartner
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: crossTenantAccessPolicyConfigurationPartner
- 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
/policies/crossTenantAccessPolicy/partners/$count:
get:
tags:
- policies.crossTenantAccessPolicy
summary: Get the number of the resource
operationId: policy.crossTenantAccessPolicy.partner_GetCount
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
/policies/crossTenantAccessPolicy/templates:
get:
tags:
- policies.crossTenantAccessPolicy
summary: Get templates from policies
description: Represents the base policy in the directory for multitenant organization settings.
operationId: policy.crossTenantAccessPolicy_GetTemplate
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.policyTemplate'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- policies.crossTenantAccessPolicy
summary: Update the navigation property templates in policies
operationId: policy.crossTenantAccessPolicy_UpdateTemplate
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.policyTemplate'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.policyTemplate'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- policies.crossTenantAccessPolicy
summary: Delete navigation property templates for policies
operationId: policy.crossTenantAccessPolicy_DeleteTemplate
parameters:
- 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
/policies/crossTenantAccessPolicy/templates/multiTenantOrganizationIdentitySynchronization:
get:
tags:
- policies.crossTenantAccessPolicy
summary: Get multiTenantOrganizationIdentitySyncPolicyTemplate
description: Get the cross-tenant access policy template with user synchronization settings for a multitenant organization.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/multitenantorganizationidentitysyncpolicytemplate-get?view=graph-rest-1.0
operationId: policy.crossTenantAccessPolicy.template_GetMultiTenantOrganizationIdentitySynchronization
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.multiTenantOrganizationIdentitySyncPolicyTemplate'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- policies.crossTenantAccessPolicy
summary: Update multiTenantOrganizationIdentitySyncPolicyTemplate
description: Update the cross-tenant access policy template with user synchronization settings for a multitenant organization.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/multitenantorganizationidentitysyncpolicytemplate-update?view=graph-rest-1.0
operationId: policy.crossTenantAccessPolicy.template_UpdateMultiTenantOrganizationIdentitySynchronization
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.multiTenantOrganizationIdentitySyncPolicyTemplate'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.multiTenantOrganizationIdentitySyncPolicyTemplate'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- policies.crossTenantAccessPolicy
summary: Delete navigation property multiTenantOrganizationIdentitySynchronization for policies
operationId: policy.crossTenantAccessPolicy.template_DeleteMultiTenantOrganizationIdentitySynchronization
parameters:
- 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
/policies/crossTenantAccessPolicy/templates/multiTenantOrganizationIdentitySynchronization/microsoft.graph.resetToDefaultSettings:
post:
tags:
- policies.crossTenantAccessPolicy
summary: Invoke action resetToDefaultSettings
description: 'Reset the cross-tenant access policy template with user synchronization settings for a multitenant organization to the default values. In its reset state, the template has no impact on user synchronization settings, other than that unconfigured user synchronization settings are created if needed, for every multitenant organization tenant.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/multitenantorganizationidentitysyncpolicytemplate-resettodefaultsettings?view=graph-rest-1.0
operationId: policy.crossTenantAccessPolicy.template.multiTenantOrganizationIdentitySynchronization_resetToDefaultSetting
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
/policies/crossTenantAccessPolicy/templates/multiTenantOrganizationPartnerConfiguration:
get:
tags:
- policies.crossTenantAccessPolicy
summary: Get multiTenantOrganizationPartnerConfigurationTemplate
description: Get the cross-tenant access policy template with inbound and outbound partner configuration settings for a multitenant organization.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/multitenantorganizationpartnerconfigurationtemplate-get?view=graph-rest-1.0
operationId: policy.crossTenantAccessPolicy.template_GetMultiTenantOrganizationPartnerConfiguration
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.multiTenantOrganizationPartnerConfigurationTemplate'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- policies.crossTenantAccessPolicy
summary: Update multiTenantOrganizationPartnerConfigurationTemplate
description: Update the cross-tenant access policy template with inbound and outbound partner configuration settings for a multitenant organization.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/multitenantorganizationpartnerconfigurationtemplate-update?view=graph-rest-1.0
operationId: policy.crossTenantAccessPolicy.template_UpdateMultiTenantOrganizationPartnerConfiguration
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.multiTenantOrganizationPartnerConfigurationTemplate'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.multiTenantOrganizationPartnerConfigurationTemplate'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- policies.crossTenantAccessPolicy
summary: Delete navigation property multiTenantOrganizationPartnerConfiguration for policies
operationId: policy.crossTenantAccessPolicy.template_DeleteMultiTenantOrganizationPartnerConfiguration
parameters:
- 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
/policies/crossTenantAccessPolicy/templates/multiTenantOrganizationPartnerConfiguration/microsoft.graph.resetToDefaultSettings:
post:
tags:
- policies.crossTenantAccessPolicy
summary: Invoke action resetToDefaultSettings
description: 'Reset the cross-tenant access policy template with inbound and outbound partner configuration settings for a multitenant organization to the default values. In its reset state, the template has no impact on partner configuration settings, other than that an unconfigured partner configuration is created if needed, for every multitenant organization tenant.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/multitenantorganizationpartnerconfigurationtemplate-resettodefaultsettings?view=graph-rest-1.0
operationId: policy.crossTenantAccessPolicy.template.multiTenantOrganizationPartnerConfiguration_resetToDefaultSetting
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
/policies/defaultAppManagementPolicy:
get:
tags:
- policies.tenantAppManagementPolicy
summary: Get tenantAppManagementPolicy
description: Read the properties of a tenantAppManagementPolicy object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/tenantappmanagementpolicy-get?view=graph-rest-1.0
operationId: policy_GetDefaultAppManagementPolicy
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.tenantAppManagementPolicy'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- policies.tenantAppManagementPolicy
summary: Update tenantAppManagementPolicy
description: Update the properties of a tenantAppManagementPolicy object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/tenantappmanagementpolicy-update?view=graph-rest-1.0
operationId: policy_UpdateDefaultAppManagementPolicy
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.tenantAppManagementPolicy'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.tenantAppManagementPolicy'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- policies.tenantAppManagementPolicy
summary: Delete navigation property defaultAppManagementPolicy for policies
operationId: policy_DeleteDefaultAppManagementPolicy
parameters:
- 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
/policies/deviceRegistrationPolicy:
get:
tags:
- policies.deviceRegistrationPolicy
summary: Get deviceRegistrationPolicy
description: 'Read the properties and relationships of a deviceRegistrationPolicy object. Represents deviceRegistrationPolicy quota restrictions, additional authentication, and authorization policies to register device identities to your organization.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/deviceregistrationpolicy-get?view=graph-rest-1.0
operationId: policy_GetDeviceRegistrationPolicy
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.deviceRegistrationPolicy'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
/policies/featureRolloutPolicies:
get:
tags:
- policies.featureRolloutPolicy
summary: List featureRolloutPolicies
description: Retrieve a list of featureRolloutPolicy objects.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/featurerolloutpolicies-list?view=graph-rest-1.0
operationId: policy_ListFeatureRolloutPolicy
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.featureRolloutPolicyCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- policies.featureRolloutPolicy
summary: Create featureRolloutPolicy
description: Create a new featureRolloutPolicy object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/featurerolloutpolicies-post?view=graph-rest-1.0
operationId: policy_CreateFeatureRolloutPolicy
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.featureRolloutPolicy'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.featureRolloutPolicy'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/policies/featureRolloutPolicies/{featureRolloutPolicy-id}':
get:
tags:
- policies.featureRolloutPolicy
summary: Get featureRolloutPolicy
description: Retrieve the properties and relationships of a featureRolloutPolicy object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/featurerolloutpolicy-get?view=graph-rest-1.0
operationId: policy_GetFeatureRolloutPolicy
parameters:
- name: featureRolloutPolicy-id
in: path
description: The unique identifier of featureRolloutPolicy
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: featureRolloutPolicy
- 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.featureRolloutPolicy'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- policies.featureRolloutPolicy
summary: Update featurerolloutpolicy
description: Update the properties of featureRolloutPolicy object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/featurerolloutpolicy-update?view=graph-rest-1.0
operationId: policy_UpdateFeatureRolloutPolicy
parameters:
- name: featureRolloutPolicy-id
in: path
description: The unique identifier of featureRolloutPolicy
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: featureRolloutPolicy
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.featureRolloutPolicy'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.featureRolloutPolicy'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- policies.featureRolloutPolicy
summary: Delete featureRolloutPolicy
description: Delete a featureRolloutPolicy object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/featurerolloutpolicy-delete?view=graph-rest-1.0
operationId: policy_DeleteFeatureRolloutPolicy
parameters:
- name: featureRolloutPolicy-id
in: path
description: The unique identifier of featureRolloutPolicy
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: featureRolloutPolicy
- 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
'/policies/featureRolloutPolicies/{featureRolloutPolicy-id}/appliesTo':
get:
tags:
- policies.featureRolloutPolicy
summary: Get appliesTo from policies
description: Nullable. Specifies a list of directoryObject resources that feature is enabled for.
operationId: policy.featureRolloutPolicy_ListAppliesTo
parameters:
- name: featureRolloutPolicy-id
in: path
description: The unique identifier of featureRolloutPolicy
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: featureRolloutPolicy
- $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
post:
tags:
- policies.featureRolloutPolicy
summary: Assign appliesTo on a featureRolloutPolicy
description: Add an appliesTo on a featureRolloutPolicy object to specify the directoryObject to which the featureRolloutPolicy should be applied.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/featurerolloutpolicy-post-appliesto?view=graph-rest-1.0
operationId: policy.featureRolloutPolicy_CreateAppliesTo
parameters:
- name: featureRolloutPolicy-id
in: path
description: The unique identifier of featureRolloutPolicy
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: featureRolloutPolicy
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/policies/featureRolloutPolicies/{featureRolloutPolicy-id}/appliesTo/{directoryObject-id}/$ref':
delete:
tags:
- policies.featureRolloutPolicy
summary: Remove appliesTo on a featureRolloutPolicy
description: Remove an appliesTo on a featureRolloutPolicy object to remove the directoryObject from feature rollout.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/featurerolloutpolicy-delete-appliesto?view=graph-rest-1.0
operationId: policy.featureRolloutPolicy.appliesTo_DeleteDirectoryObjectGraphBPreRef
parameters:
- name: featureRolloutPolicy-id
in: path
description: The unique identifier of featureRolloutPolicy
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: featureRolloutPolicy
- 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
'/policies/featureRolloutPolicies/{featureRolloutPolicy-id}/appliesTo/$count':
get:
tags:
- policies.featureRolloutPolicy
summary: Get the number of the resource
operationId: policy.featureRolloutPolicy.appliesTo_GetCount
parameters:
- name: featureRolloutPolicy-id
in: path
description: The unique identifier of featureRolloutPolicy
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: featureRolloutPolicy
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/policies/featureRolloutPolicies/{featureRolloutPolicy-id}/appliesTo/$ref':
get:
tags:
- policies.featureRolloutPolicy
summary: Get ref of appliesTo from policies
description: Nullable. Specifies a list of directoryObject resources that feature is enabled for.
operationId: policy.featureRolloutPolicy_ListAppliesToGraphBPreRef
parameters:
- name: featureRolloutPolicy-id
in: path
description: The unique identifier of featureRolloutPolicy
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: featureRolloutPolicy
- $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:
- policies.featureRolloutPolicy
summary: Assign appliesTo on a featureRolloutPolicy
description: Add an appliesTo on a featureRolloutPolicy object to specify the directoryObject to which the featureRolloutPolicy should be applied.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/featurerolloutpolicy-post-appliesto?view=graph-rest-1.0
operationId: policy.featureRolloutPolicy_CreateAppliesToGraphBPreRef
parameters:
- name: featureRolloutPolicy-id
in: path
description: The unique identifier of featureRolloutPolicy
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: featureRolloutPolicy
requestBody:
$ref: '#/components/requestBodies/refPostBody'
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- policies.featureRolloutPolicy
summary: Remove appliesTo on a featureRolloutPolicy
description: Remove an appliesTo on a featureRolloutPolicy object to remove the directoryObject from feature rollout.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/featurerolloutpolicy-delete-appliesto?view=graph-rest-1.0
operationId: policy.featureRolloutPolicy_DeleteAppliesToGraphBPreRef
parameters:
- name: featureRolloutPolicy-id
in: path
description: The unique identifier of featureRolloutPolicy
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: featureRolloutPolicy
- 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
/policies/featureRolloutPolicies/$count:
get:
tags:
- policies.featureRolloutPolicy
summary: Get the number of the resource
operationId: policy.featureRolloutPolicy_GetCount
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
/policies/federatedTokenValidationPolicy:
get:
tags:
- policies.federatedTokenValidationPolicy
summary: Get federatedTokenValidationPolicy from policies
operationId: policy_GetFederatedTokenValidationPolicy
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.federatedTokenValidationPolicy'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- policies.federatedTokenValidationPolicy
summary: Update the navigation property federatedTokenValidationPolicy in policies
operationId: policy_UpdateFederatedTokenValidationPolicy
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.federatedTokenValidationPolicy'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.federatedTokenValidationPolicy'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- policies.federatedTokenValidationPolicy
summary: Delete navigation property federatedTokenValidationPolicy for policies
operationId: policy_DeleteFederatedTokenValidationPolicy
parameters:
- 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
/policies/homeRealmDiscoveryPolicies:
get:
tags:
- policies.homeRealmDiscoveryPolicy
summary: List homeRealmDiscoveryPolicies
description: Get a list of homeRealmDiscoveryPolicy objects.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/homerealmdiscoverypolicy-list?view=graph-rest-1.0
operationId: policy_ListHomeRealmDiscoveryPolicy
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.homeRealmDiscoveryPolicyCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- policies.homeRealmDiscoveryPolicy
summary: Create homeRealmDiscoveryPolicy
description: Create a new homeRealmDiscoveryPolicy object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/homerealmdiscoverypolicy-post-homerealmdiscoverypolicies?view=graph-rest-1.0
operationId: policy_CreateHomeRealmDiscoveryPolicy
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.homeRealmDiscoveryPolicy'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.homeRealmDiscoveryPolicy'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/policies/homeRealmDiscoveryPolicies/{homeRealmDiscoveryPolicy-id}':
get:
tags:
- policies.homeRealmDiscoveryPolicy
summary: Get homeRealmDiscoveryPolicy
description: Retrieve the properties and relationships of a homeRealmDiscoveryPolicy object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/homerealmdiscoverypolicy-get?view=graph-rest-1.0
operationId: policy_GetHomeRealmDiscoveryPolicy
parameters:
- 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
patch:
tags:
- policies.homeRealmDiscoveryPolicy
summary: Update homerealmdiscoverypolicy
description: Update the properties of a homeRealmDiscoveryPolicy object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/homerealmdiscoverypolicy-update?view=graph-rest-1.0
operationId: policy_UpdateHomeRealmDiscoveryPolicy
parameters:
- name: homeRealmDiscoveryPolicy-id
in: path
description: The unique identifier of homeRealmDiscoveryPolicy
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: homeRealmDiscoveryPolicy
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.homeRealmDiscoveryPolicy'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.homeRealmDiscoveryPolicy'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- policies.homeRealmDiscoveryPolicy
summary: Delete homeRealmDiscoveryPolicy
description: Delete a homeRealmDiscoveryPolicy object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/homerealmdiscoverypolicy-delete?view=graph-rest-1.0
operationId: policy_DeleteHomeRealmDiscoveryPolicy
parameters:
- 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
'/policies/homeRealmDiscoveryPolicies/{homeRealmDiscoveryPolicy-id}/appliesTo':
get:
tags:
- policies.homeRealmDiscoveryPolicy
summary: List appliesTo
description: Get a list of directoryObject objects that a homeRealmDiscoveryPolicy object has been applied to.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/homerealmdiscoverypolicy-list-appliesto?view=graph-rest-1.0
operationId: policy.homeRealmDiscoveryPolicy_ListAppliesTo
parameters:
- name: homeRealmDiscoveryPolicy-id
in: path
description: The unique identifier of homeRealmDiscoveryPolicy
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: homeRealmDiscoveryPolicy
- $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
'/policies/homeRealmDiscoveryPolicies/{homeRealmDiscoveryPolicy-id}/appliesTo/{directoryObject-id}':
get:
tags:
- policies.homeRealmDiscoveryPolicy
summary: Get appliesTo from policies
operationId: policy.homeRealmDiscoveryPolicy_GetAppliesTo
parameters:
- 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: 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
'/policies/homeRealmDiscoveryPolicies/{homeRealmDiscoveryPolicy-id}/appliesTo/$count':
get:
tags:
- policies.homeRealmDiscoveryPolicy
summary: Get the number of the resource
operationId: policy.homeRealmDiscoveryPolicy.appliesTo_GetCount
parameters:
- name: homeRealmDiscoveryPolicy-id
in: path
description: The unique identifier of homeRealmDiscoveryPolicy
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: homeRealmDiscoveryPolicy
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
/policies/homeRealmDiscoveryPolicies/$count:
get:
tags:
- policies.homeRealmDiscoveryPolicy
summary: Get the number of the resource
operationId: policy.homeRealmDiscoveryPolicy_GetCount
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
/policies/identitySecurityDefaultsEnforcementPolicy:
get:
tags:
- policies.identitySecurityDefaultsEnforcementPolicy
summary: Get identitySecurityDefaultsEnforcementPolicy
description: Retrieve the properties of an identitySecurityDefaultsEnforcementPolicy object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/identitysecuritydefaultsenforcementpolicy-get?view=graph-rest-1.0
operationId: policy_GetIdentitySecurityDefaultsEnforcementPolicy
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.identitySecurityDefaultsEnforcementPolicy'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- policies.identitySecurityDefaultsEnforcementPolicy
summary: Update identitySecurityDefaultsEnforcementPolicy
description: Update the properties of an identitySecurityDefaultsEnforcementPolicy object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/identitysecuritydefaultsenforcementpolicy-update?view=graph-rest-1.0
operationId: policy_UpdateIdentitySecurityDefaultsEnforcementPolicy
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.identitySecurityDefaultsEnforcementPolicy'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.identitySecurityDefaultsEnforcementPolicy'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- policies.identitySecurityDefaultsEnforcementPolicy
summary: Delete navigation property identitySecurityDefaultsEnforcementPolicy for policies
operationId: policy_DeleteIdentitySecurityDefaultsEnforcementPolicy
parameters:
- 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
/policies/ownerlessGroupPolicy:
get:
tags:
- policies.ownerlessGroupPolicy
summary: Get ownerlessGroupPolicy
description: Read the properties of an ownerlessGroupPolicy object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/ownerlessgrouppolicy-get?view=graph-rest-1.0
operationId: policy_GetOwnerlessGroupPolicy
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.ownerlessGroupPolicy'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- policies.ownerlessGroupPolicy
summary: Create or update ownerlessGroupPolicy
description: 'Create or update the ownerlessGroupPolicy for the tenant. If the policy doesn''t exist, it creates a new one; if the policy exists, it updates the existing policy. To disable the policy, set isEnabled to false. Setting isEnabled to false clears the values of all other policy parameters.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/ownerlessgrouppolicy-upsert?view=graph-rest-1.0
operationId: policy_UpdateOwnerlessGroupPolicy
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.ownerlessGroupPolicy'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.ownerlessGroupPolicy'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
/policies/permissionGrantPolicies:
get:
tags:
- policies.permissionGrantPolicy
summary: List permissionGrantPolicies
description: Retrieve the list of permissionGrantPolicy objects.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/permissiongrantpolicy-list?view=graph-rest-1.0
operationId: policy_ListPermissionGrantPolicy
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.permissionGrantPolicyCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- policies.permissionGrantPolicy
summary: Create permissionGrantPolicy
description: 'Creates a permissionGrantPolicy. A permission grant policy is used to describe the conditions under which permissions can be granted (for example, during application consent). After creating the permission grant policy, you can add include condition sets to add matching rules, and add exclude condition sets to add exclusion rules.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/permissiongrantpolicy-post-permissiongrantpolicies?view=graph-rest-1.0
operationId: policy_CreatePermissionGrantPolicy
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.permissionGrantPolicy'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.permissionGrantPolicy'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/policies/permissionGrantPolicies/{permissionGrantPolicy-id}':
get:
tags:
- policies.permissionGrantPolicy
summary: Get permissionGrantPolicy
description: Retrieve a single permissionGrantPolicy object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/permissiongrantpolicy-get?view=graph-rest-1.0
operationId: policy_GetPermissionGrantPolicy
parameters:
- name: permissionGrantPolicy-id
in: path
description: The unique identifier of permissionGrantPolicy
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: permissionGrantPolicy
- 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.permissionGrantPolicy'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- policies.permissionGrantPolicy
summary: Update permissionGrantPolicy
description: Update properties of a permissionGrantPolicy.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/permissiongrantpolicy-update?view=graph-rest-1.0
operationId: policy_UpdatePermissionGrantPolicy
parameters:
- name: permissionGrantPolicy-id
in: path
description: The unique identifier of permissionGrantPolicy
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: permissionGrantPolicy
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.permissionGrantPolicy'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.permissionGrantPolicy'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- policies.permissionGrantPolicy
summary: Delete permissionGrantPolicy
description: Delete a permissionGrantPolicy object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/permissiongrantpolicy-delete?view=graph-rest-1.0
operationId: policy_DeletePermissionGrantPolicy
parameters:
- name: permissionGrantPolicy-id
in: path
description: The unique identifier of permissionGrantPolicy
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: permissionGrantPolicy
- 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
'/policies/permissionGrantPolicies/{permissionGrantPolicy-id}/excludes':
get:
tags:
- policies.permissionGrantPolicy
summary: List excludes collection of permissionGrantPolicy
description: Retrieve the condition sets which are *excluded* in a permissionGrantPolicy.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/permissiongrantpolicy-list-excludes?view=graph-rest-1.0
operationId: policy.permissionGrantPolicy_ListExclude
parameters:
- name: permissionGrantPolicy-id
in: path
description: The unique identifier of permissionGrantPolicy
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: permissionGrantPolicy
- $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.permissionGrantConditionSetCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- policies.permissionGrantPolicy
summary: Create permissionGrantConditionSet in excludes collection of permissionGrantPolicy
description: Add conditions under which a permission grant event is *excluded* in a permission grant policy. You do this by adding a permissionGrantConditionSet to the excludes collection of a permissionGrantPolicy.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/permissiongrantpolicy-post-excludes?view=graph-rest-1.0
operationId: policy.permissionGrantPolicy_CreateExclude
parameters:
- name: permissionGrantPolicy-id
in: path
description: The unique identifier of permissionGrantPolicy
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: permissionGrantPolicy
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.permissionGrantConditionSet'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.permissionGrantConditionSet'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/policies/permissionGrantPolicies/{permissionGrantPolicy-id}/excludes/{permissionGrantConditionSet-id}':
get:
tags:
- policies.permissionGrantPolicy
summary: Get excludes from policies
description: Condition sets that are excluded in this permission grant policy. Automatically expanded on GET.
operationId: policy.permissionGrantPolicy_GetExclude
parameters:
- name: permissionGrantPolicy-id
in: path
description: The unique identifier of permissionGrantPolicy
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: permissionGrantPolicy
- name: permissionGrantConditionSet-id
in: path
description: The unique identifier of permissionGrantConditionSet
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: permissionGrantConditionSet
- 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.permissionGrantConditionSet'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- policies.permissionGrantPolicy
summary: Update the navigation property excludes in policies
operationId: policy.permissionGrantPolicy_UpdateExclude
parameters:
- name: permissionGrantPolicy-id
in: path
description: The unique identifier of permissionGrantPolicy
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: permissionGrantPolicy
- name: permissionGrantConditionSet-id
in: path
description: The unique identifier of permissionGrantConditionSet
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: permissionGrantConditionSet
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.permissionGrantConditionSet'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.permissionGrantConditionSet'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- policies.permissionGrantPolicy
summary: Delete permissionGrantConditionSet from excludes collection of permissionGrantPolicy
description: Deletes a permissionGrantConditionSet from the excludes collection of a permissionGrantPolicy.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/permissiongrantpolicy-delete-excludes?view=graph-rest-1.0
operationId: policy.permissionGrantPolicy_DeleteExclude
parameters:
- name: permissionGrantPolicy-id
in: path
description: The unique identifier of permissionGrantPolicy
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: permissionGrantPolicy
- name: permissionGrantConditionSet-id
in: path
description: The unique identifier of permissionGrantConditionSet
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: permissionGrantConditionSet
- 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
'/policies/permissionGrantPolicies/{permissionGrantPolicy-id}/excludes/$count':
get:
tags:
- policies.permissionGrantPolicy
summary: Get the number of the resource
operationId: policy.permissionGrantPolicy.exclude_GetCount
parameters:
- name: permissionGrantPolicy-id
in: path
description: The unique identifier of permissionGrantPolicy
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: permissionGrantPolicy
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/policies/permissionGrantPolicies/{permissionGrantPolicy-id}/includes':
get:
tags:
- policies.permissionGrantPolicy
summary: List includes collection of permissionGrantPolicy
description: Retrieve the condition sets which are *included* in a permissionGrantPolicy.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/permissiongrantpolicy-list-includes?view=graph-rest-1.0
operationId: policy.permissionGrantPolicy_ListInclude
parameters:
- name: permissionGrantPolicy-id
in: path
description: The unique identifier of permissionGrantPolicy
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: permissionGrantPolicy
- $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.permissionGrantConditionSetCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- policies.permissionGrantPolicy
summary: Create permissionGrantConditionSet in includes collection of permissionGrantPolicy
description: Add conditions under which a permission grant event is *included* in a permission grant policy. You do this by adding a permissionGrantConditionSet to the includes collection of a permissionGrantPolicy.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/permissiongrantpolicy-post-includes?view=graph-rest-1.0
operationId: policy.permissionGrantPolicy_CreateInclude
parameters:
- name: permissionGrantPolicy-id
in: path
description: The unique identifier of permissionGrantPolicy
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: permissionGrantPolicy
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.permissionGrantConditionSet'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.permissionGrantConditionSet'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/policies/permissionGrantPolicies/{permissionGrantPolicy-id}/includes/{permissionGrantConditionSet-id}':
get:
tags:
- policies.permissionGrantPolicy
summary: Get includes from policies
description: Condition sets that are included in this permission grant policy. Automatically expanded on GET.
operationId: policy.permissionGrantPolicy_GetInclude
parameters:
- name: permissionGrantPolicy-id
in: path
description: The unique identifier of permissionGrantPolicy
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: permissionGrantPolicy
- name: permissionGrantConditionSet-id
in: path
description: The unique identifier of permissionGrantConditionSet
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: permissionGrantConditionSet
- 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.permissionGrantConditionSet'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- policies.permissionGrantPolicy
summary: Update the navigation property includes in policies
operationId: policy.permissionGrantPolicy_UpdateInclude
parameters:
- name: permissionGrantPolicy-id
in: path
description: The unique identifier of permissionGrantPolicy
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: permissionGrantPolicy
- name: permissionGrantConditionSet-id
in: path
description: The unique identifier of permissionGrantConditionSet
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: permissionGrantConditionSet
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.permissionGrantConditionSet'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.permissionGrantConditionSet'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- policies.permissionGrantPolicy
summary: Delete permissionGrantConditionSet from includes collection of permissionGrantPolicy
description: Deletes a permissionGrantConditionSet from the includes collection of a permissionGrantPolicy.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/permissiongrantpolicy-delete-includes?view=graph-rest-1.0
operationId: policy.permissionGrantPolicy_DeleteInclude
parameters:
- name: permissionGrantPolicy-id
in: path
description: The unique identifier of permissionGrantPolicy
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: permissionGrantPolicy
- name: permissionGrantConditionSet-id
in: path
description: The unique identifier of permissionGrantConditionSet
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: permissionGrantConditionSet
- 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
'/policies/permissionGrantPolicies/{permissionGrantPolicy-id}/includes/$count':
get:
tags:
- policies.permissionGrantPolicy
summary: Get the number of the resource
operationId: policy.permissionGrantPolicy.include_GetCount
parameters:
- name: permissionGrantPolicy-id
in: path
description: The unique identifier of permissionGrantPolicy
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: permissionGrantPolicy
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
/policies/permissionGrantPolicies/$count:
get:
tags:
- policies.permissionGrantPolicy
summary: Get the number of the resource
operationId: policy.permissionGrantPolicy_GetCount
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
/policies/roleManagementPolicies:
get:
tags:
- policies.unifiedRoleManagementPolicy
summary: List roleManagementPolicies
description: 'Get the details of the policies in PIM that can be applied to Microsoft Entra roles or group membership or ownership. To retrieve policies that apply to Azure RBAC, use the Azure REST PIM API for role management policies.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/policyroot-list-rolemanagementpolicies?view=graph-rest-1.0
operationId: policy_ListRoleManagementPolicy
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.unifiedRoleManagementPolicyCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- policies.unifiedRoleManagementPolicy
summary: Create new navigation property to roleManagementPolicies for policies
operationId: policy_CreateRoleManagementPolicy
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleManagementPolicy'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleManagementPolicy'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/policies/roleManagementPolicies/{unifiedRoleManagementPolicy-id}':
get:
tags:
- policies.unifiedRoleManagementPolicy
summary: Get unifiedRoleManagementPolicy
description: Retrieve the details of a role management policy.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/unifiedrolemanagementpolicy-get?view=graph-rest-1.0
operationId: policy_GetRoleManagementPolicy
parameters:
- name: unifiedRoleManagementPolicy-id
in: path
description: The unique identifier of unifiedRoleManagementPolicy
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleManagementPolicy
- 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.unifiedRoleManagementPolicy'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- policies.unifiedRoleManagementPolicy
summary: Update the navigation property roleManagementPolicies in policies
operationId: policy_UpdateRoleManagementPolicy
parameters:
- name: unifiedRoleManagementPolicy-id
in: path
description: The unique identifier of unifiedRoleManagementPolicy
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleManagementPolicy
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleManagementPolicy'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleManagementPolicy'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- policies.unifiedRoleManagementPolicy
summary: Delete navigation property roleManagementPolicies for policies
operationId: policy_DeleteRoleManagementPolicy
parameters:
- name: unifiedRoleManagementPolicy-id
in: path
description: The unique identifier of unifiedRoleManagementPolicy
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleManagementPolicy
- 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
'/policies/roleManagementPolicies/{unifiedRoleManagementPolicy-id}/effectiveRules':
get:
tags:
- policies.unifiedRoleManagementPolicy
summary: Get effectiveRules from policies
description: 'The list of effective rules like approval rules and expiration rules evaluated based on inherited referenced rules. For example, if there is a tenant-wide policy to enforce enabling an approval rule, the effective rule will be to enable approval even if the policy has a rule to disable approval. Supports $expand.'
operationId: policy.roleManagementPolicy_ListEffectiveRule
parameters:
- name: unifiedRoleManagementPolicy-id
in: path
description: The unique identifier of unifiedRoleManagementPolicy
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleManagementPolicy
- $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.unifiedRoleManagementPolicyRuleCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- policies.unifiedRoleManagementPolicy
summary: Create new navigation property to effectiveRules for policies
operationId: policy.roleManagementPolicy_CreateEffectiveRule
parameters:
- name: unifiedRoleManagementPolicy-id
in: path
description: The unique identifier of unifiedRoleManagementPolicy
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleManagementPolicy
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleManagementPolicyRule'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleManagementPolicyRule'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/policies/roleManagementPolicies/{unifiedRoleManagementPolicy-id}/effectiveRules/{unifiedRoleManagementPolicyRule-id}':
get:
tags:
- policies.unifiedRoleManagementPolicy
summary: Get effectiveRules from policies
description: 'The list of effective rules like approval rules and expiration rules evaluated based on inherited referenced rules. For example, if there is a tenant-wide policy to enforce enabling an approval rule, the effective rule will be to enable approval even if the policy has a rule to disable approval. Supports $expand.'
operationId: policy.roleManagementPolicy_GetEffectiveRule
parameters:
- name: unifiedRoleManagementPolicy-id
in: path
description: The unique identifier of unifiedRoleManagementPolicy
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleManagementPolicy
- name: unifiedRoleManagementPolicyRule-id
in: path
description: The unique identifier of unifiedRoleManagementPolicyRule
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleManagementPolicyRule
- 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.unifiedRoleManagementPolicyRule'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- policies.unifiedRoleManagementPolicy
summary: Update the navigation property effectiveRules in policies
operationId: policy.roleManagementPolicy_UpdateEffectiveRule
parameters:
- name: unifiedRoleManagementPolicy-id
in: path
description: The unique identifier of unifiedRoleManagementPolicy
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleManagementPolicy
- name: unifiedRoleManagementPolicyRule-id
in: path
description: The unique identifier of unifiedRoleManagementPolicyRule
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleManagementPolicyRule
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleManagementPolicyRule'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleManagementPolicyRule'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- policies.unifiedRoleManagementPolicy
summary: Delete navigation property effectiveRules for policies
operationId: policy.roleManagementPolicy_DeleteEffectiveRule
parameters:
- name: unifiedRoleManagementPolicy-id
in: path
description: The unique identifier of unifiedRoleManagementPolicy
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleManagementPolicy
- name: unifiedRoleManagementPolicyRule-id
in: path
description: The unique identifier of unifiedRoleManagementPolicyRule
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleManagementPolicyRule
- 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
'/policies/roleManagementPolicies/{unifiedRoleManagementPolicy-id}/effectiveRules/$count':
get:
tags:
- policies.unifiedRoleManagementPolicy
summary: Get the number of the resource
operationId: policy.roleManagementPolicy.effectiveRule_GetCount
parameters:
- name: unifiedRoleManagementPolicy-id
in: path
description: The unique identifier of unifiedRoleManagementPolicy
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleManagementPolicy
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/policies/roleManagementPolicies/{unifiedRoleManagementPolicy-id}/rules':
get:
tags:
- policies.unifiedRoleManagementPolicy
summary: List rules (for a role management policy)
description: 'Get the rules or settings defined for a role management policy. The rules are a collection of following types that are derived from the unifiedRoleManagementPolicyRule object:'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/unifiedrolemanagementpolicy-list-rules?view=graph-rest-1.0
operationId: policy.roleManagementPolicy_ListRule
parameters:
- name: unifiedRoleManagementPolicy-id
in: path
description: The unique identifier of unifiedRoleManagementPolicy
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleManagementPolicy
- $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.unifiedRoleManagementPolicyRuleCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- policies.unifiedRoleManagementPolicy
summary: Create new navigation property to rules for policies
operationId: policy.roleManagementPolicy_CreateRule
parameters:
- name: unifiedRoleManagementPolicy-id
in: path
description: The unique identifier of unifiedRoleManagementPolicy
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleManagementPolicy
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleManagementPolicyRule'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleManagementPolicyRule'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/policies/roleManagementPolicies/{unifiedRoleManagementPolicy-id}/rules/{unifiedRoleManagementPolicyRule-id}':
get:
tags:
- policies.unifiedRoleManagementPolicy
summary: Get unifiedRoleManagementPolicyRule
description: 'Retrieve a rule or settings defined for a role management policy. The rule can be one of the following types that are derived from the unifiedRoleManagementPolicyRule object:'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/unifiedrolemanagementpolicyrule-get?view=graph-rest-1.0
operationId: policy.roleManagementPolicy_GetRule
parameters:
- name: unifiedRoleManagementPolicy-id
in: path
description: The unique identifier of unifiedRoleManagementPolicy
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleManagementPolicy
- name: unifiedRoleManagementPolicyRule-id
in: path
description: The unique identifier of unifiedRoleManagementPolicyRule
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleManagementPolicyRule
- 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.unifiedRoleManagementPolicyRule'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- policies.unifiedRoleManagementPolicy
summary: Update unifiedRoleManagementPolicyRule
description: 'Update a rule defined for a role management policy. The rule can be one of the following types that are derived from the unifiedRoleManagementPolicyRule object: For more information about rules for Microsoft Entra roles and examples of updating rules, see the following articles:'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/unifiedrolemanagementpolicyrule-update?view=graph-rest-1.0
operationId: policy.roleManagementPolicy_UpdateRule
parameters:
- name: unifiedRoleManagementPolicy-id
in: path
description: The unique identifier of unifiedRoleManagementPolicy
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleManagementPolicy
- name: unifiedRoleManagementPolicyRule-id
in: path
description: The unique identifier of unifiedRoleManagementPolicyRule
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleManagementPolicyRule
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleManagementPolicyRule'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleManagementPolicyRule'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- policies.unifiedRoleManagementPolicy
summary: Delete navigation property rules for policies
operationId: policy.roleManagementPolicy_DeleteRule
parameters:
- name: unifiedRoleManagementPolicy-id
in: path
description: The unique identifier of unifiedRoleManagementPolicy
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleManagementPolicy
- name: unifiedRoleManagementPolicyRule-id
in: path
description: The unique identifier of unifiedRoleManagementPolicyRule
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleManagementPolicyRule
- 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
'/policies/roleManagementPolicies/{unifiedRoleManagementPolicy-id}/rules/$count':
get:
tags:
- policies.unifiedRoleManagementPolicy
summary: Get the number of the resource
operationId: policy.roleManagementPolicy.rule_GetCount
parameters:
- name: unifiedRoleManagementPolicy-id
in: path
description: The unique identifier of unifiedRoleManagementPolicy
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleManagementPolicy
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
/policies/roleManagementPolicies/$count:
get:
tags:
- policies.unifiedRoleManagementPolicy
summary: Get the number of the resource
operationId: policy.roleManagementPolicy_GetCount
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
/policies/roleManagementPolicyAssignments:
get:
tags:
- policies.unifiedRoleManagementPolicyAssignment
summary: List roleManagementPolicyAssignments
description: Get the details of all role management policy assignments made in PIM for Microsoft Entra roles and PIM for Groups.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/policyroot-list-rolemanagementpolicyassignments?view=graph-rest-1.0
operationId: policy_ListRoleManagementPolicyAssignment
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.unifiedRoleManagementPolicyAssignmentCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- policies.unifiedRoleManagementPolicyAssignment
summary: Create new navigation property to roleManagementPolicyAssignments for policies
operationId: policy_CreateRoleManagementPolicyAssignment
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleManagementPolicyAssignment'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleManagementPolicyAssignment'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/policies/roleManagementPolicyAssignments/{unifiedRoleManagementPolicyAssignment-id}':
get:
tags:
- policies.unifiedRoleManagementPolicyAssignment
summary: Get unifiedRoleManagementPolicyAssignment
description: Get the details of a policy assignment in PIM that's assigned to Microsoft Entra roles or group membership or ownership.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/unifiedrolemanagementpolicyassignment-get?view=graph-rest-1.0
operationId: policy_GetRoleManagementPolicyAssignment
parameters:
- name: unifiedRoleManagementPolicyAssignment-id
in: path
description: The unique identifier of unifiedRoleManagementPolicyAssignment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleManagementPolicyAssignment
- 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.unifiedRoleManagementPolicyAssignment'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- policies.unifiedRoleManagementPolicyAssignment
summary: Update the navigation property roleManagementPolicyAssignments in policies
operationId: policy_UpdateRoleManagementPolicyAssignment
parameters:
- name: unifiedRoleManagementPolicyAssignment-id
in: path
description: The unique identifier of unifiedRoleManagementPolicyAssignment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleManagementPolicyAssignment
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleManagementPolicyAssignment'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleManagementPolicyAssignment'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- policies.unifiedRoleManagementPolicyAssignment
summary: Delete navigation property roleManagementPolicyAssignments for policies
operationId: policy_DeleteRoleManagementPolicyAssignment
parameters:
- name: unifiedRoleManagementPolicyAssignment-id
in: path
description: The unique identifier of unifiedRoleManagementPolicyAssignment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleManagementPolicyAssignment
- 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
'/policies/roleManagementPolicyAssignments/{unifiedRoleManagementPolicyAssignment-id}/policy':
get:
tags:
- policies.unifiedRoleManagementPolicyAssignment
summary: Get policy from policies
description: The policy that's associated with a policy assignment. Supports $expand and a nested $expand of the rules and effectiveRules relationships for the policy.
operationId: policy.roleManagementPolicyAssignment_GetPolicy
parameters:
- name: unifiedRoleManagementPolicyAssignment-id
in: path
description: The unique identifier of unifiedRoleManagementPolicyAssignment
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: unifiedRoleManagementPolicyAssignment
- 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.unifiedRoleManagementPolicy'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
/policies/roleManagementPolicyAssignments/$count:
get:
tags:
- policies.unifiedRoleManagementPolicyAssignment
summary: Get the number of the resource
operationId: policy.roleManagementPolicyAssignment_GetCount
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
/policies/tokenIssuancePolicies:
get:
tags:
- policies.tokenIssuancePolicy
summary: List tokenIssuancePolicy
description: Get a list of tokenIssuancePolicy objects.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/tokenissuancepolicy-list?view=graph-rest-1.0
operationId: policy_ListTokenIssuancePolicy
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.tokenIssuancePolicyCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- policies.tokenIssuancePolicy
summary: Create tokenIssuancePolicy
description: Create a new tokenIssuancePolicy object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/tokenissuancepolicy-post-tokenissuancepolicy?view=graph-rest-1.0
operationId: policy_CreateTokenIssuancePolicy
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.tokenIssuancePolicy'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.tokenIssuancePolicy'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/policies/tokenIssuancePolicies/{tokenIssuancePolicy-id}':
get:
tags:
- policies.tokenIssuancePolicy
summary: Get tokenIssuancePolicies from policies
description: The policy that specifies the characteristics of SAML tokens issued by Microsoft Entra ID.
operationId: policy_GetTokenIssuancePolicy
parameters:
- 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: $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.tokenIssuancePolicy'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- policies.tokenIssuancePolicy
summary: Update tokenIssuancePolicy
description: Update the properties of a tokenIssuancePolicy object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/tokenissuancepolicy-update?view=graph-rest-1.0
operationId: policy_UpdateTokenIssuancePolicy
parameters:
- name: tokenIssuancePolicy-id
in: path
description: The unique identifier of tokenIssuancePolicy
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: tokenIssuancePolicy
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.tokenIssuancePolicy'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.tokenIssuancePolicy'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- policies.tokenIssuancePolicy
summary: Delete tokenIssuancePolicy
description: Delete a tokenIssuancePolicy object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/tokenissuancepolicy-delete?view=graph-rest-1.0
operationId: policy_DeleteTokenIssuancePolicy
parameters:
- 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
'/policies/tokenIssuancePolicies/{tokenIssuancePolicy-id}/appliesTo':
get:
tags:
- policies.tokenIssuancePolicy
summary: List appliesTo
description: Get a list of directoryObject objects that a tokenIssuancePolicy object has been applied to. The tokenIssuancePolicy can only be applied to application.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/tokenissuancepolicy-list-appliesto?view=graph-rest-1.0
operationId: policy.tokenIssuancePolicy_ListAppliesTo
parameters:
- name: tokenIssuancePolicy-id
in: path
description: The unique identifier of tokenIssuancePolicy
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: tokenIssuancePolicy
- $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
'/policies/tokenIssuancePolicies/{tokenIssuancePolicy-id}/appliesTo/{directoryObject-id}':
get:
tags:
- policies.tokenIssuancePolicy
summary: Get appliesTo from policies
operationId: policy.tokenIssuancePolicy_GetAppliesTo
parameters:
- 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: 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
'/policies/tokenIssuancePolicies/{tokenIssuancePolicy-id}/appliesTo/$count':
get:
tags:
- policies.tokenIssuancePolicy
summary: Get the number of the resource
operationId: policy.tokenIssuancePolicy.appliesTo_GetCount
parameters:
- name: tokenIssuancePolicy-id
in: path
description: The unique identifier of tokenIssuancePolicy
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: tokenIssuancePolicy
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
/policies/tokenIssuancePolicies/$count:
get:
tags:
- policies.tokenIssuancePolicy
summary: Get the number of the resource
operationId: policy.tokenIssuancePolicy_GetCount
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
/policies/tokenLifetimePolicies:
get:
tags:
- policies.tokenLifetimePolicy
summary: List tokenLifetimePolicies
description: Get a list of tokenLifetimePolicy objects.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/tokenlifetimepolicy-list?view=graph-rest-1.0
operationId: policy_ListTokenLifetimePolicy
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.tokenLifetimePolicyCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- policies.tokenLifetimePolicy
summary: Create tokenLifetimePolicy
description: Create a new tokenLifetimePolicy object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/tokenlifetimepolicy-post-tokenlifetimepolicies?view=graph-rest-1.0
operationId: policy_CreateTokenLifetimePolicy
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.tokenLifetimePolicy'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.tokenLifetimePolicy'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/policies/tokenLifetimePolicies/{tokenLifetimePolicy-id}':
get:
tags:
- policies.tokenLifetimePolicy
summary: Get tokenLifetimePolicy
description: Retrieve the properties and relationships of a tokenLifetimePolicy object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/tokenlifetimepolicy-get?view=graph-rest-1.0
operationId: policy_GetTokenLifetimePolicy
parameters:
- 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: $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.tokenLifetimePolicy'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- policies.tokenLifetimePolicy
summary: Update tokenlifetimepolicy
description: Update the properties of a tokenLifetimePolicy object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/tokenlifetimepolicy-update?view=graph-rest-1.0
operationId: policy_UpdateTokenLifetimePolicy
parameters:
- name: tokenLifetimePolicy-id
in: path
description: The unique identifier of tokenLifetimePolicy
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: tokenLifetimePolicy
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.tokenLifetimePolicy'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.tokenLifetimePolicy'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- policies.tokenLifetimePolicy
summary: Delete tokenLifetimePolicy
description: Delete a tokenLifetimePolicy object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/tokenlifetimepolicy-delete?view=graph-rest-1.0
operationId: policy_DeleteTokenLifetimePolicy
parameters:
- 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
'/policies/tokenLifetimePolicies/{tokenLifetimePolicy-id}/appliesTo':
get:
tags:
- policies.tokenLifetimePolicy
summary: List appliesTo
description: Get a list of directoryObject objects that a tokenLifetimePolicy object has been applied to. The tokenLifetimePolicy can only be applied to application.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/tokenlifetimepolicy-list-appliesto?view=graph-rest-1.0
operationId: policy.tokenLifetimePolicy_ListAppliesTo
parameters:
- name: tokenLifetimePolicy-id
in: path
description: The unique identifier of tokenLifetimePolicy
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: tokenLifetimePolicy
- $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
'/policies/tokenLifetimePolicies/{tokenLifetimePolicy-id}/appliesTo/{directoryObject-id}':
get:
tags:
- policies.tokenLifetimePolicy
summary: Get appliesTo from policies
operationId: policy.tokenLifetimePolicy_GetAppliesTo
parameters:
- 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: 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
'/policies/tokenLifetimePolicies/{tokenLifetimePolicy-id}/appliesTo/$count':
get:
tags:
- policies.tokenLifetimePolicy
summary: Get the number of the resource
operationId: policy.tokenLifetimePolicy.appliesTo_GetCount
parameters:
- name: tokenLifetimePolicy-id
in: path
description: The unique identifier of tokenLifetimePolicy
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: tokenLifetimePolicy
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
/policies/tokenLifetimePolicies/$count:
get:
tags:
- policies.tokenLifetimePolicy
summary: Get the number of the resource
operationId: policy.tokenLifetimePolicy_GetCount
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
/tenantRelationships/multiTenantOrganization:
get:
tags:
- tenantRelationships.multiTenantOrganization
summary: Get multiTenantOrganization
description: Get properties of the multitenant organization.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/multitenantorganization-get?view=graph-rest-1.0
operationId: tenantRelationship_GetMultiTenantOrganization
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.multiTenantOrganization'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- tenantRelationships.multiTenantOrganization
summary: Update multiTenantOrganization
description: Update the properties of a multitenant organization.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/multitenantorganization-update?view=graph-rest-1.0
operationId: tenantRelationship_UpdateMultiTenantOrganization
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.multiTenantOrganization'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.multiTenantOrganization'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
/tenantRelationships/multiTenantOrganization/joinRequest:
get:
tags:
- tenantRelationships.multiTenantOrganization
summary: Get multiTenantOrganizationJoinRequestRecord
description: Get the status of a tenant joining a multitenant organization.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/multitenantorganizationjoinrequestrecord-get?view=graph-rest-1.0
operationId: tenantRelationship.multiTenantOrganization_GetJoinRequest
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.multiTenantOrganizationJoinRequestRecord'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- tenantRelationships.multiTenantOrganization
summary: Update multiTenantOrganizationJoinRequestRecord
description: 'Join a multitenant organization, after the owner of the multitenant organization has added your tenant to the multitenant organization as pending. Before a tenant added to a multitenant organization can participate in the multitenant organization, the administrator of the joining tenant must submit a join request. To allow for asynchronous processing, you must wait up to 2 hours before joining a multitenant organization is completed.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/multitenantorganizationjoinrequestrecord-update?view=graph-rest-1.0
operationId: tenantRelationship.multiTenantOrganization_UpdateJoinRequest
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.multiTenantOrganizationJoinRequestRecord'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.multiTenantOrganizationJoinRequestRecord'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
/tenantRelationships/multiTenantOrganization/tenants:
get:
tags:
- tenantRelationships.multiTenantOrganization
summary: List multiTenantOrganizationMembers
description: List the tenants and their properties in the multitenant organization.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/multitenantorganization-list-tenants?view=graph-rest-1.0
operationId: tenantRelationship.multiTenantOrganization_ListTenant
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.multiTenantOrganizationMemberCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- tenantRelationships.multiTenantOrganization
summary: Add multiTenantOrganizationMember
description: Add a tenant to a multitenant organization. The administrator of an owner tenant has the permissions to add tenants to the multitenant organization. The added tenant is in the pending state until the administrator of the added tenant joins the multitenant organization by submitting a join request. A tenant can be part of only one multitenant organization.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/multitenantorganization-post-tenants?view=graph-rest-1.0
operationId: tenantRelationship.multiTenantOrganization_CreateTenant
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.multiTenantOrganizationMember'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.multiTenantOrganizationMember'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/tenantRelationships/multiTenantOrganization/tenants/{multiTenantOrganizationMember-id}':
get:
tags:
- tenantRelationships.multiTenantOrganization
summary: Get multiTenantOrganizationMember
description: Get a tenant and its properties in the multitenant organization.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/multitenantorganizationmember-get?view=graph-rest-1.0
operationId: tenantRelationship.multiTenantOrganization_GetTenant
parameters:
- name: multiTenantOrganizationMember-id
in: path
description: The unique identifier of multiTenantOrganizationMember
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: multiTenantOrganizationMember
- 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.multiTenantOrganizationMember'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- tenantRelationships.multiTenantOrganization
summary: Update multiTenantOrganizationMember
description: Update the properties of a tenant in a multitenant organization. Only owner tenants can call this API.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/multitenantorganizationmember-update?view=graph-rest-1.0
operationId: tenantRelationship.multiTenantOrganization_UpdateTenant
parameters:
- name: multiTenantOrganizationMember-id
in: path
description: The unique identifier of multiTenantOrganizationMember
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: multiTenantOrganizationMember
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.multiTenantOrganizationMember'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.multiTenantOrganizationMember'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- tenantRelationships.multiTenantOrganization
summary: Remove multiTenantOrganizationMember
description: 'Remove a tenant from a multitenant organization. A tenant can be removed in the following scenarios:'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/multitenantorganization-delete-tenants?view=graph-rest-1.0
operationId: tenantRelationship.multiTenantOrganization_DeleteTenant
parameters:
- name: multiTenantOrganizationMember-id
in: path
description: The unique identifier of multiTenantOrganizationMember
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: multiTenantOrganizationMember
- 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
/tenantRelationships/multiTenantOrganization/tenants/$count:
get:
tags:
- tenantRelationships.multiTenantOrganization
summary: Get the number of the resource
operationId: tenantRelationship.multiTenantOrganization.tenant_GetCount
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/users/{user-id}/authentication':
get:
tags:
- users.authentication
summary: Get authentication from users
description: The authentication methods that are supported for the user.
operationId: user_GetAuthentication
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: $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.authentication'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- users.authentication
summary: Update the navigation property authentication in users
operationId: user_UpdateAuthentication
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 values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.authentication'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.authentication'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- users.authentication
summary: Delete navigation property authentication for users
operationId: user_DeleteAuthentication
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: 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}/authentication/emailMethods':
get:
tags:
- users.authentication
summary: Get emailMethods from users
description: The email address registered to a user for authentication.
operationId: user.authentication_ListEmailMethod
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
- $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.emailAuthenticationMethodCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- users.authentication
summary: Create emailMethod
description: Set a user's emailAuthenticationMethod object. Email authentication is a self-service password reset method. A user may only have one email authentication method. Self-service operations aren't supported.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/authentication-post-emailmethods?view=graph-rest-1.0
operationId: user.authentication_CreateEmailMethod
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.emailAuthenticationMethod'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.emailAuthenticationMethod'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/users/{user-id}/authentication/emailMethods/{emailAuthenticationMethod-id}':
get:
tags:
- users.authentication
summary: Get emailMethods from users
description: The email address registered to a user for authentication.
operationId: user.authentication_GetEmailMethod
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: emailAuthenticationMethod-id
in: path
description: The unique identifier of emailAuthenticationMethod
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: emailAuthenticationMethod
- 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.emailAuthenticationMethod'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- users.authentication
summary: Update emailAuthenticationMethod
description: Update a user's email address represented by an emailAuthenticationMethod object. Self-service operations aren't supported.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/emailauthenticationmethod-update?view=graph-rest-1.0
operationId: user.authentication_UpdateEmailMethod
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: emailAuthenticationMethod-id
in: path
description: The unique identifier of emailAuthenticationMethod
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: emailAuthenticationMethod
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.emailAuthenticationMethod'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.emailAuthenticationMethod'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- users.authentication
summary: Delete emailAuthenticationMethod
description: Deletes a user's emailAuthenticationMethod object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/emailauthenticationmethod-delete?view=graph-rest-1.0
operationId: user.authentication_DeleteEmailMethod
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: emailAuthenticationMethod-id
in: path
description: The unique identifier of emailAuthenticationMethod
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: emailAuthenticationMethod
- 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}/authentication/emailMethods/$count':
get:
tags:
- users.authentication
summary: Get the number of the resource
operationId: user.authentication.emailMethod_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
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/users/{user-id}/authentication/externalAuthenticationMethods':
get:
tags:
- users.authentication
summary: Get externalAuthenticationMethods from users
description: Represents the external MFA registered to a user for authentication using an external identity provider.
operationId: user.authentication_ListExternalAuthenticationMethod
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
- $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.externalAuthenticationMethodCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- users.authentication
summary: Create externalAuthenticationMethod
description: Create a new externalAuthenticationMethod object. This API doesn't support self-service operations.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/authentication-post-externalauthenticationmethods?view=graph-rest-1.0
operationId: user.authentication_CreateExternalAuthenticationMethod
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.externalAuthenticationMethod'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.externalAuthenticationMethod'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/users/{user-id}/authentication/externalAuthenticationMethods/{externalAuthenticationMethod-id}':
get:
tags:
- users.authentication
summary: Get externalAuthenticationMethods from users
description: Represents the external MFA registered to a user for authentication using an external identity provider.
operationId: user.authentication_GetExternalAuthenticationMethod
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: externalAuthenticationMethod-id
in: path
description: The unique identifier of externalAuthenticationMethod
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: externalAuthenticationMethod
- 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.externalAuthenticationMethod'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- users.authentication
summary: Update the navigation property externalAuthenticationMethods in users
operationId: user.authentication_UpdateExternalAuthenticationMethod
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: externalAuthenticationMethod-id
in: path
description: The unique identifier of externalAuthenticationMethod
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: externalAuthenticationMethod
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.externalAuthenticationMethod'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.externalAuthenticationMethod'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- users.authentication
summary: Delete externalAuthenticationMethod
description: Delete an externalAuthenticationMethod object. This API doesn't support self-service operations.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/authentication-delete-externalauthenticationmethods?view=graph-rest-1.0
operationId: user.authentication_DeleteExternalAuthenticationMethod
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: externalAuthenticationMethod-id
in: path
description: The unique identifier of externalAuthenticationMethod
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: externalAuthenticationMethod
- 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}/authentication/externalAuthenticationMethods/$count':
get:
tags:
- users.authentication
summary: Get the number of the resource
operationId: user.authentication.externalAuthenticationMethod_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
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/users/{user-id}/authentication/fido2Methods':
get:
tags:
- users.authentication
summary: Get fido2Methods from users
description: Represents the FIDO2 security keys registered to a user for authentication.
operationId: user.authentication_ListFido2Method
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
- $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.fido2AuthenticationMethodCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
'/users/{user-id}/authentication/fido2Methods/{fido2AuthenticationMethod-id}':
get:
tags:
- users.authentication
summary: Get fido2Methods from users
description: Represents the FIDO2 security keys registered to a user for authentication.
operationId: user.authentication_GetFido2Method
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: fido2AuthenticationMethod-id
in: path
description: The unique identifier of fido2AuthenticationMethod
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: fido2AuthenticationMethod
- 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.fido2AuthenticationMethod'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- users.authentication
summary: Delete fido2AuthenticationMethod
description: Deletes a user's FIDO2 security key authentication method object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/fido2authenticationmethod-delete?view=graph-rest-1.0
operationId: user.authentication_DeleteFido2Method
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: fido2AuthenticationMethod-id
in: path
description: The unique identifier of fido2AuthenticationMethod
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: fido2AuthenticationMethod
- 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}/authentication/fido2Methods/$count':
get:
tags:
- users.authentication
summary: Get the number of the resource
operationId: user.authentication.fido2Method_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
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/users/{user-id}/authentication/fido2Methods/microsoft.graph.creationOptions()':
get:
tags:
- users.authentication
summary: Invoke function creationOptions
description: 'Retrieve creation options required to generate and register a Microsoft Entra ID-compatible passkey. This function returns WebAuthn credential creation options that include a challenge, relying party information, and user information, which are used by the client to create a new FIDO2 credential. The challenge property and credential IDs in excludeCredentials are Base64URL-encoded without padding. All binary data in the response follows Base64URL encoding as defined in RFC 4648 Section 5.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/fido2authenticationmethod-creationoptions?view=graph-rest-1.0
operationId: user.authentication.fido2Method_creationOption
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
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.webauthnCredentialCreationOptions'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
'/users/{user-id}/authentication/methods':
get:
tags:
- users.authentication
summary: Get methods from users
description: Represents all authentication methods registered to a user.
operationId: user.authentication_ListMethod
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
- $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.authenticationMethodCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- users.authentication
summary: Create new navigation property to methods for users
operationId: user.authentication_CreateMethod
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.authenticationMethod'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.authenticationMethod'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/users/{user-id}/authentication/methods/{authenticationMethod-id}':
get:
tags:
- users.authentication
summary: Get methods from users
description: Represents all authentication methods registered to a user.
operationId: user.authentication_GetMethod
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: authenticationMethod-id
in: path
description: The unique identifier of authenticationMethod
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: authenticationMethod
- 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.authenticationMethod'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- users.authentication
summary: Update the navigation property methods in users
operationId: user.authentication_UpdateMethod
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: authenticationMethod-id
in: path
description: The unique identifier of authenticationMethod
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: authenticationMethod
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.authenticationMethod'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.authenticationMethod'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/users/{user-id}/authentication/methods/{authenticationMethod-id}/microsoft.graph.resetPassword':
post:
tags:
- users.authentication
summary: Invoke action resetPassword
description: 'Reset a user''s password, represented by a password authentication method object. This can only be done by an administrator with appropriate permissions and can''t be performed on a user''s own account. To reset a user''s password in Azure AD B2C, use the Update user API operation and update the passwordProfile > forceChangePasswordNextSignIn object. This flow writes the new password to Microsoft Entra ID and pushes it to on-premises Active Directory if configured using password writeback. The admin can either provide a new password or have the system generate one. The user is prompted to change their password on their next sign in. This reset is a long-running operation and returns a Location header with a link where the caller can periodically check for the status of the reset operation.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/authenticationmethod-resetpassword?view=graph-rest-1.0
operationId: user.authentication.method_resetPassword
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: authenticationMethod-id
in: path
description: The unique identifier of authenticationMethod
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: authenticationMethod
requestBody:
description: Action parameters
content:
application/json:
schema:
type: object
properties:
newPassword:
type: string
nullable: true
additionalProperties:
type: object
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.passwordResetResponse'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/users/{user-id}/authentication/methods/$count':
get:
tags:
- users.authentication
summary: Get the number of the resource
operationId: user.authentication.method_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
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/users/{user-id}/authentication/microsoftAuthenticatorMethods':
get:
tags:
- users.authentication
summary: List microsoftAuthenticatorAuthenticationMethods
description: Get a list of the microsoftAuthenticatorAuthenticationMethod objects and their properties.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/microsoftauthenticatorauthenticationmethod-list?view=graph-rest-1.0
operationId: user.authentication_ListMicrosoftAuthenticatorMethod
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
- $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.microsoftAuthenticatorAuthenticationMethodCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
'/users/{user-id}/authentication/microsoftAuthenticatorMethods/{microsoftAuthenticatorAuthenticationMethod-id}':
get:
tags:
- users.authentication
summary: Get microsoftAuthenticatorAuthenticationMethod
description: Read the properties and relationships of a microsoftAuthenticatorAuthenticationMethod object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/microsoftauthenticatorauthenticationmethod-get?view=graph-rest-1.0
operationId: user.authentication_GetMicrosoftAuthenticatorMethod
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: microsoftAuthenticatorAuthenticationMethod-id
in: path
description: The unique identifier of microsoftAuthenticatorAuthenticationMethod
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: microsoftAuthenticatorAuthenticationMethod
- 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.microsoftAuthenticatorAuthenticationMethod'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- users.authentication
summary: Delete microsoftAuthenticatorAuthenticationMethod
description: Delete a microsoftAuthenticatorAuthenticationMethod object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/microsoftauthenticatorauthenticationmethod-delete?view=graph-rest-1.0
operationId: user.authentication_DeleteMicrosoftAuthenticatorMethod
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: microsoftAuthenticatorAuthenticationMethod-id
in: path
description: The unique identifier of microsoftAuthenticatorAuthenticationMethod
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: microsoftAuthenticatorAuthenticationMethod
- 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}/authentication/microsoftAuthenticatorMethods/{microsoftAuthenticatorAuthenticationMethod-id}/device':
get:
tags:
- users.authentication
summary: Get device from users
description: The registered device on which Microsoft Authenticator resides. This property is null if the device isn't registered for passwordless Phone Sign-In.
operationId: user.authentication.microsoftAuthenticatorMethod_GetDevice
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: microsoftAuthenticatorAuthenticationMethod-id
in: path
description: The unique identifier of microsoftAuthenticatorAuthenticationMethod
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: microsoftAuthenticatorAuthenticationMethod
- 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.device'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/users/{user-id}/authentication/microsoftAuthenticatorMethods/$count':
get:
tags:
- users.authentication
summary: Get the number of the resource
operationId: user.authentication.microsoftAuthenticatorMethod_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
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/users/{user-id}/authentication/operations':
get:
tags:
- users.authentication
summary: Get longRunningOperation
description: 'Read the properties and relationships of a longRunningOperation object. This API allows you to retrieve the details and status of the following long-running Microsoft Graph API operations. The possible states of the long-running operation are notStarted, running, succeeded, failed, unknownFutureValue where succeeded and failed are terminal states.'
operationId: user.authentication_ListOperation
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
- $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.longRunningOperationCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- users.authentication
summary: Create new navigation property to operations for users
operationId: user.authentication_CreateOperation
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.longRunningOperation'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.longRunningOperation'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/users/{user-id}/authentication/operations/{longRunningOperation-id}':
get:
tags:
- users.authentication
summary: Get longRunningOperation
description: 'Read the properties and relationships of a longRunningOperation object. This API allows you to retrieve the details and status of the following long-running Microsoft Graph API operations. The possible states of the long-running operation are notStarted, running, succeeded, failed, unknownFutureValue where succeeded and failed are terminal states.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/longrunningoperation-get?view=graph-rest-1.0
operationId: user.authentication_GetOperation
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: longRunningOperation-id
in: path
description: The unique identifier of longRunningOperation
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: longRunningOperation
- 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.longRunningOperation'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- users.authentication
summary: Update the navigation property operations in users
operationId: user.authentication_UpdateOperation
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: longRunningOperation-id
in: path
description: The unique identifier of longRunningOperation
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: longRunningOperation
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.longRunningOperation'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.longRunningOperation'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- users.authentication
summary: Delete navigation property operations for users
operationId: user.authentication_DeleteOperation
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: longRunningOperation-id
in: path
description: The unique identifier of longRunningOperation
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: longRunningOperation
- 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}/authentication/operations/$count':
get:
tags:
- users.authentication
summary: Get the number of the resource
operationId: user.authentication.operation_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
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/users/{user-id}/authentication/passwordMethods':
get:
tags:
- users.authentication
summary: Get passwordMethods from users
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.'
operationId: user.authentication_ListPasswordMethod
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
- $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.passwordAuthenticationMethodCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- users.authentication
summary: Create new navigation property to passwordMethods for users
operationId: user.authentication_CreatePasswordMethod
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.passwordAuthenticationMethod'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.passwordAuthenticationMethod'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/users/{user-id}/authentication/passwordMethods/{passwordAuthenticationMethod-id}':
get:
tags:
- users.authentication
summary: Get passwordMethods from users
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.'
operationId: user.authentication_GetPasswordMethod
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: passwordAuthenticationMethod-id
in: path
description: The unique identifier of passwordAuthenticationMethod
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: passwordAuthenticationMethod
- 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.passwordAuthenticationMethod'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/users/{user-id}/authentication/passwordMethods/$count':
get:
tags:
- users.authentication
summary: Get the number of the resource
operationId: user.authentication.passwordMethod_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
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/users/{user-id}/authentication/phoneMethods':
get:
tags:
- users.authentication
summary: Get phoneMethods from users
description: The phone numbers registered to a user for authentication.
operationId: user.authentication_ListPhoneMethod
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
- $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.phoneAuthenticationMethodCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- users.authentication
summary: Create phoneMethod
description: 'Add a new phone authentication method for a user. A user may only have one phone of each type, captured in the phoneType property. This means, for example, adding a mobile phone to a user with a pre-existing mobile phone fails. Additionally, a user must always have a mobile phone before adding an alternateMobile phone. Adding a phone number makes it available for use in both Azure multi-factor authentication (MFA) and self-service password reset (SSPR), if enabled. Additionally, if a user is enabled by policy to use SMS sign-in and a mobile number is added, the system attempts to register the number for use in that system.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/authentication-post-phonemethods?view=graph-rest-1.0
operationId: user.authentication_CreatePhoneMethod
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.phoneAuthenticationMethod'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.phoneAuthenticationMethod'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/users/{user-id}/authentication/phoneMethods/{phoneAuthenticationMethod-id}':
get:
tags:
- users.authentication
summary: Get phoneMethods from users
description: The phone numbers registered to a user for authentication.
operationId: user.authentication_GetPhoneMethod
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: phoneAuthenticationMethod-id
in: path
description: The unique identifier of phoneAuthenticationMethod
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: phoneAuthenticationMethod
- 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.phoneAuthenticationMethod'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- users.authentication
summary: Update phoneAuthenticationMethod
description: 'Update a user''s phone number associated with a phone authentication method object. You can''t change a phone''s type. To change a phone''s type, add a new number of the desired type and then delete the object with the original type. If a user is enabled by policy to use SMS to sign in and the mobile number is changed, the system will attempt to register the number for use in that system. Self-service operations aren''t supported.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/phoneauthenticationmethod-update?view=graph-rest-1.0
operationId: user.authentication_UpdatePhoneMethod
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: phoneAuthenticationMethod-id
in: path
description: The unique identifier of phoneAuthenticationMethod
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: phoneAuthenticationMethod
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.phoneAuthenticationMethod'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.phoneAuthenticationMethod'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- users.authentication
summary: Delete navigation property phoneMethods for users
operationId: user.authentication_DeletePhoneMethod
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: phoneAuthenticationMethod-id
in: path
description: The unique identifier of phoneAuthenticationMethod
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: phoneAuthenticationMethod
- 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}/authentication/phoneMethods/{phoneAuthenticationMethod-id}/microsoft.graph.disableSmsSignIn':
post:
tags:
- users.authentication
summary: Invoke action disableSmsSignIn
description: 'Disable SMS sign-in for an existing mobile phone number registered to a user. The number will no longer be available for SMS sign-in, which can prevent your user from signing in.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/phoneauthenticationmethod-disablesmssignin?view=graph-rest-1.0
operationId: user.authentication.phoneMethod_disableSmsSignIn
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: phoneAuthenticationMethod-id
in: path
description: The unique identifier of phoneAuthenticationMethod
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: phoneAuthenticationMethod
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/users/{user-id}/authentication/phoneMethods/{phoneAuthenticationMethod-id}/microsoft.graph.enableSmsSignIn':
post:
tags:
- users.authentication
summary: Invoke action enableSmsSignIn
description: 'Enable SMS sign-in for an existing mobile phone number registered to a user. To be successfully enabled:'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/phoneauthenticationmethod-enablesmssignin?view=graph-rest-1.0
operationId: user.authentication.phoneMethod_enableSmsSignIn
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: phoneAuthenticationMethod-id
in: path
description: The unique identifier of phoneAuthenticationMethod
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: phoneAuthenticationMethod
responses:
2XX:
description: Success
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: action
'/users/{user-id}/authentication/phoneMethods/$count':
get:
tags:
- users.authentication
summary: Get the number of the resource
operationId: user.authentication.phoneMethod_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
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/users/{user-id}/authentication/platformCredentialMethods':
get:
tags:
- users.authentication
summary: Get platformCredentialMethods from users
description: Represents a platform credential instance registered to a user on Mac OS.
operationId: user.authentication_ListPlatformCredentialMethod
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
- $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.platformCredentialAuthenticationMethodCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
'/users/{user-id}/authentication/platformCredentialMethods/{platformCredentialAuthenticationMethod-id}':
get:
tags:
- users.authentication
summary: Get platformCredentialMethods from users
description: Represents a platform credential instance registered to a user on Mac OS.
operationId: user.authentication_GetPlatformCredentialMethod
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: platformCredentialAuthenticationMethod-id
in: path
description: The unique identifier of platformCredentialAuthenticationMethod
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: platformCredentialAuthenticationMethod
- 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.platformCredentialAuthenticationMethod'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- users.authentication
summary: Delete platformCredentialAuthenticationMethod
description: Delete a platformCredentialAuthenticationMethod object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/platformcredentialauthenticationmethod-delete?view=graph-rest-1.0
operationId: user.authentication_DeletePlatformCredentialMethod
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: platformCredentialAuthenticationMethod-id
in: path
description: The unique identifier of platformCredentialAuthenticationMethod
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: platformCredentialAuthenticationMethod
- 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}/authentication/platformCredentialMethods/{platformCredentialAuthenticationMethod-id}/device':
get:
tags:
- users.authentication
summary: Get device from users
description: 'The registered device on which this Platform Credential resides. Supports $expand. When you get a user''s Platform Credential registration information, this property is returned only on a single GET and when you specify ?$expand. For example, GET /users/admin@contoso.com/authentication/platformCredentialAuthenticationMethod/_jpuR-TGZtk6aQCLF3BQjA2?$expand=device.'
operationId: user.authentication.platformCredentialMethod_GetDevice
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: platformCredentialAuthenticationMethod-id
in: path
description: The unique identifier of platformCredentialAuthenticationMethod
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: platformCredentialAuthenticationMethod
- 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.device'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/users/{user-id}/authentication/platformCredentialMethods/$count':
get:
tags:
- users.authentication
summary: Get the number of the resource
operationId: user.authentication.platformCredentialMethod_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
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/users/{user-id}/authentication/softwareOathMethods':
get:
tags:
- users.authentication
summary: Get softwareOathMethods from users
description: The software OATH time-based one-time password (TOTP) applications registered to a user for authentication.
operationId: user.authentication_ListSoftwareOathMethod
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
- $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.softwareOathAuthenticationMethodCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
'/users/{user-id}/authentication/softwareOathMethods/{softwareOathAuthenticationMethod-id}':
get:
tags:
- users.authentication
summary: Get softwareOathMethods from users
description: The software OATH time-based one-time password (TOTP) applications registered to a user for authentication.
operationId: user.authentication_GetSoftwareOathMethod
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: softwareOathAuthenticationMethod-id
in: path
description: The unique identifier of softwareOathAuthenticationMethod
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: softwareOathAuthenticationMethod
- 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.softwareOathAuthenticationMethod'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- users.authentication
summary: Delete softwareOathAuthenticationMethod
description: Delete a user's Software OATH token authentication method object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/softwareoathauthenticationmethod-delete?view=graph-rest-1.0
operationId: user.authentication_DeleteSoftwareOathMethod
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: softwareOathAuthenticationMethod-id
in: path
description: The unique identifier of softwareOathAuthenticationMethod
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: softwareOathAuthenticationMethod
- 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}/authentication/softwareOathMethods/$count':
get:
tags:
- users.authentication
summary: Get the number of the resource
operationId: user.authentication.softwareOathMethod_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
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/users/{user-id}/authentication/temporaryAccessPassMethods':
get:
tags:
- users.authentication
summary: List temporaryAccessPassMethods
description: Retrieve a list of a user's temporaryAccessPassAuthenticationMethod objects and their properties. This API will only return a single object in the collection as a user can have only one Temporary Access Pass method.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/authentication-list-temporaryaccesspassmethods?view=graph-rest-1.0
operationId: user.authentication_ListTemporaryAccessPassMethod
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
- $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.temporaryAccessPassAuthenticationMethodCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- users.authentication
summary: Create temporaryAccessPassMethod
description: 'Create a new temporaryAccessPassAuthenticationMethod object on a user. A user can only have one Temporary Access Pass that''s usable within its specified lifetime. If the user requires a new Temporary Access Pass while the current Temporary Access Pass is valid, the admin can create a new Temporary Access Pass for the user, the previous Temporary Access Pass will be deleted, and a new Temporary Access Pass will be created.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/authentication-post-temporaryaccesspassmethods?view=graph-rest-1.0
operationId: user.authentication_CreateTemporaryAccessPassMethod
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.temporaryAccessPassAuthenticationMethod'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.temporaryAccessPassAuthenticationMethod'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/users/{user-id}/authentication/temporaryAccessPassMethods/{temporaryAccessPassAuthenticationMethod-id}':
get:
tags:
- users.authentication
summary: Get temporaryAccessPassAuthenticationMethod
description: Retrieve a user's single temporaryAccessPassAuthenticationMethod object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/temporaryaccesspassauthenticationmethod-get?view=graph-rest-1.0
operationId: user.authentication_GetTemporaryAccessPassMethod
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: temporaryAccessPassAuthenticationMethod-id
in: path
description: The unique identifier of temporaryAccessPassAuthenticationMethod
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: temporaryAccessPassAuthenticationMethod
- 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.temporaryAccessPassAuthenticationMethod'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- users.authentication
summary: Delete temporaryAccessPassAuthenticationMethod
description: Delete a users's temporaryAccessPassAuthenticationMethod object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/temporaryaccesspassauthenticationmethod-delete?view=graph-rest-1.0
operationId: user.authentication_DeleteTemporaryAccessPassMethod
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: temporaryAccessPassAuthenticationMethod-id
in: path
description: The unique identifier of temporaryAccessPassAuthenticationMethod
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: temporaryAccessPassAuthenticationMethod
- 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}/authentication/temporaryAccessPassMethods/$count':
get:
tags:
- users.authentication
summary: Get the number of the resource
operationId: user.authentication.temporaryAccessPassMethod_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
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
'/users/{user-id}/authentication/windowsHelloForBusinessMethods':
get:
tags:
- users.authentication
summary: List windowsHelloForBusinessAuthenticationMethods
description: Get a list of the windowsHelloForBusinessAuthenticationMethod objects and their properties.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/windowshelloforbusinessauthenticationmethod-list?view=graph-rest-1.0
operationId: user.authentication_ListWindowsHelloGraphFPreBusinessMethod
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
- $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.windowsHelloForBusinessAuthenticationMethodCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
'/users/{user-id}/authentication/windowsHelloForBusinessMethods/{windowsHelloForBusinessAuthenticationMethod-id}':
get:
tags:
- users.authentication
summary: Get windowsHelloForBusinessAuthenticationMethod
description: Read the properties and relationships of a windowsHelloForBusinessAuthenticationMethod object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/windowshelloforbusinessauthenticationmethod-get?view=graph-rest-1.0
operationId: user.authentication_GetWindowsHelloGraphFPreBusinessMethod
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: windowsHelloForBusinessAuthenticationMethod-id
in: path
description: The unique identifier of windowsHelloForBusinessAuthenticationMethod
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: windowsHelloForBusinessAuthenticationMethod
- 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.windowsHelloForBusinessAuthenticationMethod'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- users.authentication
summary: Delete windowsHelloForBusinessAuthenticationMethod
description: Deletes a windowsHelloForBusinessAuthenticationMethod object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/windowshelloforbusinessauthenticationmethod-delete?view=graph-rest-1.0
operationId: user.authentication_DeleteWindowsHelloGraphFPreBusinessMethod
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: windowsHelloForBusinessAuthenticationMethod-id
in: path
description: The unique identifier of windowsHelloForBusinessAuthenticationMethod
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: windowsHelloForBusinessAuthenticationMethod
- 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}/authentication/windowsHelloForBusinessMethods/{windowsHelloForBusinessAuthenticationMethod-id}/device':
get:
tags:
- users.authentication
summary: Get device from users
description: 'The registered device on which this Windows Hello for Business key resides. Supports $expand. When you get a user''s Windows Hello for Business registration information, this property is returned only on a single GET and when you specify ?$expand. For example, GET /users/admin@contoso.com/authentication/windowsHelloForBusinessMethods/_jpuR-TGZtk6aQCLF3BQjA2?$expand=device.'
operationId: user.authentication.windowsHelloGraphFPreBusinessMethod_GetDevice
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: windowsHelloForBusinessAuthenticationMethod-id
in: path
description: The unique identifier of windowsHelloForBusinessAuthenticationMethod
required: true
style: simple
schema:
type: string
x-ms-docs-key-type: windowsHelloForBusinessAuthenticationMethod
- 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.device'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
'/users/{user-id}/authentication/windowsHelloForBusinessMethods/$count':
get:
tags:
- users.authentication
summary: Get the number of the resource
operationId: user.authentication.windowsHelloGraphFPreBusinessMethod_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
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
default:
$ref: '#/components/responses/error'
components:
schemas:
microsoft.graph.dataPolicyOperation:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: dataPolicyOperation
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: 'Represents when the request for this data policy operation was completed, in UTC time, using the ISO 8601 format. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Null until the operation completes.'
format: date-time
nullable: true
progress:
type: number
description: Specifies the progress of an operation.
format: double
nullable: true
status:
$ref: '#/components/schemas/microsoft.graph.dataPolicyOperationStatus'
storageLocation:
type: string
description: The URL location to where data is being exported for export requests.
nullable: true
submittedDateTime:
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 when the request for this data operation was submitted, in UTC time, using the ISO 8601 format. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z'
format: date-time
userId:
type: string
description: The id for the user on whom the operation is performed.
additionalProperties:
type: object
microsoft.graph.identityContainer:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: identityContainer
type: object
properties:
apiConnectors:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.identityApiConnector'
description: Represents entry point for API connectors.
x-ms-navigationProperty: true
authenticationEventListeners:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.authenticationEventListener'
description: Represents listeners for custom authentication extension events in Azure AD for workforce and customers.
x-ms-navigationProperty: true
authenticationEventsFlows:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.authenticationEventsFlow'
description: Represents the entry point for self-service sign-up and sign-in user flows in both Microsoft Entra workforce and external tenants.
x-ms-navigationProperty: true
b2xUserFlows:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.b2xIdentityUserFlow'
description: Represents entry point for B2X/self-service sign-up identity userflows.
x-ms-navigationProperty: true
conditionalAccess:
$ref: '#/components/schemas/microsoft.graph.conditionalAccessRoot'
customAuthenticationExtensions:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.customAuthenticationExtension'
description: Represents custom extensions to authentication flows in Azure AD for workforce and customers.
x-ms-navigationProperty: true
identityProviders:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.identityProviderBase'
x-ms-navigationProperty: true
riskPrevention:
$ref: '#/components/schemas/microsoft.graph.riskPreventionContainer'
userFlowAttributes:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.identityUserFlowAttribute'
description: Represents entry point for identity userflow attributes.
x-ms-navigationProperty: true
verifiedId:
$ref: '#/components/schemas/microsoft.graph.identityVerifiedIdRoot'
additionalProperties:
type: object
microsoft.graph.identityApiConnector:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: identityApiConnector
type: object
properties:
authenticationConfiguration:
$ref: '#/components/schemas/microsoft.graph.apiAuthenticationConfigurationBase'
displayName:
type: string
description: The name of the API connector.
nullable: true
targetUrl:
type: string
description: The URL of the API endpoint to call.
nullable: true
additionalProperties:
type: object
microsoft.graph.authenticationEventListener:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: authenticationEventListener
type: object
properties:
authenticationEventsFlowId:
type: string
description: The identifier of the authenticationEventsFlow object.
nullable: true
conditions:
$ref: '#/components/schemas/microsoft.graph.authenticationConditions'
displayName:
type: string
description: The display name of the listener.
nullable: true
additionalProperties:
type: object
microsoft.graph.authenticationEventsFlow:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: authenticationEventsFlow
type: object
properties:
conditions:
$ref: '#/components/schemas/microsoft.graph.authenticationConditions'
description:
type: string
description: The description of the events policy.
nullable: true
displayName:
type: string
description: Required. The display name for the events policy.
additionalProperties:
type: object
microsoft.graph.authenticationConditions:
title: authenticationConditions
type: object
properties:
applications:
$ref: '#/components/schemas/microsoft.graph.authenticationConditionsApplications'
additionalProperties:
type: object
microsoft.graph.authenticationConditionApplication:
title: authenticationConditionApplication
type: object
properties:
appId:
type: string
description: The identifier for an application corresponding to a condition which will trigger an authenticationEventListener.
additionalProperties:
type: object
microsoft.graph.externalUsersSelfServiceSignUpEventsFlow:
allOf:
- $ref: '#/components/schemas/microsoft.graph.authenticationEventsFlow'
- title: externalUsersSelfServiceSignUpEventsFlow
type: object
properties:
onAttributeCollection:
$ref: '#/components/schemas/microsoft.graph.onAttributeCollectionHandler'
onAttributeCollectionStart:
$ref: '#/components/schemas/microsoft.graph.onAttributeCollectionStartHandler'
onAttributeCollectionSubmit:
$ref: '#/components/schemas/microsoft.graph.onAttributeCollectionSubmitHandler'
onAuthenticationMethodLoadStart:
$ref: '#/components/schemas/microsoft.graph.onAuthenticationMethodLoadStartHandler'
onInteractiveAuthFlowStart:
$ref: '#/components/schemas/microsoft.graph.onInteractiveAuthFlowStartHandler'
onUserCreateStart:
$ref: '#/components/schemas/microsoft.graph.onUserCreateStartHandler'
additionalProperties:
type: object
microsoft.graph.onAttributeCollectionHandler:
title: onAttributeCollectionHandler
type: object
additionalProperties:
type: object
microsoft.graph.onAttributeCollectionExternalUsersSelfServiceSignUp:
allOf:
- $ref: '#/components/schemas/microsoft.graph.onAttributeCollectionHandler'
- title: onAttributeCollectionExternalUsersSelfServiceSignUp
type: object
properties:
attributeCollectionPage:
$ref: '#/components/schemas/microsoft.graph.authenticationAttributeCollectionPage'
attributes:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.identityUserFlowAttribute'
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.onAuthenticationMethodLoadStartHandler:
title: onAuthenticationMethodLoadStartHandler
type: object
additionalProperties:
type: object
microsoft.graph.onAuthenticationMethodLoadStartExternalUsersSelfServiceSignUp:
allOf:
- $ref: '#/components/schemas/microsoft.graph.onAuthenticationMethodLoadStartHandler'
- title: onAuthenticationMethodLoadStartExternalUsersSelfServiceSignUp
type: object
properties:
identityProviders:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.identityProviderBase'
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.b2xIdentityUserFlow:
allOf:
- $ref: '#/components/schemas/microsoft.graph.identityUserFlow'
- title: b2xIdentityUserFlow
type: object
properties:
apiConnectorConfiguration:
$ref: '#/components/schemas/microsoft.graph.userFlowApiConnectorConfiguration'
identityProviders:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.identityProvider'
description: The identity providers included in the user flow.
x-ms-navigationProperty: true
languages:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.userFlowLanguageConfiguration'
description: The languages supported for customization within the user flow. Language customization is enabled by default in self-service sign-up user flow. You can't create custom languages in self-service sign-up user flows.
x-ms-navigationProperty: true
userAttributeAssignments:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.identityUserFlowAttributeAssignment'
description: The user attribute assignments included in the user flow.
x-ms-navigationProperty: true
userFlowIdentityProviders:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.identityProviderBase'
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.userFlowApiConnectorConfiguration:
title: userFlowApiConnectorConfiguration
type: object
properties:
postAttributeCollection:
$ref: '#/components/schemas/microsoft.graph.identityApiConnector'
postFederationSignup:
$ref: '#/components/schemas/microsoft.graph.identityApiConnector'
additionalProperties:
type: object
microsoft.graph.identityProvider:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: identityProvider
type: object
properties:
clientId:
type: string
description: The client ID for the application. This is the client ID obtained when registering the application with the identity provider. Required. Not nullable.
nullable: true
clientSecret:
type: string
description: The client secret for the application. This is the client secret obtained when registering the application with the identity provider. This is write-only. A read operation will return . Required. Not nullable.
nullable: true
name:
type: string
description: The display name of the identity provider. Not nullable.
nullable: true
type:
type: string
description: 'The identity provider type is a required field. For B2B scenario: Google, Facebook. For B2C scenario: Microsoft, Google, Amazon, LinkedIn, Facebook, GitHub, Twitter, Weibo, QQ, WeChat, OpenIDConnect. Not nullable.'
nullable: true
additionalProperties:
type: object
microsoft.graph.userFlowLanguageConfiguration:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: userFlowLanguageConfiguration
type: object
properties:
displayName:
type: string
description: The language name to display. This property is read-only.
nullable: true
isEnabled:
type: boolean
description: Indicates whether the language is enabled within the user flow.
defaultPages:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.userFlowLanguagePage'
description: Collection of pages with the default content to display in a user flow for a specified language. This collection doesn't allow any kind of modification.
x-ms-navigationProperty: true
overridesPages:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.userFlowLanguagePage'
description: 'Collection of pages with the overrides messages to display in a user flow for a specified language. This collection only allows you to modify the content of the page, any other modification isn''t allowed (creation or deletion of pages).'
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.userFlowLanguagePage:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: userFlowLanguagePage
type: object
additionalProperties:
type: object
microsoft.graph.identityUserFlowAttributeAssignment:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: identityUserFlowAttributeAssignment
type: object
properties:
displayName:
type: string
description: The display name of the identityUserFlowAttribute within a user flow.
nullable: true
isOptional:
type: boolean
description: Determines whether the identityUserFlowAttribute is optional. true means the user doesn't have to provide a value. false means the user can't complete sign-up without providing a value.
requiresVerification:
type: boolean
description: 'Determines whether the identityUserFlowAttribute requires verification, and is only used for verifying the user''s phone number or email address.'
userAttributeValues:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.userAttributeValuesItem'
description: 'The input options for the user flow attribute. Only applicable when the userInputType is radioSingleSelect, dropdownSingleSelect, or checkboxMultiSelect.'
userInputType:
$ref: '#/components/schemas/microsoft.graph.identityUserFlowAttributeInputType'
userAttribute:
$ref: '#/components/schemas/microsoft.graph.identityUserFlowAttribute'
additionalProperties:
type: object
microsoft.graph.identityUserFlowAttribute:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: identityUserFlowAttribute
type: object
properties:
dataType:
$ref: '#/components/schemas/microsoft.graph.identityUserFlowAttributeDataType'
description:
type: string
description: The description of the user flow attribute that's shown to the user at the time of sign up.
nullable: true
displayName:
type: string
description: 'The display name of the user flow attribute. Supports $filter (eq, ne).'
nullable: true
userFlowAttributeType:
$ref: '#/components/schemas/microsoft.graph.identityUserFlowAttributeType'
additionalProperties:
type: object
microsoft.graph.assignmentOrder:
title: assignmentOrder
type: object
properties:
order:
type: array
items:
type: string
nullable: true
description: A list of identityUserFlowAttribute object identifiers that determine the order in which attributes should be collected within a user flow.
additionalProperties:
type: object
microsoft.graph.authenticationContextClassReference:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: authenticationContextClassReference
type: object
properties:
description:
type: string
description: 'A short explanation of the policies that are enforced by authenticationContextClassReference. This value should be used to provide secondary text to describe the authentication context class reference when building user-facing admin experiences. For example, a selection UX.'
nullable: true
displayName:
type: string
description: 'The display name is the friendly name of the authenticationContextClassReference object. This value should be used to identify the authentication context class reference when building user-facing admin experiences. For example, a selection UX.'
nullable: true
isAvailable:
type: boolean
description: 'Indicates whether the authenticationContextClassReference has been published by the security admin and is ready for use by apps. When it''s set to false, it shouldn''t be shown in authentication context selection UX, or used to protect app resources. It''s shown and available for Conditional Access policy authoring. The default value is false. Supports $filter (eq).'
nullable: true
additionalProperties:
type: object
microsoft.graph.authenticationStrengthRoot:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: authenticationStrengthRoot
type: object
properties:
combinations:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.authenticationMethodModes'
authenticationMethodModes:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.authenticationMethodModeDetail'
description: Names and descriptions of all valid authentication method modes in the system.
x-ms-navigationProperty: true
policies:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.authenticationStrengthPolicy'
description: 'A collection of authentication strength policies that exist for this tenant, including both built-in and custom policies.'
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.authenticationMethodModeDetail:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: authenticationMethodModeDetail
type: object
properties:
authenticationMethod:
$ref: '#/components/schemas/microsoft.graph.baseAuthenticationMethod'
displayName:
type: string
description: The display name of this mode
additionalProperties:
type: object
microsoft.graph.authenticationStrengthPolicy:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: authenticationStrengthPolicy
type: object
properties:
allowedCombinations:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.authenticationMethodModes'
description: A collection of authentication method modes that are required be used to satify this authentication strength.
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 datetime when this policy was created.
format: date-time
description:
type: string
description: The human-readable description of this policy.
nullable: true
displayName:
type: string
description: 'The human-readable display name of this policy. Supports $filter (eq, ne, not , and in).'
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 datetime when this policy was last modified.
format: date-time
policyType:
$ref: '#/components/schemas/microsoft.graph.authenticationStrengthPolicyType'
requirementsSatisfied:
$ref: '#/components/schemas/microsoft.graph.authenticationStrengthRequirements'
combinationConfigurations:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.authenticationCombinationConfiguration'
description: Settings that may be used to require specific types or instances of an authentication method to be used when authenticating with a specified combination of authentication methods.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.authenticationCombinationConfiguration:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: authenticationCombinationConfiguration
type: object
properties:
appliesToCombinations:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.authenticationMethodModes'
description: 'Which authentication method combinations this configuration applies to. Must be an allowedCombinations object, part of the authenticationStrengthPolicy. The only possible value for fido2combinationConfigurations is ''fido2''.'
additionalProperties:
type: object
microsoft.graph.authenticationMethodModes:
title: authenticationMethodModes
enum:
- password
- voice
- hardwareOath
- softwareOath
- sms
- fido2
- windowsHelloForBusiness
- microsoftAuthenticatorPush
- deviceBasedPush
- temporaryAccessPassOneTime
- temporaryAccessPassMultiUse
- email
- x509CertificateSingleFactor
- x509CertificateMultiFactor
- federatedSingleFactor
- federatedMultiFactor
- unknownFutureValue
- qrCodePin
type: string
x-ms-enum-flags:
isFlags: true
microsoft.graph.updateAllowedCombinationsResult:
title: updateAllowedCombinationsResult
type: object
properties:
additionalInformation:
type: string
description: Information about why the updateAllowedCombinations action was successful or failed.
nullable: true
conditionalAccessReferences:
type: array
items:
type: string
nullable: true
description: References to existing Conditional Access policies that use this authentication strength.
currentCombinations:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.authenticationMethodModes'
description: The list of current authentication method combinations allowed by the authentication strength.
previousCombinations:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.authenticationMethodModes'
description: The list of former authentication method combinations allowed by the authentication strength before they were updated through the updateAllowedCombinations action.
additionalProperties:
type: object
microsoft.graph.authenticationStrengthUsage:
title: authenticationStrengthUsage
type: object
properties:
mfa:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.conditionalAccessPolicy'
x-ms-navigationProperty: true
none:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.conditionalAccessPolicy'
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.caPoliciesDeletableRoot:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: caPoliciesDeletableRoot
type: object
properties:
namedLocations:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.namedLocation'
x-ms-navigationProperty: true
policies:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.conditionalAccessPolicy'
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.namedLocation:
allOf:
- $ref: '#/components/schemas/microsoft.graph.policyDeletableItem'
- title: namedLocation
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 creation date and time of the location 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
displayName:
type: string
description: Human-readable name of the location.
id:
type: string
description: Identifier of a namedLocation object. Read-only.
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 Timestamp type represents last modified date and time of the location 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
additionalProperties:
type: object
microsoft.graph.conditionalAccessPolicy:
allOf:
- $ref: '#/components/schemas/microsoft.graph.policyDeletableItem'
- title: conditionalAccessPolicy
type: object
properties:
conditions:
$ref: '#/components/schemas/microsoft.graph.conditionalAccessConditionSet'
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. Read-only.'
format: date-time
nullable: true
description:
type: string
nullable: true
displayName:
type: string
description: Specifies a display name for the conditionalAccessPolicy object.
grantControls:
$ref: '#/components/schemas/microsoft.graph.conditionalAccessGrantControls'
id:
type: string
description: Specifies the identifier of a conditionalAccessPolicy object. Read-only.
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 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
sessionControls:
$ref: '#/components/schemas/microsoft.graph.conditionalAccessSessionControls'
state:
$ref: '#/components/schemas/microsoft.graph.conditionalAccessPolicyState'
templateId:
type: string
description: Specifies the unique identifier of a Conditional Access template. Inherited from entity.
nullable: true
additionalProperties:
type: object
microsoft.graph.signInIdentity:
title: signInIdentity
type: object
additionalProperties:
type: object
microsoft.graph.signInContext:
title: signInContext
type: object
additionalProperties:
type: object
microsoft.graph.signInConditions:
title: signInConditions
type: object
properties:
authenticationFlow:
$ref: '#/components/schemas/microsoft.graph.authenticationFlow'
clientAppType:
$ref: '#/components/schemas/microsoft.graph.conditionalAccessClientApp'
country:
type: string
description: Country from where the identity is authenticating.
nullable: true
deviceInfo:
$ref: '#/components/schemas/microsoft.graph.deviceInfo'
devicePlatform:
$ref: '#/components/schemas/microsoft.graph.conditionalAccessDevicePlatform'
insiderRiskLevel:
$ref: '#/components/schemas/microsoft.graph.insiderRiskLevel'
ipAddress:
type: string
description: Ip address of the authenticating identity.
nullable: true
servicePrincipalRiskLevel:
$ref: '#/components/schemas/microsoft.graph.riskLevel'
signInRiskLevel:
$ref: '#/components/schemas/microsoft.graph.riskLevel'
userRiskLevel:
$ref: '#/components/schemas/microsoft.graph.riskLevel'
additionalProperties:
type: object
microsoft.graph.whatIfAnalysisResult:
allOf:
- $ref: '#/components/schemas/microsoft.graph.conditionalAccessPolicy'
- title: whatIfAnalysisResult
type: object
properties:
analysisReasons:
$ref: '#/components/schemas/microsoft.graph.whatIfAnalysisReasons'
policyApplies:
type: boolean
description: 'Specifies whether the policy applies to the sign-in properties provided in the request body. If policyApplies is true, the policy applies to the sign-in based on the sign-in properties provided. If policyApplies is false, the policy doesn''t apply to the sign-in based on the sign-in properties provided and the analysisReasons property is populated to show the reason for the policy not applying.'
additionalProperties:
type: object
microsoft.graph.conditionalAccessTemplate:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: conditionalAccessTemplate
type: object
properties:
description:
type: string
description: The user-friendly name of the template.
details:
$ref: '#/components/schemas/microsoft.graph.conditionalAccessPolicyDetail'
name:
type: string
description: The user-friendly name of the template.
scenarios:
$ref: '#/components/schemas/microsoft.graph.templateScenarios'
additionalProperties:
type: object
microsoft.graph.customAuthenticationExtension:
allOf:
- $ref: '#/components/schemas/microsoft.graph.customCalloutExtension'
- title: customAuthenticationExtension
type: object
properties:
behaviorOnError:
$ref: '#/components/schemas/microsoft.graph.customExtensionBehaviorOnError'
additionalProperties:
type: object
microsoft.graph.authenticationConfigurationValidation:
title: authenticationConfigurationValidation
type: object
properties:
errors:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.genericError'
description: Errors in the validation result of a customAuthenticationExtension.
warnings:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.genericError'
description: Warnings in the validation result of a customAuthenticationExtension.
additionalProperties:
type: object
microsoft.graph.customExtensionEndpointConfiguration:
title: customExtensionEndpointConfiguration
type: object
additionalProperties:
type: object
microsoft.graph.customExtensionAuthenticationConfiguration:
title: customExtensionAuthenticationConfiguration
type: object
additionalProperties:
type: object
microsoft.graph.identityProviderBase:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: identityProviderBase
type: object
properties:
displayName:
type: string
description: The display name of the identity provider.
nullable: true
additionalProperties:
type: object
microsoft.graph.riskPreventionContainer:
title: riskPreventionContainer
type: object
properties:
fraudProtectionProviders:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.fraudProtectionProvider'
description: Represents entry point for fraud protection provider configurations for Microsoft Entra External ID tenants.
x-ms-navigationProperty: true
webApplicationFirewallProviders:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.webApplicationFirewallProvider'
description: Collection of WAF provider configurations registered in the External ID tenant.
x-ms-navigationProperty: true
webApplicationFirewallVerifications:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.webApplicationFirewallVerificationModel'
description: Collection of verification operations performed for domains or hosts with WAF providers registered in the External ID tenant.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.fraudProtectionProvider:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: fraudProtectionProvider
type: object
properties:
displayName:
type: string
description: The display name of the fraud protection provider configuration.
additionalProperties:
type: object
microsoft.graph.webApplicationFirewallProvider:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: webApplicationFirewallProvider
type: object
properties:
displayName:
type: string
description: The display name of the WAF provider.
additionalProperties:
type: object
microsoft.graph.webApplicationFirewallVerificationModel:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: webApplicationFirewallVerificationModel
type: object
properties:
providerType:
$ref: '#/components/schemas/microsoft.graph.webApplicationFirewallProviderType'
verificationResult:
$ref: '#/components/schemas/microsoft.graph.webApplicationFirewallVerificationResult'
verifiedDetails:
$ref: '#/components/schemas/microsoft.graph.webApplicationFirewallVerifiedDetails'
verifiedHost:
type: string
description: The host (domain or subdomain) that was verified as part of this verification operation.
nullable: true
provider:
$ref: '#/components/schemas/microsoft.graph.webApplicationFirewallProvider'
additionalProperties:
type: object
microsoft.graph.identityVerifiedIdRoot:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: identityVerifiedIdRoot
type: object
properties:
profiles:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.verifiedIdProfile'
description: Profile containing properties about a Verified ID provider and purpose
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.verifiedIdProfile:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: verifiedIdProfile
type: object
properties:
description:
type: string
description: Description for the verified ID profile. Required.
faceCheckConfiguration:
$ref: '#/components/schemas/microsoft.graph.faceCheckConfiguration'
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: DateTime the profile was last modified. Optional.
format: date-time
nullable: true
name:
type: string
description: Display name for the verified ID profile. Required.
priority:
maximum: 2147483647
minimum: -2147483648
type: number
description: Defines profile processing priority if multiple profiles are configured. Optional.
format: int32
nullable: true
state:
$ref: '#/components/schemas/microsoft.graph.verifiedIdProfileState'
verifiedIdProfileConfiguration:
$ref: '#/components/schemas/microsoft.graph.verifiedIdProfileConfiguration'
verifiedIdUsageConfigurations:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.verifiedIdUsageConfiguration'
description: Collection defining the usage purpose for the profile. Required.
verifierDid:
type: string
description: Decentralized Identifier (DID) string that represents the verifier in the verifiable credential exchange. Required.
additionalProperties:
type: object
microsoft.graph.identityProtectionRoot:
title: identityProtectionRoot
type: object
properties:
riskDetections:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.riskDetection'
description: Risk detection in Microsoft Entra ID Protection and the associated information about the detection.
x-ms-navigationProperty: true
riskyServicePrincipals:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.riskyServicePrincipal'
description: Microsoft Entra service principals that are at risk.
x-ms-navigationProperty: true
riskyUsers:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.riskyUser'
description: Users that are flagged as at-risk by Microsoft Entra ID Protection.
x-ms-navigationProperty: true
servicePrincipalRiskDetections:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.servicePrincipalRiskDetection'
description: Represents information about detected at-risk service principals in a Microsoft Entra tenant.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.riskDetection:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: riskDetection
type: object
properties:
activity:
$ref: '#/components/schemas/microsoft.graph.activityType'
activityDateTime:
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 that the risky activity occurred. 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 look like this: 2014-01-01T00:00:00Z'
format: date-time
nullable: true
additionalInfo:
type: string
description: 'Additional information associated with the risk detection in JSON format. For example, ''[{/''Key/'':/''userAgent/'',/''Value/'':/''Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/68.0.3440.106 Safari/537.36/''}]''. Possible keys in the additionalInfo JSON string are: userAgent, alertUrl, relatedEventTimeInUtc, relatedUserAgent, deviceInformation, relatedLocation, requestId, correlationId, lastActivityTimeInUtc, malwareName, clientLocation, clientIp, riskReasons. For more information about riskReasons and possible values, see riskReasons values.'
nullable: true
correlationId:
type: string
description: Correlation ID of the sign-in associated with the risk detection. This property is null if the risk detection is not associated with a sign-in.
nullable: true
detectedDateTime:
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 that the risk was detected. 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 looks like this: 2014-01-01T00:00:00Z'
format: date-time
nullable: true
detectionTimingType:
$ref: '#/components/schemas/microsoft.graph.riskDetectionTimingType'
ipAddress:
type: string
description: Provides the IP address of the client from where the risk occurred.
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 that the risk detection was last updated. 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 look like this: 2014-01-01T00:00:00Z'
format: date-time
nullable: true
location:
$ref: '#/components/schemas/microsoft.graph.signInLocation'
requestId:
type: string
description: Request ID of the sign-in associated with the risk detection. This property is null if the risk detection is not associated with a sign-in.
nullable: true
riskDetail:
$ref: '#/components/schemas/microsoft.graph.riskDetail'
riskEventType:
type: string
description: 'The type of risk event detected. The possible values are adminConfirmedUserCompromised, anomalousToken, anomalousUserActivity, anonymizedIPAddress, generic, impossibleTravel, investigationsThreatIntelligence, suspiciousSendingPatterns, leakedCredentials, maliciousIPAddress,malwareInfectedIPAddress, mcasSuspiciousInboxManipulationRules, newCountry, passwordSpray,riskyIPAddress, suspiciousAPITraffic, suspiciousBrowser,suspiciousInboxForwarding, suspiciousIPAddress, tokenIssuerAnomaly, unfamiliarFeatures, unlikelyTravel. If the risk detection is a premium detection, will show generic. For more information about each value, see Risk types and detection.'
nullable: true
riskLevel:
$ref: '#/components/schemas/microsoft.graph.riskLevel'
riskState:
$ref: '#/components/schemas/microsoft.graph.riskState'
source:
type: string
description: 'Source of the risk detection. For example, activeDirectory.'
nullable: true
tokenIssuerType:
$ref: '#/components/schemas/microsoft.graph.tokenIssuerType'
userDisplayName:
type: string
description: The user principal name (UPN) of the user.
nullable: true
userId:
type: string
description: Unique ID of the user.
nullable: true
userPrincipalName:
type: string
description: The user principal name (UPN) of the user.
nullable: true
additionalProperties:
type: object
microsoft.graph.riskyServicePrincipal:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: riskyServicePrincipal
type: object
properties:
appId:
type: string
description: 'The globally unique identifier for the associated application (its appId property), if any.'
nullable: true
displayName:
type: string
description: The display name for the service principal.
nullable: true
isEnabled:
type: boolean
description: 'true if the service principal account is enabled; otherwise, false.'
nullable: true
isProcessing:
type: boolean
description: Indicates whether Microsoft Entra ID is currently processing the service principal's risky state.
nullable: true
riskDetail:
$ref: '#/components/schemas/microsoft.graph.riskDetail'
riskLastUpdatedDateTime:
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 risk state was last updated. 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, 2021 is 2021-01-01T00:00:00Z. Supports $filter (eq).'
format: date-time
nullable: true
riskLevel:
$ref: '#/components/schemas/microsoft.graph.riskLevel'
riskState:
$ref: '#/components/schemas/microsoft.graph.riskState'
servicePrincipalType:
type: string
description: 'Identifies whether the service principal represents an Application, a ManagedIdentity, or a legacy application (socialIdp). This is set by Microsoft Entra ID internally and is inherited from servicePrincipal.'
nullable: true
history:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.riskyServicePrincipalHistoryItem'
description: Represents the risk history of Microsoft Entra service principals.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.riskyServicePrincipalHistoryItem:
allOf:
- $ref: '#/components/schemas/microsoft.graph.riskyServicePrincipal'
- title: riskyServicePrincipalHistoryItem
type: object
properties:
activity:
$ref: '#/components/schemas/microsoft.graph.riskServicePrincipalActivity'
initiatedBy:
type: string
description: The identifier of the actor of the operation.
nullable: true
additionalProperties:
type: object
microsoft.graph.riskyUser:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: riskyUser
type: object
properties:
isDeleted:
type: boolean
description: 'Indicates whether the user is deleted. The possible values are: true, false.'
nullable: true
isProcessing:
type: boolean
description: Indicates whether the backend is processing a user's risky state.
nullable: true
riskDetail:
$ref: '#/components/schemas/microsoft.graph.riskDetail'
riskLastUpdatedDateTime:
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 risky user was last updated. 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
riskLevel:
$ref: '#/components/schemas/microsoft.graph.riskLevel'
riskState:
$ref: '#/components/schemas/microsoft.graph.riskState'
userDisplayName:
type: string
description: Risky user display name.
nullable: true
userPrincipalName:
type: string
description: Risky user principal name.
nullable: true
history:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.riskyUserHistoryItem'
description: The activity related to user risk level change
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.riskyUserHistoryItem:
allOf:
- $ref: '#/components/schemas/microsoft.graph.riskyUser'
- title: riskyUserHistoryItem
type: object
properties:
activity:
$ref: '#/components/schemas/microsoft.graph.riskUserActivity'
initiatedBy:
type: string
description: The ID of actor that does the operation.
nullable: true
userId:
type: string
description: The ID of the user.
nullable: true
additionalProperties:
type: object
microsoft.graph.servicePrincipalRiskDetection:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: servicePrincipalRiskDetection
type: object
properties:
activity:
$ref: '#/components/schemas/microsoft.graph.activityType'
activityDateTime:
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 risky activity occurred. 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
additionalInfo:
type: string
description: Additional information associated with the risk detection. This string value is represented as a JSON object with the quotations escaped.
nullable: true
appId:
type: string
description: The unique identifier for the associated application.
nullable: true
correlationId:
type: string
description: Correlation ID of the sign-in activity associated with the risk detection. This property is null if the risk detection is not associated with a sign-in activity.
nullable: true
detectedDateTime:
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 risk was detected. 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
detectionTimingType:
$ref: '#/components/schemas/microsoft.graph.riskDetectionTimingType'
ipAddress:
type: string
description: Provides the IP address of the client from where the risk occurred.
nullable: true
keyIds:
type: array
items:
type: string
nullable: true
description: The unique identifier for the key credential associated with the risk detection.
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 when the risk detection was last updated.
format: date-time
nullable: true
location:
$ref: '#/components/schemas/microsoft.graph.signInLocation'
requestId:
type: string
description: Request identifier of the sign-in activity associated with the risk detection. This property is null if the risk detection is not associated with a sign-in activity. Supports $filter (eq).
nullable: true
riskDetail:
$ref: '#/components/schemas/microsoft.graph.riskDetail'
riskEventType:
type: string
description: 'The type of risk event detected. The possible values are: investigationsThreatIntelligence, generic, adminConfirmedServicePrincipalCompromised, suspiciousSignins, leakedCredentials, anomalousServicePrincipalActivity, maliciousApplication, suspiciousApplication.'
nullable: true
riskLevel:
$ref: '#/components/schemas/microsoft.graph.riskLevel'
riskState:
$ref: '#/components/schemas/microsoft.graph.riskState'
servicePrincipalDisplayName:
type: string
description: The display name for the service principal.
nullable: true
servicePrincipalId:
type: string
description: The unique identifier for the service principal. Supports $filter (eq).
nullable: true
source:
type: string
description: 'Source of the risk detection. For example, identityProtection.'
nullable: true
tokenIssuerType:
$ref: '#/components/schemas/microsoft.graph.tokenIssuerType'
additionalProperties:
type: object
microsoft.graph.informationProtection:
title: informationProtection
type: object
properties:
bitlocker:
$ref: '#/components/schemas/microsoft.graph.bitlocker'
threatAssessmentRequests:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.threatAssessmentRequest'
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.bitlocker:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: bitlocker
type: object
properties:
recoveryKeys:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.bitlockerRecoveryKey'
description: The recovery keys associated with the bitlocker entity.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.bitlockerRecoveryKey:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: bitlockerRecoveryKey
type: object
properties:
createdDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: The date and time when the key was originally backed up to Microsoft Entra ID. Not nullable.
format: date-time
deviceId:
type: string
description: Identifier of the device the BitLocker key is originally backed up from. Supports $filter (eq).
nullable: true
key:
type: string
description: The BitLocker recovery key. Requires $select to retrieve. Not nullable.
volumeType:
$ref: '#/components/schemas/microsoft.graph.volumeType'
additionalProperties:
type: object
microsoft.graph.threatAssessmentRequest:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: threatAssessmentRequest
type: object
properties:
category:
$ref: '#/components/schemas/microsoft.graph.threatCategory'
contentType:
$ref: '#/components/schemas/microsoft.graph.threatAssessmentContentType'
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: 'The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.'
format: date-time
nullable: true
expectedAssessment:
$ref: '#/components/schemas/microsoft.graph.threatExpectedAssessment'
requestSource:
$ref: '#/components/schemas/microsoft.graph.threatAssessmentRequestSource'
status:
$ref: '#/components/schemas/microsoft.graph.threatAssessmentStatus'
results:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.threatAssessmentResult'
description: 'A collection of threat assessment results. Read-only. By default, a GET /threatAssessmentRequests/{id} does not return this property unless you apply $expand on it.'
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.threatAssessmentResult:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: threatAssessmentResult
type: object
properties:
createdDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: 'The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.'
format: date-time
nullable: true
message:
type: string
description: The result message for each threat assessment.
nullable: true
resultType:
$ref: '#/components/schemas/microsoft.graph.threatAssessmentResultType'
additionalProperties:
type: object
microsoft.graph.invitation:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: invitation
type: object
properties:
invitedUserDisplayName:
type: string
description: The display name of the user being invited.
nullable: true
invitedUserEmailAddress:
type: string
description: 'The email address of the user being invited. Required. The following special characters aren''t permitted in the email address:Tilde (~)Exclamation point (!)Number sign (#)Dollar sign ($)Percent (%)Circumflex (^)Ampersand (&)Asterisk (*)Parentheses (( ))Plus sign (+)Equal sign (=)Brackets ([ ])Braces ({ })Backslash (/)Slash mark (/)Pipe (/|)Semicolon (;)Colon (:)Quotation marks ('')Angle brackets (< >)Question mark (?)Comma (,)However, the following exceptions apply:A period (.) or a hyphen (-) is permitted anywhere in the user name, except at the beginning or end of the name.An underscore (_) is permitted anywhere in the user name, including at the beginning or end of the name.'
invitedUserMessageInfo:
$ref: '#/components/schemas/microsoft.graph.invitedUserMessageInfo'
invitedUserType:
type: string
description: 'The userType of the user being invited. By default, this is Guest. You can invite as Member if you''re a company administrator.'
nullable: true
inviteRedeemUrl:
type: string
description: The URL the user can use to redeem their invitation. Read-only.
nullable: true
inviteRedirectUrl:
type: string
description: The URL the user should be redirected to after the invitation is redeemed. Required.
resetRedemption:
type: boolean
description: 'Reset the user''s redemption status and reinvite a user while retaining their user identifier, group memberships, and app assignments. This property allows you to enable a user to sign-in using a different email address from the one in the previous invitation. When true, the invitedUser/id relationship is required. For more information about using this property, see Reset redemption status for a guest user.'
nullable: true
sendInvitationMessage:
type: boolean
description: Indicates whether an email should be sent to the user being invited. The default is false.
nullable: true
status:
type: string
description: 'The status of the invitation. The possible values are: PendingAcceptance, Completed, InProgress, and Error.'
nullable: true
invitedUser:
$ref: '#/components/schemas/microsoft.graph.user'
invitedUserSponsors:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
description: The users or groups who are sponsors of the invited user. Sponsors are users and groups that are responsible for guest users' privileges in the tenant and for keeping the guest users' information and access up to date.
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.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.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.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.certificateBasedAuthConfiguration:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: certificateBasedAuthConfiguration
type: object
properties:
certificateAuthorities:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.certificateAuthority'
description: Collection of certificate authorities which creates a trusted certificate chain.
additionalProperties:
type: object
microsoft.graph.policyRoot:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: policyRoot
type: object
properties:
activityBasedTimeoutPolicies:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.activityBasedTimeoutPolicy'
description: The policy that controls the idle time out for web sessions for applications.
x-ms-navigationProperty: true
adminConsentRequestPolicy:
$ref: '#/components/schemas/microsoft.graph.adminConsentRequestPolicy'
appManagementPolicies:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.appManagementPolicy'
description: 'The policies that enforce app management restrictions for specific applications and service principals, overriding the defaultAppManagementPolicy.'
x-ms-navigationProperty: true
authenticationFlowsPolicy:
$ref: '#/components/schemas/microsoft.graph.authenticationFlowsPolicy'
authenticationMethodsPolicy:
$ref: '#/components/schemas/microsoft.graph.authenticationMethodsPolicy'
authenticationStrengthPolicies:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.authenticationStrengthPolicy'
description: The authentication method combinations that are to be used in scenarios defined by Microsoft Entra Conditional Access.
x-ms-navigationProperty: true
authorizationPolicy:
$ref: '#/components/schemas/microsoft.graph.authorizationPolicy'
claimsMappingPolicies:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.claimsMappingPolicy'
description: 'The claim-mapping policies for WS-Fed, SAML, OAuth 2.0, and OpenID Connect protocols, for tokens issued to a specific application.'
x-ms-navigationProperty: true
conditionalAccessPolicies:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.conditionalAccessPolicy'
description: The custom rules that define an access scenario.
x-ms-navigationProperty: true
crossTenantAccessPolicy:
$ref: '#/components/schemas/microsoft.graph.crossTenantAccessPolicy'
defaultAppManagementPolicy:
$ref: '#/components/schemas/microsoft.graph.tenantAppManagementPolicy'
deviceRegistrationPolicy:
$ref: '#/components/schemas/microsoft.graph.deviceRegistrationPolicy'
featureRolloutPolicies:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.featureRolloutPolicy'
description: The feature rollout policy associated with a directory object.
x-ms-navigationProperty: true
federatedTokenValidationPolicy:
$ref: '#/components/schemas/microsoft.graph.federatedTokenValidationPolicy'
homeRealmDiscoveryPolicies:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.homeRealmDiscoveryPolicy'
description: The policy to control Microsoft Entra authentication behavior for federated users.
x-ms-navigationProperty: true
identitySecurityDefaultsEnforcementPolicy:
$ref: '#/components/schemas/microsoft.graph.identitySecurityDefaultsEnforcementPolicy'
ownerlessGroupPolicy:
$ref: '#/components/schemas/microsoft.graph.ownerlessGroupPolicy'
permissionGrantPolicies:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.permissionGrantPolicy'
description: The policy that specifies the conditions under which consent can be granted.
x-ms-navigationProperty: true
roleManagementPolicies:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleManagementPolicy'
description: Specifies the various policies associated with scopes and roles.
x-ms-navigationProperty: true
roleManagementPolicyAssignments:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleManagementPolicyAssignment'
description: The assignment of a role management policy to a role definition object.
x-ms-navigationProperty: true
tokenIssuancePolicies:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.tokenIssuancePolicy'
description: The policy that specifies the characteristics of SAML tokens issued by Microsoft Entra ID.
x-ms-navigationProperty: true
tokenLifetimePolicies:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.tokenLifetimePolicy'
description: 'The policy that controls the lifetime of a JWT access token, an ID token, or a SAML 1.1/2.0 token issued by Microsoft Entra ID.'
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.activityBasedTimeoutPolicy:
allOf:
- $ref: '#/components/schemas/microsoft.graph.stsPolicy'
- title: activityBasedTimeoutPolicy
type: object
additionalProperties:
type: object
microsoft.graph.adminConsentRequestPolicy:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: adminConsentRequestPolicy
type: object
properties:
isEnabled:
type: boolean
description: Specifies whether the admin consent request feature is enabled or disabled. Required.
notifyReviewers:
type: boolean
description: Specifies whether reviewers will receive notifications. Required.
remindersEnabled:
type: boolean
description: Specifies whether reviewers will receive reminder emails. Required.
requestDurationInDays:
maximum: 2147483647
minimum: -2147483648
type: number
description: Specifies the duration the request is active before it automatically expires if no decision is applied.
format: int32
reviewers:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.accessReviewReviewerScope'
description: The list of reviewers for the admin consent. Required.
version:
maximum: 2147483647
minimum: -2147483648
type: number
description: 'Specifies the version of this policy. When the policy is updated, this version is updated. Read-only.'
format: int32
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.authenticationFlowsPolicy:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: authenticationFlowsPolicy
type: object
properties:
description:
type: string
description: Inherited property. A description of the policy. Optional. Read-only.
nullable: true
displayName:
type: string
description: Inherited property. The human-readable name of the policy. Optional. Read-only.
nullable: true
selfServiceSignUp:
$ref: '#/components/schemas/microsoft.graph.selfServiceSignUpAuthenticationFlowConfiguration'
additionalProperties:
type: object
microsoft.graph.authenticationMethodsPolicy:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: authenticationMethodsPolicy
type: object
properties:
description:
type: string
description: A description of the policy. Read-only.
nullable: true
displayName:
type: string
description: The name of the policy. 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 of the last update to the policy. Read-only.
format: date-time
nullable: true
policyMigrationState:
$ref: '#/components/schemas/microsoft.graph.authenticationMethodsPolicyMigrationState'
policyVersion:
type: string
description: The version of the policy in use. Read-only.
nullable: true
reconfirmationInDays:
maximum: 2147483647
minimum: -2147483648
type: number
format: int32
nullable: true
registrationEnforcement:
$ref: '#/components/schemas/microsoft.graph.registrationEnforcement'
authenticationMethodConfigurations:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.authenticationMethodConfiguration'
description: Represents the settings for each authentication method. Automatically expanded on GET /policies/authenticationMethodsPolicy.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.authenticationMethodConfiguration:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: authenticationMethodConfiguration
type: object
properties:
excludeTargets:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.excludeTarget'
description: Groups of users that are excluded from a policy.
state:
$ref: '#/components/schemas/microsoft.graph.authenticationMethodState'
additionalProperties:
type: object
microsoft.graph.authorizationPolicy:
allOf:
- $ref: '#/components/schemas/microsoft.graph.policyBase'
- title: authorizationPolicy
type: object
properties:
allowedToSignUpEmailBasedSubscriptions:
type: boolean
description: Indicates whether users can sign up for email based subscriptions.
allowedToUseSSPR:
type: boolean
description: 'Indicates whether administrators of the tenant can use the Self-Service Password Reset (SSPR). For more information, see Self-service password reset for administrators.'
allowEmailVerifiedUsersToJoinOrganization:
type: boolean
description: Indicates whether a user can join the tenant by email validation.
allowInvitesFrom:
$ref: '#/components/schemas/microsoft.graph.allowInvitesFrom'
allowUserConsentForRiskyApps:
type: boolean
description: Indicates whether user consent for risky apps is allowed. We recommend keeping allowUserConsentForRiskyApps as false. Default value is false.
nullable: true
blockMsolPowerShell:
type: boolean
description: 'To disable the use of MSOL PowerShell, set this property to true. This also disables user-based access to the legacy service endpoint used by MSOL PowerShell. This doesn''t affect Microsoft Entra Connect or Microsoft Graph.'
nullable: true
defaultUserRolePermissions:
$ref: '#/components/schemas/microsoft.graph.defaultUserRolePermissions'
guestUserRoleId:
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: 'Represents role templateId for the role that should be granted to guests. Currently following roles are supported: User (a0b1b346-4d3e-4e8b-98f8-753987be4970), Guest User (10dae51f-b6af-4016-8d66-8c2a99b929b3), and Restricted Guest User (2af84b1e-32c8-42b7-82bc-daa82404023b).'
format: uuid
nullable: true
additionalProperties:
type: object
microsoft.graph.claimsMappingPolicy:
allOf:
- $ref: '#/components/schemas/microsoft.graph.stsPolicy'
- title: claimsMappingPolicy
type: object
additionalProperties:
type: object
microsoft.graph.crossTenantAccessPolicy:
allOf:
- $ref: '#/components/schemas/microsoft.graph.policyBase'
- title: crossTenantAccessPolicy
type: object
properties:
allowedCloudEndpoints:
type: array
items:
type: string
description: 'Used to specify which Microsoft clouds an organization would like to collaborate with. By default, this value is empty. Supported values for this field are: microsoftonline.com, microsoftonline.us, and partner.microsoftonline.cn.'
default:
$ref: '#/components/schemas/microsoft.graph.crossTenantAccessPolicyConfigurationDefault'
partners:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.crossTenantAccessPolicyConfigurationPartner'
description: Defines partner-specific configurations for external Microsoft Entra organizations.
x-ms-navigationProperty: true
templates:
$ref: '#/components/schemas/microsoft.graph.policyTemplate'
additionalProperties:
type: object
microsoft.graph.crossTenantAccessPolicyConfigurationDefault:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: crossTenantAccessPolicyConfigurationDefault
type: object
properties:
appServiceConnectInbound:
$ref: '#/components/schemas/microsoft.graph.crossTenantAccessPolicyAppServiceConnectSetting'
automaticUserConsentSettings:
$ref: '#/components/schemas/microsoft.graph.inboundOutboundPolicyConfiguration'
b2bCollaborationInbound:
$ref: '#/components/schemas/microsoft.graph.crossTenantAccessPolicyB2BSetting'
b2bCollaborationOutbound:
$ref: '#/components/schemas/microsoft.graph.crossTenantAccessPolicyB2BSetting'
b2bDirectConnectInbound:
$ref: '#/components/schemas/microsoft.graph.crossTenantAccessPolicyB2BSetting'
b2bDirectConnectOutbound:
$ref: '#/components/schemas/microsoft.graph.crossTenantAccessPolicyB2BSetting'
inboundTrust:
$ref: '#/components/schemas/microsoft.graph.crossTenantAccessPolicyInboundTrust'
invitationRedemptionIdentityProviderConfiguration:
$ref: '#/components/schemas/microsoft.graph.defaultInvitationRedemptionIdentityProviderConfiguration'
isServiceDefault:
type: boolean
description: 'If true, the default configuration is set to the system default configuration. If false, the default settings are customized.'
nullable: true
m365CollaborationInbound:
$ref: '#/components/schemas/microsoft.graph.crossTenantAccessPolicyM365CollaborationInboundSetting'
m365CollaborationOutbound:
$ref: '#/components/schemas/microsoft.graph.crossTenantAccessPolicyM365CollaborationOutboundSetting'
tenantRestrictions:
$ref: '#/components/schemas/microsoft.graph.crossTenantAccessPolicyTenantRestrictions'
additionalProperties:
type: object
microsoft.graph.crossTenantAccessPolicyConfigurationPartner:
title: crossTenantAccessPolicyConfigurationPartner
type: object
properties:
appServiceConnectInbound:
$ref: '#/components/schemas/microsoft.graph.crossTenantAccessPolicyAppServiceConnectSetting'
automaticUserConsentSettings:
$ref: '#/components/schemas/microsoft.graph.inboundOutboundPolicyConfiguration'
b2bCollaborationInbound:
$ref: '#/components/schemas/microsoft.graph.crossTenantAccessPolicyB2BSetting'
b2bCollaborationOutbound:
$ref: '#/components/schemas/microsoft.graph.crossTenantAccessPolicyB2BSetting'
b2bDirectConnectInbound:
$ref: '#/components/schemas/microsoft.graph.crossTenantAccessPolicyB2BSetting'
b2bDirectConnectOutbound:
$ref: '#/components/schemas/microsoft.graph.crossTenantAccessPolicyB2BSetting'
inboundTrust:
$ref: '#/components/schemas/microsoft.graph.crossTenantAccessPolicyInboundTrust'
isInMultiTenantOrganization:
type: boolean
description: Identifies whether a tenant is a member of a multitenant organization.
nullable: true
isServiceProvider:
type: boolean
description: Identifies whether the partner-specific configuration is a Cloud Service Provider for your organization.
nullable: true
m365CollaborationInbound:
$ref: '#/components/schemas/microsoft.graph.crossTenantAccessPolicyM365CollaborationInboundSetting'
m365CollaborationOutbound:
$ref: '#/components/schemas/microsoft.graph.crossTenantAccessPolicyM365CollaborationOutboundSetting'
tenantId:
type: string
description: The tenant identifier for the partner Microsoft Entra organization. Read-only. Key.
tenantRestrictions:
$ref: '#/components/schemas/microsoft.graph.crossTenantAccessPolicyTenantRestrictions'
identitySynchronization:
$ref: '#/components/schemas/microsoft.graph.crossTenantIdentitySyncPolicyPartner'
serviceProviderConstraints:
$ref: '#/components/schemas/microsoft.graph.serviceProviderConstraints'
additionalProperties:
type: object
microsoft.graph.crossTenantIdentitySyncPolicyPartner:
title: crossTenantIdentitySyncPolicyPartner
type: object
properties:
displayName:
type: string
description: Display name for the cross-tenant user synchronization policy. Use the name of the partner Microsoft Entra tenant to easily identify the policy. Optional.
nullable: true
tenantId:
type: string
description: Tenant identifier for the partner Microsoft Entra organization. Read-only.
userSyncInbound:
$ref: '#/components/schemas/microsoft.graph.crossTenantUserSyncInbound'
additionalProperties:
type: object
microsoft.graph.serviceProviderConstraints:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: serviceProviderConstraints
type: object
additionalProperties:
type: object
microsoft.graph.policyTemplate:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: policyTemplate
type: object
properties:
multiTenantOrganizationIdentitySynchronization:
$ref: '#/components/schemas/microsoft.graph.multiTenantOrganizationIdentitySyncPolicyTemplate'
multiTenantOrganizationPartnerConfiguration:
$ref: '#/components/schemas/microsoft.graph.multiTenantOrganizationPartnerConfigurationTemplate'
additionalProperties:
type: object
microsoft.graph.multiTenantOrganizationIdentitySyncPolicyTemplate:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: multiTenantOrganizationIdentitySyncPolicyTemplate
type: object
properties:
templateApplicationLevel:
$ref: '#/components/schemas/microsoft.graph.templateApplicationLevel'
userSyncInbound:
$ref: '#/components/schemas/microsoft.graph.crossTenantUserSyncInbound'
additionalProperties:
type: object
microsoft.graph.multiTenantOrganizationPartnerConfigurationTemplate:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: multiTenantOrganizationPartnerConfigurationTemplate
type: object
properties:
automaticUserConsentSettings:
$ref: '#/components/schemas/microsoft.graph.inboundOutboundPolicyConfiguration'
b2bCollaborationInbound:
$ref: '#/components/schemas/microsoft.graph.crossTenantAccessPolicyB2BSetting'
b2bCollaborationOutbound:
$ref: '#/components/schemas/microsoft.graph.crossTenantAccessPolicyB2BSetting'
b2bDirectConnectInbound:
$ref: '#/components/schemas/microsoft.graph.crossTenantAccessPolicyB2BSetting'
b2bDirectConnectOutbound:
$ref: '#/components/schemas/microsoft.graph.crossTenantAccessPolicyB2BSetting'
inboundTrust:
$ref: '#/components/schemas/microsoft.graph.crossTenantAccessPolicyInboundTrust'
templateApplicationLevel:
$ref: '#/components/schemas/microsoft.graph.templateApplicationLevel'
additionalProperties:
type: object
microsoft.graph.tenantAppManagementPolicy:
allOf:
- $ref: '#/components/schemas/microsoft.graph.policyBase'
- title: tenantAppManagementPolicy
type: object
properties:
applicationRestrictions:
$ref: '#/components/schemas/microsoft.graph.appManagementApplicationConfiguration'
isEnabled:
type: boolean
description: Denotes whether the policy is enabled. Default value is false.
servicePrincipalRestrictions:
$ref: '#/components/schemas/microsoft.graph.appManagementServicePrincipalConfiguration'
additionalProperties:
type: object
microsoft.graph.deviceRegistrationPolicy:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: deviceRegistrationPolicy
type: object
properties:
azureADJoin:
$ref: '#/components/schemas/microsoft.graph.azureADJoinPolicy'
azureADRegistration:
$ref: '#/components/schemas/microsoft.graph.azureADRegistrationPolicy'
description:
type: string
description: 'The description of the device registration policy. Always set to Tenant-wide policy that manages intial provisioning controls using quota restrictions, additional authentication and authorization checks. Read-only.'
nullable: true
displayName:
type: string
description: The name of the device registration policy. Always set to Device Registration Policy. Read-only.
nullable: true
localAdminPassword:
$ref: '#/components/schemas/microsoft.graph.localAdminPasswordSettings'
multiFactorAuthConfiguration:
$ref: '#/components/schemas/microsoft.graph.multiFactorAuthConfiguration'
userDeviceQuota:
maximum: 2147483647
minimum: -2147483648
type: number
description: 'Specifies the maximum number of devices that a user can have within your organization before blocking new device registrations. The default value is set to 50. If this property isn''t specified during the policy update operation, it''s automatically reset to 0 to indicate that users aren''t allowed to join any devices.'
format: int32
additionalProperties:
type: object
microsoft.graph.featureRolloutPolicy:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: featureRolloutPolicy
type: object
properties:
description:
type: string
description: A description for this feature rollout policy.
nullable: true
displayName:
type: string
description: The display name for this feature rollout policy.
feature:
$ref: '#/components/schemas/microsoft.graph.stagedFeatureName'
isAppliedToOrganization:
type: boolean
description: Indicates whether this feature rollout policy should be applied to the entire organization.
isEnabled:
type: boolean
description: Indicates whether the feature rollout is enabled.
appliesTo:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
description: Nullable. Specifies a list of directoryObject resources that feature is enabled for.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.federatedTokenValidationPolicy:
allOf:
- $ref: '#/components/schemas/microsoft.graph.directoryObject'
- title: federatedTokenValidationPolicy
type: object
properties:
validatingDomains:
$ref: '#/components/schemas/microsoft.graph.validatingDomains'
additionalProperties:
type: object
microsoft.graph.homeRealmDiscoveryPolicy:
allOf:
- $ref: '#/components/schemas/microsoft.graph.stsPolicy'
- title: homeRealmDiscoveryPolicy
type: object
additionalProperties:
type: object
microsoft.graph.identitySecurityDefaultsEnforcementPolicy:
allOf:
- $ref: '#/components/schemas/microsoft.graph.policyBase'
- title: identitySecurityDefaultsEnforcementPolicy
type: object
properties:
isEnabled:
type: boolean
description: 'If set to true, Microsoft Entra security defaults are enabled for the tenant.'
additionalProperties:
type: object
microsoft.graph.ownerlessGroupPolicy:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: ownerlessGroupPolicy
type: object
properties:
emailInfo:
$ref: '#/components/schemas/microsoft.graph.emailDetails'
enabledGroupIds:
type: array
items:
type: string
description: 'The collection of IDs for groups to which the policy is enabled. If empty, the policy is enabled for all groups in the tenant.'
isEnabled:
type: boolean
description: Indicates whether the ownerless group policy is enabled in the tenant. Setting this property to false clears the values of all other policy parameters.
maxMembersToNotify:
type: number
description: 'The maximum number of members to notify. Value range is 0-90. Members are prioritized by recent group activity (most active first). If there aren''t enough active members to fill the limit, remaining slots are filled with other eligible group members from the directory.'
format: int64
notificationDurationInWeeks:
type: number
description: The number of weeks for the notification duration. Value range is 1-7.
format: int64
policyWebUrl:
type: string
description: The URL to the policy documentation.
nullable: true
targetOwners:
$ref: '#/components/schemas/microsoft.graph.targetOwners'
additionalProperties:
type: object
microsoft.graph.permissionGrantPolicy:
allOf:
- $ref: '#/components/schemas/microsoft.graph.policyBase'
- title: permissionGrantPolicy
type: object
properties:
excludes:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.permissionGrantConditionSet'
description: Condition sets that are excluded in this permission grant policy. Automatically expanded on GET.
x-ms-navigationProperty: true
includes:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.permissionGrantConditionSet'
description: Condition sets that are included in this permission grant policy. Automatically expanded on GET.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.permissionGrantConditionSet:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: permissionGrantConditionSet
type: object
properties:
clientApplicationIds:
type: array
items:
type: string
nullable: true
description: 'A list of appId values for the client applications to match with, or a list with the single value all to match any client application. Default is the single value all.'
clientApplicationPublisherIds:
type: array
items:
type: string
nullable: true
description: 'A list of Microsoft Partner Network (MPN) IDs for verified publishers of the client application, or a list with the single value all to match with client apps from any publisher. Default is the single value all.'
clientApplicationsFromVerifiedPublisherOnly:
type: boolean
description: 'Set to true to only match on client applications with a verified publisher. Set to false to match on any client app, even if it doesn''t have a verified publisher. Default is false.'
nullable: true
clientApplicationTenantIds:
type: array
items:
type: string
nullable: true
description: 'A list of Microsoft Entra tenant IDs in which the client application is registered, or a list with the single value all to match with client apps registered in any tenant. Default is the single value all.'
permissionClassification:
type: string
description: 'The permission classification for the permission being granted, or all to match with any permission classification (including permissions that aren''t classified). Default is all.'
nullable: true
permissions:
type: array
items:
type: string
nullable: true
description: 'The list of id values for the specific permissions to match with, or a list with the single value all to match with any permission. The id of delegated permissions can be found in the oauth2PermissionScopes property of the API''s servicePrincipal object. The id of application permissions can be found in the appRoles property of the API''s servicePrincipal object. The id of resource-specific application permissions can be found in the resourceSpecificApplicationPermissions property of the API''s servicePrincipal object. Default is the single value all.'
permissionType:
$ref: '#/components/schemas/microsoft.graph.permissionType'
resourceApplication:
type: string
description: 'The appId of the resource application (for example the API) for which a permission is being granted, or any to match with any resource application or API. Default is any.'
nullable: true
additionalProperties:
type: object
microsoft.graph.unifiedRoleManagementPolicy:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: unifiedRoleManagementPolicy
type: object
properties:
description:
type: string
description: Description for the policy.
displayName:
type: string
description: Display name for the policy.
isOrganizationDefault:
type: boolean
description: 'This can only be set to true for a single tenant-wide policy which will apply to all scopes and roles. Set the scopeId to / and scopeType to Directory. Supports $filter (eq, ne).'
nullable: true
lastModifiedBy:
$ref: '#/components/schemas/microsoft.graph.identity'
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 time when the role setting was last modified.
format: date-time
nullable: true
scopeId:
type: string
description: The identifier of the scope where the policy is created. Can be / for the tenant or a group ID. Required.
scopeType:
type: string
description: 'The type of the scope where the policy is created. One of Directory, DirectoryRole, Group. Required.'
effectiveRules:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleManagementPolicyRule'
description: 'The list of effective rules like approval rules and expiration rules evaluated based on inherited referenced rules. For example, if there is a tenant-wide policy to enforce enabling an approval rule, the effective rule will be to enable approval even if the policy has a rule to disable approval. Supports $expand.'
x-ms-navigationProperty: true
rules:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleManagementPolicyRule'
description: The collection of rules like approval rules and expiration rules. Supports $expand.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.unifiedRoleManagementPolicyRule:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: unifiedRoleManagementPolicyRule
type: object
properties:
target:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleManagementPolicyRuleTarget'
additionalProperties:
type: object
microsoft.graph.unifiedRoleManagementPolicyAssignment:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: unifiedRoleManagementPolicyAssignment
type: object
properties:
policyId:
type: string
description: The id of the policy. Inherited from entity.
roleDefinitionId:
type: string
description: 'For Microsoft Entra roles policy, it''s the identifier of the role definition object where the policy applies. For PIM for Groups membership and ownership, it''s either member or owner. Supports $filter (eq).'
nullable: true
scopeId:
type: string
description: The identifier of the scope where the policy is assigned. Can be / for the tenant or a group ID. Required.
scopeType:
type: string
description: 'The type of the scope where the policy is assigned. One of Directory, DirectoryRole, Group. Required.'
policy:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleManagementPolicy'
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.multiTenantOrganization:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: multiTenantOrganization
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: Date when multitenant organization was created. Read-only.
format: date-time
nullable: true
description:
type: string
description: Description of the multitenant organization.
nullable: true
displayName:
type: string
description: Display name of the multitenant organization.
nullable: true
state:
$ref: '#/components/schemas/microsoft.graph.multiTenantOrganizationState'
joinRequest:
$ref: '#/components/schemas/microsoft.graph.multiTenantOrganizationJoinRequestRecord'
tenants:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.multiTenantOrganizationMember'
description: Defines tenants added to a multitenant organization.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.multiTenantOrganizationJoinRequestRecord:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: multiTenantOrganizationJoinRequestRecord
type: object
properties:
addedByTenantId:
type: string
description: 'Tenant ID of the Microsoft Entra tenant that added a tenant to the multitenant organization. To reset a failed join request, set addedByTenantId to 00000000-0000-0000-0000-000000000000. Required.'
nullable: true
memberState:
$ref: '#/components/schemas/microsoft.graph.multiTenantOrganizationMemberState'
role:
$ref: '#/components/schemas/microsoft.graph.multiTenantOrganizationMemberRole'
transitionDetails:
$ref: '#/components/schemas/microsoft.graph.multiTenantOrganizationJoinRequestTransitionDetails'
additionalProperties:
type: object
microsoft.graph.multiTenantOrganizationMember:
allOf:
- $ref: '#/components/schemas/microsoft.graph.directoryObject'
- title: multiTenantOrganizationMember
type: object
properties:
addedByTenantId:
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: Tenant ID of the tenant that added the tenant to the multitenant organization. Read-only.
format: uuid
nullable: true
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: Date and time when the tenant was added to the multitenant organization. Read-only.
format: date-time
nullable: true
displayName:
type: string
description: Display name of the tenant added to the multitenant organization.
nullable: true
joinedDateTime:
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 tenant joined the multitenant organization. Read-only.
format: date-time
nullable: true
role:
$ref: '#/components/schemas/microsoft.graph.multiTenantOrganizationMemberRole'
state:
$ref: '#/components/schemas/microsoft.graph.multiTenantOrganizationMemberState'
tenantId:
type: string
description: Tenant ID of the Microsoft Entra tenant added to the multitenant organization. Set at the time tenant is added.Supports $filter. Key.
transitionDetails:
$ref: '#/components/schemas/microsoft.graph.multiTenantOrganizationMemberTransitionDetails'
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.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.webauthnCredentialCreationOptions:
title: webauthnCredentialCreationOptions
type: object
properties:
challengeTimeoutDateTime:
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 challenge times out and can no longer be used to create a credential.
format: date-time
nullable: true
publicKey:
$ref: '#/components/schemas/microsoft.graph.webauthnPublicKeyCredentialCreationOptions'
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.passwordResetResponse:
title: passwordResetResponse
type: object
properties:
newPassword:
type: string
description: The Microsoft Entra ID-generated password.
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.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.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.entity:
title: entity
type: object
properties:
id:
type: string
description: The unique identifier for an entity. Read-only.
additionalProperties:
type: object
ReferenceNumeric:
enum:
- '-INF'
- INF
- NaN
type: string
nullable: true
microsoft.graph.dataPolicyOperationStatus:
title: dataPolicyOperationStatus
enum:
- notStarted
- running
- complete
- failed
- unknownFutureValue
type: string
microsoft.graph.conditionalAccessRoot:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: conditionalAccessRoot
type: object
properties:
authenticationContextClassReferences:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.authenticationContextClassReference'
description: Read-only. Nullable. Returns a collection of the specified authentication context class references.
x-ms-navigationProperty: true
authenticationStrength:
$ref: '#/components/schemas/microsoft.graph.authenticationStrengthRoot'
deletedItems:
$ref: '#/components/schemas/microsoft.graph.caPoliciesDeletableRoot'
namedLocations:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.namedLocation'
description: Read-only. Nullable. Returns a collection of the specified named locations.
x-ms-navigationProperty: true
policies:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.conditionalAccessPolicy'
description: Read-only. Nullable. Returns a collection of the specified Conditional Access (CA) policies.
x-ms-navigationProperty: true
templates:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.conditionalAccessTemplate'
description: Read-only. Nullable. Returns a collection of the specified Conditional Access templates.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.apiAuthenticationConfigurationBase:
title: apiAuthenticationConfigurationBase
type: object
additionalProperties:
type: object
microsoft.graph.authenticationConditionsApplications:
title: authenticationConditionsApplications
type: object
properties:
includeApplications:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.authenticationConditionApplication'
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.onAttributeCollectionStartHandler:
title: onAttributeCollectionStartHandler
type: object
additionalProperties:
type: object
microsoft.graph.onAttributeCollectionSubmitHandler:
title: onAttributeCollectionSubmitHandler
type: object
additionalProperties:
type: object
microsoft.graph.onInteractiveAuthFlowStartHandler:
title: onInteractiveAuthFlowStartHandler
type: object
additionalProperties:
type: object
microsoft.graph.onUserCreateStartHandler:
title: onUserCreateStartHandler
type: object
additionalProperties:
type: object
microsoft.graph.authenticationAttributeCollectionPage:
title: authenticationAttributeCollectionPage
type: object
properties:
views:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.authenticationAttributeCollectionPageViewConfiguration'
description: A collection of displays of the attribute collection page.
additionalProperties:
type: object
microsoft.graph.identityUserFlow:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: identityUserFlow
type: object
properties:
userFlowType:
$ref: '#/components/schemas/microsoft.graph.userFlowType'
userFlowTypeVersion:
type: number
format: float
nullable: true
additionalProperties:
type: object
microsoft.graph.userAttributeValuesItem:
title: userAttributeValuesItem
type: object
properties:
isDefault:
type: boolean
description: Determines whether the value is set as the default.
name:
type: string
description: The display name of the property displayed to the user in the user flow.
nullable: true
value:
type: string
description: The value that is set when this item is selected.
nullable: true
additionalProperties:
type: object
microsoft.graph.identityUserFlowAttributeInputType:
title: identityUserFlowAttributeInputType
enum:
- textBox
- dateTimeDropdown
- radioSingleSelect
- dropdownSingleSelect
- emailBox
- checkboxMultiSelect
type: string
microsoft.graph.identityUserFlowAttributeDataType:
title: identityUserFlowAttributeDataType
enum:
- string
- boolean
- int64
- stringCollection
- dateTime
- unknownFutureValue
type: string
microsoft.graph.identityUserFlowAttributeType:
title: identityUserFlowAttributeType
enum:
- builtIn
- custom
- required
- unknownFutureValue
type: string
microsoft.graph.baseAuthenticationMethod:
title: baseAuthenticationMethod
enum:
- password
- voice
- hardwareOath
- softwareOath
- sms
- fido2
- windowsHelloForBusiness
- microsoftAuthenticator
- temporaryAccessPass
- email
- x509Certificate
- federation
- unknownFutureValue
- qrCodePin
type: string
microsoft.graph.authenticationStrengthPolicyType:
title: authenticationStrengthPolicyType
enum:
- builtIn
- custom
- unknownFutureValue
type: string
microsoft.graph.authenticationStrengthRequirements:
title: authenticationStrengthRequirements
enum:
- none
- mfa
- unknownFutureValue
type: string
x-ms-enum-flags:
isFlags: true
microsoft.graph.policyDeletableItem:
title: policyDeletableItem
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
format: date-time
nullable: true
additionalProperties:
type: object
microsoft.graph.conditionalAccessConditionSet:
title: conditionalAccessConditionSet
type: object
properties:
applications:
$ref: '#/components/schemas/microsoft.graph.conditionalAccessApplications'
authenticationFlows:
$ref: '#/components/schemas/microsoft.graph.conditionalAccessAuthenticationFlows'
clientApplications:
$ref: '#/components/schemas/microsoft.graph.conditionalAccessClientApplications'
clientAppTypes:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.conditionalAccessClientApp'
description: 'Client application types included in the policy. The possible values are: all, browser, mobileAppsAndDesktopClients, exchangeActiveSync, easSupported, other. Required. The easUnsupported enumeration member will be deprecated in favor of exchangeActiveSync, which includes EAS supported and unsupported platforms.'
devices:
$ref: '#/components/schemas/microsoft.graph.conditionalAccessDevices'
insiderRiskLevels:
$ref: '#/components/schemas/microsoft.graph.conditionalAccessInsiderRiskLevels'
locations:
$ref: '#/components/schemas/microsoft.graph.conditionalAccessLocations'
platforms:
$ref: '#/components/schemas/microsoft.graph.conditionalAccessPlatforms'
servicePrincipalRiskLevels:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.riskLevel'
description: 'Service principal risk levels included in the policy. The possible values are: low, medium, high, none, unknownFutureValue.'
signInRiskLevels:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.riskLevel'
description: 'Sign-in risk levels included in the policy. The possible values are: low, medium, high, hidden, none, unknownFutureValue. Required.'
userRiskLevels:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.riskLevel'
description: 'User risk levels included in the policy. The possible values are: low, medium, high, hidden, none, unknownFutureValue. Required.'
users:
$ref: '#/components/schemas/microsoft.graph.conditionalAccessUsers'
additionalProperties:
type: object
microsoft.graph.conditionalAccessGrantControls:
title: conditionalAccessGrantControls
type: object
properties:
builtInControls:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.conditionalAccessGrantControl'
description: 'List of values of built-in controls required by the policy. Possible values: block, mfa, compliantDevice, domainJoinedDevice, approvedApplication, compliantApplication, passwordChange, unknownFutureValue, riskRemediation. Use the Prefer: include-unknown-enum-members request header to get the following value in this evolvable enum: riskRemediation.'
customAuthenticationFactors:
type: array
items:
type: string
description: 'List of custom controls IDs required by the policy. For more information, see Custom controls.'
operator:
type: string
description: 'Defines the relationship of the grant controls. Possible values: AND, OR.'
nullable: true
termsOfUse:
type: array
items:
type: string
description: List of terms of use IDs required by the policy.
authenticationStrength:
$ref: '#/components/schemas/microsoft.graph.authenticationStrengthPolicy'
additionalProperties:
type: object
microsoft.graph.conditionalAccessSessionControls:
title: conditionalAccessSessionControls
type: object
properties:
applicationEnforcedRestrictions:
$ref: '#/components/schemas/microsoft.graph.applicationEnforcedRestrictionsSessionControl'
cloudAppSecurity:
$ref: '#/components/schemas/microsoft.graph.cloudAppSecuritySessionControl'
disableResilienceDefaults:
type: boolean
description: Session control that determines whether it is acceptable for Microsoft Entra ID to extend existing sessions based on information collected prior to an outage or not.
nullable: true
persistentBrowser:
$ref: '#/components/schemas/microsoft.graph.persistentBrowserSessionControl'
secureSignInSession:
$ref: '#/components/schemas/microsoft.graph.secureSignInSessionControl'
signInFrequency:
$ref: '#/components/schemas/microsoft.graph.signInFrequencySessionControl'
additionalProperties:
type: object
microsoft.graph.conditionalAccessPolicyState:
title: conditionalAccessPolicyState
enum:
- enabled
- disabled
- enabledForReportingButNotEnforced
type: string
microsoft.graph.authenticationFlow:
title: authenticationFlow
type: object
properties:
transferMethod:
$ref: '#/components/schemas/microsoft.graph.conditionalAccessTransferMethods'
additionalProperties:
type: object
microsoft.graph.conditionalAccessClientApp:
title: conditionalAccessClientApp
enum:
- all
- browser
- mobileAppsAndDesktopClients
- exchangeActiveSync
- easSupported
- other
- unknownFutureValue
type: string
microsoft.graph.deviceInfo:
title: deviceInfo
type: object
properties:
deviceId:
type: string
description: Unique identifier set by Azure Device Registration Service at the time of registration.
nullable: true
displayName:
type: string
description: The display name for the device.
nullable: true
enrollmentProfileName:
type: string
description: Enrollment profile applied to the device.
nullable: true
extensionAttribute1:
type: string
description: Extension attribute.
nullable: true
extensionAttribute10:
type: string
description: Extension attribute.
nullable: true
extensionAttribute11:
type: string
description: Extension attribute.
nullable: true
extensionAttribute12:
type: string
description: Extension attribute.
nullable: true
extensionAttribute13:
type: string
description: Extension attribute.
nullable: true
extensionAttribute14:
type: string
description: Extension attribute.
nullable: true
extensionAttribute15:
type: string
description: Extension attribute.
nullable: true
extensionAttribute2:
type: string
description: Extension attribute.
nullable: true
extensionAttribute3:
type: string
description: Extension attribute.
nullable: true
extensionAttribute4:
type: string
description: Extension attribute.
nullable: true
extensionAttribute5:
type: string
description: Extension attribute.
nullable: true
extensionAttribute6:
type: string
description: Extension attribute.
nullable: true
extensionAttribute7:
type: string
description: Extension attribute.
nullable: true
extensionAttribute8:
type: string
description: Extension attribute.
nullable: true
extensionAttribute9:
type: string
description: Extension attribute.
nullable: true
isCompliant:
type: boolean
description: Indicates the device compliance status with Mobile Management Device (MDM) policies. Default is false.
nullable: true
manufacturer:
type: string
description: Manufacturer of the device.
nullable: true
mdmAppId:
type: string
description: Application identifier used to register device into MDM.
nullable: true
model:
type: string
description: Model of the device.
nullable: true
operatingSystem:
type: string
description: The type of operating system on the device.
nullable: true
operatingSystemVersion:
type: string
description: The version of the operating system on the device.
nullable: true
ownership:
type: string
description: Ownership of the device. This property is set by Intune.
nullable: true
physicalIds:
type: array
items:
type: string
nullable: true
description: A collection of physical identifiers for the device.
profileType:
type: string
description: The profile type of the device.
nullable: true
systemLabels:
type: array
items:
type: string
nullable: true
description: List of labels applied to the device by the system.
trustType:
type: string
description: Type of trust for the joined device.
nullable: true
additionalProperties:
type: object
microsoft.graph.conditionalAccessDevicePlatform:
title: conditionalAccessDevicePlatform
enum:
- android
- iOS
- windows
- windowsPhone
- macOS
- all
- unknownFutureValue
- linux
type: string
microsoft.graph.insiderRiskLevel:
title: insiderRiskLevel
enum:
- none
- minor
- moderate
- elevated
- unknownFutureValue
type: string
microsoft.graph.riskLevel:
title: riskLevel
enum:
- low
- medium
- high
- hidden
- none
- unknownFutureValue
type: string
microsoft.graph.whatIfAnalysisReasons:
title: whatIfAnalysisReasons
enum:
- notSet
- notEnoughInformation
- invalidCondition
- users
- workloadIdentities
- application
- userActions
- authenticationContext
- devicePlatform
- devices
- clientApps
- location
- signInRisk
- emptyPolicy
- invalidPolicy
- policyNotEnabled
- userRisk
- time
- insiderRisk
- authenticationFlow
- unknownFutureValue
type: string
x-ms-enum-flags:
isFlags: true
microsoft.graph.conditionalAccessPolicyDetail:
title: conditionalAccessPolicyDetail
type: object
properties:
conditions:
$ref: '#/components/schemas/microsoft.graph.conditionalAccessConditionSet'
grantControls:
$ref: '#/components/schemas/microsoft.graph.conditionalAccessGrantControls'
sessionControls:
$ref: '#/components/schemas/microsoft.graph.conditionalAccessSessionControls'
additionalProperties:
type: object
microsoft.graph.templateScenarios:
title: templateScenarios
enum:
- new
- secureFoundation
- zeroTrust
- remoteWork
- protectAdmins
- emergingThreats
- unknownFutureValue
type: string
x-ms-enum-flags:
isFlags: true
microsoft.graph.customCalloutExtension:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: customCalloutExtension
type: object
properties:
authenticationConfiguration:
$ref: '#/components/schemas/microsoft.graph.customExtensionAuthenticationConfiguration'
clientConfiguration:
$ref: '#/components/schemas/microsoft.graph.customExtensionClientConfiguration'
description:
type: string
description: Description for the customCalloutExtension object.
nullable: true
displayName:
type: string
description: Display name for the customCalloutExtension object.
nullable: true
endpointConfiguration:
$ref: '#/components/schemas/microsoft.graph.customExtensionEndpointConfiguration'
additionalProperties:
type: object
microsoft.graph.customExtensionBehaviorOnError:
title: customExtensionBehaviorOnError
type: object
additionalProperties:
type: object
microsoft.graph.genericError:
title: genericError
type: object
properties:
code:
type: string
description: The error code.
nullable: true
message:
type: string
description: The error message.
nullable: true
additionalProperties:
type: object
microsoft.graph.webApplicationFirewallProviderType:
title: webApplicationFirewallProviderType
enum:
- akamai
- cloudflare
- unknownFutureValue
type: string
microsoft.graph.webApplicationFirewallVerificationResult:
title: webApplicationFirewallVerificationResult
type: object
properties:
errors:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.genericError'
description: List of errors encountered during the verification process.
status:
$ref: '#/components/schemas/microsoft.graph.webApplicationFirewallVerificationStatus'
verifiedOnDateTime:
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: UTC timestamp when the verification was performed or last updated. This indicates when the verification result was produced.
format: date-time
warnings:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.genericError'
description: List of warnings produced during verification.
additionalProperties:
type: object
microsoft.graph.webApplicationFirewallVerifiedDetails:
title: webApplicationFirewallVerifiedDetails
type: object
properties:
dnsConfiguration:
$ref: '#/components/schemas/microsoft.graph.webApplicationFirewallDnsConfiguration'
additionalProperties:
type: object
microsoft.graph.faceCheckConfiguration:
title: faceCheckConfiguration
type: object
properties:
isEnabled:
type: boolean
description: Defines if Face Check is required. Currently must always be true.
sourcePhotoClaimName:
type: string
description: Source of photo to validate Face Check against. Currently must always be portrait.
additionalProperties:
type: object
microsoft.graph.verifiedIdProfileState:
title: verifiedIdProfileState
enum:
- enabled
- disabled
- unknownFutureValue
type: string
microsoft.graph.verifiedIdProfileConfiguration:
title: verifiedIdProfileConfiguration
type: object
properties:
acceptedIssuer:
type: string
description: Trusted Verified ID issuer.
claimBindings:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.claimBinding'
description: Claim bindings from Verified ID to source attributes.
claimBindingSource:
$ref: '#/components/schemas/microsoft.graph.claimBindingSource'
claimValidation:
$ref: '#/components/schemas/microsoft.graph.claimValidation'
type:
type: string
description: Verified ID type.
additionalProperties:
type: object
microsoft.graph.verifiedIdUsageConfiguration:
title: verifiedIdUsageConfiguration
type: object
properties:
isEnabledForTestOnly:
type: boolean
description: Sets profile usage for evaluation (test-only) or production.
purpose:
$ref: '#/components/schemas/microsoft.graph.verifiedIdUsageConfigurationPurpose'
additionalProperties:
type: object
microsoft.graph.activityType:
title: activityType
enum:
- signin
- user
- unknownFutureValue
- servicePrincipal
type: string
microsoft.graph.riskDetectionTimingType:
title: riskDetectionTimingType
enum:
- notDefined
- realtime
- nearRealtime
- offline
- unknownFutureValue
type: string
microsoft.graph.signInLocation:
title: signInLocation
type: object
properties:
city:
type: string
description: Provides the city where the sign-in originated and is determined using latitude/longitude information from the sign-in activity.
nullable: true
countryOrRegion:
type: string
description: Provides the country code info (two letter code) where the sign-in originated. This is calculated using latitude/longitude information from the sign-in activity.
nullable: true
geoCoordinates:
$ref: '#/components/schemas/microsoft.graph.geoCoordinates'
state:
type: string
description: Provides the State where the sign-in originated. This is calculated using latitude/longitude information from the sign-in activity.
nullable: true
additionalProperties:
type: object
microsoft.graph.riskDetail:
title: riskDetail
enum:
- none
- adminGeneratedTemporaryPassword
- userPerformedSecuredPasswordChange
- userPerformedSecuredPasswordReset
- adminConfirmedSigninSafe
- aiConfirmedSigninSafe
- userPassedMFADrivenByRiskBasedPolicy
- adminDismissedAllRiskForUser
- adminConfirmedSigninCompromised
- hidden
- adminConfirmedUserCompromised
- unknownFutureValue
- m365DAdminDismissedDetection
- adminConfirmedServicePrincipalCompromised
- adminDismissedAllRiskForServicePrincipal
- userChangedPasswordOnPremises
- adminDismissedRiskForSignIn
- adminConfirmedAccountSafe
- microsoftRevokedSessions
type: string
microsoft.graph.riskState:
title: riskState
enum:
- none
- confirmedSafe
- remediated
- dismissed
- atRisk
- confirmedCompromised
- unknownFutureValue
type: string
microsoft.graph.tokenIssuerType:
title: tokenIssuerType
enum:
- AzureAD
- ADFederationServices
- UnknownFutureValue
- AzureADBackupAuth
- ADFederationServicesMFAAdapter
- NPSExtension
type: string
microsoft.graph.riskServicePrincipalActivity:
title: riskServicePrincipalActivity
type: object
properties:
detail:
$ref: '#/components/schemas/microsoft.graph.riskDetail'
riskEventTypes:
type: array
items:
type: string
nullable: true
description: 'The type of risk event detected. The possible values are: investigationsThreatIntelligence, generic, adminConfirmedServicePrincipalCompromised, suspiciousSignins, leakedCredentials, anomalousServicePrincipalActivity, maliciousApplication, suspiciousApplication.'
additionalProperties:
type: object
microsoft.graph.riskUserActivity:
title: riskUserActivity
type: object
properties:
detail:
$ref: '#/components/schemas/microsoft.graph.riskDetail'
riskEventTypes:
type: array
items:
type: string
nullable: true
description: The type of risk event detected.
additionalProperties:
type: object
microsoft.graph.volumeType:
title: volumeType
enum:
- operatingSystemVolume
- fixedDataVolume
- removableDataVolume
- unknownFutureValue
type: string
microsoft.graph.threatCategory:
title: threatCategory
enum:
- undefined
- spam
- phishing
- malware
- unknownFutureValue
type: string
microsoft.graph.threatAssessmentContentType:
title: threatAssessmentContentType
enum:
- mail
- url
- file
type: string
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.threatExpectedAssessment:
title: threatExpectedAssessment
enum:
- block
- unblock
type: string
microsoft.graph.threatAssessmentRequestSource:
title: threatAssessmentRequestSource
enum:
- undefined
- user
- administrator
type: string
microsoft.graph.threatAssessmentStatus:
title: threatAssessmentStatus
enum:
- pending
- completed
type: string
microsoft.graph.threatAssessmentResultType:
title: threatAssessmentResultType
enum:
- checkPolicy
- rescan
- unknownFutureValue
type: string
microsoft.graph.invitedUserMessageInfo:
title: invitedUserMessageInfo
type: object
properties:
ccRecipients:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.recipient'
description: Additional recipients the invitation message should be sent to. Currently only one additional recipient is supported.
customizedMessageBody:
type: string
description: Customized message body you want to send if you don't want the default message. Only plain text is allowed.
nullable: true
messageLanguage:
type: string
description: 'The language you want to send the default message in. If the customizedMessageBody is specified, this property is ignored, and the message is sent using the customizedMessageBody. The language format should be in ISO 639. The default is en-US.'
nullable: true
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.customSecurityAttributeValue:
title: customSecurityAttributeValue
type: object
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.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.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.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.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.certificateAuthority:
title: certificateAuthority
type: object
properties:
certificate:
type: string
description: Required. The base64 encoded string representing the public certificate.
format: base64url
certificateRevocationListUrl:
type: string
description: The URL of the certificate revocation list.
nullable: true
deltaCertificateRevocationListUrl:
type: string
description: The URL contains the list of all revoked certificates since the last time a full certificate revocaton list was created.
nullable: true
isRootAuthority:
type: boolean
description: 'Required. true if the trusted certificate is a root authority, false if the trusted certificate is an intermediate authority.'
issuer:
type: string
description: 'The issuer of the certificate, calculated from the certificate value. Read-only.'
issuerSki:
type: string
description: 'The subject key identifier of the certificate, calculated from the certificate value. 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.accessReviewReviewerScope:
title: accessReviewReviewerScope
type: object
properties:
query:
type: string
description: The query specifying who will be the reviewer.
nullable: true
queryRoot:
type: string
description: 'In the scenario where reviewers need to be specified dynamically, this property is used to indicate the relative source of the query. This property is only required if a relative query, for example, ./manager, is specified. Possible value: decisions.'
nullable: true
queryType:
type: string
description: The type of query. Examples include MicrosoftGraph and ARM.
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.selfServiceSignUpAuthenticationFlowConfiguration:
title: selfServiceSignUpAuthenticationFlowConfiguration
type: object
properties:
isEnabled:
type: boolean
description: Indicates whether self-service sign-up flow is enabled or disabled. The default value is false. This property isn't a key. Required.
additionalProperties:
type: object
microsoft.graph.authenticationMethodsPolicyMigrationState:
title: authenticationMethodsPolicyMigrationState
enum:
- preMigration
- migrationInProgress
- migrationComplete
- unknownFutureValue
type: string
microsoft.graph.registrationEnforcement:
title: registrationEnforcement
type: object
properties:
authenticationMethodsRegistrationCampaign:
$ref: '#/components/schemas/microsoft.graph.authenticationMethodsRegistrationCampaign'
additionalProperties:
type: object
microsoft.graph.excludeTarget:
title: excludeTarget
type: object
properties:
id:
type: string
description: The object identifier of a Microsoft Entra user or group.
targetType:
$ref: '#/components/schemas/microsoft.graph.authenticationMethodTargetType'
additionalProperties:
type: object
microsoft.graph.authenticationMethodState:
title: authenticationMethodState
enum:
- enabled
- disabled
type: string
microsoft.graph.allowInvitesFrom:
title: allowInvitesFrom
enum:
- none
- adminsAndGuestInviters
- adminsGuestInvitersAndAllMembers
- everyone
- unknownFutureValue
type: string
microsoft.graph.defaultUserRolePermissions:
title: defaultUserRolePermissions
type: object
properties:
allowedToCreateApps:
type: boolean
description: Indicates whether the default user role can create applications. This setting corresponds to the Users can register applications setting in the User settings menu in the Microsoft Entra admin center.
allowedToCreateSecurityGroups:
type: boolean
description: 'Indicates whether the default user role can create security groups. This setting corresponds to the following menus in the Microsoft Entra admin center: The Users can create security groups in Microsoft Entra admin centers, API or PowerShell setting in the Group settings menu. Users can create security groups setting in the User settings menu.'
allowedToCreateTenants:
type: boolean
description: 'Indicates whether the default user role can create tenants. This setting corresponds to the Restrict non-admin users from creating tenants setting in the User settings menu in the Microsoft Entra admin center. When this setting is false, users assigned the Tenant Creator role can still create tenants.'
nullable: true
allowedToReadBitlockerKeysForOwnedDevice:
type: boolean
description: Indicates whether the registered owners of a device can read their own BitLocker recovery keys with default user role.
nullable: true
allowedToReadOtherUsers:
type: boolean
description: Indicates whether the default user role can read other users. DO NOT SET THIS VALUE TO false.
permissionGrantPoliciesAssigned:
type: array
items:
type: string
nullable: true
description: 'Indicates if user consent to apps is allowed, and if it is, which permission to grant consent and which app consent policy (permissionGrantPolicy) govern the permission for users to grant consent. Value should be in the format managePermissionGrantsForSelf.{id}, where {id} is the id of a built-in or custom app consent policy. An empty list indicates user consent to apps is disabled.'
additionalProperties:
type: object
microsoft.graph.crossTenantAccessPolicyAppServiceConnectSetting:
title: crossTenantAccessPolicyAppServiceConnectSetting
type: object
properties:
applications:
$ref: '#/components/schemas/microsoft.graph.crossTenantAccessPolicyTargetConfiguration'
additionalProperties:
type: object
microsoft.graph.inboundOutboundPolicyConfiguration:
title: inboundOutboundPolicyConfiguration
type: object
properties:
inboundAllowed:
type: boolean
description: Defines whether external users coming inbound are allowed.
nullable: true
outboundAllowed:
type: boolean
description: Defines whether internal users are allowed to go outbound.
nullable: true
additionalProperties:
type: object
microsoft.graph.crossTenantAccessPolicyB2BSetting:
title: crossTenantAccessPolicyB2BSetting
type: object
properties:
applications:
$ref: '#/components/schemas/microsoft.graph.crossTenantAccessPolicyTargetConfiguration'
usersAndGroups:
$ref: '#/components/schemas/microsoft.graph.crossTenantAccessPolicyTargetConfiguration'
additionalProperties:
type: object
microsoft.graph.crossTenantAccessPolicyInboundTrust:
title: crossTenantAccessPolicyInboundTrust
type: object
properties:
isCompliantDeviceAccepted:
type: boolean
description: Specifies whether compliant devices from external Microsoft Entra organizations are trusted.
nullable: true
isHybridAzureADJoinedDeviceAccepted:
type: boolean
description: Specifies whether Microsoft Entra hybrid joined devices from external Microsoft Entra organizations are trusted.
nullable: true
isMfaAccepted:
type: boolean
description: Specifies whether MFA from external Microsoft Entra organizations is trusted.
nullable: true
additionalProperties:
type: object
microsoft.graph.defaultInvitationRedemptionIdentityProviderConfiguration:
allOf:
- $ref: '#/components/schemas/microsoft.graph.invitationRedemptionIdentityProviderConfiguration'
- title: defaultInvitationRedemptionIdentityProviderConfiguration
type: object
additionalProperties:
type: object
microsoft.graph.crossTenantAccessPolicyM365CollaborationInboundSetting:
title: crossTenantAccessPolicyM365CollaborationInboundSetting
type: object
properties:
users:
$ref: '#/components/schemas/microsoft.graph.crossTenantAccessPolicyTargetConfiguration'
additionalProperties:
type: object
microsoft.graph.crossTenantAccessPolicyM365CollaborationOutboundSetting:
title: crossTenantAccessPolicyM365CollaborationOutboundSetting
type: object
properties:
usersAndGroups:
$ref: '#/components/schemas/microsoft.graph.crossTenantAccessPolicyTargetConfiguration'
additionalProperties:
type: object
microsoft.graph.crossTenantAccessPolicyTenantRestrictions:
allOf:
- $ref: '#/components/schemas/microsoft.graph.crossTenantAccessPolicyB2BSetting'
- title: crossTenantAccessPolicyTenantRestrictions
type: object
properties:
devices:
$ref: '#/components/schemas/microsoft.graph.devicesFilter'
additionalProperties:
type: object
microsoft.graph.crossTenantUserSyncInbound:
title: crossTenantUserSyncInbound
type: object
properties:
isSyncAllowed:
type: boolean
description: Defines whether user objects should be synchronized from the partner tenant. false causes any current user synchronization from the source tenant to the target tenant to stop. This property has no impact on existing users who have already been synchronized.
nullable: true
additionalProperties:
type: object
microsoft.graph.templateApplicationLevel:
title: templateApplicationLevel
enum:
- none
- newPartners
- existingPartners
- unknownFutureValue
type: string
x-ms-enum-flags:
isFlags: true
microsoft.graph.appManagementApplicationConfiguration:
allOf:
- $ref: '#/components/schemas/microsoft.graph.appManagementConfiguration'
- title: appManagementApplicationConfiguration
type: object
properties:
identifierUris:
$ref: '#/components/schemas/microsoft.graph.identifierUriConfiguration'
additionalProperties:
type: object
microsoft.graph.appManagementServicePrincipalConfiguration:
allOf:
- $ref: '#/components/schemas/microsoft.graph.appManagementConfiguration'
- title: appManagementServicePrincipalConfiguration
type: object
additionalProperties:
type: object
microsoft.graph.azureADJoinPolicy:
title: azureADJoinPolicy
type: object
properties:
allowedToJoin:
$ref: '#/components/schemas/microsoft.graph.deviceRegistrationMembership'
isAdminConfigurable:
type: boolean
description: Determines if administrators can modify this policy.
nullable: true
localAdmins:
$ref: '#/components/schemas/microsoft.graph.localAdminSettings'
additionalProperties:
type: object
microsoft.graph.azureADRegistrationPolicy:
title: azureADRegistrationPolicy
type: object
properties:
allowedToRegister:
$ref: '#/components/schemas/microsoft.graph.deviceRegistrationMembership'
isAdminConfigurable:
type: boolean
description: Determines if administrators can modify this policy.
nullable: true
additionalProperties:
type: object
microsoft.graph.localAdminPasswordSettings:
title: localAdminPasswordSettings
type: object
properties:
isEnabled:
type: boolean
description: Specifies whether LAPS is enabled. The default value is false. An admin can set it to true to enable Local Admin Password Solution (LAPS) within their organization.
nullable: true
additionalProperties:
type: object
microsoft.graph.multiFactorAuthConfiguration:
title: multiFactorAuthConfiguration
enum:
- notRequired
- required
- unknownFutureValue
type: string
microsoft.graph.stagedFeatureName:
title: stagedFeatureName
enum:
- passthroughAuthentication
- seamlessSso
- passwordHashSync
- emailAsAlternateId
- unknownFutureValue
- certificateBasedAuthentication
- multiFactorAuthentication
type: string
microsoft.graph.validatingDomains:
title: validatingDomains
type: object
properties:
rootDomains:
$ref: '#/components/schemas/microsoft.graph.rootDomains'
additionalProperties:
type: object
microsoft.graph.emailDetails:
title: emailDetails
type: object
properties:
body:
type: string
description: The body content of the notification email in plain text format.
senderEmailAddress:
type: string
description: The email address of the sender for notification emails. Shared mailboxes aren't supported.
subject:
type: string
description: The subject line of the notification email.
additionalProperties:
type: object
microsoft.graph.targetOwners:
title: targetOwners
type: object
properties:
notifyMembers:
$ref: '#/components/schemas/microsoft.graph.notifyMembers'
securityGroups:
type: array
items:
type: string
description: 'The collection of IDs for security groups used for allowing or blocking filtering. When notifyMembers is all, all members are eligible for ownership and this collection can be empty. When notifyMembers is allowSelected, only members in these security groups are eligible. When notifyMembers is blockSelected, members in these security groups are excluded.'
additionalProperties:
type: object
microsoft.graph.permissionType:
title: permissionType
enum:
- delegatedUserConsentable
- delegated
- application
type: string
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.unifiedRoleManagementPolicyRuleTarget:
title: unifiedRoleManagementPolicyRuleTarget
type: object
properties:
caller:
type: string
description: 'The type of caller that''s the target of the policy rule. Allowed values are: None, Admin, EndUser.'
nullable: true
enforcedSettings:
type: array
items:
type: string
nullable: true
description: The list of role settings that are enforced and cannot be overridden by child scopes. Use All for all settings.
inheritableSettings:
type: array
items:
type: string
nullable: true
description: The list of role settings that can be inherited by child scopes. Use All for all settings.
level:
type: string
description: 'The role assignment type that''s the target of policy rule. Allowed values are: Eligibility, Assignment.'
nullable: true
operations:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleManagementPolicyRuleTargetOperations'
description: 'The role management operations that are the target of the policy rule. Allowed values are: All, Activate, Deactivate, Assign, Update, Remove, Extend, Renew.'
targetObjects:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.multiTenantOrganizationState:
title: multiTenantOrganizationState
enum:
- active
- inactive
- unknownFutureValue
type: string
microsoft.graph.multiTenantOrganizationMemberState:
title: multiTenantOrganizationMemberState
enum:
- pending
- active
- removed
- unknownFutureValue
type: string
microsoft.graph.multiTenantOrganizationMemberRole:
title: multiTenantOrganizationMemberRole
enum:
- owner
- member
- unknownFutureValue
type: string
microsoft.graph.multiTenantOrganizationJoinRequestTransitionDetails:
title: multiTenantOrganizationJoinRequestTransitionDetails
type: object
properties:
desiredMemberState:
$ref: '#/components/schemas/microsoft.graph.multiTenantOrganizationMemberState'
details:
type: string
description: Details that explain the processing status if any. Read-only.
nullable: true
status:
$ref: '#/components/schemas/microsoft.graph.multiTenantOrganizationMemberProcessingStatus'
additionalProperties:
type: object
microsoft.graph.multiTenantOrganizationMemberTransitionDetails:
title: multiTenantOrganizationMemberTransitionDetails
type: object
properties:
desiredRole:
$ref: '#/components/schemas/microsoft.graph.multiTenantOrganizationMemberRole'
desiredState:
$ref: '#/components/schemas/microsoft.graph.multiTenantOrganizationMemberState'
details:
type: string
description: Details that explain the processing status if any. Read-only.
nullable: true
status:
$ref: '#/components/schemas/microsoft.graph.multiTenantOrganizationMemberProcessingStatus'
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.webauthnPublicKeyCredentialCreationOptions:
title: webauthnPublicKeyCredentialCreationOptions
type: object
properties:
attestation:
type: string
description: Specifies the relying party's preference for attestation conveyance.
nullable: true
authenticatorSelection:
$ref: '#/components/schemas/microsoft.graph.webauthnAuthenticatorSelectionCriteria'
challenge:
type: string
description: The challenge that the authenticator must sign to prove possession of the credential. This value is Base64URL-encoded without padding.
nullable: true
excludeCredentials:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.webauthnPublicKeyCredentialDescriptor'
description: 'A list of credentials that are already registered for this user, which should be excluded from selection.'
extensions:
$ref: '#/components/schemas/microsoft.graph.webauthnAuthenticationExtensionsClientInputs'
pubKeyCredParams:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.webauthnPublicKeyCredentialParameters'
description: 'The cryptographic parameters that the relying party supports, in order of preference.'
rp:
$ref: '#/components/schemas/microsoft.graph.webauthnPublicKeyCredentialRpEntity'
timeout:
maximum: 2147483647
minimum: -2147483648
type: number
description: 'The time, in milliseconds, that the caller is willing to wait for the operation to complete.'
format: int32
nullable: true
user:
$ref: '#/components/schemas/microsoft.graph.webauthnPublicKeyCredentialUserEntity'
additionalProperties:
type: object
microsoft.graph.alternativeSecurityId:
title: alternativeSecurityId
type: object
properties:
identityProvider:
type: string
description: For internal use only.
nullable: true
key:
type: string
description: For internal use only.
format: base64url
nullable: true
type:
maximum: 2147483647
minimum: -2147483648
type: number
description: For internal use only.
format: int32
nullable: 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
ReferenceCreate:
type: object
properties:
'@odata.id':
type: string
additionalProperties:
type: object
ReferenceUpdate:
type: object
properties:
'@odata.id':
type: string
'@odata.type':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.dataPolicyOperationCollectionResponse:
title: Collection of dataPolicyOperation
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.dataPolicyOperation'
'@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
ODataCountResponse:
type: integer
format: int32
microsoft.graph.identityApiConnectorCollectionResponse:
title: Collection of identityApiConnector
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.identityApiConnector'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.authenticationEventListenerCollectionResponse:
title: Collection of authenticationEventListener
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.authenticationEventListener'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.authenticationEventsFlowCollectionResponse:
title: Collection of authenticationEventsFlow
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.authenticationEventsFlow'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.authenticationConditionApplicationCollectionResponse:
title: Collection of authenticationConditionApplication
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.authenticationConditionApplication'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.identityUserFlowAttributeCollectionResponse:
title: Collection of identityUserFlowAttribute
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.identityUserFlowAttribute'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
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.identityProviderBaseCollectionResponse:
title: Collection of identityProviderBase
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.identityProviderBase'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.externalUsersSelfServiceSignUpEventsFlowCollectionResponse:
title: Collection of externalUsersSelfServiceSignUpEventsFlow
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.externalUsersSelfServiceSignUpEventsFlow'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.b2xIdentityUserFlowCollectionResponse:
title: Collection of b2xIdentityUserFlow
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.b2xIdentityUserFlow'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.identityProviderCollectionResponse:
title: Collection of identityProvider
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.identityProvider'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.userFlowLanguageConfigurationCollectionResponse:
title: Collection of userFlowLanguageConfiguration
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.userFlowLanguageConfiguration'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.userFlowLanguagePageCollectionResponse:
title: Collection of userFlowLanguagePage
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.userFlowLanguagePage'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.identityUserFlowAttributeAssignmentCollectionResponse:
title: Collection of identityUserFlowAttributeAssignment
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.identityUserFlowAttributeAssignment'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.authenticationContextClassReferenceCollectionResponse:
title: Collection of authenticationContextClassReference
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.authenticationContextClassReference'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.authenticationMethodModeDetailCollectionResponse:
title: Collection of authenticationMethodModeDetail
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.authenticationMethodModeDetail'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.authenticationStrengthPolicyCollectionResponse:
title: Collection of authenticationStrengthPolicy
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.authenticationStrengthPolicy'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.authenticationCombinationConfigurationCollectionResponse:
title: Collection of authenticationCombinationConfiguration
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.authenticationCombinationConfiguration'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.namedLocationCollectionResponse:
title: Collection of namedLocation
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.namedLocation'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.conditionalAccessPolicyCollectionResponse:
title: Collection of conditionalAccessPolicy
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.conditionalAccessPolicy'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.conditionalAccessTemplateCollectionResponse:
title: Collection of conditionalAccessTemplate
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.conditionalAccessTemplate'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.customAuthenticationExtensionCollectionResponse:
title: Collection of customAuthenticationExtension
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.customAuthenticationExtension'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.fraudProtectionProviderCollectionResponse:
title: Collection of fraudProtectionProvider
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.fraudProtectionProvider'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.webApplicationFirewallProviderCollectionResponse:
title: Collection of webApplicationFirewallProvider
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.webApplicationFirewallProvider'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.webApplicationFirewallVerificationModelCollectionResponse:
title: Collection of webApplicationFirewallVerificationModel
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.webApplicationFirewallVerificationModel'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.verifiedIdProfileCollectionResponse:
title: Collection of verifiedIdProfile
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.verifiedIdProfile'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.riskDetectionCollectionResponse:
title: Collection of riskDetection
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.riskDetection'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.riskyServicePrincipalCollectionResponse:
title: Collection of riskyServicePrincipal
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.riskyServicePrincipal'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.riskyServicePrincipalHistoryItemCollectionResponse:
title: Collection of riskyServicePrincipalHistoryItem
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.riskyServicePrincipalHistoryItem'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.riskyUserCollectionResponse:
title: Collection of riskyUser
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.riskyUser'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.riskyUserHistoryItemCollectionResponse:
title: Collection of riskyUserHistoryItem
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.riskyUserHistoryItem'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.servicePrincipalRiskDetectionCollectionResponse:
title: Collection of servicePrincipalRiskDetection
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.servicePrincipalRiskDetection'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.bitlockerRecoveryKeyCollectionResponse:
title: Collection of bitlockerRecoveryKey
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.bitlockerRecoveryKey'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.threatAssessmentRequestCollectionResponse:
title: Collection of threatAssessmentRequest
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.threatAssessmentRequest'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.threatAssessmentResultCollectionResponse:
title: Collection of threatAssessmentResult
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.threatAssessmentResult'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.invitationCollectionResponse:
title: Collection of invitation
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.invitation'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.serviceProvisioningErrorCollectionResponse:
title: Collection of microsoft.graph.serviceProvisioningError
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.serviceProvisioningError'
'@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.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.certificateBasedAuthConfigurationCollectionResponse:
title: Collection of certificateBasedAuthConfiguration
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.certificateBasedAuthConfiguration'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.activityBasedTimeoutPolicyCollectionResponse:
title: Collection of activityBasedTimeoutPolicy
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.activityBasedTimeoutPolicy'
'@odata.nextLink':
type: string
nullable: true
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
microsoft.graph.authenticationMethodConfigurationCollectionResponse:
title: Collection of authenticationMethodConfiguration
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.authenticationMethodConfiguration'
'@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.crossTenantAccessPolicyConfigurationPartnerCollectionResponse:
title: Collection of crossTenantAccessPolicyConfigurationPartner
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.crossTenantAccessPolicyConfigurationPartner'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.featureRolloutPolicyCollectionResponse:
title: Collection of featureRolloutPolicy
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.featureRolloutPolicy'
'@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.permissionGrantPolicyCollectionResponse:
title: Collection of permissionGrantPolicy
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.permissionGrantPolicy'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.permissionGrantConditionSetCollectionResponse:
title: Collection of permissionGrantConditionSet
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.permissionGrantConditionSet'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.unifiedRoleManagementPolicyCollectionResponse:
title: Collection of unifiedRoleManagementPolicy
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleManagementPolicy'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.unifiedRoleManagementPolicyRuleCollectionResponse:
title: Collection of unifiedRoleManagementPolicyRule
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleManagementPolicyRule'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.unifiedRoleManagementPolicyAssignmentCollectionResponse:
title: Collection of unifiedRoleManagementPolicyAssignment
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleManagementPolicyAssignment'
'@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.multiTenantOrganizationMemberCollectionResponse:
title: Collection of multiTenantOrganizationMember
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.multiTenantOrganizationMember'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.emailAuthenticationMethodCollectionResponse:
title: Collection of emailAuthenticationMethod
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.emailAuthenticationMethod'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.externalAuthenticationMethodCollectionResponse:
title: Collection of externalAuthenticationMethod
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.externalAuthenticationMethod'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.fido2AuthenticationMethodCollectionResponse:
title: Collection of fido2AuthenticationMethod
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.fido2AuthenticationMethod'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.authenticationMethodCollectionResponse:
title: Collection of authenticationMethod
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.authenticationMethod'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.microsoftAuthenticatorAuthenticationMethodCollectionResponse:
title: Collection of microsoftAuthenticatorAuthenticationMethod
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.microsoftAuthenticatorAuthenticationMethod'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.longRunningOperationCollectionResponse:
title: Collection of longRunningOperation
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.longRunningOperation'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.passwordAuthenticationMethodCollectionResponse:
title: Collection of passwordAuthenticationMethod
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.passwordAuthenticationMethod'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.phoneAuthenticationMethodCollectionResponse:
title: Collection of phoneAuthenticationMethod
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.phoneAuthenticationMethod'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.platformCredentialAuthenticationMethodCollectionResponse:
title: Collection of platformCredentialAuthenticationMethod
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.platformCredentialAuthenticationMethod'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.softwareOathAuthenticationMethodCollectionResponse:
title: Collection of softwareOathAuthenticationMethod
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.softwareOathAuthenticationMethod'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.temporaryAccessPassAuthenticationMethodCollectionResponse:
title: Collection of temporaryAccessPassAuthenticationMethod
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.temporaryAccessPassAuthenticationMethod'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.windowsHelloForBusinessAuthenticationMethodCollectionResponse:
title: Collection of windowsHelloForBusinessAuthenticationMethod
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.windowsHelloForBusinessAuthenticationMethod'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.authenticationAttributeCollectionPageViewConfiguration:
title: authenticationAttributeCollectionPageViewConfiguration
type: object
properties:
description:
type: string
description: The description of the page.
nullable: true
inputs:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.authenticationAttributeCollectionInputConfiguration'
description: 'The display configuration of attributes being collected on the attribute collection page. You must specify all attributes that you want to retain, otherwise they''re removed from the user flow.'
title:
type: string
description: The title of the attribute collection page.
nullable: true
additionalProperties:
type: object
microsoft.graph.userFlowType:
title: userFlowType
enum:
- signUp
- signIn
- signUpOrSignIn
- passwordReset
- profileUpdate
- resourceOwner
- unknownFutureValue
type: string
microsoft.graph.conditionalAccessApplications:
title: conditionalAccessApplications
type: object
properties:
applicationFilter:
$ref: '#/components/schemas/microsoft.graph.conditionalAccessFilter'
excludeApplications:
type: array
items:
type: string
description: 'Can be one of the following: The list of client IDs (appId) explicitly excluded from the policy. Office365 - For the list of apps included in Office365, see Apps included in Conditional Access Office 365 app suite MicrosoftAdminPortals - For more information, see Conditional Access Target resources: Microsoft Admin Portals'
includeApplications:
type: array
items:
type: string
description: 'Can be one of the following: The list of client IDs (appId) the policy applies to, unless explicitly excluded (in excludeApplications) All Office365 - For the list of apps included in Office365, see Apps included in Conditional Access Office 365 app suite MicrosoftAdminPortals - For more information, see Conditional Access Target resources: Microsoft Admin Portals'
includeAuthenticationContextClassReferences:
type: array
items:
type: string
includeUserActions:
type: array
items:
type: string
description: User actions to include. Supported values are urn:user:registersecurityinfo and urn:user:registerdevice
additionalProperties:
type: object
microsoft.graph.conditionalAccessAuthenticationFlows:
title: conditionalAccessAuthenticationFlows
type: object
properties:
transferMethods:
$ref: '#/components/schemas/microsoft.graph.conditionalAccessTransferMethods'
additionalProperties:
type: object
microsoft.graph.conditionalAccessClientApplications:
title: conditionalAccessClientApplications
type: object
properties:
excludeServicePrincipals:
type: array
items:
type: string
description: Service principal IDs excluded from the policy scope.
includeServicePrincipals:
type: array
items:
type: string
description: 'Service principal IDs included in the policy scope, or ServicePrincipalsInMyTenant.'
servicePrincipalFilter:
$ref: '#/components/schemas/microsoft.graph.conditionalAccessFilter'
additionalProperties:
type: object
microsoft.graph.conditionalAccessDevices:
title: conditionalAccessDevices
type: object
properties:
deviceFilter:
$ref: '#/components/schemas/microsoft.graph.conditionalAccessFilter'
additionalProperties:
type: object
microsoft.graph.conditionalAccessInsiderRiskLevels:
title: conditionalAccessInsiderRiskLevels
enum:
- minor
- moderate
- elevated
- unknownFutureValue
type: string
x-ms-enum-flags:
isFlags: true
microsoft.graph.conditionalAccessLocations:
title: conditionalAccessLocations
type: object
properties:
excludeLocations:
type: array
items:
type: string
description: Location IDs excluded from scope of policy.
includeLocations:
type: array
items:
type: string
description: 'Location IDs in scope of policy unless explicitly excluded, All, or AllTrusted.'
additionalProperties:
type: object
microsoft.graph.conditionalAccessPlatforms:
title: conditionalAccessPlatforms
type: object
properties:
excludePlatforms:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.conditionalAccessDevicePlatform'
description: 'The possible values are: android, iOS, windows, windowsPhone, macOS, linux, all, unknownFutureValue.'
includePlatforms:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.conditionalAccessDevicePlatform'
description: 'The possible values are: android, iOS, windows, windowsPhone, macOS, linux, all, unknownFutureValue.'
additionalProperties:
type: object
microsoft.graph.conditionalAccessUsers:
title: conditionalAccessUsers
type: object
properties:
excludeGroups:
type: array
items:
type: string
description: Group IDs excluded from scope of policy.
excludeGuestsOrExternalUsers:
$ref: '#/components/schemas/microsoft.graph.conditionalAccessGuestsOrExternalUsers'
excludeRoles:
type: array
items:
type: string
description: Role IDs excluded from scope of policy.
excludeUsers:
type: array
items:
type: string
description: User IDs excluded from scope of policy and/or GuestsOrExternalUsers.
includeGroups:
type: array
items:
type: string
description: Group IDs in scope of policy unless explicitly excluded.
includeGuestsOrExternalUsers:
$ref: '#/components/schemas/microsoft.graph.conditionalAccessGuestsOrExternalUsers'
includeRoles:
type: array
items:
type: string
description: Role IDs in scope of policy unless explicitly excluded.
includeUsers:
type: array
items:
type: string
description: 'User IDs in scope of policy unless explicitly excluded, None, All, or GuestsOrExternalUsers.'
additionalProperties:
type: object
microsoft.graph.conditionalAccessGrantControl:
title: conditionalAccessGrantControl
enum:
- block
- mfa
- compliantDevice
- domainJoinedDevice
- approvedApplication
- compliantApplication
- passwordChange
- unknownFutureValue
- riskRemediation
type: string
microsoft.graph.applicationEnforcedRestrictionsSessionControl:
allOf:
- $ref: '#/components/schemas/microsoft.graph.conditionalAccessSessionControl'
- title: applicationEnforcedRestrictionsSessionControl
type: object
additionalProperties:
type: object
microsoft.graph.cloudAppSecuritySessionControl:
allOf:
- $ref: '#/components/schemas/microsoft.graph.conditionalAccessSessionControl'
- title: cloudAppSecuritySessionControl
type: object
properties:
cloudAppSecurityType:
$ref: '#/components/schemas/microsoft.graph.cloudAppSecuritySessionControlType'
additionalProperties:
type: object
microsoft.graph.persistentBrowserSessionControl:
allOf:
- $ref: '#/components/schemas/microsoft.graph.conditionalAccessSessionControl'
- title: persistentBrowserSessionControl
type: object
properties:
mode:
$ref: '#/components/schemas/microsoft.graph.persistentBrowserSessionMode'
additionalProperties:
type: object
microsoft.graph.secureSignInSessionControl:
allOf:
- $ref: '#/components/schemas/microsoft.graph.conditionalAccessSessionControl'
- title: secureSignInSessionControl
type: object
additionalProperties:
type: object
microsoft.graph.signInFrequencySessionControl:
allOf:
- $ref: '#/components/schemas/microsoft.graph.conditionalAccessSessionControl'
- title: signInFrequencySessionControl
type: object
properties:
authenticationType:
$ref: '#/components/schemas/microsoft.graph.signInFrequencyAuthenticationType'
frequencyInterval:
$ref: '#/components/schemas/microsoft.graph.signInFrequencyInterval'
type:
$ref: '#/components/schemas/microsoft.graph.signinFrequencyType'
value:
maximum: 2147483647
minimum: -2147483648
type: number
description: The number of days or hours.
format: int32
nullable: true
additionalProperties:
type: object
microsoft.graph.conditionalAccessTransferMethods:
title: conditionalAccessTransferMethods
enum:
- none
- deviceCodeFlow
- authenticationTransfer
- unknownFutureValue
type: string
x-ms-enum-flags:
isFlags: true
microsoft.graph.customExtensionClientConfiguration:
title: customExtensionClientConfiguration
type: object
properties:
maximumRetries:
maximum: 2147483647
minimum: -2147483648
type: number
description: 'The max number of retries that Microsoft Entra ID makes to the external API. Values of 0 or 1 are supported. If null, the default for the service applies.'
format: int32
nullable: true
timeoutInMilliseconds:
maximum: 2147483647
minimum: -2147483648
type: number
description: The max duration in milliseconds that Microsoft Entra ID waits for a response from the external app before it shuts down the connection. The valid range is between 200 and 2000 milliseconds. Default duration is 1000.
format: int32
nullable: true
additionalProperties:
type: object
microsoft.graph.webApplicationFirewallVerificationStatus:
title: webApplicationFirewallVerificationStatus
enum:
- success
- warning
- failure
- unknownFutureValue
type: string
microsoft.graph.webApplicationFirewallDnsConfiguration:
title: webApplicationFirewallDnsConfiguration
type: object
properties:
isDomainVerified:
type: boolean
description: Indicates whether the domain owning this DNS record has been verified by the WAF provider.
isProxied:
type: boolean
description: 'Indicates whether traffic for this DNS record is proxied through the WAF provider''s network (for example, using a CDN or reverse proxy).'
name:
type: string
description: 'The DNS record name (for example, www.contoso.com or contoso.com). This is the host or zone name to which the configuration applies.'
nullable: true
recordType:
$ref: '#/components/schemas/microsoft.graph.webApplicationFirewallDnsRecordType'
value:
type: string
description: The value of the DNS record.
nullable: true
additionalProperties:
type: object
microsoft.graph.claimBinding:
title: claimBinding
type: object
properties:
matchConfidenceLevel:
$ref: '#/components/schemas/microsoft.graph.matchConfidenceLevel'
sourceAttribute:
type: string
description: 'Source attribute name from the source system, for example a directory attribute.'
verifiedIdClaim:
type: string
description: 'Verified ID claim name or path, for example vc.credentialSubject.firstName.'
additionalProperties:
type: object
microsoft.graph.claimBindingSource:
title: claimBindingSource
enum:
- directory
- unknownFutureValue
type: string
microsoft.graph.claimValidation:
title: claimValidation
type: object
properties:
customExtensionId:
type: string
description: The identifier of a custom extension for claim validation.
isEnabled:
type: boolean
description: Indicates whether claim validation is enabled.
additionalProperties:
type: object
microsoft.graph.verifiedIdUsageConfigurationPurpose:
title: verifiedIdUsageConfigurationPurpose
enum:
- recovery
- onboarding
- all
- unknownFutureValue
type: string
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.recipient:
title: recipient
type: object
properties:
emailAddress:
$ref: '#/components/schemas/microsoft.graph.emailAddress'
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.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.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.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.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.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.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.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.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.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.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.authenticationMethodsRegistrationCampaign:
title: authenticationMethodsRegistrationCampaign
type: object
properties:
excludeTargets:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.excludeTarget'
description: Users and groups of users that are excluded from being prompted to set up the authentication method.
includeTargets:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.authenticationMethodsRegistrationCampaignIncludeTarget'
description: Users and groups of users that are prompted to set up the authentication method.
snoozeDurationInDays:
maximum: 2147483647
minimum: -2147483648
type: number
description: 'Specifies the number of days that the user sees a prompt again if they select ''Not now'' and snoozes the prompt. Minimum: 0 days. Maximum: 14 days. If the value is ''0'', the user is prompted during every MFA attempt.'
format: int32
state:
$ref: '#/components/schemas/microsoft.graph.advancedConfigState'
additionalProperties:
type: object
microsoft.graph.authenticationMethodTargetType:
title: authenticationMethodTargetType
enum:
- user
- group
- unknownFutureValue
type: string
microsoft.graph.crossTenantAccessPolicyTargetConfiguration:
title: crossTenantAccessPolicyTargetConfiguration
type: object
properties:
accessType:
$ref: '#/components/schemas/microsoft.graph.crossTenantAccessPolicyTargetConfigurationAccessType'
targets:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.crossTenantAccessPolicyTarget'
description: 'Specifies whether to target users, groups, or applications with this rule.'
additionalProperties:
type: object
microsoft.graph.invitationRedemptionIdentityProviderConfiguration:
title: invitationRedemptionIdentityProviderConfiguration
type: object
properties:
fallbackIdentityProvider:
$ref: '#/components/schemas/microsoft.graph.b2bIdentityProvidersType'
primaryIdentityProviderPrecedenceOrder:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.b2bIdentityProvidersType'
description: 'Collection of identity providers in priority order of preference to be used for guest invitation redemption. The possible values are: azureActiveDirectory, externalFederation, or socialIdentityProviders.'
additionalProperties:
type: object
microsoft.graph.devicesFilter:
title: devicesFilter
type: object
properties:
mode:
$ref: '#/components/schemas/microsoft.graph.crossTenantAccessPolicyTargetConfigurationAccessType'
rule:
type: string
description: 'Defines the rule to filter the devices. For example, device.deviceAttribute2 -eq ''PrivilegedAccessWorkstation''.'
nullable: true
additionalProperties:
type: object
microsoft.graph.identifierUriConfiguration:
title: identifierUriConfiguration
type: object
properties:
nonDefaultUriAddition:
$ref: '#/components/schemas/microsoft.graph.identifierUriRestriction'
uriAdditionWithoutUniqueTenantIdentifier:
$ref: '#/components/schemas/microsoft.graph.identifierUriRestriction'
additionalProperties:
type: object
microsoft.graph.deviceRegistrationMembership:
title: deviceRegistrationMembership
type: object
additionalProperties:
type: object
microsoft.graph.localAdminSettings:
title: localAdminSettings
type: object
properties:
enableGlobalAdmins:
type: boolean
description: Indicates whether global administrators are local administrators on all Microsoft Entra-joined devices. This setting only applies to future registrations. Default is true.
nullable: true
registeringUsers:
$ref: '#/components/schemas/microsoft.graph.deviceRegistrationMembership'
additionalProperties:
type: object
microsoft.graph.rootDomains:
title: rootDomains
enum:
- none
- all
- allFederated
- allManaged
- enumerated
- allManagedAndEnumeratedFederated
- unknownFutureValue
type: string
microsoft.graph.notifyMembers:
title: notifyMembers
enum:
- all
- allowSelected
- blockSelected
- unknownFutureValue
type: string
microsoft.graph.unifiedRoleManagementPolicyRuleTargetOperations:
title: unifiedRoleManagementPolicyRuleTargetOperations
enum:
- all
- activate
- deactivate
- assign
- update
- remove
- extend
- renew
- unknownFutureValue
type: string
microsoft.graph.multiTenantOrganizationMemberProcessingStatus:
title: multiTenantOrganizationMemberProcessingStatus
enum:
- notStarted
- running
- succeeded
- failed
- unknownFutureValue
type: string
microsoft.graph.webauthnAuthenticationExtensionsClientOutputs:
title: webauthnAuthenticationExtensionsClientOutputs
type: object
additionalProperties:
type: object
microsoft.graph.webauthnAuthenticatorAttestationResponse:
title: webauthnAuthenticatorAttestationResponse
type: object
properties:
attestationObject:
type: string
description: A CBOR-encoded attestation object containing the authenticator data and attestation statement. This value is Base64URL-encoded without padding.
nullable: true
clientDataJSON:
type: string
description: Contains the JSON-compatible serialization of client data passed to the authenticator by the client. This value is Base64URL-encoded without padding.
nullable: true
additionalProperties:
type: object
microsoft.graph.webauthnAuthenticatorSelectionCriteria:
title: webauthnAuthenticatorSelectionCriteria
type: object
properties:
authenticatorAttachment:
type: string
description: 'Specifies the preferred attachment modality for the authenticator. Possible values: platform (device-bound authenticator, such as Windows Hello), cross-platform (removable authenticator, such as a USB security key), or null (no preference).'
nullable: true
requireResidentKey:
type: boolean
description: 'Indicates whether the authenticator must create a client-side-resident credential (also known as a discoverable credential). If true, the credential can be used without providing a credential ID.'
nullable: true
userVerification:
type: string
description: 'Specifies the relying party''s preference for user verification during credential creation. Possible values: required, preferred, or discouraged.'
nullable: true
additionalProperties:
type: object
microsoft.graph.webauthnPublicKeyCredentialDescriptor:
title: webauthnPublicKeyCredentialDescriptor
type: object
properties:
id:
type: string
description: The credential ID of the credential being described. This value is Base64URL-encoded without padding.
nullable: true
transports:
type: array
items:
type: string
nullable: true
description: 'A hint about the types of transport that the authenticator supports. Possible values include: usb, nfc, ble, internal.'
type:
type: string
description: 'The type of credential. Currently, the only supported value is public-key.'
nullable: true
additionalProperties:
type: object
microsoft.graph.webauthnAuthenticationExtensionsClientInputs:
title: webauthnAuthenticationExtensionsClientInputs
type: object
additionalProperties:
type: object
microsoft.graph.webauthnPublicKeyCredentialParameters:
title: webauthnPublicKeyCredentialParameters
type: object
properties:
alg:
maximum: 2147483647
minimum: -2147483648
type: number
description: 'A COSE algorithm identifier representing the cryptographic algorithm to use for this credential type. For example, -7 represents ES256.'
format: int32
nullable: true
type:
type: string
description: 'The type of credential to create. Currently, the only supported value is public-key.'
nullable: true
additionalProperties:
type: object
microsoft.graph.webauthnPublicKeyCredentialRpEntity:
title: webauthnPublicKeyCredentialRpEntity
type: object
properties:
id:
type: string
description: 'The relying party identifier. For web applications, this value is typically the domain name.'
nullable: true
name:
type: string
description: The human-readable name for the relying party.
nullable: true
additionalProperties:
type: object
microsoft.graph.webauthnPublicKeyCredentialUserEntity:
title: webauthnPublicKeyCredentialUserEntity
type: object
properties:
displayName:
type: string
description: 'A human-readable name for the user account, intended for display.'
nullable: true
id:
type: string
description: 'A user identifier, determined by the relying party. This value is opaque to the authenticator and is Base64URL-encoded without padding.'
nullable: true
name:
type: string
description: 'A human-readable identifier for the user account, such as a username or email address.'
nullable: 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.authenticationAttributeCollectionInputConfiguration:
title: authenticationAttributeCollectionInputConfiguration
type: object
properties:
attribute:
type: string
description: The built-in or custom attribute for which a value is being collected.
defaultValue:
type: string
description: The default value of the attribute displayed to the end user. The capability to set the default value isn't available through the Microsoft Entra admin center.
nullable: true
editable:
type: boolean
description: Defines whether the attribute is editable by the end user.
nullable: true
hidden:
type: boolean
description: Defines whether the attribute is displayed to the end user. The capability to hide isn't available through the Microsoft Entra admin center.
nullable: true
inputType:
$ref: '#/components/schemas/microsoft.graph.authenticationAttributeCollectionInputType'
label:
type: string
description: 'The label of the attribute field that''s displayed to end user, unless overridden.'
options:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.authenticationAttributeCollectionOptionConfiguration'
description: The option values for certain multiple-option input types.
required:
type: boolean
description: Defines whether the field is required.
nullable: true
validationRegEx:
type: string
description: 'The regex for the value of the field. For more information about the supported regexes, see validationRegEx values for inputType objects. To understand how to specify regexes, see the Regular expressions cheat sheet.'
nullable: true
writeToDirectory:
type: boolean
description: Defines whether Microsoft Entra ID stores the value that it collects.
nullable: true
additionalProperties:
type: object
microsoft.graph.conditionalAccessFilter:
title: conditionalAccessFilter
type: object
properties:
mode:
$ref: '#/components/schemas/microsoft.graph.filterMode'
rule:
type: string
description: 'Rule syntax is similar to that used for membership rules for groups in Microsoft Entra ID. For details, see rules with multiple expressions'
additionalProperties:
type: object
microsoft.graph.conditionalAccessGuestsOrExternalUsers:
title: conditionalAccessGuestsOrExternalUsers
type: object
properties:
externalTenants:
$ref: '#/components/schemas/microsoft.graph.conditionalAccessExternalTenants'
guestOrExternalUserTypes:
$ref: '#/components/schemas/microsoft.graph.conditionalAccessGuestOrExternalUserTypes'
additionalProperties:
type: object
microsoft.graph.conditionalAccessSessionControl:
title: conditionalAccessSessionControl
type: object
properties:
isEnabled:
type: boolean
description: Specifies whether the session control is enabled.
nullable: true
additionalProperties:
type: object
microsoft.graph.cloudAppSecuritySessionControlType:
title: cloudAppSecuritySessionControlType
enum:
- mcasConfigured
- monitorOnly
- blockDownloads
- unknownFutureValue
type: string
microsoft.graph.persistentBrowserSessionMode:
title: persistentBrowserSessionMode
enum:
- always
- never
type: string
microsoft.graph.signInFrequencyAuthenticationType:
title: signInFrequencyAuthenticationType
enum:
- primaryAndSecondaryAuthentication
- secondaryAuthentication
- unknownFutureValue
type: string
microsoft.graph.signInFrequencyInterval:
title: signInFrequencyInterval
enum:
- timeBased
- everyTime
- unknownFutureValue
type: string
microsoft.graph.signinFrequencyType:
title: signinFrequencyType
enum:
- days
- hours
type: string
microsoft.graph.webApplicationFirewallDnsRecordType:
title: webApplicationFirewallDnsRecordType
enum:
- cname
- unknownFutureValue
type: string
microsoft.graph.matchConfidenceLevel:
title: matchConfidenceLevel
enum:
- exact
- relaxed
- unknownFutureValue
type: string
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.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.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.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.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