openapi: 3.1.0 info: title: Microsoft Graph Applications API description: The Microsoft Graph Applications API provides operations to manage application registrations in Microsoft Entra ID (Azure AD). This includes creating, reading, updating, and deleting applications, managing credentials, owners, federated identity credentials, extension properties, and synchronization configurations. version: 1.0.0 contact: name: Microsoft Graph Support url: https://developer.microsoft.com/graph license: name: Microsoft API License url: https://docs.microsoft.com/legal/microsoft-apis/terms-of-use servers: - url: https://graph.microsoft.com/v1.0 description: Microsoft Graph v1.0 endpoint paths: /applications: description: Provides operations to manage the collection of application entities. get: tags: - Applications summary: Microsoft Graph List applications description: Get the list of applications in this organization. operationId: listApplications externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/application-list?view=graph-rest-1.0 parameters: - name: ConsistencyLevel in: header description: 'Indicates the requested consistency level. Documentation URL: https://docs.microsoft.com/graph/aad-advanced-queries' schema: type: string examples: example-1: description: $search and $count queries require the client to set the ConsistencyLevel HTTP header to 'eventual'. value: eventual - $ref: '#/components/parameters/Top' - $ref: '#/components/parameters/Skip' - $ref: '#/components/parameters/Search' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Count' - name: $orderby in: query description: Order items by property values style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities style: form explode: false schema: uniqueItems: true type: array items: type: string responses: 2XX: $ref: '#/components/responses/ApplicationCollectionResponse' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: 2XX x-ms-pageable: nextLinkName: '@odata.nextLink' operationName: listMore x-ms-docs-operation-type: operation post: tags: - Applications summary: Microsoft Graph Create application description: Create a new application object. operationId: createApplications externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/application-post-applications?view=graph-rest-1.0 requestBody: description: New entity content: application/json: schema: $ref: '#/components/schemas/Application' examples: ApplicationRequestExample: $ref: '#/components/examples/ApplicationRequestExample' required: true responses: 2XX: description: Created entity content: application/json: schema: $ref: '#/components/schemas/Application' examples: ApplicationExample: $ref: '#/components/examples/ApplicationExample' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: 2XX x-ms-docs-operation-type: operation /applications/{application-id}: description: Provides operations to manage the collection of application entities. get: tags: - Applications summary: Microsoft Graph Get application description: Get the properties and relationships of an application object. operationId: getApplications externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/application-get?view=graph-rest-1.0 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/Application' examples: ApplicationExample: $ref: '#/components/examples/ApplicationExample' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: 2XX x-ms-docs-operation-type: operation patch: tags: - Applications summary: Microsoft Graph Upsert application description: Create a new application object if it doesn't exist, or update the properties of an existing application object. operationId: updateApplications externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/application-upsert?view=graph-rest-1.0 requestBody: description: New property values content: application/json: schema: $ref: '#/components/schemas/Application' examples: ApplicationRequestExample: $ref: '#/components/examples/ApplicationRequestExample' required: true responses: 2XX: description: Success content: application/json: schema: $ref: '#/components/schemas/Application' examples: ApplicationExample: $ref: '#/components/examples/ApplicationExample' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: 2XX x-ms-docs-operation-type: operation delete: tags: - Applications summary: Microsoft Graph Delete application description: Delete an application object. When deleted, apps are moved to a temporary container and can be restored within 30 days. After that time, they are permanently deleted. operationId: deleteApplications externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/application-delete?view=graph-rest-1.0 parameters: - name: If-Match in: header description: ETag schema: type: string responses: '204': description: Success 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: '204' x-ms-docs-operation-type: operation parameters: - name: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application /applications/{application-id}/appManagementPolicies: description: Provides operations to manage the appManagementPolicies property of the microsoft.graph.application entity. get: tags: - Applications App Management Policies summary: Microsoft Graph Get appManagementPolicies from applications description: The appManagementPolicy applied to this application. operationId: getApplicationsAppManagementPolicies 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/AppManagementPolicyCollectionResponse' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: 2XX x-ms-pageable: nextLinkName: '@odata.nextLink' operationName: listMore x-ms-docs-operation-type: operation parameters: - name: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application /applications/{application-id}/appManagementPolicies/{appManagementPolicy-id}/$ref: description: Provides operations to manage the collection of application entities. delete: tags: - Applications App Management Policies summary: Microsoft Graph Remove appliesTo description: 'Remove an appManagementPolicy policy object from an application or service principal object. When you remove the appManagementPolicy, the application or service principal adopts the tenant-wide tenantAppManagementPolicy setting. ' operationId: deleteApplicationsAppManagementPolicies externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/appmanagementpolicy-delete-appliesto?view=graph-rest-1.0 parameters: - name: If-Match in: header description: ETag schema: type: string responses: '204': description: Success 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: '204' x-ms-docs-operation-type: operation parameters: - name: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application - name: appManagementPolicy-id in: path description: The unique identifier of appManagementPolicy required: true schema: type: string x-ms-docs-key-type: appManagementPolicy /applications/{application-id}/appManagementPolicies/$count: description: Provides operations to count the resources in the collection. get: tags: - Applications App Management Policies summary: Microsoft Graph Get the number of the resource description: Performs GET operation on /applications/{application-id}/appManagementPolicies/$count operationId: countApplicationsAppManagementPolicies parameters: - $ref: '#/components/parameters/Search' - $ref: '#/components/parameters/Filter' responses: 2XX: $ref: '#/components/responses/ODataCountResponse' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: 2XX parameters: - name: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application /applications/{application-id}/appManagementPolicies/$ref: description: Provides operations to manage the collection of application entities. get: tags: - Applications App Management Policies summary: Microsoft Graph Get ref of appManagementPolicies from applications description: The appManagementPolicy applied to this application. operationId: getApplicationsAppManagementPolicies1 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 responses: 2XX: $ref: '#/components/responses/StringCollectionResponse' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: 2XX x-ms-pageable: nextLinkName: '@odata.nextLink' operationName: listMore x-ms-docs-operation-type: operation post: tags: - Applications App Management Policies summary: Microsoft Graph Assign appliesTo description: Assign an appManagementPolicy policy object to an application or service principal object. The application or service principal adopts this policy over the tenant-wide tenantAppManagementPolicy setting. Only one policy object can be assigned to an application or service principal. operationId: createApplicationsAppManagementPolicies externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/appmanagementpolicy-post-appliesto?view=graph-rest-1.0 requestBody: $ref: '#/components/requestBodies/refPostBody' responses: '204': description: Success 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: '204' x-ms-docs-operation-type: operation delete: tags: - Applications App Management Policies summary: Microsoft Graph Remove appliesTo description: 'Remove an appManagementPolicy policy object from an application or service principal object. When you remove the appManagementPolicy, the application or service principal adopts the tenant-wide tenantAppManagementPolicy setting. ' operationId: deleteApplicationsAppManagementPolicies1 externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/appmanagementpolicy-delete-appliesto?view=graph-rest-1.0 parameters: - name: If-Match in: header description: ETag schema: type: string - name: '@id' in: query description: The delete Uri required: true schema: type: string responses: '204': description: Success 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: '204' x-ms-docs-operation-type: operation parameters: - name: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application /applications/{application-id}/createdOnBehalfOf: description: Provides operations to manage the createdOnBehalfOf property of the microsoft.graph.application entity. get: tags: - Applications Created on Behalf Of summary: Microsoft Graph Get createdOnBehalfOf from applications description: Supports $filter (/$count eq 0, /$count ne 0). Read-only. operationId: getApplicationsCreatedOnBehalfOf 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/DirectoryObject' examples: DirectoryObjectExample: $ref: '#/components/examples/DirectoryObjectExample' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: 2XX x-ms-docs-operation-type: operation parameters: - name: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application /applications/{application-id}/extensionProperties: description: Provides operations to manage the extensionProperties property of the microsoft.graph.application entity. get: tags: - Applications Extension Properties summary: Microsoft Graph List extensionProperties (directory extensions) description: Retrieve the list of directory extension definitions, represented by extensionProperty objects on an application. operationId: getApplicationsExtensionProperties externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/application-list-extensionproperty?view=graph-rest-1.0 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/ExtensionPropertyCollectionResponse' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: 2XX x-ms-pageable: nextLinkName: '@odata.nextLink' operationName: listMore x-ms-docs-operation-type: operation post: tags: - Applications Extension Properties summary: Microsoft Graph Create extensionProperty (directory extension) description: Create a new directory extension definition, represented by an extensionProperty object. operationId: createApplicationsExtensionProperties externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/application-post-extensionproperty?view=graph-rest-1.0 requestBody: description: New navigation property content: application/json: schema: $ref: '#/components/schemas/ExtensionProperty' examples: ExtensionPropertyRequestExample: $ref: '#/components/examples/ExtensionPropertyRequestExample' required: true responses: 2XX: description: Created navigation property. content: application/json: schema: $ref: '#/components/schemas/ExtensionProperty' examples: ExtensionPropertyExample: $ref: '#/components/examples/ExtensionPropertyExample' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: 2XX x-ms-docs-operation-type: operation parameters: - name: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application /applications/{application-id}/extensionProperties/{extensionProperty-id}: description: Provides operations to manage the extensionProperties property of the microsoft.graph.application entity. get: tags: - Applications Extension Properties summary: Microsoft Graph Get extensionProperty (directory extension) description: Read a directory extension definition represented by an extensionProperty object. operationId: getApplicationsExtensionProperties1 externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/extensionproperty-get?view=graph-rest-1.0 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/ExtensionProperty' examples: ExtensionPropertyExample: $ref: '#/components/examples/ExtensionPropertyExample' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: 2XX x-ms-docs-operation-type: operation patch: tags: - Applications Extension Properties summary: Microsoft Graph Update Extension Properties description: Performs PATCH operation on /applications/{application-id}/extensionProperties/{extensionProperty-id} operationId: updateApplicationsExtensionProperties requestBody: description: New navigation property values content: application/json: schema: $ref: '#/components/schemas/ExtensionProperty' examples: ExtensionPropertyRequestExample: $ref: '#/components/examples/ExtensionPropertyRequestExample' required: true responses: 2XX: description: Success content: application/json: schema: $ref: '#/components/schemas/ExtensionProperty' examples: ExtensionPropertyExample: $ref: '#/components/examples/ExtensionPropertyExample' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: 2XX x-ms-docs-operation-type: operation delete: tags: - Applications Extension Properties summary: Microsoft Graph Delete extensionProperty (directory extension) description: Delete a directory extension definition represented by an extensionProperty object. You can delete only directory extensions that aren't synced from on-premises active directory (AD). operationId: deleteApplicationsExtensionProperties externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/extensionproperty-delete?view=graph-rest-1.0 parameters: - name: If-Match in: header description: ETag schema: type: string responses: '204': description: Success 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: '204' x-ms-docs-operation-type: operation parameters: - name: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application - name: extensionProperty-id in: path description: The unique identifier of extensionProperty required: true schema: type: string x-ms-docs-key-type: extensionProperty /applications/{application-id}/extensionProperties/$count: description: Provides operations to count the resources in the collection. get: tags: - Applications Extension Properties summary: Microsoft Graph Get the number of the resource description: Performs GET operation on /applications/{application-id}/extensionProperties/$count operationId: countApplicationsExtensionProperties parameters: - $ref: '#/components/parameters/Search' - $ref: '#/components/parameters/Filter' responses: 2XX: $ref: '#/components/responses/ODataCountResponse' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: 2XX parameters: - name: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application /applications/{application-id}/federatedIdentityCredentials: description: Provides operations to manage the federatedIdentityCredentials property of the microsoft.graph.application entity. get: tags: - Applications Federated Identity Credentials summary: Microsoft Graph List federatedIdentityCredential objects description: Get a list of the federatedIdentityCredential objects and their properties assigned to an application. operationId: getApplicationsFederatedIdentityCredentials externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/federatedidentitycredential-list?view=graph-rest-1.0 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/FederatedIdentityCredentialCollectionResponse' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: 2XX x-ms-pageable: nextLinkName: '@odata.nextLink' operationName: listMore x-ms-docs-operation-type: operation post: tags: - Applications Federated Identity Credentials summary: Microsoft Graph Create federatedIdentityCredential description: Create a new federatedIdentityCredential object for an application. By configuring a trust relationship between your Microsoft Entra application registration and the identity provider for your compute platform, you can use tokens issued by that platform to authenticate with Microsoft identity platform and call APIs in the Microsoft ecosystem. Maximum of 20 objects can be added to an application. operationId: createApplicationsFederatedIdentityCredentials externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/federatedidentitycredential-post?view=graph-rest-1.0 requestBody: description: New navigation property content: application/json: schema: $ref: '#/components/schemas/FederatedIdentityCredential' examples: FederatedIdentityCredentialRequestExample: $ref: '#/components/examples/FederatedIdentityCredentialRequestExample' required: true responses: 2XX: description: Created navigation property. content: application/json: schema: $ref: '#/components/schemas/FederatedIdentityCredential' examples: FederatedIdentityCredentialExample: $ref: '#/components/examples/FederatedIdentityCredentialExample' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: 2XX x-ms-docs-operation-type: operation parameters: - name: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application /applications/{application-id}/federatedIdentityCredentials/{federatedIdentityCredential-id}: description: Provides operations to manage the federatedIdentityCredentials property of the microsoft.graph.application entity. get: tags: - Applications Federated Identity Credentials summary: Microsoft Graph Get federatedIdentityCredential description: Read the properties and relationships of a federatedIdentityCredential object assigned to an application. operationId: getApplicationsFederatedIdentityCredentials1 externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/federatedidentitycredential-get?view=graph-rest-1.0 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/FederatedIdentityCredential' examples: FederatedIdentityCredentialExample: $ref: '#/components/examples/FederatedIdentityCredentialExample' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: 2XX x-ms-docs-operation-type: operation patch: tags: - Applications Federated Identity Credentials summary: Microsoft Graph Upsert federatedIdentityCredential description: Create a new federatedIdentityCredential object for an application if it doesn't exist, or update the properties of an existing federatedIdentityCredential object. By configuring a trust relationship between your Microsoft Entra application registration and the identity provider for your compute platform, you can use tokens issued by that platform to authenticate with Microsoft identity platform and call APIs in the Microsoft ecosystem. Maximum of 20 objects can be added to an application. operationId: updateApplicationsFederatedIdentityCredentials externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/federatedidentitycredential-upsert?view=graph-rest-1.0 requestBody: description: New navigation property values content: application/json: schema: $ref: '#/components/schemas/FederatedIdentityCredential' examples: FederatedIdentityCredentialRequestExample: $ref: '#/components/examples/FederatedIdentityCredentialRequestExample' required: true responses: 2XX: description: Success content: application/json: schema: $ref: '#/components/schemas/FederatedIdentityCredential' examples: FederatedIdentityCredentialExample: $ref: '#/components/examples/FederatedIdentityCredentialExample' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: 2XX x-ms-docs-operation-type: operation delete: tags: - Applications Federated Identity Credentials summary: Microsoft Graph Delete federatedIdentityCredential description: Delete a federatedIdentityCredential object from an application. operationId: deleteApplicationsFederatedIdentityCredentials externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/federatedidentitycredential-delete?view=graph-rest-1.0 parameters: - name: If-Match in: header description: ETag schema: type: string responses: '204': description: Success 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: '204' x-ms-docs-operation-type: operation parameters: - name: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application - name: federatedIdentityCredential-id in: path description: The unique identifier of federatedIdentityCredential required: true schema: type: string x-ms-docs-key-type: federatedIdentityCredential /applications/{application-id}/federatedIdentityCredentials(name='{name}'): description: Provides operations to manage the federatedIdentityCredentials property of the microsoft.graph.application entity. get: tags: - Applications Federated Identity Credentials(name='{name}') summary: Microsoft Graph Get federatedIdentityCredential description: Read the properties and relationships of a federatedIdentityCredential object assigned to an application. operationId: getApplicationsFederatedIdentityCredentials(name='{name}') externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/federatedidentitycredential-get?view=graph-rest-1.0 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/FederatedIdentityCredential' examples: FederatedIdentityCredentialExample: $ref: '#/components/examples/FederatedIdentityCredentialExample' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: 2XX x-ms-docs-operation-type: operation patch: tags: - Applications Federated Identity Credentials(name='{name}') summary: Microsoft Graph Upsert federatedIdentityCredential description: Create a new federatedIdentityCredential object for an application if it doesn't exist, or update the properties of an existing federatedIdentityCredential object. By configuring a trust relationship between your Microsoft Entra application registration and the identity provider for your compute platform, you can use tokens issued by that platform to authenticate with Microsoft identity platform and call APIs in the Microsoft ecosystem. Maximum of 20 objects can be added to an application. operationId: updateApplicationsFederatedIdentityCredentials(name='{name}') externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/federatedidentitycredential-upsert?view=graph-rest-1.0 requestBody: description: New navigation property values content: application/json: schema: $ref: '#/components/schemas/FederatedIdentityCredential' examples: FederatedIdentityCredentialRequestExample: $ref: '#/components/examples/FederatedIdentityCredentialRequestExample' required: true responses: 2XX: description: Success content: application/json: schema: $ref: '#/components/schemas/FederatedIdentityCredential' examples: FederatedIdentityCredentialExample: $ref: '#/components/examples/FederatedIdentityCredentialExample' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: 2XX x-ms-docs-operation-type: operation delete: tags: - Applications Federated Identity Credentials(name='{name}') summary: Microsoft Graph Delete federatedIdentityCredential description: Delete a federatedIdentityCredential object from an application. operationId: deleteApplicationsFederatedIdentityCredentials(name='{name}') externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/federatedidentitycredential-delete?view=graph-rest-1.0 parameters: - name: If-Match in: header description: ETag schema: type: string responses: '204': description: Success 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: '204' x-ms-docs-operation-type: operation parameters: - name: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application - name: name in: path description: Alternate key of federatedIdentityCredential required: true schema: type: string /applications/{application-id}/federatedIdentityCredentials/$count: description: Provides operations to count the resources in the collection. get: tags: - Applications Federated Identity Credentials summary: Microsoft Graph Get the number of the resource description: Performs GET operation on /applications/{application-id}/federatedIdentityCredentials/$count operationId: countApplicationsFederatedIdentityCredentials parameters: - $ref: '#/components/parameters/Search' - $ref: '#/components/parameters/Filter' responses: 2XX: $ref: '#/components/responses/ODataCountResponse' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: 2XX parameters: - name: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application /applications/{application-id}/homeRealmDiscoveryPolicies: description: Provides operations to manage the homeRealmDiscoveryPolicies property of the microsoft.graph.application entity. get: tags: - Applications Home Realm Discovery Policies summary: Microsoft Graph Get homeRealmDiscoveryPolicies from applications description: Performs GET operation on /applications/{application-id}/homeRealmDiscoveryPolicies operationId: getApplicationsHomeRealmDiscoveryPolicies 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/HomeRealmDiscoveryPolicyCollectionResponse' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: 2XX x-ms-pageable: nextLinkName: '@odata.nextLink' operationName: listMore x-ms-docs-operation-type: operation parameters: - name: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application /applications/{application-id}/homeRealmDiscoveryPolicies/{homeRealmDiscoveryPolicy-id}: description: Provides operations to manage the homeRealmDiscoveryPolicies property of the microsoft.graph.application entity. get: tags: - Applications Home Realm Discovery Policies summary: Microsoft Graph Get homeRealmDiscoveryPolicies from applications description: Performs GET operation on /applications/{application-id}/homeRealmDiscoveryPolicies/{homeRealmDiscoveryPolicy-id} operationId: getApplicationsHomeRealmDiscoveryPolicies1 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/HomeRealmDiscoveryPolicy' examples: HomeRealmDiscoveryPolicyExample: $ref: '#/components/examples/HomeRealmDiscoveryPolicyExample' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: 2XX x-ms-docs-operation-type: operation parameters: - name: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application - name: homeRealmDiscoveryPolicy-id in: path description: The unique identifier of homeRealmDiscoveryPolicy required: true schema: type: string x-ms-docs-key-type: homeRealmDiscoveryPolicy /applications/{application-id}/homeRealmDiscoveryPolicies/$count: description: Provides operations to count the resources in the collection. get: tags: - Applications Home Realm Discovery Policies summary: Microsoft Graph Get the number of the resource description: Performs GET operation on /applications/{application-id}/homeRealmDiscoveryPolicies/$count operationId: countApplicationsHomeRealmDiscoveryPolicies parameters: - $ref: '#/components/parameters/Search' - $ref: '#/components/parameters/Filter' responses: 2XX: $ref: '#/components/responses/ODataCountResponse' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: 2XX parameters: - name: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application /applications/{application-id}/logo: description: Provides operations to manage the media for the application entity. get: tags: - Applications Logo summary: Microsoft Graph Get logo for application from applications description: The main logo for the application. Not nullable. operationId: getApplicationsLogo responses: 2XX: description: Retrieved media content content: application/octet-stream: schema: type: string format: binary 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: 2XX put: tags: - Applications Logo summary: Microsoft Graph Update logo for application in applications description: The main logo for the application. Not nullable. operationId: replaceApplicationsLogo requestBody: description: New media content. content: application/octet-stream: schema: type: string format: binary required: true responses: 2XX: description: Success 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: 2XX delete: tags: - Applications Logo summary: Microsoft Graph Delete logo for application in applications description: The main logo for the application. Not nullable. operationId: deleteApplicationsLogo parameters: - name: If-Match in: header description: ETag schema: type: string responses: '204': description: Success 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: '204' parameters: - name: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application /applications/{application-id}/addKey: description: Provides operations to call the addKey method. post: tags: - Applications Add Key summary: Microsoft Graph Create Add Key description: Add a key credential to an application. This method, along with removeKey can be used by an application to automate rolling its expiring keys. As part of the request validation for this method, a proof of possession of an existing key is verified before the action can be performed. Applications that don't have any existing valid certificates (no certificates have been added yet, or all certificates have expired), won't be able to use this service action. You can use the Update application operation to perform an update instead. operationId: addKeyApplications externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/application-addkey?view=graph-rest-1.0 requestBody: description: Action parameters content: application/json: schema: type: object properties: keyCredential: $ref: '#/components/schemas/KeyCredential' passwordCredential: anyOf: - $ref: '#/components/schemas/PasswordCredential' - type: object nullable: true proof: type: string examples: addKeyApplicationsRequestExample: $ref: '#/components/examples/addKeyApplicationsRequestExample' required: true responses: 2XX: description: Success content: application/json: schema: $ref: '#/components/schemas/KeyCredential' examples: KeyCredentialExample: $ref: '#/components/examples/KeyCredentialExample' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: 2XX x-ms-docs-operation-type: action parameters: - name: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application /applications/{application-id}/addPassword: description: Provides operations to call the addPassword method. post: tags: - Applications Add Password summary: Microsoft Graph Create Add Password description: Adds a strong password or secret to an application. You can also add passwords while creating the application. operationId: addPasswordApplications externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/application-addpassword?view=graph-rest-1.0 requestBody: description: Action parameters content: application/json: schema: type: object properties: passwordCredential: anyOf: - $ref: '#/components/schemas/PasswordCredential' - type: object nullable: true examples: addPasswordApplicationsRequestExample: $ref: '#/components/examples/addPasswordApplicationsRequestExample' required: true responses: 2XX: description: Success content: application/json: schema: $ref: '#/components/schemas/PasswordCredential' examples: PasswordCredentialExample: $ref: '#/components/examples/PasswordCredentialExample' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: 2XX x-ms-docs-operation-type: action parameters: - name: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application /applications/{application-id}/checkMemberGroups: description: Provides operations to call the checkMemberGroups method. post: tags: - Applications Check Member Groups summary: Microsoft Graph Create Check Member Groups description: "Check for membership in a specified list of group IDs, and return from that list the IDs of groups where a specified object is a member. The specified object can be of one of the following types:\r\n- user\r\n- group\r\n- service principal\r\n- organizational contact\r\n- device\r\n- directory object This function is transitive. You can check up to a maximum of 20 groups per request. This function supports all groups provisioned in Microsoft Entra ID. Because Microsoft 365 groups cannot contain other groups, membership in a Microsoft 365 group is always direct." operationId: checkMemberGroupsApplications externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/directoryobject-checkmembergroups?view=graph-rest-1.0 requestBody: description: Action parameters content: application/json: schema: type: object properties: groupIds: type: array items: type: string examples: checkMemberGroupsApplicationsRequestExample: $ref: '#/components/examples/checkMemberGroupsApplicationsRequestExample' required: true responses: 2XX: description: Success content: application/json: schema: type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: type: string 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: 2XX x-ms-docs-operation-type: action x-ms-pageable: nextLinkName: '@odata.nextLink' operationName: listMore parameters: - name: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application /applications/{application-id}/checkMemberObjects: description: Provides operations to call the checkMemberObjects method. post: tags: - Applications Check Member Objects summary: Microsoft Graph Create Check Member Objects description: Performs POST operation on /applications/{application-id}/checkMemberObjects operationId: checkMemberObjectsApplications requestBody: description: Action parameters content: application/json: schema: type: object properties: ids: type: array items: type: string examples: checkMemberObjectsApplicationsRequestExample: $ref: '#/components/examples/checkMemberObjectsApplicationsRequestExample' required: true responses: 2XX: description: Success content: application/json: schema: type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: type: string 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: 2XX x-ms-docs-operation-type: action x-ms-pageable: nextLinkName: '@odata.nextLink' operationName: listMore parameters: - name: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application /applications/{application-id}/getMemberGroups: description: Provides operations to call the getMemberGroups method. post: tags: - Applications Get Member Groups summary: Microsoft Graph Create Get Member Groups description: Return all the group IDs for the groups that the specified user, group, service principal, organizational contact, device, or directory object is a member of. This function is transitive. This API returns up to 11,000 group IDs. If more than 11,000 results are available, it returns a 400 Bad Request error with the DirectoryResultSizeLimitExceeded error code. If you get the DirectoryResultSizeLimitExceeded error code, use the List group transitive memberOf API instead. operationId: getMemberGroupsApplications externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/directoryobject-getmembergroups?view=graph-rest-1.0 requestBody: description: Action parameters content: application/json: schema: type: object properties: securityEnabledOnly: type: boolean default: false nullable: true examples: getMemberGroupsApplicationsRequestExample: $ref: '#/components/examples/getMemberGroupsApplicationsRequestExample' required: true responses: 2XX: description: Success content: application/json: schema: type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: type: string 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: 2XX x-ms-docs-operation-type: action x-ms-pageable: nextLinkName: '@odata.nextLink' operationName: listMore parameters: - name: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application /applications/{application-id}/getMemberObjects: description: Provides operations to call the getMemberObjects method. post: tags: - Applications Get Member Objects summary: Microsoft Graph Create Get Member Objects description: "Return all IDs for the groups, administrative units, and directory roles that an object of one of the following types is a member of:\r\n- user\r\n- group\r\n- service principal\r\n- organizational contact\r\n- device\r\n- directory object This function is transitive. Only users and role-enabled groups can be members of directory roles." operationId: getMemberObjectsApplications externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/directoryobject-getmemberobjects?view=graph-rest-1.0 requestBody: description: Action parameters content: application/json: schema: type: object properties: securityEnabledOnly: type: boolean default: false nullable: true examples: getMemberObjectsApplicationsRequestExample: $ref: '#/components/examples/getMemberObjectsApplicationsRequestExample' required: true responses: 2XX: description: Success content: application/json: schema: type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: type: string 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: 2XX x-ms-docs-operation-type: action x-ms-pageable: nextLinkName: '@odata.nextLink' operationName: listMore parameters: - name: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application /applications/{application-id}/removeKey: description: Provides operations to call the removeKey method. post: tags: - Applications Remove Key summary: Microsoft Graph Create Remove Key description: Remove a key credential from an application. This method along with addKey can be used by an application to automate rolling its expiring keys. As part of the request validation for this method, a proof of possession of an existing key is verified before the action can be performed. operationId: removeKeyApplications externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/application-removekey?view=graph-rest-1.0 requestBody: description: Action parameters content: application/json: schema: type: object properties: keyId: pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string format: uuid proof: type: string examples: removeKeyApplicationsRequestExample: $ref: '#/components/examples/removeKeyApplicationsRequestExample' required: true responses: '204': description: Success 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: '204' x-ms-docs-operation-type: action parameters: - name: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application /applications/{application-id}/removePassword: description: Provides operations to call the removePassword method. post: tags: - Applications Remove Password summary: Microsoft Graph Create Remove Password description: Remove a password from an application. operationId: removePasswordApplications externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/application-removepassword?view=graph-rest-1.0 requestBody: description: Action parameters content: application/json: schema: type: object properties: keyId: pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string format: uuid examples: removePasswordApplicationsRequestExample: $ref: '#/components/examples/removePasswordApplicationsRequestExample' required: true responses: '204': description: Success 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: '204' x-ms-docs-operation-type: action parameters: - name: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application /applications/{application-id}/restore: description: Provides operations to call the restore method. post: tags: - Applications Restore summary: Microsoft Graph Create Restore description: "Restore a recently deleted application, group, servicePrincipal, administrative unit, or user object from deleted items. Restore a recently deleted directory object from deleted items. The following types are supported:\r\n- administrativeUnit\r\n- application\r\n- certificateBasedAuthPki\r\n- certificateAuthorityDetail\r\n- group\r\n- servicePrincipal\r\n- user If an item is accidentally deleted, you can fully restore the item. Additionally, restoring an application doesn't automatically restore the associated service principal automatically. You must call this API to explicitly restore the deleted service principal. A recently deleted item remains available for up to 30 days. After 30 days, the item is permanently deleted." operationId: restoreApplications externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/directory-deleteditems-restore?view=graph-rest-1.0 responses: 2XX: description: Success content: application/json: schema: anyOf: - $ref: '#/components/schemas/DirectoryObject' - type: object nullable: true examples: DirectoryObjectExample: $ref: '#/components/examples/DirectoryObjectExample' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: 2XX x-ms-docs-operation-type: action parameters: - name: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application /applications/{application-id}/setVerifiedPublisher: description: Provides operations to call the setVerifiedPublisher method. post: tags: - Applications Set Verified Publisher summary: Microsoft Graph Create Set Verified Publisher description: Set the verifiedPublisher on an application. For more information, including prerequisites to setting a verified publisher, see Publisher verification. operationId: setVerifiedPublisherApplications externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/application-setverifiedpublisher?view=graph-rest-1.0 requestBody: description: Action parameters content: application/json: schema: type: object properties: verifiedPublisherId: type: string examples: setVerifiedPublisherApplicationsRequestExample: $ref: '#/components/examples/setVerifiedPublisherApplicationsRequestExample' required: true responses: '204': description: Success 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: '204' x-ms-docs-operation-type: action parameters: - name: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application /applications/{application-id}/unsetVerifiedPublisher: description: Provides operations to call the unsetVerifiedPublisher method. post: tags: - Applications Unset Verified Publisher summary: Microsoft Graph Create Unset Verified Publisher description: Unset the verifiedPublisher previously set on an application, removing all verified publisher properties. For more information, see Publisher verification. operationId: unsetVerifiedPublisherApplications externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/application-unsetverifiedpublisher?view=graph-rest-1.0 responses: '204': description: Success 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: '204' x-ms-docs-operation-type: action parameters: - name: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application /applications/{application-id}/owners: description: Provides operations to manage the owners property of the microsoft.graph.application entity. get: tags: - Applications Owners summary: Microsoft Graph List owners of an application description: Retrieve a list of owners for an application that are directoryObject types. operationId: getApplicationsOwners externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/application-list-owners?view=graph-rest-1.0 parameters: - name: ConsistencyLevel in: header description: 'Indicates the requested consistency level. Documentation URL: https://docs.microsoft.com/graph/aad-advanced-queries' schema: type: string examples: example-1: description: $search and $count queries require the client to set the ConsistencyLevel HTTP header to 'eventual'. value: eventual - $ref: '#/components/parameters/Top' - $ref: '#/components/parameters/Skip' - $ref: '#/components/parameters/Search' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Count' - name: $orderby in: query description: Order items by property values style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities style: form explode: false schema: uniqueItems: true type: array items: type: string responses: 2XX: $ref: '#/components/responses/DirectoryObjectCollectionResponse' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: 2XX x-ms-pageable: nextLinkName: '@odata.nextLink' operationName: listMore x-ms-docs-operation-type: operation parameters: - name: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application /applications/{application-id}/owners/{directoryObject-id}/$ref: description: Provides operations to manage the collection of application entities. delete: tags: - Applications Owners summary: Microsoft Graph Remove application owner description: Remove an owner from an application. As a recommended best practice, apps should have at least two owners. operationId: deleteApplicationsOwners externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/application-delete-owners?view=graph-rest-1.0 parameters: - name: If-Match in: header description: ETag schema: type: string responses: '204': description: Success 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: '204' x-ms-docs-operation-type: operation parameters: - name: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application - name: directoryObject-id in: path description: The unique identifier of directoryObject required: true schema: type: string x-ms-docs-key-type: directoryObject /applications/{application-id}/owners/{directoryObject-id}/graph.appRoleAssignment: description: Casts the previous resource to appRoleAssignment. get: tags: - Applications Owners summary: Microsoft Graph Get the item of type microsoft.graph.directoryObject as microsoft.graph.appRoleAssignment description: Performs GET operation on /applications/{application-id}/owners/{directoryObject-id}/graph.appRoleAssignment operationId: getApplicationsOwnersGraphAppRoleAssignment parameters: - name: ConsistencyLevel in: header description: 'Indicates the requested consistency level. Documentation URL: https://docs.microsoft.com/graph/aad-advanced-queries' schema: type: string examples: example-1: description: $search and $count queries require the client to set the ConsistencyLevel HTTP header to 'eventual'. value: eventual - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities style: form explode: false schema: uniqueItems: true type: array items: type: string responses: 2XX: description: Entity result. content: application/json: schema: $ref: '#/components/schemas/AppRoleAssignment' examples: AppRoleAssignmentExample: $ref: '#/components/examples/AppRoleAssignmentExample' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: 2XX parameters: - name: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application - name: directoryObject-id in: path description: The unique identifier of directoryObject required: true schema: type: string x-ms-docs-key-type: directoryObject /applications/{application-id}/owners/{directoryObject-id}/graph.endpoint: description: Casts the previous resource to endpoint. get: tags: - Applications Owners summary: Microsoft Graph Get the item of type microsoft.graph.directoryObject as microsoft.graph.endpoint description: Performs GET operation on /applications/{application-id}/owners/{directoryObject-id}/graph.endpoint operationId: getApplicationsOwnersGraphEndpoint parameters: - name: ConsistencyLevel in: header description: 'Indicates the requested consistency level. Documentation URL: https://docs.microsoft.com/graph/aad-advanced-queries' schema: type: string examples: example-1: description: $search and $count queries require the client to set the ConsistencyLevel HTTP header to 'eventual'. value: eventual - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities style: form explode: false schema: uniqueItems: true type: array items: type: string responses: 2XX: description: Entity result. content: application/json: schema: $ref: '#/components/schemas/Endpoint' examples: EndpointExample: $ref: '#/components/examples/EndpointExample' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: 2XX parameters: - name: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application - name: directoryObject-id in: path description: The unique identifier of directoryObject required: true schema: type: string x-ms-docs-key-type: directoryObject /applications/{application-id}/owners/{directoryObject-id}/graph.servicePrincipal: description: Casts the previous resource to servicePrincipal. get: tags: - Applications Owners summary: Microsoft Graph Get the item of type microsoft.graph.directoryObject as microsoft.graph.servicePrincipal description: Performs GET operation on /applications/{application-id}/owners/{directoryObject-id}/graph.servicePrincipal operationId: getApplicationsOwnersGraphServicePrincipal parameters: - name: ConsistencyLevel in: header description: 'Indicates the requested consistency level. Documentation URL: https://docs.microsoft.com/graph/aad-advanced-queries' schema: type: string examples: example-1: description: $search and $count queries require the client to set the ConsistencyLevel HTTP header to 'eventual'. value: eventual - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities style: form explode: false schema: uniqueItems: true type: array items: type: string responses: 2XX: description: Entity result. content: application/json: schema: $ref: '#/components/schemas/ServicePrincipal' examples: ServicePrincipalExample: $ref: '#/components/examples/ServicePrincipalExample' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: 2XX parameters: - name: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application - name: directoryObject-id in: path description: The unique identifier of directoryObject required: true schema: type: string x-ms-docs-key-type: directoryObject /applications/{application-id}/owners/{directoryObject-id}/graph.user: description: Casts the previous resource to user. get: tags: - Applications Owners summary: Microsoft Graph Get the item of type microsoft.graph.directoryObject as microsoft.graph.user description: Performs GET operation on /applications/{application-id}/owners/{directoryObject-id}/graph.user operationId: getApplicationsOwnersGraphUser parameters: - name: ConsistencyLevel in: header description: 'Indicates the requested consistency level. Documentation URL: https://docs.microsoft.com/graph/aad-advanced-queries' schema: type: string examples: example-1: description: $search and $count queries require the client to set the ConsistencyLevel HTTP header to 'eventual'. value: eventual - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities style: form explode: false schema: uniqueItems: true type: array items: type: string responses: 2XX: description: Entity result. content: application/json: schema: $ref: '#/components/schemas/User' examples: UserExample: $ref: '#/components/examples/UserExample' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: 2XX parameters: - name: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application - name: directoryObject-id in: path description: The unique identifier of directoryObject required: true schema: type: string x-ms-docs-key-type: directoryObject /applications/{application-id}/owners/$count: description: Provides operations to count the resources in the collection. get: tags: - Applications Owners summary: Microsoft Graph Get the number of the resource description: Performs GET operation on /applications/{application-id}/owners/$count operationId: countApplicationsOwners parameters: - name: ConsistencyLevel in: header description: 'Indicates the requested consistency level. Documentation URL: https://docs.microsoft.com/graph/aad-advanced-queries' schema: type: string examples: example-1: description: $search and $count queries require the client to set the ConsistencyLevel HTTP header to 'eventual'. value: eventual - $ref: '#/components/parameters/Search' - $ref: '#/components/parameters/Filter' responses: 2XX: $ref: '#/components/responses/ODataCountResponse' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: 2XX parameters: - name: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application /applications/{application-id}/owners/$ref: description: Provides operations to manage the collection of application entities. get: tags: - Applications Owners summary: Microsoft Graph List owners of an application description: Retrieve a list of owners for an application that are directoryObject types. operationId: getApplicationsOwners1 externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/application-list-owners?view=graph-rest-1.0 parameters: - name: ConsistencyLevel in: header description: 'Indicates the requested consistency level. Documentation URL: https://docs.microsoft.com/graph/aad-advanced-queries' schema: type: string examples: example-1: description: $search and $count queries require the client to set the ConsistencyLevel HTTP header to 'eventual'. value: eventual - $ref: '#/components/parameters/Top' - $ref: '#/components/parameters/Skip' - $ref: '#/components/parameters/Search' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Count' - name: $orderby in: query description: Order items by property values style: form explode: false schema: uniqueItems: true type: array items: type: string responses: 2XX: $ref: '#/components/responses/StringCollectionResponse' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: 2XX x-ms-pageable: nextLinkName: '@odata.nextLink' operationName: listMore x-ms-docs-operation-type: operation post: tags: - Applications Owners summary: Microsoft Graph Add owner description: Add an owner to an application. Application owners can be individual users, the associated service principal, or another service principal. operationId: createApplicationsOwners externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/application-post-owners?view=graph-rest-1.0 requestBody: $ref: '#/components/requestBodies/refPostBody' responses: '204': description: Success 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: '204' x-ms-docs-operation-type: operation delete: tags: - Applications Owners summary: Microsoft Graph Remove application owner description: Remove an owner from an application. As a recommended best practice, apps should have at least two owners. operationId: deleteApplicationsOwners1 externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/application-delete-owners?view=graph-rest-1.0 parameters: - name: If-Match in: header description: ETag schema: type: string - name: '@id' in: query description: The delete Uri required: true schema: type: string responses: '204': description: Success 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: '204' x-ms-docs-operation-type: operation parameters: - name: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application /applications/{application-id}/owners/graph.appRoleAssignment: description: Casts the previous resource to appRoleAssignment. get: tags: - Applications Owners summary: Microsoft Graph Get the items of type microsoft.graph.appRoleAssignment in the microsoft.graph.directoryObject collection description: Performs GET operation on /applications/{application-id}/owners/graph.appRoleAssignment operationId: getApplicationsOwnersGraphAppRoleAssignment1 parameters: - name: ConsistencyLevel in: header description: 'Indicates the requested consistency level. Documentation URL: https://docs.microsoft.com/graph/aad-advanced-queries' schema: type: string examples: example-1: description: $search and $count queries require the client to set the ConsistencyLevel HTTP header to 'eventual'. value: eventual - $ref: '#/components/parameters/Top' - $ref: '#/components/parameters/Skip' - $ref: '#/components/parameters/Search' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Count' - name: $orderby in: query description: Order items by property values style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities style: form explode: false schema: uniqueItems: true type: array items: type: string responses: 2XX: $ref: '#/components/responses/AppRoleAssignmentCollectionResponse' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: 2XX x-ms-pageable: nextLinkName: '@odata.nextLink' operationName: listMore parameters: - name: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application /applications/{application-id}/owners/graph.appRoleAssignment/$count: description: Provides operations to count the resources in the collection. get: tags: - Applications Owners summary: Microsoft Graph Get the number of the resource description: Performs GET operation on /applications/{application-id}/owners/graph.appRoleAssignment/$count operationId: countApplicationsOwnersGraphAppRoleAssignment parameters: - name: ConsistencyLevel in: header description: 'Indicates the requested consistency level. Documentation URL: https://docs.microsoft.com/graph/aad-advanced-queries' schema: type: string examples: example-1: description: $search and $count queries require the client to set the ConsistencyLevel HTTP header to 'eventual'. value: eventual - $ref: '#/components/parameters/Search' - $ref: '#/components/parameters/Filter' responses: 2XX: $ref: '#/components/responses/ODataCountResponse' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: 2XX parameters: - name: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application /applications/{application-id}/owners/graph.endpoint: description: Casts the previous resource to endpoint. get: tags: - Applications Owners summary: Microsoft Graph Get the items of type microsoft.graph.endpoint in the microsoft.graph.directoryObject collection description: Performs GET operation on /applications/{application-id}/owners/graph.endpoint operationId: getApplicationsOwnersGraphEndpoint1 parameters: - name: ConsistencyLevel in: header description: 'Indicates the requested consistency level. Documentation URL: https://docs.microsoft.com/graph/aad-advanced-queries' schema: type: string examples: example-1: description: $search and $count queries require the client to set the ConsistencyLevel HTTP header to 'eventual'. value: eventual - $ref: '#/components/parameters/Top' - $ref: '#/components/parameters/Skip' - $ref: '#/components/parameters/Search' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Count' - name: $orderby in: query description: Order items by property values style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities style: form explode: false schema: uniqueItems: true type: array items: type: string responses: 2XX: $ref: '#/components/responses/EndpointCollectionResponse' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: 2XX x-ms-pageable: nextLinkName: '@odata.nextLink' operationName: listMore parameters: - name: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application /applications/{application-id}/owners/graph.endpoint/$count: description: Provides operations to count the resources in the collection. get: tags: - Applications Owners summary: Microsoft Graph Get the number of the resource description: Performs GET operation on /applications/{application-id}/owners/graph.endpoint/$count operationId: countApplicationsOwnersGraphEndpoint parameters: - name: ConsistencyLevel in: header description: 'Indicates the requested consistency level. Documentation URL: https://docs.microsoft.com/graph/aad-advanced-queries' schema: type: string examples: example-1: description: $search and $count queries require the client to set the ConsistencyLevel HTTP header to 'eventual'. value: eventual - $ref: '#/components/parameters/Search' - $ref: '#/components/parameters/Filter' responses: 2XX: $ref: '#/components/responses/ODataCountResponse' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: 2XX parameters: - name: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application /applications/{application-id}/owners/graph.servicePrincipal: description: Casts the previous resource to servicePrincipal. get: tags: - Applications Owners summary: Microsoft Graph Get the items of type microsoft.graph.servicePrincipal in the microsoft.graph.directoryObject collection description: Performs GET operation on /applications/{application-id}/owners/graph.servicePrincipal operationId: getApplicationsOwnersGraphServicePrincipal1 parameters: - name: ConsistencyLevel in: header description: 'Indicates the requested consistency level. Documentation URL: https://docs.microsoft.com/graph/aad-advanced-queries' schema: type: string examples: example-1: description: $search and $count queries require the client to set the ConsistencyLevel HTTP header to 'eventual'. value: eventual - $ref: '#/components/parameters/Top' - $ref: '#/components/parameters/Skip' - $ref: '#/components/parameters/Search' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Count' - name: $orderby in: query description: Order items by property values style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities style: form explode: false schema: uniqueItems: true type: array items: type: string responses: 2XX: $ref: '#/components/responses/ServicePrincipalCollectionResponse' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: 2XX x-ms-pageable: nextLinkName: '@odata.nextLink' operationName: listMore parameters: - name: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application /applications/{application-id}/owners/graph.servicePrincipal/$count: description: Provides operations to count the resources in the collection. get: tags: - Applications Owners summary: Microsoft Graph Get the number of the resource description: Performs GET operation on /applications/{application-id}/owners/graph.servicePrincipal/$count operationId: countApplicationsOwnersGraphServicePrincipal parameters: - name: ConsistencyLevel in: header description: 'Indicates the requested consistency level. Documentation URL: https://docs.microsoft.com/graph/aad-advanced-queries' schema: type: string examples: example-1: description: $search and $count queries require the client to set the ConsistencyLevel HTTP header to 'eventual'. value: eventual - $ref: '#/components/parameters/Search' - $ref: '#/components/parameters/Filter' responses: 2XX: $ref: '#/components/responses/ODataCountResponse' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: 2XX parameters: - name: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application /applications/{application-id}/owners/graph.user: description: Casts the previous resource to user. get: tags: - Applications Owners summary: Microsoft Graph Get the items of type microsoft.graph.user in the microsoft.graph.directoryObject collection description: Performs GET operation on /applications/{application-id}/owners/graph.user operationId: getApplicationsOwnersGraphUser1 parameters: - name: ConsistencyLevel in: header description: 'Indicates the requested consistency level. Documentation URL: https://docs.microsoft.com/graph/aad-advanced-queries' schema: type: string examples: example-1: description: $search and $count queries require the client to set the ConsistencyLevel HTTP header to 'eventual'. value: eventual - $ref: '#/components/parameters/Top' - $ref: '#/components/parameters/Skip' - $ref: '#/components/parameters/Search' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Count' - name: $orderby in: query description: Order items by property values style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities style: form explode: false schema: uniqueItems: true type: array items: type: string responses: 2XX: $ref: '#/components/responses/UserCollectionResponse' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: 2XX x-ms-pageable: nextLinkName: '@odata.nextLink' operationName: listMore parameters: - name: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application /applications/{application-id}/owners/graph.user/$count: description: Provides operations to count the resources in the collection. get: tags: - Applications Owners summary: Microsoft Graph Get the number of the resource description: Performs GET operation on /applications/{application-id}/owners/graph.user/$count operationId: countApplicationsOwnersGraphUser parameters: - name: ConsistencyLevel in: header description: 'Indicates the requested consistency level. Documentation URL: https://docs.microsoft.com/graph/aad-advanced-queries' schema: type: string examples: example-1: description: $search and $count queries require the client to set the ConsistencyLevel HTTP header to 'eventual'. value: eventual - $ref: '#/components/parameters/Search' - $ref: '#/components/parameters/Filter' responses: 2XX: $ref: '#/components/responses/ODataCountResponse' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: 2XX parameters: - name: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application /applications/{application-id}/synchronization: description: Provides operations to manage the synchronization property of the microsoft.graph.application entity. get: tags: - Applications Synchronization summary: Microsoft Graph Get synchronization from applications description: Represents the capability for Microsoft Entra identity synchronization through the Microsoft Graph API. operationId: getApplicationsSynchronization 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/Synchronization' examples: SynchronizationExample: $ref: '#/components/examples/SynchronizationExample' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: 2XX x-ms-docs-operation-type: operation put: tags: - Applications Synchronization summary: Microsoft Graph Replace Synchronization description: Performs PUT operation on /applications/{application-id}/synchronization operationId: replaceApplicationsSynchronization requestBody: description: New navigation property values content: application/json: schema: $ref: '#/components/schemas/Synchronization' examples: SynchronizationRequestExample: $ref: '#/components/examples/SynchronizationRequestExample' required: true responses: 2XX: description: Success content: application/json: schema: $ref: '#/components/schemas/Synchronization' examples: SynchronizationExample: $ref: '#/components/examples/SynchronizationExample' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: 2XX x-ms-docs-operation-type: operation delete: tags: - Applications Synchronization summary: Microsoft Graph Delete Synchronization description: Performs DELETE operation on /applications/{application-id}/synchronization operationId: deleteApplicationsSynchronization parameters: - name: If-Match in: header description: ETag schema: type: string responses: '204': description: Success 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: '204' x-ms-docs-operation-type: operation parameters: - name: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application /applications/{application-id}/synchronization/jobs: description: Provides operations to manage the jobs property of the microsoft.graph.synchronization entity. get: tags: - Applications Synchronization summary: Microsoft Graph Get jobs from applications description: Performs synchronization by periodically running in the background, polling for changes in one directory, and pushing them to another directory. operationId: getApplicationsSynchronizationJobs 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/SynchronizationJobCollectionResponse' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: 2XX x-ms-pageable: nextLinkName: '@odata.nextLink' operationName: listMore x-ms-docs-operation-type: operation post: tags: - Applications Synchronization summary: Microsoft Graph Create Jobs description: Performs POST operation on /applications/{application-id}/synchronization/jobs operationId: createApplicationsSynchronizationJobs requestBody: description: New navigation property content: application/json: schema: $ref: '#/components/schemas/SynchronizationJob' examples: SynchronizationJobRequestExample: $ref: '#/components/examples/SynchronizationJobRequestExample' required: true responses: 2XX: description: Created navigation property. content: application/json: schema: $ref: '#/components/schemas/SynchronizationJob' examples: SynchronizationJobExample: $ref: '#/components/examples/SynchronizationJobExample' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: 2XX x-ms-docs-operation-type: operation parameters: - name: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application /applications/{application-id}/synchronization/jobs/{synchronizationJob-id}: description: Provides operations to manage the jobs property of the microsoft.graph.synchronization entity. get: tags: - Applications Synchronization summary: Microsoft Graph Get jobs from applications description: Performs synchronization by periodically running in the background, polling for changes in one directory, and pushing them to another directory. operationId: getApplicationsSynchronizationJobs1 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/SynchronizationJob' examples: SynchronizationJobExample: $ref: '#/components/examples/SynchronizationJobExample' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: 2XX x-ms-docs-operation-type: operation patch: tags: - Applications Synchronization summary: Microsoft Graph Update Jobs description: Performs PATCH operation on /applications/{application-id}/synchronization/jobs/{synchronizationJob-id} operationId: updateApplicationsSynchronizationJobs requestBody: description: New navigation property values content: application/json: schema: $ref: '#/components/schemas/SynchronizationJob' examples: SynchronizationJobRequestExample: $ref: '#/components/examples/SynchronizationJobRequestExample' required: true responses: 2XX: description: Success content: application/json: schema: $ref: '#/components/schemas/SynchronizationJob' examples: SynchronizationJobExample: $ref: '#/components/examples/SynchronizationJobExample' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: 2XX x-ms-docs-operation-type: operation delete: tags: - Applications Synchronization summary: Microsoft Graph Delete Jobs description: Performs DELETE operation on /applications/{application-id}/synchronization/jobs/{synchronizationJob-id} operationId: deleteApplicationsSynchronizationJobs parameters: - name: If-Match in: header description: ETag schema: type: string responses: '204': description: Success 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: '204' x-ms-docs-operation-type: operation parameters: - name: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application - name: synchronizationJob-id in: path description: The unique identifier of synchronizationJob required: true schema: type: string x-ms-docs-key-type: synchronizationJob /applications/{application-id}/synchronization/jobs/{synchronizationJob-id}/bulkUpload: description: Provides operations to manage the bulkUpload property of the microsoft.graph.synchronizationJob entity. get: tags: - Applications Synchronization summary: Microsoft Graph Get bulkUpload from applications description: The bulk upload operation for the job. operationId: getApplicationsSynchronizationJobsBulkUpload 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/BulkUpload' examples: BulkUploadExample: $ref: '#/components/examples/BulkUploadExample' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: 2XX x-ms-docs-operation-type: operation patch: tags: - Applications Synchronization summary: Microsoft Graph Update Bulk Upload description: Performs PATCH operation on /applications/{application-id}/synchronization/jobs/{synchronizationJob-id}/bulkUpload operationId: updateApplicationsSynchronizationJobsBulkUpload requestBody: description: New navigation property values content: application/json: schema: $ref: '#/components/schemas/BulkUpload' examples: BulkUploadRequestExample: $ref: '#/components/examples/BulkUploadRequestExample' required: true responses: 2XX: description: Success content: application/json: schema: $ref: '#/components/schemas/BulkUpload' examples: BulkUploadExample: $ref: '#/components/examples/BulkUploadExample' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: 2XX x-ms-docs-operation-type: operation delete: tags: - Applications Synchronization summary: Microsoft Graph Delete Bulk Upload description: Performs DELETE operation on /applications/{application-id}/synchronization/jobs/{synchronizationJob-id}/bulkUpload operationId: deleteApplicationsSynchronizationJobsBulkUpload parameters: - name: If-Match in: header description: ETag schema: type: string responses: '204': description: Success 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: '204' x-ms-docs-operation-type: operation parameters: - name: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application - name: synchronizationJob-id in: path description: The unique identifier of synchronizationJob required: true schema: type: string x-ms-docs-key-type: synchronizationJob /applications/{application-id}/synchronization/jobs/{synchronizationJob-id}/bulkUpload/$value: description: Provides operations to manage the media for the application entity. get: tags: - Applications Synchronization summary: Microsoft Graph Get Bulk Upload description: The bulk upload operation for the job. operationId: getApplicationsSynchronizationJobsBulkUpload1 responses: 2XX: description: Retrieved media content content: application/octet-stream: schema: type: string format: binary 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: 2XX put: tags: - Applications Synchronization summary: Microsoft Graph Replace Bulk Upload description: The bulk upload operation for the job. operationId: replaceApplicationsSynchronizationJobsBulkUpload requestBody: description: New media content. content: application/octet-stream: schema: type: string format: binary required: true responses: 2XX: description: Success 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: 2XX delete: tags: - Applications Synchronization summary: Microsoft Graph Delete Bulk Upload description: The bulk upload operation for the job. operationId: deleteApplicationsSynchronizationJobsBulkUpload1 parameters: - name: If-Match in: header description: ETag schema: type: string responses: '204': description: Success 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: '204' parameters: - name: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application - name: synchronizationJob-id in: path description: The unique identifier of synchronizationJob required: true schema: type: string x-ms-docs-key-type: synchronizationJob /applications/{application-id}/synchronization/jobs/{synchronizationJob-id}/pause: description: Provides operations to call the pause method. post: tags: - Applications Synchronization summary: Microsoft Graph Create Pause description: Temporarily stop a running synchronization job. All the progress, including job state, is persisted, and the job will continue from where it left off when a start call is made. operationId: pauseApplicationsSynchronizationJobs externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronizationjob-pause?view=graph-rest-1.0 responses: '204': description: Success 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: '204' x-ms-docs-operation-type: action parameters: - name: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application - name: synchronizationJob-id in: path description: The unique identifier of synchronizationJob required: true schema: type: string x-ms-docs-key-type: synchronizationJob /applications/{application-id}/synchronization/jobs/{synchronizationJob-id}/provisionOnDemand: description: Provides operations to call the provisionOnDemand method. post: tags: - Applications Synchronization summary: Microsoft Graph Create Provision On Demand description: Select a user and provision the account on-demand. The rate limit for this API is 5 requests per 10 seconds. operationId: provisionApplicationsSynchronizationJobsProvisionOnDemand externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronizationjob-provisionondemand?view=graph-rest-1.0 requestBody: description: Action parameters content: application/json: schema: type: object properties: parameters: type: array items: $ref: '#/components/schemas/SynchronizationJobApplicationParameters' examples: provisionApplicationsSynchronizationJobsProvisionOnDemandRequestExample: $ref: '#/components/examples/provisionApplicationsSynchronizationJobsProvisionOnDemandRequestExample' required: true responses: 2XX: description: Success content: application/json: schema: $ref: '#/components/schemas/StringKeyStringValuePair' examples: StringKeyStringValuePairExample: $ref: '#/components/examples/StringKeyStringValuePairExample' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: 2XX x-ms-docs-operation-type: action parameters: - name: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application - name: synchronizationJob-id in: path description: The unique identifier of synchronizationJob required: true schema: type: string x-ms-docs-key-type: synchronizationJob /applications/{application-id}/synchronization/jobs/{synchronizationJob-id}/restart: description: Provides operations to call the restart method. post: tags: - Applications Synchronization summary: Microsoft Graph Create Restart description: Restart a stopped synchronization job, forcing it to reprocess all the objects in the directory. Optionally clears existing the synchronization state and previous errors. operationId: restartApplicationsSynchronizationJobs externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronizationjob-restart?view=graph-rest-1.0 requestBody: description: Action parameters content: application/json: schema: type: object properties: criteria: anyOf: - $ref: '#/components/schemas/SynchronizationJobRestartCriteria' - type: object nullable: true examples: restartApplicationsSynchronizationJobsRequestExample: $ref: '#/components/examples/restartApplicationsSynchronizationJobsRequestExample' required: true responses: '204': description: Success 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: '204' x-ms-docs-operation-type: action parameters: - name: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application - name: synchronizationJob-id in: path description: The unique identifier of synchronizationJob required: true schema: type: string x-ms-docs-key-type: synchronizationJob /applications/{application-id}/synchronization/jobs/{synchronizationJob-id}/start: description: Provides operations to call the start method. post: tags: - Applications Synchronization summary: Microsoft Graph Create Start description: 'Start an existing synchronization job. If the job is in a paused state, it continues processing changes from the point where it was paused. If the job is in quarantine, the quarantine status is cleared. Don''t create scripts to call the start job continuously while it''s running because that can cause the service to stop running. Use the start job only when the job is currently paused or in quarantine. ' operationId: startApplicationsSynchronizationJobs externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronizationjob-start?view=graph-rest-1.0 responses: '204': description: Success 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: '204' x-ms-docs-operation-type: action parameters: - name: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application - name: synchronizationJob-id in: path description: The unique identifier of synchronizationJob required: true schema: type: string x-ms-docs-key-type: synchronizationJob /applications/{application-id}/synchronization/jobs/{synchronizationJob-id}/validateCredentials: description: Provides operations to call the validateCredentials method. post: tags: - Applications Synchronization summary: Microsoft Graph Create Validate Credentials description: Validate that the credentials are valid in the tenant. operationId: validateCredentialsApplicationsSynchronizationJobs externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronizationjob-validatecredentials?view=graph-rest-1.0 requestBody: description: Action parameters content: application/json: schema: type: object properties: applicationIdentifier: type: string nullable: true templateId: type: string nullable: true useSavedCredentials: type: boolean default: false nullable: true credentials: type: array items: $ref: '#/components/schemas/SynchronizationSecretKeyStringValuePair' examples: validateCredentialsApplicationsSynchronizationJobsRequestExample: $ref: '#/components/examples/validateCredentialsApplicationsSynchronizationJobsRequestExample' required: true responses: '204': description: Success 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: '204' x-ms-docs-operation-type: action parameters: - name: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application - name: synchronizationJob-id in: path description: The unique identifier of synchronizationJob required: true schema: type: string x-ms-docs-key-type: synchronizationJob /applications/{application-id}/synchronization/jobs/{synchronizationJob-id}/schema: description: Provides operations to manage the schema property of the microsoft.graph.synchronizationJob entity. get: tags: - Applications Synchronization summary: Microsoft Graph Get schema from applications description: The synchronization schema configured for the job. operationId: getApplicationsSynchronizationJobsSchema 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/SynchronizationSchema' examples: SynchronizationSchemaExample: $ref: '#/components/examples/SynchronizationSchemaExample' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: 2XX x-ms-docs-operation-type: operation patch: tags: - Applications Synchronization summary: Microsoft Graph Update Schema description: Performs PATCH operation on /applications/{application-id}/synchronization/jobs/{synchronizationJob-id}/schema operationId: updateApplicationsSynchronizationJobsSchema requestBody: description: New navigation property values content: application/json: schema: $ref: '#/components/schemas/SynchronizationSchema' examples: SynchronizationSchemaRequestExample: $ref: '#/components/examples/SynchronizationSchemaRequestExample' required: true responses: 2XX: description: Success content: application/json: schema: $ref: '#/components/schemas/SynchronizationSchema' examples: SynchronizationSchemaExample: $ref: '#/components/examples/SynchronizationSchemaExample' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: 2XX x-ms-docs-operation-type: operation delete: tags: - Applications Synchronization summary: Microsoft Graph Delete Schema description: Performs DELETE operation on /applications/{application-id}/synchronization/jobs/{synchronizationJob-id}/schema operationId: deleteApplicationsSynchronizationJobsSchema parameters: - name: If-Match in: header description: ETag schema: type: string responses: '204': description: Success 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: '204' x-ms-docs-operation-type: operation parameters: - name: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application - name: synchronizationJob-id in: path description: The unique identifier of synchronizationJob required: true schema: type: string x-ms-docs-key-type: synchronizationJob /applications/{application-id}/synchronization/jobs/{synchronizationJob-id}/schema/directories: description: Provides operations to manage the directories property of the microsoft.graph.synchronizationSchema entity. get: tags: - Applications Synchronization summary: Microsoft Graph Get directories from applications description: Contains the collection of directories and all of their objects. operationId: getApplicationsSynchronizationJobsSchemaDirectories 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/DirectoryDefinitionCollectionResponse' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: 2XX x-ms-pageable: nextLinkName: '@odata.nextLink' operationName: listMore x-ms-docs-operation-type: operation post: tags: - Applications Synchronization summary: Microsoft Graph Create Directories description: Performs POST operation on /applications/{application-id}/synchronization/jobs/{synchronizationJob-id}/schema/directories operationId: createApplicationsSynchronizationJobsSchemaDirectories requestBody: description: New navigation property content: application/json: schema: $ref: '#/components/schemas/DirectoryDefinition' examples: DirectoryDefinitionRequestExample: $ref: '#/components/examples/DirectoryDefinitionRequestExample' required: true responses: 2XX: description: Created navigation property. content: application/json: schema: $ref: '#/components/schemas/DirectoryDefinition' examples: DirectoryDefinitionExample: $ref: '#/components/examples/DirectoryDefinitionExample' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: 2XX x-ms-docs-operation-type: operation parameters: - name: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application - name: synchronizationJob-id in: path description: The unique identifier of synchronizationJob required: true schema: type: string x-ms-docs-key-type: synchronizationJob /applications/{application-id}/synchronization/jobs/{synchronizationJob-id}/schema/directories/{directoryDefinition-id}: description: Provides operations to manage the directories property of the microsoft.graph.synchronizationSchema entity. get: tags: - Applications Synchronization summary: Microsoft Graph Get directories from applications description: Contains the collection of directories and all of their objects. operationId: getApplicationsSynchronizationJobsSchemaDirectories1 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/DirectoryDefinition' examples: DirectoryDefinitionExample: $ref: '#/components/examples/DirectoryDefinitionExample' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: 2XX x-ms-docs-operation-type: operation patch: tags: - Applications Synchronization summary: Microsoft Graph Update Directories description: Performs PATCH operation on /applications/{application-id}/synchronization/jobs/{synchronizationJob-id}/schema/directories/{directoryDefinition-id} operationId: updateApplicationsSynchronizationJobsSchemaDirectories requestBody: description: New navigation property values content: application/json: schema: $ref: '#/components/schemas/DirectoryDefinition' examples: DirectoryDefinitionRequestExample: $ref: '#/components/examples/DirectoryDefinitionRequestExample' required: true responses: 2XX: description: Success content: application/json: schema: $ref: '#/components/schemas/DirectoryDefinition' examples: DirectoryDefinitionExample: $ref: '#/components/examples/DirectoryDefinitionExample' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: 2XX x-ms-docs-operation-type: operation delete: tags: - Applications Synchronization summary: Microsoft Graph Delete Directories description: Performs DELETE operation on /applications/{application-id}/synchronization/jobs/{synchronizationJob-id}/schema/directories/{directoryDefinition-id} operationId: deleteApplicationsSynchronizationJobsSchemaDirectories parameters: - name: If-Match in: header description: ETag schema: type: string responses: '204': description: Success 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: '204' x-ms-docs-operation-type: operation parameters: - name: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application - name: synchronizationJob-id in: path description: The unique identifier of synchronizationJob required: true schema: type: string x-ms-docs-key-type: synchronizationJob - name: directoryDefinition-id in: path description: The unique identifier of directoryDefinition required: true schema: type: string x-ms-docs-key-type: directoryDefinition ? /applications/{application-id}/synchronization/jobs/{synchronizationJob-id}/schema/directories/{directoryDefinition-id}/discover : description: Provides operations to call the discover method. post: tags: - Applications Synchronization summary: Microsoft Graph Create Discover description: 'Discover the latest schema definition for provisioning to an application. ' operationId: createApplicationsSynchronizationJobsSchemaDirectoriesDiscover externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-directorydefinition-discover?view=graph-rest-1.0 responses: 2XX: description: Success content: application/json: schema: anyOf: - $ref: '#/components/schemas/DirectoryDefinition' - type: object nullable: true examples: DirectoryDefinitionExample: $ref: '#/components/examples/DirectoryDefinitionExample' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: 2XX x-ms-docs-operation-type: action parameters: - name: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application - name: synchronizationJob-id in: path description: The unique identifier of synchronizationJob required: true schema: type: string x-ms-docs-key-type: synchronizationJob - name: directoryDefinition-id in: path description: The unique identifier of directoryDefinition required: true schema: type: string x-ms-docs-key-type: directoryDefinition /applications/{application-id}/synchronization/jobs/{synchronizationJob-id}/schema/directories/$count: description: Provides operations to count the resources in the collection. get: tags: - Applications Synchronization summary: Microsoft Graph Get the number of the resource description: Performs GET operation on /applications/{application-id}/synchronization/jobs/{synchronizationJob-id}/schema/directories/$count operationId: countApplicationsSynchronizationJobsSchemaDirectories parameters: - $ref: '#/components/parameters/Search' - $ref: '#/components/parameters/Filter' responses: 2XX: $ref: '#/components/responses/ODataCountResponse' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: 2XX parameters: - name: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application - name: synchronizationJob-id in: path description: The unique identifier of synchronizationJob required: true schema: type: string x-ms-docs-key-type: synchronizationJob /applications/{application-id}/synchronization/jobs/{synchronizationJob-id}/schema/filterOperators(): description: Provides operations to call the filterOperators method. get: tags: - Applications Synchronization summary: Microsoft Graph Get Filter Operators() description: List all operators supported in the scoping filters. operationId: getApplicationsSynchronizationJobsSchemaFilterOperators() externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronizationschema-filteroperators?view=graph-rest-1.0 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 filterOperatorSchema type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/FilterOperatorSchema' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: 2XX x-ms-docs-operation-type: function x-ms-pageable: nextLinkName: '@odata.nextLink' operationName: listMore parameters: - name: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application - name: synchronizationJob-id in: path description: The unique identifier of synchronizationJob required: true schema: type: string x-ms-docs-key-type: synchronizationJob /applications/{application-id}/synchronization/jobs/{synchronizationJob-id}/schema/functions(): description: Provides operations to call the functions method. get: tags: - Applications Synchronization summary: Microsoft Graph Get Functions() description: List all the functions currently supported in the attributeMappingSource. operationId: getApplicationsSynchronizationJobsSchemaFunctions() externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronizationschema-functions?view=graph-rest-1.0 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 attributeMappingFunctionSchema type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/AttributeMappingFunctionSchema' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: 2XX x-ms-docs-operation-type: function x-ms-pageable: nextLinkName: '@odata.nextLink' operationName: listMore parameters: - name: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application - name: synchronizationJob-id in: path description: The unique identifier of synchronizationJob required: true schema: type: string x-ms-docs-key-type: synchronizationJob /applications/{application-id}/synchronization/jobs/{synchronizationJob-id}/schema/parseExpression: description: Provides operations to call the parseExpression method. post: tags: - Applications Synchronization summary: Microsoft Graph Create Parse Expression description: Parse a given string expression into an attributeMappingSource object. For more information about expressions, see Writing Expressions for Attribute Mappings in Microsoft Entra ID. operationId: createApplicationsSynchronizationJobsSchemaParseExpression externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronizationschema-parseexpression?view=graph-rest-1.0 requestBody: description: Action parameters content: application/json: schema: type: object properties: expression: type: string nullable: true testInputObject: anyOf: - $ref: '#/components/schemas/ExpressionInputObject' - type: object nullable: true targetAttributeDefinition: anyOf: - $ref: '#/components/schemas/AttributeDefinition' - type: object nullable: true examples: createApplicationsSynchronizationJobsSchemaParseExpressionRequestExample: $ref: '#/components/examples/createApplicationsSynchronizationJobsSchemaParseExpressionRequestExample' required: true responses: 2XX: description: Success content: application/json: schema: anyOf: - $ref: '#/components/schemas/ParseExpressionResponse' - type: object nullable: true 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: 2XX x-ms-docs-operation-type: action parameters: - name: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application - name: synchronizationJob-id in: path description: The unique identifier of synchronizationJob required: true schema: type: string x-ms-docs-key-type: synchronizationJob /applications/{application-id}/synchronization/jobs/$count: description: Provides operations to count the resources in the collection. get: tags: - Applications Synchronization summary: Microsoft Graph Get the number of the resource description: Performs GET operation on /applications/{application-id}/synchronization/jobs/$count operationId: countApplicationsSynchronizationJobs parameters: - $ref: '#/components/parameters/Search' - $ref: '#/components/parameters/Filter' responses: 2XX: $ref: '#/components/responses/ODataCountResponse' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: 2XX parameters: - name: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application /applications/{application-id}/synchronization/jobs/validateCredentials: description: Provides operations to call the validateCredentials method. post: tags: - Applications Synchronization summary: Microsoft Graph Create Validate Credentials description: Performs POST operation on /applications/{application-id}/synchronization/jobs/validateCredentials operationId: validateCredentialsApplicationsSynchronizationJobs1 requestBody: description: Action parameters content: application/json: schema: type: object properties: applicationIdentifier: type: string nullable: true templateId: type: string nullable: true useSavedCredentials: type: boolean default: false nullable: true credentials: type: array items: $ref: '#/components/schemas/SynchronizationSecretKeyStringValuePair' examples: validateCredentialsApplicationsSynchronizationJobs1RequestExample: $ref: '#/components/examples/validateCredentialsApplicationsSynchronizationJobs1RequestExample' required: true responses: '204': description: Success 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: '204' x-ms-docs-operation-type: action parameters: - name: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application /applications/{application-id}/synchronization/acquireAccessToken: description: Provides operations to call the acquireAccessToken method. post: tags: - Applications Synchronization summary: Microsoft Graph Create Acquire Access Token description: Acquire an OAuth access token to authorize the Microsoft Entra provisioning service to provision users into an application. operationId: acquireAccessTokenApplicationsSynchronization externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronization-acquireaccesstoken?view=graph-rest-1.0 requestBody: description: Action parameters content: application/json: schema: type: object properties: credentials: type: array items: $ref: '#/components/schemas/SynchronizationSecretKeyStringValuePair' examples: acquireAccessTokenApplicationsSynchronizationRequestExample: $ref: '#/components/examples/acquireAccessTokenApplicationsSynchronizationRequestExample' required: true responses: '204': description: Success 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: '204' x-ms-docs-operation-type: action parameters: - name: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application /applications/{application-id}/synchronization/secrets: put: tags: - Applications Synchronization summary: Microsoft Graph Update property secrets value. description: Performs PUT operation on /applications/{application-id}/synchronization/secrets operationId: replaceApplicationsSynchronizationSecrets requestBody: description: New property values content: application/json: schema: type: object properties: value: type: array items: $ref: '#/components/schemas/SynchronizationSecretKeyStringValuePair' examples: replaceApplicationsSynchronizationSecretsRequestExample: $ref: '#/components/examples/replaceApplicationsSynchronizationSecretsRequestExample' required: true responses: 2XX: description: Success content: application/json: schema: type: object properties: value: type: array items: $ref: '#/components/schemas/SynchronizationSecretKeyStringValuePair' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: 2XX parameters: - name: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application /applications/{application-id}/synchronization/secrets/$count: description: Provides operations to count the resources in the collection. get: tags: - Applications Synchronization summary: Microsoft Graph Get the number of the resource description: Performs GET operation on /applications/{application-id}/synchronization/secrets/$count operationId: countApplicationsSynchronizationSecrets parameters: - $ref: '#/components/parameters/Search' - $ref: '#/components/parameters/Filter' responses: 2XX: $ref: '#/components/responses/ODataCountResponse' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: 2XX parameters: - name: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application /applications/{application-id}/synchronization/templates: description: Provides operations to manage the templates property of the microsoft.graph.synchronization entity. get: tags: - Applications Synchronization summary: Microsoft Graph Get templates from applications description: Preconfigured synchronization settings for a particular application. operationId: getApplicationsSynchronizationTemplates 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/SynchronizationTemplateCollectionResponse' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: 2XX x-ms-pageable: nextLinkName: '@odata.nextLink' operationName: listMore x-ms-docs-operation-type: operation post: tags: - Applications Synchronization summary: Microsoft Graph Create Templates description: Performs POST operation on /applications/{application-id}/synchronization/templates operationId: createApplicationsSynchronizationTemplates requestBody: description: New navigation property content: application/json: schema: $ref: '#/components/schemas/SynchronizationTemplate' examples: SynchronizationTemplateRequestExample: $ref: '#/components/examples/SynchronizationTemplateRequestExample' required: true responses: 2XX: description: Created navigation property. content: application/json: schema: $ref: '#/components/schemas/SynchronizationTemplate' examples: SynchronizationTemplateExample: $ref: '#/components/examples/SynchronizationTemplateExample' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: 2XX x-ms-docs-operation-type: operation parameters: - name: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application /applications/{application-id}/synchronization/templates/{synchronizationTemplate-id}: description: Provides operations to manage the templates property of the microsoft.graph.synchronization entity. get: tags: - Applications Synchronization summary: Microsoft Graph Get templates from applications description: Preconfigured synchronization settings for a particular application. operationId: getApplicationsSynchronizationTemplates1 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/SynchronizationTemplate' examples: SynchronizationTemplateExample: $ref: '#/components/examples/SynchronizationTemplateExample' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: 2XX x-ms-docs-operation-type: operation patch: tags: - Applications Synchronization summary: Microsoft Graph Update synchronizationTemplate description: Update (override) the synchronization template associated with a given application. operationId: updateApplicationsSynchronizationTemplates externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronizationtemplate-update?view=graph-rest-1.0 requestBody: description: New navigation property values content: application/json: schema: $ref: '#/components/schemas/SynchronizationTemplate' examples: SynchronizationTemplateRequestExample: $ref: '#/components/examples/SynchronizationTemplateRequestExample' required: true responses: 2XX: description: Success content: application/json: schema: $ref: '#/components/schemas/SynchronizationTemplate' examples: SynchronizationTemplateExample: $ref: '#/components/examples/SynchronizationTemplateExample' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: 2XX x-ms-docs-operation-type: operation delete: tags: - Applications Synchronization summary: Microsoft Graph Delete Templates description: Performs DELETE operation on /applications/{application-id}/synchronization/templates/{synchronizationTemplate-id} operationId: deleteApplicationsSynchronizationTemplates parameters: - name: If-Match in: header description: ETag schema: type: string responses: '204': description: Success 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: '204' x-ms-docs-operation-type: operation parameters: - name: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application - name: synchronizationTemplate-id in: path description: The unique identifier of synchronizationTemplate required: true schema: type: string x-ms-docs-key-type: synchronizationTemplate /applications/{application-id}/synchronization/templates/{synchronizationTemplate-id}/schema: description: Provides operations to manage the schema property of the microsoft.graph.synchronizationTemplate entity. get: tags: - Applications Synchronization summary: Microsoft Graph Get schema from applications description: Default synchronization schema for the jobs based on this template. operationId: getApplicationsSynchronizationTemplatesSchema 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/SynchronizationSchema' examples: SynchronizationSchemaExample: $ref: '#/components/examples/SynchronizationSchemaExample' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: 2XX x-ms-docs-operation-type: operation patch: tags: - Applications Synchronization summary: Microsoft Graph Update Schema description: Performs PATCH operation on /applications/{application-id}/synchronization/templates/{synchronizationTemplate-id}/schema operationId: updateApplicationsSynchronizationTemplatesSchema requestBody: description: New navigation property values content: application/json: schema: $ref: '#/components/schemas/SynchronizationSchema' examples: SynchronizationSchemaRequestExample: $ref: '#/components/examples/SynchronizationSchemaRequestExample' required: true responses: 2XX: description: Success content: application/json: schema: $ref: '#/components/schemas/SynchronizationSchema' examples: SynchronizationSchemaExample: $ref: '#/components/examples/SynchronizationSchemaExample' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: 2XX x-ms-docs-operation-type: operation delete: tags: - Applications Synchronization summary: Microsoft Graph Delete Schema description: Performs DELETE operation on /applications/{application-id}/synchronization/templates/{synchronizationTemplate-id}/schema operationId: deleteApplicationsSynchronizationTemplatesSchema parameters: - name: If-Match in: header description: ETag schema: type: string responses: '204': description: Success 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: '204' x-ms-docs-operation-type: operation parameters: - name: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application - name: synchronizationTemplate-id in: path description: The unique identifier of synchronizationTemplate required: true schema: type: string x-ms-docs-key-type: synchronizationTemplate /applications/{application-id}/synchronization/templates/{synchronizationTemplate-id}/schema/directories: description: Provides operations to manage the directories property of the microsoft.graph.synchronizationSchema entity. get: tags: - Applications Synchronization summary: Microsoft Graph Get directories from applications description: Contains the collection of directories and all of their objects. operationId: getApplicationsSynchronizationTemplatesSchemaDirectories 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/DirectoryDefinitionCollectionResponse' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: 2XX x-ms-pageable: nextLinkName: '@odata.nextLink' operationName: listMore x-ms-docs-operation-type: operation post: tags: - Applications Synchronization summary: Microsoft Graph Create Directories description: Performs POST operation on /applications/{application-id}/synchronization/templates/{synchronizationTemplate-id}/schema/directories operationId: createApplicationsSynchronizationTemplatesSchemaDirectories requestBody: description: New navigation property content: application/json: schema: $ref: '#/components/schemas/DirectoryDefinition' examples: DirectoryDefinitionRequestExample: $ref: '#/components/examples/DirectoryDefinitionRequestExample' required: true responses: 2XX: description: Created navigation property. content: application/json: schema: $ref: '#/components/schemas/DirectoryDefinition' examples: DirectoryDefinitionExample: $ref: '#/components/examples/DirectoryDefinitionExample' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: 2XX x-ms-docs-operation-type: operation parameters: - name: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application - name: synchronizationTemplate-id in: path description: The unique identifier of synchronizationTemplate required: true schema: type: string x-ms-docs-key-type: synchronizationTemplate ? /applications/{application-id}/synchronization/templates/{synchronizationTemplate-id}/schema/directories/{directoryDefinition-id} : description: Provides operations to manage the directories property of the microsoft.graph.synchronizationSchema entity. get: tags: - Applications Synchronization summary: Microsoft Graph Get directories from applications description: Contains the collection of directories and all of their objects. operationId: getApplicationsSynchronizationTemplatesSchemaDirectories1 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/DirectoryDefinition' examples: DirectoryDefinitionExample: $ref: '#/components/examples/DirectoryDefinitionExample' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: 2XX x-ms-docs-operation-type: operation patch: tags: - Applications Synchronization summary: Microsoft Graph Update Directories description: Performs PATCH operation on /applications/{application-id}/synchronization/templates/{synchronizationTemplate-id}/schema/directories/{directoryDefinition-id} operationId: updateApplicationsSynchronizationTemplatesSchemaDirectories requestBody: description: New navigation property values content: application/json: schema: $ref: '#/components/schemas/DirectoryDefinition' examples: DirectoryDefinitionRequestExample: $ref: '#/components/examples/DirectoryDefinitionRequestExample' required: true responses: 2XX: description: Success content: application/json: schema: $ref: '#/components/schemas/DirectoryDefinition' examples: DirectoryDefinitionExample: $ref: '#/components/examples/DirectoryDefinitionExample' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: 2XX x-ms-docs-operation-type: operation delete: tags: - Applications Synchronization summary: Microsoft Graph Delete Directories description: Performs DELETE operation on /applications/{application-id}/synchronization/templates/{synchronizationTemplate-id}/schema/directories/{directoryDefinition-id} operationId: deleteApplicationsSynchronizationTemplatesSchemaDirectories parameters: - name: If-Match in: header description: ETag schema: type: string responses: '204': description: Success 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: '204' x-ms-docs-operation-type: operation parameters: - name: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application - name: synchronizationTemplate-id in: path description: The unique identifier of synchronizationTemplate required: true schema: type: string x-ms-docs-key-type: synchronizationTemplate - name: directoryDefinition-id in: path description: The unique identifier of directoryDefinition required: true schema: type: string x-ms-docs-key-type: directoryDefinition ? /applications/{application-id}/synchronization/templates/{synchronizationTemplate-id}/schema/directories/{directoryDefinition-id}/discover : description: Provides operations to call the discover method. post: tags: - Applications Synchronization summary: Microsoft Graph Create Discover description: 'Discover the latest schema definition for provisioning to an application. ' operationId: createApplicationsSynchronizationTemplatesSchemaDirectoriesDiscover externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-directorydefinition-discover?view=graph-rest-1.0 responses: 2XX: description: Success content: application/json: schema: anyOf: - $ref: '#/components/schemas/DirectoryDefinition' - type: object nullable: true examples: DirectoryDefinitionExample: $ref: '#/components/examples/DirectoryDefinitionExample' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: 2XX x-ms-docs-operation-type: action parameters: - name: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application - name: synchronizationTemplate-id in: path description: The unique identifier of synchronizationTemplate required: true schema: type: string x-ms-docs-key-type: synchronizationTemplate - name: directoryDefinition-id in: path description: The unique identifier of directoryDefinition required: true schema: type: string x-ms-docs-key-type: directoryDefinition /applications/{application-id}/synchronization/templates/{synchronizationTemplate-id}/schema/directories/$count: description: Provides operations to count the resources in the collection. get: tags: - Applications Synchronization summary: Microsoft Graph Get the number of the resource description: Performs GET operation on /applications/{application-id}/synchronization/templates/{synchronizationTemplate-id}/schema/directories/$count operationId: countApplicationsSynchronizationTemplatesSchemaDirectories parameters: - $ref: '#/components/parameters/Search' - $ref: '#/components/parameters/Filter' responses: 2XX: $ref: '#/components/responses/ODataCountResponse' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: 2XX parameters: - name: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application - name: synchronizationTemplate-id in: path description: The unique identifier of synchronizationTemplate required: true schema: type: string x-ms-docs-key-type: synchronizationTemplate /applications/{application-id}/synchronization/templates/{synchronizationTemplate-id}/schema/filterOperators(): description: Provides operations to call the filterOperators method. get: tags: - Applications Synchronization summary: Microsoft Graph Get Filter Operators() description: List all operators supported in the scoping filters. operationId: getApplicationsSynchronizationTemplatesSchemaFilterOperators() externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronizationschema-filteroperators?view=graph-rest-1.0 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 filterOperatorSchema type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/FilterOperatorSchema' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: 2XX x-ms-docs-operation-type: function x-ms-pageable: nextLinkName: '@odata.nextLink' operationName: listMore parameters: - name: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application - name: synchronizationTemplate-id in: path description: The unique identifier of synchronizationTemplate required: true schema: type: string x-ms-docs-key-type: synchronizationTemplate /applications/{application-id}/synchronization/templates/{synchronizationTemplate-id}/schema/functions(): description: Provides operations to call the functions method. get: tags: - Applications Synchronization summary: Microsoft Graph Get Functions() description: List all the functions currently supported in the attributeMappingSource. operationId: getApplicationsSynchronizationTemplatesSchemaFunctions() externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronizationschema-functions?view=graph-rest-1.0 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 attributeMappingFunctionSchema type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/AttributeMappingFunctionSchema' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: 2XX x-ms-docs-operation-type: function x-ms-pageable: nextLinkName: '@odata.nextLink' operationName: listMore parameters: - name: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application - name: synchronizationTemplate-id in: path description: The unique identifier of synchronizationTemplate required: true schema: type: string x-ms-docs-key-type: synchronizationTemplate /applications/{application-id}/synchronization/templates/{synchronizationTemplate-id}/schema/parseExpression: description: Provides operations to call the parseExpression method. post: tags: - Applications Synchronization summary: Microsoft Graph Create Parse Expression description: Parse a given string expression into an attributeMappingSource object. For more information about expressions, see Writing Expressions for Attribute Mappings in Microsoft Entra ID. operationId: createApplicationsSynchronizationTemplatesSchemaParseExpression externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronizationschema-parseexpression?view=graph-rest-1.0 requestBody: description: Action parameters content: application/json: schema: type: object properties: expression: type: string nullable: true testInputObject: anyOf: - $ref: '#/components/schemas/ExpressionInputObject' - type: object nullable: true targetAttributeDefinition: anyOf: - $ref: '#/components/schemas/AttributeDefinition' - type: object nullable: true examples: createApplicationsSynchronizationTemplatesSchemaParseExpressionRequestExample: $ref: '#/components/examples/createApplicationsSynchronizationTemplatesSchemaParseExpressionRequestExample' required: true responses: 2XX: description: Success content: application/json: schema: anyOf: - $ref: '#/components/schemas/ParseExpressionResponse' - type: object nullable: true 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: 2XX x-ms-docs-operation-type: action parameters: - name: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application - name: synchronizationTemplate-id in: path description: The unique identifier of synchronizationTemplate required: true schema: type: string x-ms-docs-key-type: synchronizationTemplate /applications/{application-id}/synchronization/templates/$count: description: Provides operations to count the resources in the collection. get: tags: - Applications Synchronization summary: Microsoft Graph Get the number of the resource description: Performs GET operation on /applications/{application-id}/synchronization/templates/$count operationId: countApplicationsSynchronizationTemplates parameters: - $ref: '#/components/parameters/Search' - $ref: '#/components/parameters/Filter' responses: 2XX: $ref: '#/components/responses/ODataCountResponse' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: 2XX parameters: - name: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application /applications/{application-id}/tokenIssuancePolicies: description: Provides operations to manage the tokenIssuancePolicies property of the microsoft.graph.application entity. get: tags: - Applications Token Issuance Policies summary: Microsoft Graph List assigned tokenIssuancePolicies description: List the tokenIssuancePolicy objects that are assigned to an application. operationId: getApplicationsTokenIssuancePolicies externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/application-list-tokenissuancepolicies?view=graph-rest-1.0 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/TokenIssuancePolicyCollectionResponse' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: 2XX x-ms-pageable: nextLinkName: '@odata.nextLink' operationName: listMore x-ms-docs-operation-type: operation parameters: - name: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application /applications/{application-id}/tokenIssuancePolicies/{tokenIssuancePolicy-id}/$ref: description: Provides operations to manage the collection of application entities. delete: tags: - Applications Token Issuance Policies summary: Microsoft Graph Remove tokenIssuancePolicy description: Remove a tokenIssuancePolicy from an application. operationId: deleteApplicationsTokenIssuancePolicies externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/application-delete-tokenissuancepolicies?view=graph-rest-1.0 parameters: - name: If-Match in: header description: ETag schema: type: string responses: '204': description: Success 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: '204' x-ms-docs-operation-type: operation parameters: - name: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application - name: tokenIssuancePolicy-id in: path description: The unique identifier of tokenIssuancePolicy required: true schema: type: string x-ms-docs-key-type: tokenIssuancePolicy /applications/{application-id}/tokenIssuancePolicies/$count: description: Provides operations to count the resources in the collection. get: tags: - Applications Token Issuance Policies summary: Microsoft Graph Get the number of the resource description: Performs GET operation on /applications/{application-id}/tokenIssuancePolicies/$count operationId: countApplicationsTokenIssuancePolicies parameters: - $ref: '#/components/parameters/Search' - $ref: '#/components/parameters/Filter' responses: 2XX: $ref: '#/components/responses/ODataCountResponse' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: 2XX parameters: - name: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application /applications/{application-id}/tokenIssuancePolicies/$ref: description: Provides operations to manage the collection of application entities. get: tags: - Applications Token Issuance Policies summary: Microsoft Graph List assigned tokenIssuancePolicies description: List the tokenIssuancePolicy objects that are assigned to an application. operationId: getApplicationsTokenIssuancePolicies1 externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/application-list-tokenissuancepolicies?view=graph-rest-1.0 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 responses: 2XX: $ref: '#/components/responses/StringCollectionResponse' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: 2XX x-ms-pageable: nextLinkName: '@odata.nextLink' operationName: listMore x-ms-docs-operation-type: operation post: tags: - Applications Token Issuance Policies summary: Microsoft Graph Assign tokenIssuancePolicy description: Assign a tokenIssuancePolicy to an application. operationId: createApplicationsTokenIssuancePolicies externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/application-post-tokenissuancepolicies?view=graph-rest-1.0 requestBody: $ref: '#/components/requestBodies/refPostBody' responses: '204': description: Success 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: '204' x-ms-docs-operation-type: operation delete: tags: - Applications Token Issuance Policies summary: Microsoft Graph Remove tokenIssuancePolicy description: Remove a tokenIssuancePolicy from an application. operationId: deleteApplicationsTokenIssuancePolicies1 externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/application-delete-tokenissuancepolicies?view=graph-rest-1.0 parameters: - name: If-Match in: header description: ETag schema: type: string - name: '@id' in: query description: The delete Uri required: true schema: type: string responses: '204': description: Success 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: '204' x-ms-docs-operation-type: operation parameters: - name: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application /applications/{application-id}/tokenLifetimePolicies: description: Provides operations to manage the tokenLifetimePolicies property of the microsoft.graph.application entity. get: tags: - Applications Token Lifetime Policies summary: Microsoft Graph List assigned tokenLifetimePolicies description: List the tokenLifetimePolicy objects that are assigned to an application. Only one object is returned in the collection because only one tokenLifetimePolicy can be assigned to an application. operationId: getApplicationsTokenLifetimePolicies externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/application-list-tokenlifetimepolicies?view=graph-rest-1.0 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/TokenLifetimePolicyCollectionResponse' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: 2XX x-ms-pageable: nextLinkName: '@odata.nextLink' operationName: listMore x-ms-docs-operation-type: operation parameters: - name: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application /applications/{application-id}/tokenLifetimePolicies/{tokenLifetimePolicy-id}/$ref: description: Provides operations to manage the collection of application entities. delete: tags: - Applications Token Lifetime Policies summary: Microsoft Graph Remove tokenLifetimePolicy description: Remove a tokenLifetimePolicy from an application. operationId: deleteApplicationsTokenLifetimePolicies externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/application-delete-tokenlifetimepolicies?view=graph-rest-1.0 parameters: - name: If-Match in: header description: ETag schema: type: string responses: '204': description: Success 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: '204' x-ms-docs-operation-type: operation parameters: - name: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application - name: tokenLifetimePolicy-id in: path description: The unique identifier of tokenLifetimePolicy required: true schema: type: string x-ms-docs-key-type: tokenLifetimePolicy /applications/{application-id}/tokenLifetimePolicies/$count: description: Provides operations to count the resources in the collection. get: tags: - Applications Token Lifetime Policies summary: Microsoft Graph Get the number of the resource description: Performs GET operation on /applications/{application-id}/tokenLifetimePolicies/$count operationId: countApplicationsTokenLifetimePolicies parameters: - $ref: '#/components/parameters/Search' - $ref: '#/components/parameters/Filter' responses: 2XX: $ref: '#/components/responses/ODataCountResponse' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: 2XX parameters: - name: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application /applications/{application-id}/tokenLifetimePolicies/$ref: description: Provides operations to manage the collection of application entities. get: tags: - Applications Token Lifetime Policies summary: Microsoft Graph List assigned tokenLifetimePolicies description: List the tokenLifetimePolicy objects that are assigned to an application. Only one object is returned in the collection because only one tokenLifetimePolicy can be assigned to an application. operationId: getApplicationsTokenLifetimePolicies1 externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/application-list-tokenlifetimepolicies?view=graph-rest-1.0 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 responses: 2XX: $ref: '#/components/responses/StringCollectionResponse' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: 2XX x-ms-pageable: nextLinkName: '@odata.nextLink' operationName: listMore x-ms-docs-operation-type: operation post: tags: - Applications Token Lifetime Policies summary: Microsoft Graph Assign tokenLifetimePolicy description: Assign a tokenLifetimePolicy to an application. You can have multiple tokenLifetimePolicy policies in a tenant but can assign only one tokenLifetimePolicy per application. operationId: createApplicationsTokenLifetimePolicies externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/application-post-tokenlifetimepolicies?view=graph-rest-1.0 requestBody: $ref: '#/components/requestBodies/refPostBody' responses: '204': description: Success 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: '204' x-ms-docs-operation-type: operation delete: tags: - Applications Token Lifetime Policies summary: Microsoft Graph Remove tokenLifetimePolicy description: Remove a tokenLifetimePolicy from an application. operationId: deleteApplicationsTokenLifetimePolicies1 externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/application-delete-tokenlifetimepolicies?view=graph-rest-1.0 parameters: - name: If-Match in: header description: ETag schema: type: string - name: '@id' in: query description: The delete Uri required: true schema: type: string responses: '204': description: Success 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: '204' x-ms-docs-operation-type: operation parameters: - name: application-id in: path description: The unique identifier of application required: true schema: type: string x-ms-docs-key-type: application /applications(appId='{appId}'): description: Provides operations to manage the collection of application entities. get: tags: - Applications(app Id='{app Id}') summary: Microsoft Graph Get application description: Get the properties and relationships of an application object. operationId: getApplications(appId='{appId}') externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/application-get?view=graph-rest-1.0 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/Application' examples: ApplicationExample: $ref: '#/components/examples/ApplicationExample' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: 2XX x-ms-docs-operation-type: operation patch: tags: - Applications(app Id='{app Id}') summary: Microsoft Graph Upsert application description: Create a new application object if it doesn't exist, or update the properties of an existing application object. operationId: updateApplications(appId='{appId}') externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/application-upsert?view=graph-rest-1.0 requestBody: description: New property values content: application/json: schema: $ref: '#/components/schemas/Application' examples: ApplicationRequestExample: $ref: '#/components/examples/ApplicationRequestExample' required: true responses: 2XX: description: Success content: application/json: schema: $ref: '#/components/schemas/Application' examples: ApplicationExample: $ref: '#/components/examples/ApplicationExample' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: 2XX x-ms-docs-operation-type: operation delete: tags: - Applications(app Id='{app Id}') summary: Microsoft Graph Delete application description: Delete an application object. When deleted, apps are moved to a temporary container and can be restored within 30 days. After that time, they are permanently deleted. operationId: deleteApplications(appId='{appId}') externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/application-delete?view=graph-rest-1.0 parameters: - name: If-Match in: header description: ETag schema: type: string responses: '204': description: Success 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: '204' x-ms-docs-operation-type: operation parameters: - name: appId in: path description: Alternate key of application required: true schema: type: string nullable: true /applications(uniqueName='{uniqueName}'): description: Provides operations to manage the collection of application entities. get: tags: - Applications(unique Name='{unique Name}') summary: Microsoft Graph Get application description: Get the properties and relationships of an application object. operationId: getApplications(uniqueName='{uniqueName}') externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/application-get?view=graph-rest-1.0 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/Application' examples: ApplicationExample: $ref: '#/components/examples/ApplicationExample' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: 2XX x-ms-docs-operation-type: operation patch: tags: - Applications(unique Name='{unique Name}') summary: Microsoft Graph Upsert application description: Create a new application object if it doesn't exist, or update the properties of an existing application object. operationId: updateApplications(uniqueName='{uniqueName}') externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/application-upsert?view=graph-rest-1.0 requestBody: description: New property values content: application/json: schema: $ref: '#/components/schemas/Application' examples: ApplicationRequestExample: $ref: '#/components/examples/ApplicationRequestExample' required: true responses: 2XX: description: Success content: application/json: schema: $ref: '#/components/schemas/Application' examples: ApplicationExample: $ref: '#/components/examples/ApplicationExample' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: 2XX x-ms-docs-operation-type: operation delete: tags: - Applications(unique Name='{unique Name}') summary: Microsoft Graph Delete application description: Delete an application object. When deleted, apps are moved to a temporary container and can be restored within 30 days. After that time, they are permanently deleted. operationId: deleteApplications(uniqueName='{uniqueName}') externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/application-delete?view=graph-rest-1.0 parameters: - name: If-Match in: header description: ETag schema: type: string responses: '204': description: Success 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: '204' x-ms-docs-operation-type: operation parameters: - name: uniqueName in: path description: Alternate key of application required: true schema: type: string nullable: true /applications/$count: description: Provides operations to count the resources in the collection. get: tags: - Applications summary: Microsoft Graph Get the number of the resource description: Performs GET operation on /applications/$count operationId: countApplications parameters: - name: ConsistencyLevel in: header description: 'Indicates the requested consistency level. Documentation URL: https://docs.microsoft.com/graph/aad-advanced-queries' schema: type: string examples: example-1: description: $search and $count queries require the client to set the ConsistencyLevel HTTP header to 'eventual'. value: eventual - $ref: '#/components/parameters/Search' - $ref: '#/components/parameters/Filter' responses: 2XX: $ref: '#/components/responses/ODataCountResponse' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: 2XX /applications/delta(): description: Provides operations to call the delta method. get: tags: - Applications Delta() summary: Microsoft Graph Get Delta() description: Get newly created, updated, or deleted applications without performing a full read of the entire resource collection. For more information, see Use delta query to track changes in Microsoft Graph data for details. operationId: getDeltaApplicationsDelta() externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/application-delta?view=graph-rest-1.0 parameters: - $ref: '#/components/parameters/Top' - $ref: '#/components/parameters/Skip' - $ref: '#/components/parameters/Search' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Count' - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $orderby in: query description: Order items by property values style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities style: form explode: false schema: uniqueItems: true type: array items: type: string responses: 2XX: description: Success content: application/json: schema: title: Collection of application type: object allOf: - $ref: '#/components/schemas/BaseDeltaFunctionResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Application' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: 2XX x-ms-docs-operation-type: function x-ms-pageable: nextLinkName: '@odata.nextLink' operationName: listMore /applications/getAvailableExtensionProperties: description: Provides operations to call the getAvailableExtensionProperties method. post: tags: - Applications Get Available Extension Properties summary: Microsoft Graph Create Get Available Extension Properties description: 'Return all directory extension definitions that are registered in a directory, including through multitenant apps. The following entities support extension properties:' operationId: createApplicationsGetAvailableExtensionProperties externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/directoryobject-getavailableextensionproperties?view=graph-rest-1.0 requestBody: description: Action parameters content: application/json: schema: type: object properties: isSyncedFromOnPremises: type: boolean default: false nullable: true examples: createApplicationsGetAvailableExtensionPropertiesRequestExample: $ref: '#/components/examples/createApplicationsGetAvailableExtensionPropertiesRequestExample' required: true responses: 2XX: description: Success content: application/json: schema: title: Collection of extensionProperty type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/ExtensionProperty' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: 2XX x-ms-docs-operation-type: action x-ms-pageable: nextLinkName: '@odata.nextLink' operationName: listMore /applications/getByIds: description: Provides operations to call the getByIds method. post: tags: - Applications Get by Ids summary: Microsoft Graph Create Get By Ids description: 'Return the directory objects specified in a list of IDs. Only a subset of user properties are returned by default in v1.0. Some common uses for this function are to:' operationId: getByIdsApplications externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/directoryobject-getbyids?view=graph-rest-1.0 requestBody: description: Action parameters content: application/json: schema: type: object properties: ids: type: array items: type: string types: type: array items: type: string nullable: true examples: getByIdsApplicationsRequestExample: $ref: '#/components/examples/getByIdsApplicationsRequestExample' required: true responses: 2XX: description: Success content: application/json: schema: title: Collection of directoryObject type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/DirectoryObject' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: 2XX x-ms-docs-operation-type: action x-ms-pageable: nextLinkName: '@odata.nextLink' operationName: listMore /applications/validateProperties: description: Provides operations to call the validateProperties method. post: tags: - Applications Validate Properties summary: Microsoft Graph Create Validate Properties description: "Validate that a Microsoft 365 group's display name or mail nickname complies with naming policies. Clients can use this API to determine whether a display name or mail nickname is valid before trying to create a Microsoft 365 group. To validate the properties of an existing group, use the group: validateProperties function. The following policy validations are performed for the display name and mail nickname properties:\r\n1. Validate the prefix and suffix naming policy\r\n2. Validate the custom banned words policy\r\n3. Validate that the mail nickname is unique This API only returns the first validation failure that is encountered. If the properties fail multiple validations, only the first validation failure is returned. However, you can validate both the mail nickname and the display name and receive a collection of validation errors if you're only validating the prefix and suffix naming policy. To learn more about configuring naming policies, see Configure naming policy." operationId: createApplicationsValidateProperties externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/directoryobject-validateproperties?view=graph-rest-1.0 requestBody: description: Action parameters content: application/json: schema: type: object properties: entityType: type: string nullable: true displayName: type: string nullable: true mailNickname: type: string nullable: true onBehalfOfUserId: pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string format: uuid nullable: true examples: createApplicationsValidatePropertiesRequestExample: $ref: '#/components/examples/createApplicationsValidatePropertiesRequestExample' required: true responses: '204': description: Success 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: '204' x-ms-docs-operation-type: action /identity/authenticationEventsFlows/{authenticationEventsFlow-id}/conditions/applications/includeApplications: description: Provides operations to manage the includeApplications property of the microsoft.graph.authenticationConditionsApplications entity. get: tags: - Identity Authentication Events Flows summary: Microsoft Graph 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.' operationId: getIdentityAuthenticationEventsFlowsConditionsApplicationsIncludeApplications externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/authenticationconditionsapplications-list-includeapplications?view=graph-rest-1.0 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/AuthenticationConditionApplicationCollectionResponse' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: 2XX x-ms-pageable: nextLinkName: '@odata.nextLink' operationName: listMore x-ms-docs-operation-type: operation post: tags: - Identity Authentication Events Flows summary: Microsoft Graph 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. operationId: createIdentityAuthenticationEventsFlowsConditionsApplicationsIncludeApplications externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/authenticationconditionsapplications-post-includeapplications?view=graph-rest-1.0 requestBody: description: New navigation property content: application/json: schema: $ref: '#/components/schemas/AuthenticationConditionApplication' required: true responses: 2XX: description: Created navigation property. content: application/json: schema: $ref: '#/components/schemas/AuthenticationConditionApplication' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: 2XX x-ms-docs-operation-type: operation parameters: - name: authenticationEventsFlow-id in: path description: The unique identifier of authenticationEventsFlow required: true schema: type: string x-ms-docs-key-type: authenticationEventsFlow ? /identity/authenticationEventsFlows/{authenticationEventsFlow-id}/conditions/applications/includeApplications/{authenticationConditionApplication-appId} : description: Provides operations to manage the includeApplications property of the microsoft.graph.authenticationConditionsApplications entity. get: tags: - Identity Authentication Events Flows summary: Microsoft Graph Get includeApplications from identity description: Performs GET operation on /identity/authenticationEventsFlows/{authenticationEventsFlow-id}/conditions/applications/includeApplications/{authenticationConditionApplication-appId} operationId: getIdentityAuthenticationEventsFlowsConditionsApplicationsIncludeApplications1 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/AuthenticationConditionApplication' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: 2XX x-ms-docs-operation-type: operation patch: tags: - Identity Authentication Events Flows summary: Microsoft Graph Update Include Applications description: Performs PATCH operation on /identity/authenticationEventsFlows/{authenticationEventsFlow-id}/conditions/applications/includeApplications/{authenticationConditionApplication-appId} operationId: updateIdentityAuthenticationEventsFlowsConditionsApplicationsIncludeApplications requestBody: description: New navigation property values content: application/json: schema: $ref: '#/components/schemas/AuthenticationConditionApplication' required: true responses: 2XX: description: Success content: application/json: schema: $ref: '#/components/schemas/AuthenticationConditionApplication' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: 2XX x-ms-docs-operation-type: operation delete: tags: - Identity Authentication Events Flows summary: Microsoft Graph 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. operationId: deleteIdentityAuthenticationEventsFlowsConditionsApplicationsIncludeApplications externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/authenticationconditionapplication-delete?view=graph-rest-1.0 parameters: - name: If-Match in: header description: ETag schema: type: string responses: '204': description: Success 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: '204' x-ms-docs-operation-type: operation parameters: - name: authenticationEventsFlow-id in: path description: The unique identifier of authenticationEventsFlow required: true schema: type: string x-ms-docs-key-type: authenticationEventsFlow - name: authenticationConditionApplication-appId in: path description: The unique identifier of authenticationConditionApplication required: true schema: type: string x-ms-docs-key-type: authenticationConditionApplication /identity/authenticationEventsFlows/{authenticationEventsFlow-id}/conditions/applications/includeApplications/$count: description: Provides operations to count the resources in the collection. get: tags: - Identity Authentication Events Flows summary: Microsoft Graph Get the number of the resource description: Performs GET operation on /identity/authenticationEventsFlows/{authenticationEventsFlow-id}/conditions/applications/includeApplications/$count operationId: countIdentityAuthenticationEventsFlowsConditionsApplicationsIncludeApplications parameters: - $ref: '#/components/parameters/Search' - $ref: '#/components/parameters/Filter' responses: 2XX: $ref: '#/components/responses/ODataCountResponse' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: 2XX parameters: - name: authenticationEventsFlow-id in: path description: The unique identifier of authenticationEventsFlow required: true schema: type: string x-ms-docs-key-type: authenticationEventsFlow ? /identity/authenticationEventsFlows/{authenticationEventsFlow-id}/graph.externalUsersSelfServiceSignUpEventsFlow/conditions/applications/includeApplications : description: Provides operations to manage the includeApplications property of the microsoft.graph.authenticationConditionsApplications entity. get: tags: - Identity Authentication Events Flows summary: Microsoft Graph Get includeApplications from identity description: Performs GET operation on /identity/authenticationEventsFlows/{authenticationEventsFlow-id}/graph.externalUsersSelfServiceSignUpEventsFlow/conditions/applications/includeApplications operationId: getIdentityAuthenticationEventsFlowsGraphExternalUsersSelfServiceSignUpEventsFlowConditionsApplicationsIncludeApplications 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/AuthenticationConditionApplicationCollectionResponse' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: 2XX x-ms-pageable: nextLinkName: '@odata.nextLink' operationName: listMore x-ms-docs-operation-type: operation post: tags: - Identity Authentication Events Flows summary: Microsoft Graph Create Include Applications description: Performs POST operation on /identity/authenticationEventsFlows/{authenticationEventsFlow-id}/graph.externalUsersSelfServiceSignUpEventsFlow/conditions/applications/includeApplications operationId: createIdentityAuthenticationEventsFlowsGraphExternalUsersSelfServiceSignUpEventsFlowConditionsApplicationsIncludeApplications requestBody: description: New navigation property content: application/json: schema: $ref: '#/components/schemas/AuthenticationConditionApplication' required: true responses: 2XX: description: Created navigation property. content: application/json: schema: $ref: '#/components/schemas/AuthenticationConditionApplication' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: 2XX x-ms-docs-operation-type: operation parameters: - name: authenticationEventsFlow-id in: path description: The unique identifier of authenticationEventsFlow required: true schema: type: string x-ms-docs-key-type: authenticationEventsFlow ? /identity/authenticationEventsFlows/{authenticationEventsFlow-id}/graph.externalUsersSelfServiceSignUpEventsFlow/conditions/applications/includeApplications/{authenticationConditionApplication-appId} : description: Provides operations to manage the includeApplications property of the microsoft.graph.authenticationConditionsApplications entity. get: tags: - Identity Authentication Events Flows summary: Microsoft Graph Get includeApplications from identity description: Performs GET operation on /identity/authenticationEventsFlows/{authenticationEventsFlow-id}/graph.externalUsersSelfServiceSignUpEventsFlow/conditions/applications/includeApplications/{authenticationConditionApplication-appId} operationId: getIdentityAuthenticationEventsFlowsGraphExternalUsersSelfServiceSignUpEventsFlowConditionsApplicationsIncludeApplications1 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/AuthenticationConditionApplication' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: 2XX x-ms-docs-operation-type: operation patch: tags: - Identity Authentication Events Flows summary: Microsoft Graph Update Include Applications description: Performs PATCH operation on /identity/authenticationEventsFlows/{authenticationEventsFlow-id}/graph.externalUsersSelfServiceSignUpEventsFlow/conditions/applications/includeApplications/{authenticationConditionApplication-appId} operationId: updateIdentityAuthenticationEventsFlowsGraphExternalUsersSelfServiceSignUpEventsFlowConditionsApplicationsIncludeApplications requestBody: description: New navigation property values content: application/json: schema: $ref: '#/components/schemas/AuthenticationConditionApplication' required: true responses: 2XX: description: Success content: application/json: schema: $ref: '#/components/schemas/AuthenticationConditionApplication' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: 2XX x-ms-docs-operation-type: operation delete: tags: - Identity Authentication Events Flows summary: Microsoft Graph Delete Include Applications description: Performs DELETE operation on /identity/authenticationEventsFlows/{authenticationEventsFlow-id}/graph.externalUsersSelfServiceSignUpEventsFlow/conditions/applications/includeApplications/{authenticationConditionApplication-appId} operationId: deleteIdentityAuthenticationEventsFlowsGraphExternalUsersSelfServiceSignUpEventsFlowConditionsApplicationsIncludeApplications parameters: - name: If-Match in: header description: ETag schema: type: string responses: '204': description: Success 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: '204' x-ms-docs-operation-type: operation parameters: - name: authenticationEventsFlow-id in: path description: The unique identifier of authenticationEventsFlow required: true schema: type: string x-ms-docs-key-type: authenticationEventsFlow - name: authenticationConditionApplication-appId in: path description: The unique identifier of authenticationConditionApplication required: true schema: type: string x-ms-docs-key-type: authenticationConditionApplication ? /identity/authenticationEventsFlows/{authenticationEventsFlow-id}/graph.externalUsersSelfServiceSignUpEventsFlow/conditions/applications/includeApplications/$count : description: Provides operations to count the resources in the collection. get: tags: - Identity Authentication Events Flows summary: Microsoft Graph Get the number of the resource description: Performs GET operation on /identity/authenticationEventsFlows/{authenticationEventsFlow-id}/graph.externalUsersSelfServiceSignUpEventsFlow/conditions/applications/includeApplications/$count operationId: countIdentityAuthenticationEventsFlowsGraphExternalUsersSelfServiceSignUpEventsFlowConditionsApplicationsIncludeApplications parameters: - $ref: '#/components/parameters/Search' - $ref: '#/components/parameters/Filter' responses: 2XX: $ref: '#/components/responses/ODataCountResponse' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-microcks-operation: delay: 100 dispatcher: FALLBACK dispatcherRules: 2XX parameters: - name: authenticationEventsFlow-id in: path description: The unique identifier of authenticationEventsFlow required: true schema: type: string x-ms-docs-key-type: authenticationEventsFlow tags: - name: Applications description: Operations for managing application registrations - name: Applications Add Key description: Operations for managing application registrations - name: Applications Add Password description: Operations for managing application registrations - name: Applications App Management Policies description: Operations for managing application registrations - name: Applications Check Member Groups description: Operations for managing application registrations - name: Applications Check Member Objects description: Operations for managing application registrations - name: Applications Created on Behalf Of description: Operations for managing application registrations - name: Applications Delta() description: Operations for managing application registrations - name: Applications Extension Properties description: Operations for managing application registrations - name: Applications Federated Identity Credentials description: Operations for managing application registrations - name: Applications Federated Identity Credentials(name='{name}') description: Operations for managing application registrations - name: Applications Get Available Extension Properties description: Operations for managing application registrations - name: Applications Get by Ids description: Operations for managing application registrations - name: Applications Get Member Groups description: Operations for managing application registrations - name: Applications Get Member Objects description: Operations for managing application registrations - name: Applications Home Realm Discovery Policies description: Operations for managing application registrations - name: Applications Logo description: Operations for managing application registrations - name: Applications Owners description: Operations for managing application registrations - name: Applications Remove Key description: Operations for managing application registrations - name: Applications Remove Password description: Operations for managing application registrations - name: Applications Restore description: Operations for managing application registrations - name: Applications Set Verified Publisher description: Operations for managing application registrations - name: Applications Synchronization description: Operations for managing application registrations - name: Applications Token Issuance Policies description: Operations for managing application registrations - name: Applications Token Lifetime Policies description: Operations for managing application registrations - name: Applications Unset Verified Publisher description: Operations for managing application registrations - name: Applications Validate Properties description: Operations for managing application registrations - name: Applications(app Id='{app Id}') description: Operations for managing application registrations - name: Applications(unique Name='{unique Name}') description: Operations for managing application registrations - name: Identity Authentication Events Flows description: Operations related to Identity Authentication Events Flows components: schemas: Application: allOf: - $ref: '#/components/schemas/DirectoryObject' - title: application required: - '@odata.type' type: object properties: addIns: type: array items: $ref: '#/components/schemas/AddIn' description: Defines custom behavior that a consuming service can use to call an app in specific contexts. For example, applications that can render file streams can set the addIns property for its 'FileHandler' functionality. This lets services like Microsoft 365 call the application in the context of a document the user is working on. api: anyOf: - $ref: '#/components/schemas/ApiApplication' - type: object nullable: true description: Specifies settings for an application that implements a web API. appId: type: string description: The unique identifier for the application that is assigned to an application by Microsoft Entra ID. Not nullable. Read-only. Alternate key. Supports $filter (eq). nullable: true applicationTemplateId: type: string description: Unique identifier of the applicationTemplate. Supports $filter (eq, not, ne). Read-only. null if the app wasn't created from an application template. nullable: true appRoles: type: array items: $ref: '#/components/schemas/AppRole' description: The collection of roles defined for the application. With app role assignments, these roles can be assigned to users, groups, or service principals associated with other applications. Not nullable. authenticationBehaviors: anyOf: - $ref: '#/components/schemas/AuthenticationBehaviors' - type: object nullable: true certification: anyOf: - $ref: '#/components/schemas/Certification' - type: object nullable: true description: Specifies the certification status of the application. createdDateTime: pattern: ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$ type: string description: The date and time the application was registered. The DateTimeOffset type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. Supports $filter (eq, ne, not, ge, le, in, and eq on null values) and $orderby. format: date-time nullable: true defaultRedirectUri: type: string nullable: true description: type: string description: Free text field to provide a description of the application object to end users. The maximum allowed size is 1,024 characters. Supports $filter (eq, ne, not, ge, le, startsWith) and $search. nullable: true disabledByMicrosoftStatus: type: string description: 'Specifies whether Microsoft has disabled the registered application. The possible values are: null (default value), NotDisabled, and DisabledDueToViolationOfServicesAgreement (reasons include suspicious, abusive, or malicious activity, or a violation of the Microsoft Services Agreement). Supports $filter (eq, ne, not).' nullable: true displayName: type: string description: The display name for the application. Maximum length is 256 characters. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values), $search, and $orderby. nullable: true groupMembershipClaims: type: string description: 'Configures the groups claim issued in a user or OAuth 2.0 access token that the application expects. To set this attribute, use one of the following valid string values: None, SecurityGroup (for security groups and Microsoft Entra roles), All (this gets all of the security groups, distribution groups, and Microsoft Entra directory roles that the signed-in user is a member of).' nullable: true identifierUris: type: array items: type: string description: Also known as App ID URI, this value is set when an application is used as a resource app. The identifierUris acts as the prefix for the scopes you reference in your API's code, and it must be globally unique across Microsoft Entra ID. For more information on valid identifierUris patterns and best practices, see Microsoft Entra application registration security best practices. Not nullable. Supports $filter (eq, ne, ge, le, startsWith). info: anyOf: - $ref: '#/components/schemas/InformationalUrl' - type: object nullable: true description: 'Basic profile information of the application such as app''s marketing, support, terms of service and privacy statement URLs. The terms of service and privacy statement are surfaced to users through the user consent experience. For more info, see How to: Add Terms of service and privacy statement for registered Microsoft Entra apps. Supports $filter (eq, ne, not, ge, le, and eq on null values).' isDeviceOnlyAuthSupported: type: boolean description: Specifies whether this application supports device authentication without a user. The default is false. nullable: true isFallbackPublicClient: type: boolean description: Specifies the fallback application type as public client, such as an installed application running on a mobile device. The default value is false, which means the fallback application type is confidential client such as a web app. There are certain scenarios where Microsoft Entra ID can't determine the client application type. For example, the ROPC flow where it's configured without specifying a redirect URI. In those cases, Microsoft Entra ID interprets the application type based on the value of this property. nullable: true keyCredentials: type: array items: $ref: '#/components/schemas/KeyCredential' description: The collection of key credentials associated with the application. Not nullable. Supports $filter (eq, not, ge, le). logo: type: string description: The main logo for the application. Not nullable. format: base64url nativeAuthenticationApisEnabled: anyOf: - $ref: '#/components/schemas/NativeAuthenticationApisEnabled' - type: object nullable: true description: 'Specifies whether the Native Authentication APIs are enabled for the application. The possible values are: none and all. Default is none. For more information, see Native Authentication.' notes: type: string description: Notes relevant for the management of the application. nullable: true oauth2RequirePostResponse: type: boolean optionalClaims: anyOf: - $ref: '#/components/schemas/OptionalClaims' - type: object nullable: true description: 'Application developers can configure optional claims in their Microsoft Entra applications to specify the claims that are sent to their application by the Microsoft security token service. For more information, see How to: Provide optional claims to your app.' parentalControlSettings: anyOf: - $ref: '#/components/schemas/ParentalControlSettings' - type: object nullable: true description: Specifies parental control settings for an application. passwordCredentials: type: array items: $ref: '#/components/schemas/PasswordCredential' description: The collection of password credentials associated with the application. Not nullable. publicClient: anyOf: - $ref: '#/components/schemas/PublicClientApplication' - type: object nullable: true description: Specifies settings for installed clients such as desktop or mobile devices. publisherDomain: type: string description: 'The verified publisher domain for the application. Read-only. For more information, see How to: Configure an application''s publisher domain. Supports $filter (eq, ne, ge, le, startsWith).' nullable: true requestSignatureVerification: anyOf: - $ref: '#/components/schemas/RequestSignatureVerification' - type: object nullable: true description: Specifies whether this application requires Microsoft Entra ID to verify the signed authentication requests. requiredResourceAccess: type: array items: $ref: '#/components/schemas/RequiredResourceAccess' description: Specifies the resources that the application needs to access. This property also specifies the set of delegated permissions and application roles that it needs for each of those resources. This configuration of access to the required resources drives the consent experience. No more than 50 resource services (APIs) can be configured. Beginning mid-October 2021, the total number of required permissions must not exceed 400. For more information, see Limits on requested permissions per app. Not nullable. Supports $filter (eq, not, ge, le). samlMetadataUrl: type: string description: The URL where the service exposes SAML metadata for federation. This property is valid only for single-tenant applications. Nullable. nullable: true serviceManagementReference: type: string description: References application or service contact information from a Service or Asset Management database. Nullable. nullable: true servicePrincipalLockConfiguration: anyOf: - $ref: '#/components/schemas/ServicePrincipalLockConfiguration' - type: object nullable: true description: Specifies whether sensitive properties of a multitenant application should be locked for editing after the application is provisioned in a tenant. Nullable. null by default. signInAudience: type: string description: 'Specifies the Microsoft accounts that are supported for the current application. The possible values are: AzureADMyOrg (default), AzureADMultipleOrgs, AzureADandPersonalMicrosoftAccount, and PersonalMicrosoftAccount. See more in the table. The value of this object also limits the number of permissions an app can request. For more information, see Limits on requested permissions per app. The value for this property has implications on other app object properties. As a result, if you change this property, you might need to change other properties first. For more information, see Validation differences for signInAudience.Supports $filter (eq, ne, not).' nullable: true spa: anyOf: - $ref: '#/components/schemas/SpaApplication' - type: object nullable: true description: Specifies settings for a single-page application, including sign out URLs and redirect URIs for authorization codes and access tokens. tags: type: array items: type: string description: Custom strings that can be used to categorize and identify the application. Not nullable. Strings added here will also appear in the tags property of any associated service principals.Supports $filter (eq, not, ge, le, startsWith) and $search. tokenEncryptionKeyId: pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Specifies the keyId of a public key from the keyCredentials collection. When configured, Microsoft Entra ID encrypts all the tokens it emits by using the key this property points to. The application code that receives the encrypted token must use the matching private key to decrypt the token before it can be used for the signed-in user. format: uuid nullable: true uniqueName: type: string description: The unique identifier that can be assigned to an application and used as an alternate key. Immutable. Read-only. nullable: true verifiedPublisher: anyOf: - $ref: '#/components/schemas/VerifiedPublisher' - type: object nullable: true description: Specifies the verified publisher of the application. For more information about how publisher verification helps support application security, trustworthiness, and compliance, see Publisher verification. web: anyOf: - $ref: '#/components/schemas/WebApplication' - type: object nullable: true description: Specifies settings for a web application. appManagementPolicies: type: array items: $ref: '#/components/schemas/AppManagementPolicy' description: The appManagementPolicy applied to this application. x-ms-navigationProperty: true createdOnBehalfOf: anyOf: - $ref: '#/components/schemas/DirectoryObject' - type: object nullable: true description: Supports $filter (/$count eq 0, /$count ne 0). Read-only. x-ms-navigationProperty: true extensionProperties: type: array items: $ref: '#/components/schemas/ExtensionProperty' description: Read-only. Nullable. Supports $expand and $filter (/$count eq 0, /$count ne 0). x-ms-navigationProperty: true federatedIdentityCredentials: type: array items: $ref: '#/components/schemas/FederatedIdentityCredential' description: Federated identities for applications. Supports $expand and $filter (startsWith, /$count eq 0, /$count ne 0). x-ms-navigationProperty: true homeRealmDiscoveryPolicies: type: array items: $ref: '#/components/schemas/HomeRealmDiscoveryPolicy' x-ms-navigationProperty: true owners: type: array items: $ref: '#/components/schemas/DirectoryObject' description: Directory objects that are owners of this application. The owners are a set of nonadmin users or service principals who are allowed to modify this object. Supports $expand, $filter (/$count eq 0, /$count ne 0, /$count eq 1, /$count ne 1), and $select nested in $expand. x-ms-navigationProperty: true synchronization: anyOf: - $ref: '#/components/schemas/Synchronization' - type: object nullable: true description: Represents the capability for Microsoft Entra identity synchronization through the Microsoft Graph API. x-ms-navigationProperty: true tokenIssuancePolicies: type: array items: $ref: '#/components/schemas/TokenIssuancePolicy' x-ms-navigationProperty: true tokenLifetimePolicies: type: array items: $ref: '#/components/schemas/TokenLifetimePolicy' x-ms-navigationProperty: true '@odata.type': type: string default: '#microsoft.graph.application' x-ms-discriminator-value: '#microsoft.graph.application' DirectoryObject: allOf: - $ref: '#/components/schemas/Entity' - title: directoryObject required: - '@odata.type' 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 '@odata.type': type: string discriminator: propertyName: '@odata.type' mapping: '#microsoft.graph.administrativeUnit': '#/components/schemas/microsoft.graph.administrativeUnit' '#microsoft.graph.application': '#/components/schemas/microsoft.graph.application' '#microsoft.graph.appRoleAssignment': '#/components/schemas/microsoft.graph.appRoleAssignment' '#microsoft.graph.certificateAuthorityDetail': '#/components/schemas/microsoft.graph.certificateAuthorityDetail' '#microsoft.graph.certificateBasedAuthPki': '#/components/schemas/microsoft.graph.certificateBasedAuthPki' '#microsoft.graph.contract': '#/components/schemas/microsoft.graph.contract' '#microsoft.graph.device': '#/components/schemas/microsoft.graph.device' '#microsoft.graph.directoryObjectPartnerReference': '#/components/schemas/microsoft.graph.directoryObjectPartnerReference' '#microsoft.graph.directoryRole': '#/components/schemas/microsoft.graph.directoryRole' '#microsoft.graph.directoryRoleTemplate': '#/components/schemas/microsoft.graph.directoryRoleTemplate' '#microsoft.graph.endpoint': '#/components/schemas/microsoft.graph.endpoint' '#microsoft.graph.extensionProperty': '#/components/schemas/microsoft.graph.extensionProperty' '#microsoft.graph.group': '#/components/schemas/microsoft.graph.group' '#microsoft.graph.groupSettingTemplate': '#/components/schemas/microsoft.graph.groupSettingTemplate' '#microsoft.graph.multiTenantOrganizationMember': '#/components/schemas/microsoft.graph.multiTenantOrganizationMember' '#microsoft.graph.organization': '#/components/schemas/microsoft.graph.organization' '#microsoft.graph.orgContact': '#/components/schemas/microsoft.graph.orgContact' '#microsoft.graph.policyBase': '#/components/schemas/microsoft.graph.policyBase' '#microsoft.graph.appManagementPolicy': '#/components/schemas/microsoft.graph.appManagementPolicy' '#microsoft.graph.authorizationPolicy': '#/components/schemas/microsoft.graph.authorizationPolicy' '#microsoft.graph.crossTenantAccessPolicy': '#/components/schemas/microsoft.graph.crossTenantAccessPolicy' '#microsoft.graph.identitySecurityDefaultsEnforcementPolicy': '#/components/schemas/microsoft.graph.identitySecurityDefaultsEnforcementPolicy' '#microsoft.graph.permissionGrantPolicy': '#/components/schemas/microsoft.graph.permissionGrantPolicy' '#microsoft.graph.stsPolicy': '#/components/schemas/microsoft.graph.stsPolicy' '#microsoft.graph.activityBasedTimeoutPolicy': '#/components/schemas/microsoft.graph.activityBasedTimeoutPolicy' '#microsoft.graph.claimsMappingPolicy': '#/components/schemas/microsoft.graph.claimsMappingPolicy' '#microsoft.graph.homeRealmDiscoveryPolicy': '#/components/schemas/microsoft.graph.homeRealmDiscoveryPolicy' '#microsoft.graph.tokenIssuancePolicy': '#/components/schemas/microsoft.graph.tokenIssuancePolicy' '#microsoft.graph.tokenLifetimePolicy': '#/components/schemas/microsoft.graph.tokenLifetimePolicy' '#microsoft.graph.tenantAppManagementPolicy': '#/components/schemas/microsoft.graph.tenantAppManagementPolicy' '#microsoft.graph.resourceSpecificPermissionGrant': '#/components/schemas/microsoft.graph.resourceSpecificPermissionGrant' '#microsoft.graph.servicePrincipal': '#/components/schemas/microsoft.graph.servicePrincipal' '#microsoft.graph.user': '#/components/schemas/microsoft.graph.user' ExtensionProperty: allOf: - $ref: '#/components/schemas/DirectoryObject' - title: extensionProperty required: - '@odata.type' type: object properties: appDisplayName: type: string description: Display name of the application object on which this extension property is defined. Read-only. nullable: true dataType: type: string description: Specifies the data type of the value the extension property can hold. Following values are supported. Binary - 256 bytes maximumBooleanDateTime - Must be specified in ISO 8601 format. Will be stored in UTC.Integer - 32-bit value.LargeInteger - 64-bit value.String - 256 characters maximumNot nullable. For multivalued directory extensions, these limits apply per value in the collection. isMultiValued: type: boolean description: 'Defines the directory extension as a multi-valued property. When true, the directory extension property can store a collection of objects of the dataType; for example, a collection of string types such as ''extensionb7b1c57b532f40b8b5ed4b7a7ba67401jobGroupTracker'': [''String 1'', ''String 2'']. The default value is false. Supports $filter (eq).' isSyncedFromOnPremises: type: boolean description: Indicates if this extension property was synced from on-premises active directory using Microsoft Entra Connect. Read-only. nullable: true name: type: string description: Name of the extension property. Not nullable. Supports $filter (eq). targetObjects: type: array items: type: string description: Following values are supported. Not nullable. UserGroupAdministrativeUnitApplicationDeviceOrganization '@odata.type': type: string default: '#microsoft.graph.extensionProperty' x-ms-discriminator-value: '#microsoft.graph.extensionProperty' FederatedIdentityCredential: allOf: - $ref: '#/components/schemas/Entity' - title: federatedIdentityCredential required: - '@odata.type' type: object properties: audiences: type: array items: type: string description: The audience that can appear in the external token. This field is mandatory and should be set to api://AzureADTokenExchange for Microsoft Entra ID. It says what Microsoft identity platform should accept in the aud claim in the incoming token. This value represents Microsoft Entra ID in your external identity provider and has no fixed value across identity providers - you might need to create a new application registration in your identity provider to serve as the audience of this token. This field can only accept a single value and has a limit of 600 characters. Required. description: type: string description: The unvalidated description of the federated identity credential, provided by the user. It has a limit of 600 characters. Optional. nullable: true issuer: type: string description: The URL of the external identity provider, which must match the issuer claim of the external token being exchanged. The combination of the values of issuer and subject must be unique within the app. It has a limit of 600 characters. Required. name: type: string description: The unique identifier for the federated identity credential, which has a limit of 120 characters and must be URL friendly. The string is immutable after it's created. Alternate key. Required. Not nullable. Supports $filter (eq). subject: type: string description: Required. The identifier of the external software workload within the external identity provider. Like the audience value, it has no fixed format; each identity provider uses their own - sometimes a GUID, sometimes a colon delimited identifier, sometimes arbitrary strings. The value here must match the sub claim within the token presented to Microsoft Entra ID. The combination of issuer and subject must be unique within the app. It has a limit of 600 characters. Supports $filter (eq). '@odata.type': type: string x-ms-discriminator-value: '#microsoft.graph.federatedIdentityCredential' HomeRealmDiscoveryPolicy: allOf: - $ref: '#/components/schemas/StsPolicy' - title: homeRealmDiscoveryPolicy required: - '@odata.type' type: object properties: '@odata.type': type: string default: '#microsoft.graph.homeRealmDiscoveryPolicy' x-ms-discriminator-value: '#microsoft.graph.homeRealmDiscoveryPolicy' KeyCredential: title: keyCredential required: - '@odata.type' type: object properties: customKeyIdentifier: type: string description: A 40-character binary type that can be used to identify the credential. Optional. When not provided in the payload, defaults to the thumbprint of the certificate. format: base64url nullable: true displayName: type: string description: The friendly name for the key, with a maximum length of 90 characters. Longer values are accepted but shortened. Optional. nullable: true endDateTime: pattern: ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$ type: string description: The date and time at which the credential expires. The DateTimeOffset type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. format: date-time nullable: true key: type: string description: The certificate's raw data in byte array converted to Base64 string. Returned only on $select for a single object, that is, GET applications/{applicationId}?$select=keyCredentials or GET servicePrincipals/{servicePrincipalId}?$select=keyCredentials; otherwise, it's always null. From a .cer certificate, you can read the key using the Convert.ToBase64String() method. For more information, see Get the certificate key. format: base64url nullable: true keyId: pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: The unique identifier (GUID) for the key. format: uuid nullable: true startDateTime: pattern: ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$ type: string description: The date and time at which the credential becomes valid.The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. format: date-time nullable: true type: type: string description: The type of key credential; for example, Symmetric, AsymmetricX509Cert. nullable: true usage: type: string description: A string that describes the purpose for which the key can be used; for example, Verify. nullable: true '@odata.type': type: string PasswordCredential: title: passwordCredential required: - '@odata.type' type: object properties: customKeyIdentifier: type: string description: Do not use. format: base64url nullable: true displayName: type: string description: Friendly name for the password. Optional. nullable: true endDateTime: pattern: ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$ type: string description: The date and time at which the password expires represented using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Optional. format: date-time nullable: true hint: type: string description: Contains the first three characters of the password. Read-only. nullable: true keyId: pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: The unique identifier for the password. format: uuid nullable: true secretText: type: string description: Read-only; Contains the strong passwords generated by Microsoft Entra ID that are 16-64 characters in length. The generated password value is only returned during the initial POST request to addPassword. There is no way to retrieve this password in the future. nullable: true startDateTime: pattern: ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$ type: string description: The date and time at which the password becomes valid. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Optional. format: date-time nullable: true '@odata.type': type: string BaseCollectionPaginationCountResponse: title: Base collection pagination and count responses type: object properties: '@odata.count': type: integer format: int64 nullable: true '@odata.nextLink': type: string nullable: true AppRoleAssignment: allOf: - $ref: '#/components/schemas/DirectoryObject' - title: appRoleAssignment required: - '@odata.type' 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 '@odata.type': type: string default: '#microsoft.graph.appRoleAssignment' x-ms-discriminator-value: '#microsoft.graph.appRoleAssignment' Endpoint: allOf: - $ref: '#/components/schemas/DirectoryObject' - title: endpoint required: - '@odata.type' type: object properties: capability: type: string providerId: type: string nullable: true providerName: type: string nullable: true providerResourceId: type: string nullable: true uri: type: string '@odata.type': type: string default: '#microsoft.graph.endpoint' x-ms-discriminator-value: '#microsoft.graph.endpoint' ServicePrincipal: allOf: - $ref: '#/components/schemas/DirectoryObject' - title: servicePrincipal required: - '@odata.type' type: object properties: accountEnabled: type: boolean description: true if the service principal account is enabled; otherwise, false. If set to false, then no users are able to sign in to this app, even if they're assigned to it. Supports $filter (eq, ne, not, in). nullable: true addIns: type: array items: $ref: '#/components/schemas/AddIn' description: Defines custom behavior that a consuming service can use to call an app in specific contexts. For example, applications that can render file streams may set the addIns property for its 'FileHandler' functionality. This lets services like Microsoft 365 call the application in the context of a document the user is working on. alternativeNames: type: array items: type: string description: Used to retrieve service principals by subscription, identify resource group and full resource IDs for managed identities. Supports $filter (eq, not, ge, le, startsWith). appDescription: type: string description: The description exposed by the associated application. nullable: true appDisplayName: type: string description: The display name exposed by the associated application. Maximum length is 256 characters. nullable: true appId: type: string description: The unique identifier for the associated application (its appId property). Alternate key. Supports $filter (eq, ne, not, in, startsWith). nullable: true applicationTemplateId: type: string description: Unique identifier of the applicationTemplate. Supports $filter (eq, not, ne). Read-only. null if the service principal wasn't created from an application template. nullable: true appOwnerOrganizationId: pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Contains the tenant ID where the application is registered. This is applicable only to service principals backed by applications. Supports $filter (eq, ne, NOT, ge, le). format: uuid nullable: true appRoleAssignmentRequired: type: boolean description: Specifies whether users or other service principals need to be granted an app role assignment for this service principal before users can sign in or apps can get tokens. The default value is false. Not nullable. Supports $filter (eq, ne, NOT). appRoles: type: array items: $ref: '#/components/schemas/AppRole' description: The roles exposed by the application that's linked to this service principal. For more information, see the appRoles property definition on the application entity. Not nullable. customSecurityAttributes: anyOf: - $ref: '#/components/schemas/CustomSecurityAttributeValue' - type: object nullable: true description: An open complex type that holds the value of a custom security attribute that is assigned to a directory object. Nullable. Returned only on $select. Supports $filter (eq, ne, not, startsWith). Filter value is case sensitive. To read this property, the calling app must be assigned the CustomSecAttributeAssignment.Read.All permission. To write this property, the calling app must be assigned the CustomSecAttributeAssignment.ReadWrite.All permissions. To read or write this property in delegated scenarios, the admin must be assigned the Attribute Assignment Administrator role. description: type: string description: Free text field to provide an internal end-user facing description of the service principal. End-user portals such MyApps displays the application description in this field. The maximum allowed size is 1,024 characters. Supports $filter (eq, ne, not, ge, le, startsWith) and $search. nullable: true disabledByMicrosoftStatus: type: string description: 'Specifies whether Microsoft has disabled the registered application. The possible values are: null (default value), NotDisabled, and DisabledDueToViolationOfServicesAgreement (reasons include suspicious, abusive, or malicious activity, or a violation of the Microsoft Services Agreement). Supports $filter (eq, ne, not).' nullable: true displayName: type: string description: The display name for the service principal. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values), $search, and $orderby. nullable: true homepage: type: string description: Home page or landing page of the application. nullable: true info: anyOf: - $ref: '#/components/schemas/InformationalUrl' - type: object nullable: true description: 'Basic profile information of the acquired application such as app''s marketing, support, terms of service and privacy statement URLs. The terms of service and privacy statement are surfaced to users through the user consent experience. For more info, see How to: Add Terms of service and privacy statement for registered Microsoft Entra apps. Supports $filter (eq, ne, not, ge, le, and eq on null values).' keyCredentials: type: array items: $ref: '#/components/schemas/KeyCredential' description: The collection of key credentials associated with the service principal. Not nullable. Supports $filter (eq, not, ge, le). loginUrl: type: string description: Specifies the URL where the service provider redirects the user to Microsoft Entra ID to authenticate. Microsoft Entra ID uses the URL to launch the application from Microsoft 365 or the Microsoft Entra My Apps. When blank, Microsoft Entra ID performs IdP-initiated sign-on for applications configured with SAML-based single sign-on. The user launches the application from Microsoft 365, the Microsoft Entra My Apps, or the Microsoft Entra SSO URL. nullable: true logoutUrl: type: string description: Specifies the URL that the Microsoft's authorization service uses to sign out a user using OpenID Connect front-channel, back-channel, or SAML sign out protocols. nullable: true notes: type: string description: Free text field to capture information about the service principal, typically used for operational purposes. Maximum allowed size is 1,024 characters. nullable: true notificationEmailAddresses: type: array items: type: string description: Specifies the list of email addresses where Microsoft Entra ID sends a notification when the active certificate is near the expiration date. This is only for the certificates used to sign the SAML token issued for Microsoft Entra Gallery applications. oauth2PermissionScopes: type: array items: $ref: '#/components/schemas/PermissionScope' description: The delegated permissions exposed by the application. For more information, see the oauth2PermissionScopes property on the application entity's api property. Not nullable. passwordCredentials: type: array items: $ref: '#/components/schemas/PasswordCredential' description: The collection of password credentials associated with the application. Not nullable. preferredSingleSignOnMode: type: string description: 'Specifies the single sign-on mode configured for this application. Microsoft Entra ID uses the preferred single sign-on mode to launch the application from Microsoft 365 or the My Apps portal. The supported values are password, saml, notSupported, and oidc. Note: This field might be null for older SAML apps and for OIDC applications where it isn''t set automatically.' nullable: true preferredTokenSigningKeyThumbprint: type: string description: This property can be used on SAML applications (apps that have preferredSingleSignOnMode set to saml) to control which certificate is used to sign the SAML responses. For applications that aren't SAML, don't write or otherwise rely on this property. nullable: true replyUrls: type: array items: type: string description: The URLs that user tokens are sent to for sign in with the associated application, or the redirect URIs that OAuth 2.0 authorization codes and access tokens are sent to for the associated application. Not nullable. resourceSpecificApplicationPermissions: type: array items: $ref: '#/components/schemas/ResourceSpecificPermission' description: The resource-specific application permissions exposed by this application. Currently, resource-specific permissions are only supported for Teams apps accessing to specific chats and teams using Microsoft Graph. Read-only. samlSingleSignOnSettings: anyOf: - $ref: '#/components/schemas/SamlSingleSignOnSettings' - type: object nullable: true description: The collection for settings related to saml single sign-on. servicePrincipalNames: type: array items: type: string description: Contains the list of identifiersUris, copied over from the associated application. Additional values can be added to hybrid applications. These values can be used to identify the permissions exposed by this app within Microsoft Entra ID. For example,Client apps can specify a resource URI that is based on the values of this property to acquire an access token, which is the URI returned in the 'aud' claim.The any operator is required for filter expressions on multi-valued properties. Not nullable. Supports $filter (eq, not, ge, le, startsWith). servicePrincipalType: type: string description: 'Identifies whether the service principal represents an application, a managed identity, or a legacy application. This is set by Microsoft Entra ID internally. The servicePrincipalType property can be set to three different values: Application - A service principal that represents an application or service. The appId property identifies the associated app registration, and matches the appId of an application, possibly from a different tenant. If the associated app registration is missing, tokens aren''t issued for the service principal.ManagedIdentity - A service principal that represents a managed identity. Service principals representing managed identities can be granted access and permissions, but can''t be updated or modified directly.Legacy - A service principal that represents an app created before app registrations, or through legacy experiences. A legacy service principal can have credentials, service principal names, reply URLs, and other properties that are editable by an authorized user, but doesn''t have an associated app registration. The appId value doesn''t associate the service principal with an app registration. The service principal can only be used in the tenant where it was created.SocialIdp - For internal use.' nullable: true signInAudience: type: string description: 'Specifies the Microsoft accounts that are supported for the current application. Read-only. Supported values are:AzureADMyOrg: Users with a Microsoft work or school account in my organization''s Microsoft Entra tenant (single-tenant).AzureADMultipleOrgs: Users with a Microsoft work or school account in any organization''s Microsoft Entra tenant (multitenant).AzureADandPersonalMicrosoftAccount: Users with a personal Microsoft account, or a work or school account in any organization''s Microsoft Entra tenant.PersonalMicrosoftAccount: Users with a personal Microsoft account only.' nullable: true tags: type: array items: type: string description: Custom strings that can be used to categorize and identify the service principal. Not nullable. The value is the union of strings set here and on the associated application entity's tags property.Supports $filter (eq, not, ge, le, startsWith). tokenEncryptionKeyId: pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Specifies the keyId of a public key from the keyCredentials collection. When configured, Microsoft Entra ID issues tokens for this application encrypted using the key specified by this property. The application code that receives the encrypted token must use the matching private key to decrypt the token before it can be used for the signed-in user. format: uuid nullable: true verifiedPublisher: anyOf: - $ref: '#/components/schemas/VerifiedPublisher' - type: object nullable: true description: Specifies the verified publisher of the application that's linked to this service principal. appManagementPolicies: type: array items: $ref: '#/components/schemas/AppManagementPolicy' description: The appManagementPolicy applied to this application. x-ms-navigationProperty: true appRoleAssignedTo: type: array items: $ref: '#/components/schemas/AppRoleAssignment' description: App role assignments for this app or service, granted to users, groups, and other service principals. Supports $expand. x-ms-navigationProperty: true appRoleAssignments: type: array items: $ref: '#/components/schemas/AppRoleAssignment' description: App role assignment for another app or service, granted to this service principal. Supports $expand. x-ms-navigationProperty: true claimsMappingPolicies: type: array items: $ref: '#/components/schemas/ClaimsMappingPolicy' description: The claimsMappingPolicies assigned to this service principal. Supports $expand. x-ms-navigationProperty: true createdObjects: type: array items: $ref: '#/components/schemas/DirectoryObject' description: Directory objects created by this service principal. Read-only. Nullable. x-ms-navigationProperty: true delegatedPermissionClassifications: type: array items: $ref: '#/components/schemas/DelegatedPermissionClassification' x-ms-navigationProperty: true endpoints: type: array items: $ref: '#/components/schemas/Endpoint' x-ms-navigationProperty: true federatedIdentityCredentials: type: array items: $ref: '#/components/schemas/FederatedIdentityCredential' description: Federated identities for a specific type of service principal - managed identity. Supports $expand and $filter (/$count eq 0, /$count ne 0). x-ms-navigationProperty: true homeRealmDiscoveryPolicies: type: array items: $ref: '#/components/schemas/HomeRealmDiscoveryPolicy' description: The homeRealmDiscoveryPolicies assigned to this service principal. Supports $expand. x-ms-navigationProperty: true memberOf: type: array items: $ref: '#/components/schemas/DirectoryObject' description: 'Roles that this service principal is a member of. HTTP Methods: GET Read-only. Nullable. Supports $expand.' x-ms-navigationProperty: true oauth2PermissionGrants: type: array items: $ref: '#/components/schemas/OAuth2permissionGrant' description: Delegated permission grants authorizing this service principal to access an API on behalf of a signed-in user. Read-only. Nullable. x-ms-navigationProperty: true ownedObjects: type: array items: $ref: '#/components/schemas/DirectoryObject' description: Directory objects that this service principal owns. Read-only. Nullable. Supports $expand, $select nested in $expand, and $filter (/$count eq 0, /$count ne 0, /$count eq 1, /$count ne 1). x-ms-navigationProperty: true owners: type: array items: $ref: '#/components/schemas/DirectoryObject' description: Directory objects that are owners of this servicePrincipal. The owners are a set of nonadmin users or servicePrincipals who are allowed to modify this object. Supports $expand, $filter (/$count eq 0, /$count ne 0, /$count eq 1, /$count ne 1), and $select nested in $expand. x-ms-navigationProperty: true remoteDesktopSecurityConfiguration: anyOf: - $ref: '#/components/schemas/RemoteDesktopSecurityConfiguration' - type: object nullable: true description: The remoteDesktopSecurityConfiguration object applied to this service principal. Supports $filter (eq) for isRemoteDesktopProtocolEnabled property. x-ms-navigationProperty: true synchronization: anyOf: - $ref: '#/components/schemas/Synchronization' - type: object nullable: true description: Represents the capability for Microsoft Entra identity synchronization through the Microsoft Graph API. x-ms-navigationProperty: true tokenIssuancePolicies: type: array items: $ref: '#/components/schemas/TokenIssuancePolicy' description: The tokenIssuancePolicies assigned to this service principal. x-ms-navigationProperty: true tokenLifetimePolicies: type: array items: $ref: '#/components/schemas/TokenLifetimePolicy' description: The tokenLifetimePolicies assigned to this service principal. x-ms-navigationProperty: true transitiveMemberOf: type: array items: $ref: '#/components/schemas/DirectoryObject' x-ms-navigationProperty: true '@odata.type': type: string default: '#microsoft.graph.servicePrincipal' x-ms-discriminator-value: '#microsoft.graph.servicePrincipal' User: allOf: - $ref: '#/components/schemas/DirectoryObject' - title: user required: - '@odata.type' type: object properties: aboutMe: type: string description: A freeform text entry field for the user to describe themselves. Returned only on $select. nullable: true accountEnabled: type: boolean description: true if the account is enabled; otherwise, false. This property is required when a user is created. Returned only on $select. Supports $filter (eq, ne, not, and in). 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. Returned only on $select. Supports $filter (eq, ne, not, and in).' nullable: true assignedLicenses: type: array items: $ref: '#/components/schemas/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. Returned only on $select. Supports $filter (eq, not, /$count eq 0, /$count ne 0). assignedPlans: type: array items: $ref: '#/components/schemas/AssignedPlan' description: The plans that are assigned to the user. Read-only. Not nullable. Returned only on $select. Supports $filter (eq and not). authorizationInfo: anyOf: - $ref: '#/components/schemas/AuthorizationInfo' - type: object 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 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. Returned only on $select. 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).' city: type: string description: The city where the user is located. Maximum length is 128 characters. Returned only on $select. 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.Returned only on $select. 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. Returned only on $select. 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. Returned only on $select. 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. Returned only on $select. 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.Returned only on $select. Supports $filter (eq, ne, not, in).' nullable: true customSecurityAttributes: anyOf: - $ref: '#/components/schemas/CustomSecurityAttributeValue' - type: object nullable: true description: An open complex type that holds the value of a custom security attribute that is assigned to a directory object. Nullable. Returned only on $select. Supports $filter (eq, ne, not, startsWith). The filter value is case-sensitive. To read this property, the calling app must be assigned the CustomSecAttributeAssignment.Read.All permission. To write this property, the calling app must be assigned the CustomSecAttributeAssignment.ReadWrite.All permissions. To read or write this property in delegated scenarios, the admin must be assigned the Attribute Assignment Administrator role. department: type: string description: The name of the department in which the user works. Maximum length is 64 characters. Returned only on $select. 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. Returned only on $select. 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. Returned only on $select. 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: anyOf: - $ref: '#/components/schemas/EmployeeOrgData' - type: object nullable: true description: Represents organization data (for example, division and costCenter) associated with a user. Returned only on $select. Supports $filter (eq, ne, not , ge, le, in). employeeType: type: string description: Captures enterprise worker type. For example, Employee, Contractor, Consultant, or Vendor. Returned only on $select. 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. Returned only on $select. 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. Returned only on $select. Supports $filter (eq, ne, not , in). format: date-time nullable: true faxNumber: type: string description: The fax number of the user. Returned only on $select. 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. Returned only on $select. 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/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. Returned only on $select. Supports $filter (eq) with limitations. 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. Returned only on $select. 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. Returned only on $select. 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. Returned only on $select. 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. Returned only on $select. 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. Returned only on $select.' nullable: true licenseAssignmentStates: type: array items: $ref: '#/components/schemas/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. Returned only on $select. 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: anyOf: - $ref: '#/components/schemas/MailboxSettings' - type: object nullable: true 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. Returned only on $select. 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. Returned only on $select. 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. nullable: true mySite: type: string description: The URL for the user's site. Returned only on $select. 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. Returned only on $select. 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. Returned only on $select. nullable: true onPremisesExtensionAttributes: anyOf: - $ref: '#/components/schemas/OnPremisesExtensionAttributes' - type: object nullable: true description: Contains extensionAttributes1-15 for the user. These extension attributes are also known as Exchange custom attributes 1-15. Each attribute can store up to 1024 characters. For an onPremisesSyncEnabled user, the source of authority for this set of properties is the on-premises and is read-only. For a cloud-only user (where onPremisesSyncEnabled is false), these properties can be set during the creation or update of a user object. For a cloud-only user previously synced from on-premises Active Directory, these properties are read-only in Microsoft Graph but can be fully managed through the Exchange Admin Center or the Exchange Online V2 module in PowerShell. Returned only on $select. Supports $filter (eq, ne, not, in). 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. Returned only on $select. Supports $filter (eq, ne, not, ge, le, in).' 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. Returned only on $select. Supports $filter (eq, ne, not, ge, le, in).' format: date-time nullable: true onPremisesProvisioningErrors: type: array items: $ref: '#/components/schemas/OnPremisesProvisioningError' description: Errors when using Microsoft synchronization product during provisioning. Returned only on $select. 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. Returned only on $select. 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. Returned only on $select. 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. Returned only on $select. 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. Returned only on $select. 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. Returned only on $select. Supports $filter (eq, not, ge, le, in, startsWith, endsWith, /$count eq 0, /$count ne 0).' 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. Returned only on $select. 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: anyOf: - $ref: '#/components/schemas/PasswordProfile' - type: object nullable: true description: 'Specifies the password profile for the user. The profile contains the user''s password. This property is required when a user is created. The password in the profile must satisfy minimum requirements as specified by the passwordPolicies property. By default, a strong password is required. Returned only on $select. Supports $filter (eq, ne, not, in, and eq on null values). To update this property: User-PasswordProfile.ReadWrite.All is the least privileged permission to update this property. In delegated scenarios, the User Administrator Microsoft Entra role is the least privileged admin role supported to update this property for nonadmin users. Privileged Authentication Administrator is the least privileged role that''s allowed to update this property for all administrators in the tenant. In general, the signed-in user must have a higher privileged administrator role as indicated in Who can reset passwords. In app-only scenarios, the calling app must be assigned a supported permission and at least the User Administrator Microsoft Entra role.' pastProjects: type: array items: type: string nullable: true description: A list for the user to enumerate their past projects. Returned only on $select. 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. Returned only on $select. 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.Returned only on $select. nullable: true print: anyOf: - $ref: '#/components/schemas/UserPrint' - type: object nullable: true provisionedPlans: type: array items: $ref: '#/components/schemas/ProvisionedPlan' description: The plans that are provisioned for the user. Read-only. Not nullable. Returned only on $select. 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. Returned only on $select. 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. Returned only on $select. schools: type: array items: type: string nullable: true description: A list for the user to enumerate the schools they attended. Returned only on $select. 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/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: anyOf: - $ref: '#/components/schemas/SignInActivity' - type: object nullable: true description: 'Get the last signed-in date and request ID of the sign-in for a given user. Read-only.Returned only on $select. Supports $filter (eq, ne, not, ge, le) but not with any other filterable properties. Note: Details for this property require a Microsoft Entra ID P1 or P2 license and the AuditLog.Read.All permission.This property isn''t returned for a user who never signed in or last signed in before April 2020.' 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. Returned only on $select. format: date-time nullable: true skills: type: array items: type: string nullable: true description: A list for the user to enumerate their skills. Returned only on $select. state: type: string description: The state or province in the user's address. Maximum length is 128 characters. Returned only on $select. 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. Returned only on $select. 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. Returned only on $select. 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.' 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. Returned only on $select. 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/UserActivity' description: The user's activities across devices. Read-only. Nullable. x-ms-navigationProperty: true agreementAcceptances: type: array items: $ref: '#/components/schemas/AgreementAcceptance' description: The user's terms of use acceptance statuses. Read-only. Nullable. x-ms-navigationProperty: true appRoleAssignments: type: array items: $ref: '#/components/schemas/AppRoleAssignment' description: Represents the app roles a user is granted for an application. Supports $expand. x-ms-navigationProperty: true authentication: anyOf: - $ref: '#/components/schemas/Authentication' - type: object nullable: true description: The authentication methods that are supported for the user. x-ms-navigationProperty: true calendar: anyOf: - $ref: '#/components/schemas/Calendar' - type: object nullable: true description: The user's primary calendar. Read-only. x-ms-navigationProperty: true calendarGroups: type: array items: $ref: '#/components/schemas/CalendarGroup' description: The user's calendar groups. Read-only. Nullable. x-ms-navigationProperty: true calendars: type: array items: $ref: '#/components/schemas/Calendar' description: The user's calendars. Read-only. Nullable. x-ms-navigationProperty: true calendarView: type: array items: $ref: '#/components/schemas/Event' description: The calendar view for the calendar. Read-only. Nullable. x-ms-navigationProperty: true chats: type: array items: $ref: '#/components/schemas/Chat' x-ms-navigationProperty: true cloudClipboard: anyOf: - $ref: '#/components/schemas/CloudClipboardRoot' - type: object nullable: true x-ms-navigationProperty: true cloudPCs: type: array items: $ref: '#/components/schemas/CloudPc' description: The user's Cloud PCs. Read-only. Nullable. x-ms-navigationProperty: true contactFolders: type: array items: $ref: '#/components/schemas/ContactFolder' description: The user's contacts folders. Read-only. Nullable. x-ms-navigationProperty: true contacts: type: array items: $ref: '#/components/schemas/Contact' description: The user's contacts. Read-only. Nullable. x-ms-navigationProperty: true createdObjects: type: array items: $ref: '#/components/schemas/DirectoryObject' description: Directory objects that the user created. Read-only. Nullable. x-ms-navigationProperty: true dataSecurityAndGovernance: anyOf: - $ref: '#/components/schemas/UserDataSecurityAndGovernance' - type: object nullable: true description: The data security and governance settings for the user. Read-only. Nullable. x-ms-navigationProperty: true deviceManagementTroubleshootingEvents: type: array items: $ref: '#/components/schemas/DeviceManagementTroubleshootingEvent' description: The list of troubleshooting events for this user. x-ms-navigationProperty: true directReports: type: array items: $ref: '#/components/schemas/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: anyOf: - $ref: '#/components/schemas/Drive' - type: object nullable: true description: The user's OneDrive. Read-only. x-ms-navigationProperty: true drives: type: array items: $ref: '#/components/schemas/Drive' description: A collection of drives available for this user. Read-only. x-ms-navigationProperty: true employeeExperience: anyOf: - $ref: '#/components/schemas/EmployeeExperienceUser' - type: object nullable: true x-ms-navigationProperty: true events: type: array items: $ref: '#/components/schemas/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/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/Site' x-ms-navigationProperty: true inferenceClassification: anyOf: - $ref: '#/components/schemas/InferenceClassification' - type: object nullable: true description: Relevance classification of the user's messages based on explicit designations that override inferred relevance or importance. x-ms-navigationProperty: true insights: anyOf: - $ref: '#/components/schemas/ItemInsights' - type: object nullable: true description: Represents relationships between a user and items such as OneDrive for work or school documents, calculated using advanced analytics and machine learning techniques. Read-only. Nullable. x-ms-navigationProperty: true joinedTeams: type: array items: $ref: '#/components/schemas/Team' x-ms-navigationProperty: true licenseDetails: type: array items: $ref: '#/components/schemas/LicenseDetails' description: A collection of this user's license details. Read-only. x-ms-navigationProperty: true mailFolders: type: array items: $ref: '#/components/schemas/MailFolder' description: The user's mail folders. Read-only. Nullable. x-ms-navigationProperty: true managedAppRegistrations: type: array items: $ref: '#/components/schemas/ManagedAppRegistration' description: Zero or more managed app registrations that belong to the user. x-ms-navigationProperty: true managedDevices: type: array items: $ref: '#/components/schemas/ManagedDevice' description: The managed devices associated with the user. x-ms-navigationProperty: true manager: anyOf: - $ref: '#/components/schemas/DirectoryObject' - type: object nullable: true description: The user or contact that is this user's manager. Read-only. Supports $expand. x-ms-navigationProperty: true memberOf: type: array items: $ref: '#/components/schemas/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/Message' description: The messages in a mailbox or folder. Read-only. Nullable. x-ms-navigationProperty: true oauth2PermissionGrants: type: array items: $ref: '#/components/schemas/OAuth2permissionGrant' x-ms-navigationProperty: true onenote: anyOf: - $ref: '#/components/schemas/Onenote' - type: object nullable: true x-ms-navigationProperty: true onlineMeetings: type: array items: $ref: '#/components/schemas/OnlineMeeting' description: Information about a meeting, including the URL used to join a meeting, the attendees list, and the description. x-ms-navigationProperty: true outlook: anyOf: - $ref: '#/components/schemas/OutlookUser' - type: object nullable: true x-ms-navigationProperty: true ownedDevices: type: array items: $ref: '#/components/schemas/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/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/Person' description: People that are relevant to the user. Read-only. Nullable. x-ms-navigationProperty: true permissionGrants: type: array items: $ref: '#/components/schemas/ResourceSpecificPermissionGrant' description: List all resource-specific permission grants of a user. x-ms-navigationProperty: true photo: anyOf: - $ref: '#/components/schemas/ProfilePhoto' - type: object nullable: true description: The user's profile photo. Read-only. x-ms-navigationProperty: true photos: type: array items: $ref: '#/components/schemas/ProfilePhoto' description: The collection of the user's profile photos in different sizes. Read-only. x-ms-navigationProperty: true planner: anyOf: - $ref: '#/components/schemas/PlannerUser' - type: object nullable: true description: Entry-point to the Planner resource that might exist for a user. Read-only. x-ms-navigationProperty: true presence: anyOf: - $ref: '#/components/schemas/Presence' - type: object nullable: true x-ms-navigationProperty: true registeredDevices: type: array items: $ref: '#/components/schemas/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/ScopedRoleMembership' x-ms-navigationProperty: true settings: anyOf: - $ref: '#/components/schemas/UserSettings' - type: object nullable: true x-ms-navigationProperty: true solutions: anyOf: - $ref: '#/components/schemas/UserSolutionRoot' - type: object nullable: true description: The identifier that relates the user to the working time schedule triggers. Read-Only. Nullable x-ms-navigationProperty: true sponsors: type: array items: $ref: '#/components/schemas/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: anyOf: - $ref: '#/components/schemas/UserTeamwork' - type: object nullable: true description: A container for Microsoft Teams features available for the user. Read-only. Nullable. x-ms-navigationProperty: true todo: anyOf: - $ref: '#/components/schemas/Todo' - type: object nullable: true description: Represents the To Do services available to a user. x-ms-navigationProperty: true transitiveMemberOf: type: array items: $ref: '#/components/schemas/DirectoryObject' description: The groups, including nested groups, and directory roles that a user is a member of. Nullable. x-ms-navigationProperty: true '@odata.type': type: string default: '#microsoft.graph.user' description: Represents a Microsoft Entra user account. x-ms-discriminator-value: '#microsoft.graph.user' Synchronization: allOf: - $ref: '#/components/schemas/Entity' - title: synchronization required: - '@odata.type' type: object properties: secrets: type: array items: $ref: '#/components/schemas/SynchronizationSecretKeyStringValuePair' description: Represents a collection of credentials to access provisioned cloud applications. jobs: type: array items: $ref: '#/components/schemas/SynchronizationJob' description: Performs synchronization by periodically running in the background, polling for changes in one directory, and pushing them to another directory. x-ms-navigationProperty: true templates: type: array items: $ref: '#/components/schemas/SynchronizationTemplate' description: Preconfigured synchronization settings for a particular application. x-ms-navigationProperty: true '@odata.type': type: string x-ms-discriminator-value: '#microsoft.graph.synchronization' SynchronizationJob: allOf: - $ref: '#/components/schemas/Entity' - title: synchronizationJob required: - '@odata.type' type: object properties: schedule: anyOf: - $ref: '#/components/schemas/SynchronizationSchedule' - type: object nullable: true description: Schedule used to run the job. Read-only. status: anyOf: - $ref: '#/components/schemas/SynchronizationStatus' - type: object nullable: true description: Status of the job, which includes when the job was last run, current job state, and errors. synchronizationJobSettings: type: array items: $ref: '#/components/schemas/KeyValuePair' description: Settings associated with the job. Some settings are inherited from the template. templateId: type: string description: Identifier of the synchronization template this job is based on. nullable: true bulkUpload: anyOf: - $ref: '#/components/schemas/BulkUpload' - type: object nullable: true description: The bulk upload operation for the job. x-ms-navigationProperty: true schema: anyOf: - $ref: '#/components/schemas/SynchronizationSchema' - type: object nullable: true description: The synchronization schema configured for the job. x-ms-navigationProperty: true '@odata.type': type: string x-ms-discriminator-value: '#microsoft.graph.synchronizationJob' BulkUpload: allOf: - $ref: '#/components/schemas/Entity' - title: bulkUpload required: - '@odata.type' type: object properties: '@odata.type': type: string x-ms-discriminator-value: '#microsoft.graph.bulkUpload' StringKeyStringValuePair: title: stringKeyStringValuePair required: - '@odata.type' type: object properties: key: type: string description: Key. nullable: true value: type: string description: Value. nullable: true '@odata.type': type: string SynchronizationSchema: allOf: - $ref: '#/components/schemas/Entity' - title: synchronizationSchema required: - '@odata.type' type: object properties: synchronizationRules: type: array items: $ref: '#/components/schemas/SynchronizationRule' description: A collection of synchronization rules configured for the synchronizationJob or synchronizationTemplate. version: type: string description: The version of the schema, updated automatically with every schema change. nullable: true directories: type: array items: $ref: '#/components/schemas/DirectoryDefinition' description: Contains the collection of directories and all of their objects. x-ms-navigationProperty: true '@odata.type': type: string x-ms-discriminator-value: '#microsoft.graph.synchronizationSchema' DirectoryDefinition: allOf: - $ref: '#/components/schemas/Entity' - title: directoryDefinition required: - '@odata.type' type: object properties: discoverabilities: $ref: '#/components/schemas/DirectoryDefinitionDiscoverabilities' discoveryDateTime: pattern: ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$ type: string description: Represents the discovery date and time using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. format: date-time nullable: true name: type: string description: Name of the directory. Must be unique within the synchronization schema. Not nullable. nullable: true objects: type: array items: $ref: '#/components/schemas/ObjectDefinition' description: Collection of objects supported by the directory. readOnly: type: boolean description: Whether this object is read-only. version: type: string description: Read only value that indicates version discovered. null if discovery hasn't yet occurred. nullable: true '@odata.type': type: string x-ms-discriminator-value: '#microsoft.graph.directoryDefinition' AttributeDefinition: title: attributeDefinition required: - '@odata.type' type: object properties: anchor: type: boolean description: true if the attribute should be used as the anchor for the object. Anchor attributes must have a unique value identifying an object, and must be immutable. Default is false. One, and only one, of the object's attributes must be designated as the anchor to support synchronization. apiExpressions: type: array items: $ref: '#/components/schemas/StringKeyStringValuePair' caseExact: type: boolean description: true if value of this attribute should be treated as case-sensitive. This setting affects how the synchronization engine detects changes for the attribute. defaultValue: type: string description: The default value of the attribute. nullable: true flowNullValues: type: boolean description: '''true'' to allow null values for attributes.' metadata: type: array items: $ref: '#/components/schemas/AttributeDefinitionMetadataEntry' description: Metadata for the given object. multivalued: type: boolean description: true if an attribute can have multiple values. Default is false. mutability: $ref: '#/components/schemas/Mutability' name: type: string description: Name of the attribute. Must be unique within the object definition. Not nullable. nullable: true referencedObjects: type: array items: $ref: '#/components/schemas/ReferencedObject' description: For attributes with reference type, lists referenced objects (for example, the manager attribute would list User as the referenced object). required: type: boolean description: true if attribute is required. Object can not be created if any of the required attributes are missing. If during synchronization, the required attribute has no value, the default value will be used. If default the value was not set, synchronization will record an error. type: $ref: '#/components/schemas/AttributeType' '@odata.type': type: string SynchronizationTemplate: allOf: - $ref: '#/components/schemas/Entity' - title: synchronizationTemplate required: - '@odata.type' type: object properties: applicationId: pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: Identifier of the application this template belongs to. format: uuid default: type: boolean description: true if this template is recommended to be the default for the application. description: type: string description: Description of the template. nullable: true discoverable: type: boolean description: true if this template should appear in the collection of templates available for the application instance (service principal). factoryTag: type: string description: One of the well-known factory tags supported by the synchronization engine. The factoryTag tells the synchronization engine which implementation to use when processing jobs based on this template. nullable: true metadata: type: array items: $ref: '#/components/schemas/SynchronizationMetadataEntry' description: Additional extension properties. Unless mentioned explicitly, metadata values should not be changed. schema: anyOf: - $ref: '#/components/schemas/SynchronizationSchema' - type: object nullable: true description: Default synchronization schema for the jobs based on this template. x-ms-navigationProperty: true '@odata.type': type: string x-ms-discriminator-value: '#microsoft.graph.synchronizationTemplate' BaseDeltaFunctionResponse: title: Base delta function response type: object properties: '@odata.nextLink': type: string nullable: true '@odata.deltaLink': type: string nullable: true Entity: title: Entity type: object properties: id: type: string description: The unique identifier for the entity. ODataError: title: ODataError type: object required: - error properties: error: $ref: '#/components/schemas/MainError' MainError: title: MainError type: object required: - code - message properties: code: type: string description: Error code message: type: string description: Error message target: type: string description: Target of the error nullable: true details: type: array items: $ref: '#/components/schemas/ErrorDetail' innerError: $ref: '#/components/schemas/InnerError' ErrorDetail: title: ErrorDetail type: object required: - code - message properties: code: type: string message: type: string target: type: string nullable: true InnerError: title: InnerError type: object properties: request-id: type: string date: type: string format: date-time client-request-id: type: string ODataCountResponse: title: ODataCountResponse type: integer format: int32 description: The count of entities parameters: Top: name: $top in: query description: Show only the first n items style: form explode: false schema: minimum: 0 type: integer example: 50 Skip: name: $skip in: query description: Skip the first n items style: form explode: false schema: minimum: 0 type: integer Search: name: $search in: query description: Search items by search phrases style: form explode: false schema: type: string Filter: name: $filter in: query description: Filter items by property values style: form explode: false schema: type: string Count: name: $count in: query description: Include count of items style: form explode: false schema: type: boolean examples: AppRoleAssignmentExample: value: id: 00000000-0000-0000-0000-000000000001 deletedDateTime: '2024-01-15T10:30:00Z' '@odata.type': '#microsoft.graph.approleassignment' appRoleId: 00000000-0000-0000-0000-000000000001 createdDateTime: '2024-01-15T10:30:00Z' principalDisplayName: Example Display Name principalId: 00000000-0000-0000-0000-000000000001 principalType: exampleType resourceDisplayName: Example Display Name ApplicationExample: value: id: 00000000-0000-0000-0000-000000000001 deletedDateTime: '2024-01-15T10:30:00Z' '@odata.type': '#microsoft.graph.application' addIns: - {} api: {} appId: 00000000-0000-0000-0000-000000000001 applicationTemplateId: 00000000-0000-0000-0000-000000000001 appRoles: - {} authenticationBehaviors: {} ApplicationRequestExample: value: id: 00000000-0000-0000-0000-000000000001 deletedDateTime: '2024-01-15T10:30:00Z' '@odata.type': '#microsoft.graph.application' addIns: - {} api: {} appId: 00000000-0000-0000-0000-000000000001 applicationTemplateId: 00000000-0000-0000-0000-000000000001 appRoles: - {} authenticationBehaviors: {} BulkUploadExample: value: id: 00000000-0000-0000-0000-000000000001 '@odata.type': '#microsoft.graph.bulkupload' BulkUploadRequestExample: value: id: 00000000-0000-0000-0000-000000000001 '@odata.type': '#microsoft.graph.bulkupload' DirectoryDefinitionExample: value: id: 00000000-0000-0000-0000-000000000001 discoverabilities: {} discoveryDateTime: '2024-01-15T10:30:00Z' name: example-name objects: - {} readOnly: true version: 1.0.0 '@odata.type': '#microsoft.graph.directorydefinition' DirectoryDefinitionRequestExample: value: id: 00000000-0000-0000-0000-000000000001 discoverabilities: {} discoveryDateTime: '2024-01-15T10:30:00Z' name: example-name objects: - {} readOnly: true version: 1.0.0 '@odata.type': '#microsoft.graph.directorydefinition' DirectoryObjectExample: value: id: 00000000-0000-0000-0000-000000000001 deletedDateTime: '2024-01-15T10:30:00Z' '@odata.type': '#microsoft.graph.directoryobject' EndpointExample: value: id: 00000000-0000-0000-0000-000000000001 deletedDateTime: '2024-01-15T10:30:00Z' '@odata.type': '#microsoft.graph.endpoint' capability: string-value providerId: 00000000-0000-0000-0000-000000000001 providerName: 00000000-0000-0000-0000-000000000001 providerResourceId: 00000000-0000-0000-0000-000000000001 uri: https://example.com/resource ExtensionPropertyExample: value: id: 00000000-0000-0000-0000-000000000001 deletedDateTime: '2024-01-15T10:30:00Z' '@odata.type': '#microsoft.graph.extensionproperty' appDisplayName: Example Display Name dataType: exampleType isMultiValued: true isSyncedFromOnPremises: true name: example-name targetObjects: - string-value ExtensionPropertyRequestExample: value: id: 00000000-0000-0000-0000-000000000001 deletedDateTime: '2024-01-15T10:30:00Z' '@odata.type': '#microsoft.graph.extensionproperty' appDisplayName: Example Display Name dataType: exampleType isMultiValued: true isSyncedFromOnPremises: true name: example-name targetObjects: - string-value FederatedIdentityCredentialExample: value: id: 00000000-0000-0000-0000-000000000001 audiences: - string-value description: This is an example description. issuer: string-value name: example-name subject: string-value '@odata.type': '#microsoft.graph.federatedidentitycredential' FederatedIdentityCredentialRequestExample: value: id: 00000000-0000-0000-0000-000000000001 audiences: - string-value description: This is an example description. issuer: string-value name: example-name subject: string-value '@odata.type': '#microsoft.graph.federatedidentitycredential' HomeRealmDiscoveryPolicyExample: value: '@odata.type': '#microsoft.graph.homerealmdiscoverypolicy' KeyCredentialExample: value: customKeyIdentifier: 00000000-0000-0000-0000-000000000001 displayName: Example Display Name endDateTime: '2024-01-15T10:30:00Z' key: string-value keyId: 00000000-0000-0000-0000-000000000001 startDateTime: '2024-01-15T10:30:00Z' '@odata.type': '#microsoft.graph.keycredential' ODataCountResponseExample: value: 42 ODataErrorExample: value: error: code: BadRequest message: The request is invalid. target: /resource details: - code: InvalidParameter message: Parameter value is invalid. target: parameterName innerError: request-id: 00000000-0000-0000-0000-000000000001 date: '2024-01-15T10:30:00Z' client-request-id: 00000000-0000-0000-0000-000000000002 PasswordCredentialExample: value: customKeyIdentifier: 00000000-0000-0000-0000-000000000001 displayName: Example Display Name endDateTime: '2024-01-15T10:30:00Z' hint: string-value keyId: 00000000-0000-0000-0000-000000000001 secretText: string-value '@odata.type': '#microsoft.graph.passwordcredential' ServicePrincipalExample: value: id: 00000000-0000-0000-0000-000000000001 deletedDateTime: '2024-01-15T10:30:00Z' '@odata.type': '#microsoft.graph.serviceprincipal' accountEnabled: true addIns: - {} alternativeNames: - example-name appDescription: This is an example description. appDisplayName: Example Display Name appId: 00000000-0000-0000-0000-000000000001 StringKeyStringValuePairExample: value: key: string-value value: string-value '@odata.type': '#microsoft.graph.stringkeystringvaluepair' SynchronizationExample: value: id: 00000000-0000-0000-0000-000000000001 secrets: - {} jobs: - '@odata.type': '#microsoft.graph.synchronizationjob' templates: - '@odata.type': '#microsoft.graph.synchronizationtemplate' '@odata.type': '#microsoft.graph.synchronization' SynchronizationJobExample: value: id: 00000000-0000-0000-0000-000000000001 schedule: {} status: {} synchronizationJobSettings: - {} templateId: 00000000-0000-0000-0000-000000000001 bulkUpload: '@odata.type': '#microsoft.graph.bulkupload' schema: '@odata.type': '#microsoft.graph.synchronizationschema' '@odata.type': '#microsoft.graph.synchronizationjob' SynchronizationJobRequestExample: value: id: 00000000-0000-0000-0000-000000000001 schedule: {} status: {} synchronizationJobSettings: - {} templateId: 00000000-0000-0000-0000-000000000001 bulkUpload: '@odata.type': '#microsoft.graph.bulkupload' schema: '@odata.type': '#microsoft.graph.synchronizationschema' '@odata.type': '#microsoft.graph.synchronizationjob' SynchronizationRequestExample: value: id: 00000000-0000-0000-0000-000000000001 secrets: - {} jobs: - '@odata.type': '#microsoft.graph.synchronizationjob' templates: - '@odata.type': '#microsoft.graph.synchronizationtemplate' '@odata.type': '#microsoft.graph.synchronization' SynchronizationSchemaExample: value: id: 00000000-0000-0000-0000-000000000001 synchronizationRules: - {} version: 1.0.0 directories: - '@odata.type': '#microsoft.graph.directorydefinition' '@odata.type': '#microsoft.graph.synchronizationschema' SynchronizationSchemaRequestExample: value: id: 00000000-0000-0000-0000-000000000001 synchronizationRules: - {} version: 1.0.0 directories: - '@odata.type': '#microsoft.graph.directorydefinition' '@odata.type': '#microsoft.graph.synchronizationschema' SynchronizationTemplateExample: value: id: 00000000-0000-0000-0000-000000000001 applicationId: 00000000-0000-0000-0000-000000000001 default: true description: This is an example description. discoverable: true factoryTag: string-value metadata: - {} '@odata.type': '#microsoft.graph.synchronizationtemplate' SynchronizationTemplateRequestExample: value: id: 00000000-0000-0000-0000-000000000001 applicationId: 00000000-0000-0000-0000-000000000001 default: true description: This is an example description. discoverable: true factoryTag: string-value metadata: - {} '@odata.type': '#microsoft.graph.synchronizationtemplate' UserExample: value: id: 00000000-0000-0000-0000-000000000001 deletedDateTime: '2024-01-15T10:30:00Z' '@odata.type': '#microsoft.graph.user' aboutMe: string-value accountEnabled: true ageGroup: string-value assignedLicenses: - {} assignedPlans: - {} authorizationInfo: {} acquireAccessTokenApplicationsSynchronizationRequestExample: value: credentials: - {} addKeyApplicationsRequestExample: value: keyCredential: customKeyIdentifier: 00000000-0000-0000-0000-000000000001 displayName: Example Display Name endDateTime: '2024-01-15T10:30:00Z' key: string-value keyId: 00000000-0000-0000-0000-000000000001 startDateTime: '2024-01-15T10:30:00Z' '@odata.type': '#microsoft.graph.keycredential' passwordCredential: customKeyIdentifier: 00000000-0000-0000-0000-000000000001 displayName: Example Display Name endDateTime: '2024-01-15T10:30:00Z' hint: string-value keyId: 00000000-0000-0000-0000-000000000001 secretText: string-value '@odata.type': '#microsoft.graph.passwordcredential' proof: string-value addPasswordApplicationsRequestExample: value: passwordCredential: customKeyIdentifier: 00000000-0000-0000-0000-000000000001 displayName: Example Display Name endDateTime: '2024-01-15T10:30:00Z' hint: string-value keyId: 00000000-0000-0000-0000-000000000001 secretText: string-value '@odata.type': '#microsoft.graph.passwordcredential' checkMemberGroupsApplicationsRequestExample: value: groupIds: - 00000000-0000-0000-0000-000000000001 checkMemberObjectsApplicationsRequestExample: value: ids: - 00000000-0000-0000-0000-000000000001 createApplicationsGetAvailableExtensionPropertiesRequestExample: value: isSyncedFromOnPremises: true createApplicationsSynchronizationJobsSchemaParseExpressionRequestExample: value: expression: string-value testInputObject: {} targetAttributeDefinition: anchor: true apiExpressions: - '@odata.type': '#microsoft.graph.stringkeystringvaluepair' caseExact: true defaultValue: string-value flowNullValues: true metadata: - {} '@odata.type': '#microsoft.graph.attributedefinition' createApplicationsSynchronizationTemplatesSchemaParseExpressionRequestExample: value: expression: string-value testInputObject: {} targetAttributeDefinition: anchor: true apiExpressions: - '@odata.type': '#microsoft.graph.stringkeystringvaluepair' caseExact: true defaultValue: string-value flowNullValues: true metadata: - {} '@odata.type': '#microsoft.graph.attributedefinition' createApplicationsValidatePropertiesRequestExample: value: entityType: exampleType displayName: Example Display Name mailNickname: example-name onBehalfOfUserId: 00000000-0000-0000-0000-000000000001 getByIdsApplicationsRequestExample: value: ids: - 00000000-0000-0000-0000-000000000001 types: - exampleType getMemberGroupsApplicationsRequestExample: value: securityEnabledOnly: true getMemberObjectsApplicationsRequestExample: value: securityEnabledOnly: true provisionApplicationsSynchronizationJobsProvisionOnDemandRequestExample: value: parameters: - {} removeKeyApplicationsRequestExample: value: keyId: 00000000-0000-0000-0000-000000000001 proof: string-value removePasswordApplicationsRequestExample: value: keyId: 00000000-0000-0000-0000-000000000001 replaceApplicationsSynchronizationSecretsRequestExample: value: value: - {} restartApplicationsSynchronizationJobsRequestExample: value: criteria: {} setVerifiedPublisherApplicationsRequestExample: value: verifiedPublisherId: 00000000-0000-0000-0000-000000000001 validateCredentialsApplicationsSynchronizationJobs1RequestExample: value: applicationIdentifier: 00000000-0000-0000-0000-000000000001 templateId: 00000000-0000-0000-0000-000000000001 useSavedCredentials: true credentials: - {} validateCredentialsApplicationsSynchronizationJobsRequestExample: value: applicationIdentifier: 00000000-0000-0000-0000-000000000001 templateId: 00000000-0000-0000-0000-000000000001 useSavedCredentials: true credentials: - {} responses: ApplicationCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/ApplicationCollectionResponse' error: description: error content: application/json: schema: $ref: '#/components/schemas/ODataError' examples: ODataErrorExample: $ref: '#/components/examples/ODataErrorExample' ODataCountResponse: description: The count of the resource content: text/plain: schema: $ref: '#/components/schemas/ODataCountResponse' examples: ODataCountResponseExample: $ref: '#/components/examples/ODataCountResponseExample' StringCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/StringCollectionResponse' EndpointCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/EndpointCollectionResponse' UserCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/UserCollectionResponse'