Lezen in het Engels Bewerken

Delen via


application resource type

Namespace: microsoft.graph

Represents an application. Any application that outsources authentication to Microsoft Entra ID must be registered in the Microsoft identity platform. Application registration involves telling Microsoft Entra ID about your application, including the URL where it's located, the URL to send replies after authentication, the URI to identify your application, and more.

Inherits from directoryObject.

This resource is an open type that allows other properties to be passed in.

This resource supports:

  • Adding your own data to custom properties as extensions.
  • Using delta query to track incremental additions, deletions, and updates, by providing a delta function.
  • Alternate key syntax. The appId property is a supported alternate key. For more information, see Get application.

Methods

Method Return Type Description
List application collection Retrieve the list of applications in the organization.
Create application Creates (registers) a new application.
Get application Read properties and relationships of application object.
Update None Update application object.
Upsert application Create a new application if it doesn't exist, or update the properties of an existing application.
Delete None Delete application object.
Get delta application Get newly created, updated, or deleted applications without performing a full read of the entire resource collection.
Deleted items
List directoryObject collection Retrieve a list of recently deleted applications.
Get directoryObject Retrieve the properties of a recently deleted application.
Restore directoryObject Restore a recently deleted application.
Permanently delete None Permanently delete an application.
List deleted items owned by user directoryObject collection Retrieve the applications deleted in the tenant in the last 30 days and that are owned by a user.
Certificates and secrets
Add password passwordCredential Add a strong password to an application.
Remove password passwordCredential Remove a password from an application.
Add key keyCredential Add a key credential to an application.
Remove key None Remove a key credential from an application.
Owners
List directoryObject collection Get the owners of an application.
Add directoryObject Assign an owner to an application. Application owners can be users or service principals.
Remove None Remove an owner from an application. As a recommended best practice, apps should have at least two owners.
Verified publisher
Set None Set the verified publisher of an application.
Unset None Unset the verified publisher of an application.

Properties

Belangrijk

Specific usage of $filter and the $search query parameter is supported only when you use the ConsistencyLevel header set to eventual and $count. For more information, see Advanced query capabilities on directory objects.

Property Type Description
addIns addIn collection 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 apiApplication Specifies settings for an application that implements a web API.
appId String 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).
applicationTemplateId String Unique identifier of the applicationTemplate. Supports $filter (eq, not, ne). Read-only. null if the app wasn't created from an application template.
appRoles appRole collection 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.
certification certification Specifies the certification status of the application.
createdDateTime DateTimeOffset 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.
deletedDateTime DateTimeOffset The date and time the application was deleted. 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.
description String 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.
disabledByMicrosoftStatus String Specifies whether Microsoft has disabled the registered application. 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).
displayName String The display name for the application. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values), $search, and $orderby.
groupMembershipClaims String 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).
id String Unique identifier for the application object. This property is referred to as Object ID in the Microsoft Entra admin center. Inherited from directoryObject. Key. Not nullable. Read-only. Supports $filter (eq, ne, not, in).
identifierUris String collection 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. You can use the default value provided, which is in the form api://<appId>, or specify a more readable URI like https://contoso.com/api. 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 informationalUrl 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 Boolean Specifies whether this application supports device authentication without a user. The default is false.
isFallbackPublicClient Boolean 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.
keyCredentials keyCredential collection The collection of key credentials associated with the application. Not nullable. Supports $filter (eq, not, ge, le).
logo Stream The main logo for the application. Not nullable.
nativeAuthenticationApisEnabled nativeAuthenticationApisEnabled 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 String Notes relevant for the management of the application.
oauth2RequiredPostResponse Boolean Specifies whether, as part of OAuth 2.0 token requests, Microsoft Entra ID allows POST requests, as opposed to GET requests. The default is false, which specifies that only GET requests are allowed.
optionalClaims optionalClaims 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 parentalControlSettings Specifies parental control settings for an application.
passwordCredentials passwordCredential collection The collection of password credentials associated with the application. Not nullable.
publicClient publicClientApplication Specifies settings for installed clients such as desktop or mobile devices.
publisherDomain String 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).
requestSignatureVerification requestSignatureVerification Specifies whether this application requires Microsoft Entra ID to verify the signed authentication requests.
requiredResourceAccess requiredResourceAccess collection 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 String The URL where the service exposes SAML metadata for federation. This property is valid only for single-tenant applications. Nullable.
serviceManagementReference String References application or service contact information from a Service or Asset Management database. Nullable.
servicePrincipalLockConfiguration servicePrincipalLockConfiguration 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 String 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).
spa spaApplication Specifies settings for a single-page application, including sign out URLs and redirect URIs for authorization codes and access tokens.
tags String collection 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 String 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.
uniqueName String The unique identifier that can be assigned to an application and used as an alternate key. Immutable. Read-only.
verifiedPublisher verifiedPublisher 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 webApplication Specifies settings for a web application.

