openapi: 3.1.0
info:
title: Microsoft Graph Admin Admin.admin Applications.application API
description: 'Microsoft Graph API for managing administrative resources in Microsoft Entra ID.
This API enables administrators to manage Microsoft Edge browser settings, Internet Explorer mode configurations,
site lists, shared browser sites, Microsoft 365 Apps installation options, people insights, service announcements,
SharePoint settings, Copilot administration, directory administrative units, and admin consent policies.'
version: 1.0.0
contact:
name: Microsoft Graph API Support
url: https://developer.microsoft.com/graph
servers:
- url: https://graph.microsoft.com/v1.0
description: Microsoft Graph API v1.0 endpoint
tags:
- name: Applications.application
x-ms-docs-toc-type: page
paths:
/applications:
description: Provides operations to manage the collection of application entities.
get:
tags:
- Applications.application
summary: Microsoft Graph List applications
description: Get the list of applications in this organization.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/application-list?view=graph-rest-1.0
operationId: applications.application.ListApplication
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/microsoft.graph.applicationCollectionResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- Applications.application
summary: Microsoft Graph Create application
description: Create a new application object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/application-post-applications?view=graph-rest-1.0
operationId: applications.application.CreateApplication
requestBody:
description: New entity
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.application'
required: true
responses:
2XX:
description: Created entity
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.application'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
/applications/{application-id}:
description: Provides operations to manage the collection of application entities.
parameters:
- name: application-id
in: path
description: The unique identifier of application
required: true
schema:
type: string
x-ms-docs-key-type: application
get:
tags:
- Applications.application
summary: Microsoft Graph Get application
description: Get the properties and relationships of an application object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/application-get?view=graph-rest-1.0
operationId: applications.application.GetApplication
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved entity
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.application'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- Applications.application
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.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/application-upsert?view=graph-rest-1.0
operationId: applications.application.UpdateApplication
requestBody:
description: New property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.application'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.application'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- Applications.application
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.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/application-delete?view=graph-rest-1.0
operationId: applications.application.DeleteApplication
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
/applications/{application-id}/logo:
description: Provides operations to manage the media for the application entity.
parameters:
- name: application-id
in: path
description: The unique identifier of application
required: true
schema:
type: string
x-ms-docs-key-type: application
get:
tags:
- Applications.application
summary: Microsoft Graph Get logo for application from applications
description: The main logo for the application. Not nullable.
operationId: applications.application.GetLogo
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'
put:
tags:
- Applications.application
summary: Microsoft Graph Update logo for application in applications
description: The main logo for the application. Not nullable.
operationId: applications.application.UpdateLogo
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'
delete:
tags:
- Applications.application
summary: Microsoft Graph Delete logo for application in applications
description: The main logo for the application. Not nullable.
operationId: applications.application.DeleteLogo
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'
/applications(appId='{appId}'):
description: Provides operations to manage the collection of application entities.
parameters:
- name: appId
in: path
description: Alternate key of application
required: true
schema:
type: string
nullable: true
get:
tags:
- Applications.application
summary: Microsoft Graph Get application
description: Get the properties and relationships of an application object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/application-get?view=graph-rest-1.0
operationId: applications.application.GetApplicationByAppId
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved entity
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.application'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- Applications.application
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.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/application-upsert?view=graph-rest-1.0
operationId: applications.application.UpdateApplicationByAppId
requestBody:
description: New property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.application'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.application'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- Applications.application
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.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/application-delete?view=graph-rest-1.0
operationId: applications.application.DeleteApplicationByAppId
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
/applications(uniqueName='{uniqueName}'):
description: Provides operations to manage the collection of application entities.
parameters:
- name: uniqueName
in: path
description: Alternate key of application
required: true
schema:
type: string
nullable: true
get:
tags:
- Applications.application
summary: Microsoft Graph Get application
description: Get the properties and relationships of an application object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/application-get?view=graph-rest-1.0
operationId: applications.application.GetApplicationByUniqueName
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved entity
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.application'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- Applications.application
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.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/application-upsert?view=graph-rest-1.0
operationId: applications.application.UpdateApplicationByUniqueName
requestBody:
description: New property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.application'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.application'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- Applications.application
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.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/application-delete?view=graph-rest-1.0
operationId: applications.application.DeleteApplicationByUniqueName
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
/applications/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- Applications.application
summary: Microsoft Graph Get the number of the resource
operationId: applications.GetCount-8398
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'
components:
schemas:
microsoft.graph.synchronization:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: synchronization
required:
- '@odata.type'
type: object
properties:
secrets:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.synchronizationSecretKeyStringValuePair'
description: Represents a collection of credentials to access provisioned cloud applications.
jobs:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.synchronizationJob'
description: Performs synchronization by periodically running in the background, polling for changes in one directory, and pushing them to another directory.
x-ms-navigationProperty: true
templates:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.synchronizationTemplate'
description: Preconfigured synchronization settings for a particular application.
x-ms-navigationProperty: true
'@odata.type':
type: string
x-ms-discriminator-value: '#microsoft.graph.synchronization'
microsoft.graph.objectDefinition:
title: objectDefinition
required:
- '@odata.type'
type: object
properties:
attributes:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.attributeDefinition'
description: Defines attributes of the object.
metadata:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.objectDefinitionMetadataEntry'
description: Metadata for the given object.
name:
type: string
description: Name of the object. Must be unique within a directory definition. Not nullable.
nullable: true
supportedApis:
type: array
items:
type: string
nullable: true
description: The API that the provisioning service queries to retrieve data for synchronization.
'@odata.type':
type: string
microsoft.graph.synchronizationTaskExecution:
title: synchronizationTaskExecution
required:
- '@odata.type'
type: object
properties:
activityIdentifier:
type: string
description: Identifier of the job run.
nullable: true
countEntitled:
type: number
description: Count of processed entries that were assigned for this application.
format: int64
countEntitledForProvisioning:
type: number
description: Count of processed entries that were assigned for provisioning.
format: int64
countEscrowed:
type: number
description: Count of entries that were escrowed (errors).
format: int64
countEscrowedRaw:
type: number
description: Count of entries that were escrowed, including system-generated escrows.
format: int64
countExported:
type: number
description: Count of exported entries.
format: int64
countExports:
type: number
description: Count of entries that were expected to be exported.
format: int64
countImported:
type: number
description: Count of imported entries.
format: int64
countImportedDeltas:
type: number
description: Count of imported delta-changes.
format: int64
countImportedReferenceDeltas:
type: number
description: Count of imported delta-changes pertaining to reference changes.
format: int64
error:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.synchronizationError'
- type: object
nullable: true
description: If an error was encountered, contains a synchronizationError object with details.
state:
$ref: '#/components/schemas/microsoft.graph.synchronizationTaskExecutionResult'
timeBegan:
pattern: ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$
type: string
description: Time when this job run began. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.
format: date-time
timeEnded:
pattern: ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$
type: string
description: Time when this job run ended. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.
format: date-time
'@odata.type':
type: string
microsoft.graph.appManagementRestrictionState:
title: appManagementRestrictionState
enum:
- enabled
- disabled
- unknownFutureValue
type: string
microsoft.graph.stsPolicy:
allOf:
- $ref: '#/components/schemas/microsoft.graph.policyBase'
- title: stsPolicy
required:
- '@odata.type'
type: object
properties:
definition:
type: array
items:
type: string
description: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required.
isOrganizationDefault:
type: boolean
description: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false.
nullable: true
appliesTo:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
x-ms-navigationProperty: true
'@odata.type':
type: string
default: '#microsoft.graph.stsPolicy'
discriminator:
propertyName: '@odata.type'
mapping:
'#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.application:
allOf:
- $ref: '#/components/schemas/microsoft.graph.directoryObject'
- title: application
required:
- '@odata.type'
type: object
properties:
addIns:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.addIn'
description: Defines custom behavior that a consuming service can use to call an app in specific contexts. For example, applications that can render file streams can set the addIns property for its 'FileHandler' functionality. This lets services like Microsoft 365 call the application in the context of a document the user is working on.
api:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.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/microsoft.graph.appRole'
description: The collection of roles defined for the application. With app role assignments, these roles can be assigned to users, groups, or service principals associated with other applications. Not nullable.
authenticationBehaviors:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.authenticationBehaviors'
- type: object
nullable: true
certification:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.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/microsoft.graph.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/microsoft.graph.keyCredential'
description: The collection of key credentials associated with the application. Not nullable. Supports $filter (eq, not, ge, le).
logo:
type: string
description: The main logo for the application. Not nullable.
format: base64url
nativeAuthenticationApisEnabled:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.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/microsoft.graph.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:
# --- truncated at 32 KB (253 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/microsoft-graph/refs/heads/main/openapi/microsoft-graph-applications-application-api-openapi.yml