signInAudience values

Value Description
AzureADMyOrg Users with a Microsoft work or school account in my organization's Microsoft Entra tenant (single tenant). This is the default value for the signInAudience property.
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. For authenticating users with Azure AD B2C user flows, use AzureADandPersonalMicrosoftAccount. This value allows for the widest set of user identities including local accounts and user identities from Microsoft, Facebook, Google, Twitter, or any OpenID Connect provider.
PersonalMicrosoftAccount Users with a personal Microsoft account only.

Limits on requested permissions per app

Microsoft Entra ID limits the number of permissions that can be requested and consented by a client app. These limits depend on the signInAudience value for an app, shown in the app's manifest.

signInAudience Allowed users Maximum permissions the app can request Maximum Microsoft Graph permissions the app can request Maximum permissions that can be consented in a single request
AzureADMyOrg Users from the organization where the app is registered 400 400 About 155 delegated permissions and about 300 application permissions
AzureADMultipleOrgs Users from any Microsoft Entra organization 400 400 About 155 delegated permissions and about 300 application permissions
PersonalMicrosoftAccount Consumer users (such as Outlook.com or Live.com accounts) 30 30 30
AzureADandPersonalMicrosoftAccount Consumer users and users from any Microsoft Entra organization 30 30 30

Relationships

Belangrijk

Specific usage of the $filter query parameter is supported only when you use the ConsistencyLevel header set to eventual and $count. For more information, see Advanced query capabilities on directory objects.

Relationship Type Description
appManagementPolicies appManagementPolicy collection The appManagementPolicy applied to this application.
createdOnBehalfOf directoryObject Supports $filter (/$count eq 0, /$count ne 0). Read-only.
extensionProperties extensionProperty collection Read-only. Nullable. Supports $expand and $filter (/$count eq 0, /$count ne 0).
federatedIdentityCredentials federatedIdentityCredential collection Federated identities for applications. Supports $expand and $filter (startsWith, /$count eq 0, /$count ne 0).
owners directoryObject collection Directory objects that are owners of the application. Read-only. Nullable. Supports $expand, $filter (/$count eq 0, /$count ne 0, /$count eq 1, /$count ne 1), and $select nested in $expand.
synchronization synchronization Represents the capability for Microsoft Entra identity synchronization through the Microsoft Graph API.

JSON representation

The following JSON representation shows the resource type.

{
  "addIns": [{"@odata.type": "microsoft.graph.addIn"}],
  "api": {"@odata.type": "microsoft.graph.apiApplication"},
  "appId": "String",
  "applicationTemplateId": "String",
  "appRoles": [{"@odata.type": "microsoft.graph.appRole"}],
  "certification": {"@odata.type": "microsoft.graph.certification"},
  "createdDateTime": "String (timestamp)",
  "deletedDateTime": "String (timestamp)",
  "disabledByMicrosoftStatus": "String",
  "displayName": "String",
  "groupMembershipClaims": "String",
  "id": "String (identifier)",
  "identifierUris": ["String"],
  "info": {"@odata.type": "microsoft.graph.informationalUrl"},
  "isDeviceOnlyAuthSupported": false,
  "isFallbackPublicClient": false,
  "keyCredentials": [{"@odata.type": "microsoft.graph.keyCredential"}],
  "logo": "Stream",
  "nativeAuthenticationApisEnabled": "String",
  "notes": "String",
  "oauth2RequiredPostResponse": false,
  "optionalClaims": {"@odata.type": "microsoft.graph.optionalClaims"},
  "parentalControlSettings": {"@odata.type": "microsoft.graph.parentalControlSettings"},
  "passwordCredentials": [{"@odata.type": "microsoft.graph.passwordCredential"}],
  "publicClient": {"@odata.type": "microsoft.graph.publicClientApplication"},
  "publisherDomain": "String",
  "requestSignatureVerification": {"@odata.type": "microsoft.graph.requestSignatureVerification"},
  "requiredResourceAccess": [{"@odata.type": "microsoft.graph.requiredResourceAccess"}],
  "servicePrincipalLockConfiguration": {"@odata.type": "microsoft.graph.servicePrincipalLockConfiguration"},
  "serviceManagementReference": "String",
  "signInAudience": "String",
  "spa": {"@odata.type": "microsoft.graph.spaApplication"},
  "tags": ["String"],
  "tokenEncryptionKeyId": "String",
  "uniqueName": "String",
  "verifiedPublisher": {"@odata.type": "microsoft.graph.verifiedPublisher"},
  "web": {"@odata.type": "microsoft.graph.webApplication"}
}