Show / Hide Table of Contents

Application.ReadWrite.OwnedBy

Allows the app to create other applications, and fully manage those applications (read, update, update application secrets and delete), without a signed-in user.  It cannot update any apps that it is not an owner of.

Graph Methods

Type: A = Application Permission, D = Delegate Permission

Ver Type Method
V1 A DELETE /applications(appId='{appId}')
V1 A DELETE /applications(appId='{appId}')/federatedIdentityCredentials/{federatedIdentityCredentialId}
V1 A DELETE /applications(appId='{appId}')/federatedIdentityCredentials/{federatedIdentityCredentialName}
V1 A DELETE /applications(appId='{appId}')/owners/{id}/$ref
V1 A DELETE /applications(appId='{appId}')/tokenLifetimePolicies/$ref
V1 A DELETE /applications/{application ObjectId}/extensionProperties/{id}
V1 A DELETE /applications/{applicationObjectId}
V1 A DELETE /applications/{id}/federatedIdentityCredentials/{federatedIdentityCredentialId}
V1 A DELETE /applications/{id}/federatedIdentityCredentials/{federatedIdentityCredentialName}
V1 A DELETE /applications/{id}/owners/{id}/$ref
V1 A DELETE /applications/{id}/synchronization/templates/{templateId}/schema
V1 A DELETE /applications/{id}/tokenIssuancePolicies/{id}/$ref
V1 A DELETE /applications/{id}/tokenLifetimePolicies/{id}/$ref
V1 A DELETE /applications/{id}/tokenLifetimePolicies/$ref
V1 A DELETE /directory/deleteditems/{id}
V1 A DELETE /directory/deletedItems/{id}
V1 A DELETE /servicePrincipals(appId='{appId}')
V1 A DELETE /servicePrincipals(appId='{appId}')/claimsMappingPolicies/{id}/$ref
V1 A DELETE /servicePrincipals(appId='{appId}')/homeRealmDiscoveryPolicies/{id}/$ref
V1 A DELETE /servicePrincipals(appId='{appId}')/homeRealmDiscoveryPolicies/{policyId}/$ref
V1 A DELETE /servicePrincipals(appId='{appId}')/owners/{id}/$ref
V1 A DELETE /servicePrincipals(appId='{appId}')/tokenLifetimePolicies/$ref
V1 A DELETE /servicePrincipals/{id}
V1 A DELETE /servicePrincipals/{id}/claimsMappingPolicies/{id}/$ref
V1 A DELETE /servicePrincipals/{id}/homeRealmDiscoveryPolicies/{id}/$ref
V1 A DELETE /servicePrincipals/{id}/homeRealmDiscoveryPolicies/{policyId}/$ref
V1 A DELETE /serviceprincipals/{id}/owners/{id}/$ref
V1 A DELETE /servicePrincipals/{id}/owners/{id}/$ref
V1 A DELETE /servicePrincipals/{id}/synchronization/jobs/{jobId}/
V1 A DELETE /servicePrincipals/{id}/synchronization/jobs/{jobId}/schema
V1 A DELETE /servicePrincipals/{id}/tokenLifetimePolicies/$ref
V1 A GET /applications
V1 A GET /applications(appId='{appId}')
V1 A GET /applications(appId='{appId}')/federatedIdentityCredentials
V1 A GET /applications(appId='{appId}')/federatedIdentityCredentials/{federatedIdentityCredentialId}
V1 A GET /applications(appId='{appId}')/federatedIdentityCredentials/{federatedIdentityCredentialName}
V1 A GET /applications(appId='{appId}')/owners
V1 A GET /applications(appId='{appId}')/tokenIssuancePolicies
V1 A GET /applications(appId='{appId}')/tokenLifetimePolicies
V1 A GET /applications/{application ObjectId}/extensionProperties
V1 A GET /applications/{application ObjectId}/extensionProperties/{extensionPropertyId}
V1 A GET /applications/{applicationObjectId}
V1 A GET /applications/{id}/federatedIdentityCredentials
V1 A GET /applications/{id}/federatedIdentityCredentials/{federatedIdentityCredentialId}
V1 A GET /applications/{id}/federatedIdentityCredentials/{federatedIdentityCredentialName}
V1 A GET /applications/{id}/owners
V1 A GET /applications/{id}/synchronization/templates/{templateId}/schema
V1 A GET /applications/{id}/synchronization/templates/{templateId}/schema/filterOperators
V1 A GET /applications/{id}/synchronization/templates/{templateId}/schema/functions
V1 A GET /applications/{id}/tokenIssuancePolicies
V1 A GET /applications/{id}/tokenLifetimePolicies
V1 A GET /applications/delta
V1 A GET /directory/deleteditems/{id}
V1 A GET /directory/deletedItems/{id}
V1 A GET /servicePrincipals
V1 A GET /servicePrincipals(appId='{appId}')
V1 A GET /servicePrincipals(appId='{appId}')/appRoleAssignedTo
V1 A GET /servicePrincipals(appId='{appId}')/appRoleAssignments
V1 A GET /servicePrincipals(appId='{appId}')/claimsMappingPolicies
V1 A GET /servicePrincipals(appId='{appId}')/delegatedPermissionClassifications
V1 A GET /servicePrincipals(appId='{appId}')/homeRealmDiscoveryPolicies
V1 A GET /servicePrincipals(appId='{appId}')/ownedObjects
V1 A GET /servicePrincipals(appId='{appId}')/owners
V1 A GET /servicePrincipals(appId='{appId}')/tokenLifetimePolicies
V1 A GET /servicePrincipals/{id}
V1 A GET /servicePrincipals/{id}/appRoleAssignedTo
V1 A GET /servicePrincipals/{id}/appRoleAssignments
V1 A GET /servicePrincipals/{id}/claimsMappingPolicies
V1 A GET /servicePrincipals/{id}/createdObjects
V1 A GET /servicePrincipals/{id}/delegatedPermissionClassifications
V1 A GET /servicePrincipals/{id}/homeRealmDiscoveryPolicies
V1 A GET /servicePrincipals/{id}/memberOf
V1 A GET /servicePrincipals/{id}/ownedObjects
V1 A GET /servicePrincipals/{id}/owners
V1 A GET /servicePrincipals/{id}/synchronization/jobs/
V1 A GET /servicePrincipals/{id}/synchronization/jobs/{jobId}/
V1 A GET /servicePrincipals/{id}/synchronization/jobs/{jobId}/schema
V1 A GET /servicePrincipals/{id}/synchronization/jobs/{jobId}/schema/filterOperators
V1 A GET /servicePrincipals/{id}/synchronization/jobs/{jobId}/schema/functions
V1 A GET /servicePrincipals/{id}/synchronization/templates/{templateId}/schema
V1 A GET /servicePrincipals/{id}/synchronization/templates/{templateId}/schema/filterOperators
V1 A GET /servicePrincipals/{id}/synchronization/templates/{templateId}/schema/functions
V1 A GET /servicePrincipals/{id}/tokenLifetimePolicies
V1 A GET /servicePrincipals/delta
V1 A GET applications/{id}/synchronization/templates
V1 A GET applications/{id}/synchronization/templates/{templateId}
V1 A GET servicePrincipals/{id}/synchronization/templates
V1 A GET servicePrincipals/{id}/synchronization/templates/{templateId}
V1 A PATCH /applications(appId='{appId}')
V1 A PATCH /applications(appId='{appId}')/federatedIdentityCredentials/{federatedIdentityCredentialId}
V1 A PATCH /applications(appId='{appId}')/federatedIdentityCredentials/{federatedIdentityCredentialName}
V1 A PATCH /applications/{applicationObjectId}
V1 A PATCH /applications/{id}/federatedIdentityCredentials/{federatedIdentityCredentialId}
V1 A PATCH /applications/{id}/federatedIdentityCredentials/{federatedIdentityCredentialName}
V1 A PATCH /servicePrincipals(appId='{appId}')
V1 A PATCH /servicePrincipals/{id}
V1 A PATCH applications/{id}/synchronization/templates/{templateId}
V1 A POST /applications
V1 A POST /applications(appId='{appId}')/addKey
V1 A POST /applications(appId='{appId}')/addPassword
V1 A POST /applications(appId='{appId}')/federatedIdentityCredentials
V1 A POST /applications(appId='{appId}')/owners/$ref
V1 A POST /applications(appId='{appId}')/removeKey
V1 A POST /applications(appId='{appId}')/removePassword
V1 A POST /applications(appId='{appId}')/tokenIssuancePolicies/$ref
V1 A POST /applications(appId='{appId}')/tokenLifetimePolicies/$ref
V1 A POST /applications/{application ObjectId}/extensionProperties
V1 A POST /applications/{applicationsId}/synchronization/acquireAccessToken
V1 A POST /applications/{id}/addKey
V1 A POST /applications/{id}/addPassword
V1 A POST /applications/{id}/federatedIdentityCredentials
V1 A POST /applications/{id}/owners/$ref
V1 A POST /applications/{id}/removeKey
V1 A POST /applications/{id}/removePassword
V1 A POST /applications/{id}/tokenIssuancePolicies/$ref
V1 A POST /applications/{id}/tokenLifetimePolicies/$ref
V1 A POST /applicationTemplates/{applicationTemplate-id}/instantiate
V1 A POST /applicationTemplates/{id}/instantiate
V1 A POST /directory/deleteditems/{id}/restore
V1 A POST /directory/deletedItems/{id}/restore
V1 A POST /servicePrincipals
V1 A POST /servicePrincipals(appId='{appId}')/addKey
V1 A POST /servicePrincipals(appId='{appId}')/addPassword
V1 A POST /servicePrincipals(appId='{appId}')/addTokenSigningCertificate
V1 A POST /servicePrincipals(appId='{appId}')/claimsMappingPolicies/$ref
V1 A POST /servicePrincipals(appId='{appId}')/getPasswordSingleSignOnCredentials
V1 A POST /servicePrincipals(appId='{appId}')/homeRealmDiscoveryPolicies/$ref
V1 A POST /servicePrincipals(appId='{appId}')/owners/$ref
V1 A POST /serviceprincipals(appId='{appId}')/removeKey
V1 A POST /servicePrincipals(appId='{appId}')/removeKey
V1 A POST /servicePrincipals(appId='{appId}')/removePassword
V1 A POST /servicePrincipals(appId='{appId}')/tokenLifetimePolicies/$ref
V1 A POST /serviceprincipals/{id}/addKey
V1 A POST /servicePrincipals/{id}/addKey
V1 A POST /servicePrincipals/{id}/addPassword
V1 A POST /servicePrincipals/{id}/addTokenSigningCertificate
V1 A POST /servicePrincipals/{id}/claimsMappingPolicies/$ref
V1 A POST /servicePrincipals/{id}/getPasswordSingleSignOnCredentials
V1 A POST /servicePrincipals/{id}/homeRealmDiscoveryPolicies/$ref
V1 A POST /servicePrincipals/{id}/owners/$ref
V1 A POST /serviceprincipals/{id}/removeKey
V1 A POST /servicePrincipals/{id}/removePassword
V1 A POST /servicePrincipals/{id}/synchronization/jobs/
V1 A POST /servicePrincipals/{id}/synchronization/jobs/{id}/schema/parseExpression
V1 A POST /servicePrincipals/{id}/synchronization/jobs/{id}/validateCredentials
V1 A POST /servicePrincipals/{id}/synchronization/jobs/{jobId}/pause
V1 A POST /servicePrincipals/{id}/synchronization/jobs/{jobId}/schema/directories/{directoryId}/discover
V1 A POST /servicePrincipals/{id}/synchronization/jobs/{jobId}/start
V1 A POST /servicePrincipals/{id}/synchronization/templates/{id}/schema/parseExpression
V1 A POST /servicePrincipals/{id}/tokenLifetimePolicies/$ref
V1 A POST /servicePrincipals/{servicePrincipalId}/synchronization/jobs/{jobId}/restart
V1 A POST /servicePrincipals/{servicePrincipalsId}/synchronization/acquireAccessToken
V1 A POST /servicePrincipals/{servicePrincipalsId}/synchronization/jobs/{synchronizationJobId}/provisionOnDemand
V1 A PUT /applications/{id}/synchronization/templates/{templateId}/schema
V1 A PUT /servicePrincipals/{id}/synchronization/jobs/{jobId}/schema
V1 A PUT /servicePrincipals/{id}/synchronization/secrets

Application Permission

Id 18a4783c-866b-4cc7-a460-3d5e5662c884
Display String Manage apps that this app creates or owns
Description Allows the app to create other applications, and fully manage those applications (read, update, update application secrets and delete), without a signed-in user.  It cannot update any apps that it is not an owner of.

Resources

addIn

Property Type Description
id guid
properties keyValue collection
type string

administrativeUnit

Property Type Description
description String An optional description for the administrative unit. Supports $filter (eq, ne, in, startsWith), $search.
displayName String Display name for the administrative unit. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values), $search, and $orderBy.
id String Unique identifier for the administrative unit. Read-only. Supports $filter (eq).
visibility String Controls whether the administrative unit and its members are hidden or public. Can be set to HiddenMembership. If not set (value is null), the default behavior is public. When set to HiddenMembership, only members of the administrative unit can list other members of the administrative unit.

apiApplication

Property Type Description
acceptMappedClaims Boolean When true, allows an application to use claims mapping without specifying a custom signing key.
knownClientApplications Guid collection Used for bundling consent if you have a solution that contains two parts: a client app and a custom web API app. If you set the appID of the client app to this value, the user only consents once to the client app. Azure AD knows that consenting to the client means implicitly consenting to the web API and automatically provisions service principals for both APIs at the same time. Both the client and the web API app must be registered in the same tenant.
oauth2PermissionScopes permissionScope collection The definition of the delegated permissions exposed by the web API represented by this application registration. These delegated permissions may be requested by a client application, and may be granted by users or administrators during consent. Delegated permissions are sometimes referred to as OAuth 2.0 scopes.
preAuthorizedApplications preAuthorizedApplication collection Lists the client applications that are pre-authorized with the specified delegated permissions to access this application's APIs. Users are not required to consent to any pre-authorized application (for the permissions specified). However, any additional permissions not listed in preAuthorizedApplications (requested through incremental consent for example) will require user consent.
requestedAccessTokenVersion Int32 Specifies the access token version expected by this resource. This changes the version and format of the JWT produced independent of the endpoint or client used to request the access token.

The endpoint used, v1.0 or v2.0, is chosen by the client and only impacts the version of id_tokens. Resources need to explicitly configure **r

application

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 may set the addIns property for its "FileHandler" functionality. This will let services like Office 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 Azure AD. Not nullable. Read-only. Supports $filter (eq).
applicationTemplateId String Unique identifier of the applicationTemplate. Supports $filter (eq, not, ne).
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 1024 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 may 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 Azure AD roles), All (this gets all of the security groups, distribution groups, and Azure AD 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 Azure portal. 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'll 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://<application-client-id>, or specify a more readable URI like https://contoso.com/api. For more information on valid identifierUris patterns and best practices, see Azure AD 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 Azure AD 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 Azure AD cannot determine the client application type. For example, the ROPC flow where it is configured without specifying a redirect URI. In those cases Azure AD 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.
notes String Notes relevant for the management of the application.
oauth2RequiredPostResponse Boolean Specifies whether, as part of OAuth 2.0 token requests, Azure AD 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 Azure AD 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).
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.
signInAudience String Specifies the Microsoft accounts that are supported for the current application. The possible values are: AzureADMyOrg, AzureADMultipleOrgs, AzureADandPersonalMicrosoftAccount (default), 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 may 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.

Supports $filter (eq, not, ge, le, startsWith).
tokenEncryptionKeyId String Specifies the keyId of a public key from the keyCredentials collection. When configured, Azure AD 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.
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.

applicationServicePrincipal

Property Type Description
application application Represents an application registered in Azure Active Directory.
servicePrincipal servicePrincipal Represents an instance of an application in a directory.

appRole

Property Type Description
allowedMemberTypes String collection Specifies whether this app role can be assigned to users and groups (by setting to "User"]), to other application's (by setting to ["Application"], or both (by setting to ["User", "Application"]). App roles supporting assignment to other applications' service principals are also known as [application permissions. The "Application" value is only supported for app roles defined on application entities.
description String The description for the app role. This is displayed when the app role is being assigned and, if the app role functions as an application permission, during consent experiences.
displayName String Display name for the permission that appears in the app role assignment and consent experiences.
id Guid Unique role identifier inside the appRoles collection. When creating a new app role, a new GUID identifier must be provided.
isEnabled Boolean When creating or updating an app role, this must be set to true (which is the default). To delete a role, this must first be set to false. At that point, in a subsequent call, this role may be removed.
origin String Specifies if the app role is defined on the application object or on the servicePrincipal entity. Must not be included in any POST or PATCH requests. Read-only.
value String Specifies the value to include in the roles claim in ID tokens and access tokens authenticating an assigned user or service principal. Must not exceed 120 characters in length. Allowed characters are : ! # $ % & ' ( ) * + , - . / : ; < = > ? @ [ ] ^ + _ ` { | } ~, as well as characters in the ranges 0-9, A-Z and a-z. Any other character, including the space character, are not allowed. May not begin with ..

appRoleAssignment

Property Type Description
appRoleId Guid The identifier (id) for the app role which is 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 has not 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.
createdDateTime DateTimeOffset 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.
id String A unique identifier for the appRoleAssignment key. Not nullable. Read-only.
principalDisplayName String The display name of the user, group, or service principal that was granted the app role assignment. Read-only. Supports $filter (eq and startswith).
principalId Guid 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.
principalType String The type of the assigned principal. This can either be User, Group, or ServicePrincipal. Read-only.
resourceDisplayName String The display name of the resource app's service principal to which the assignment is made.
resourceId Guid The unique identifier (**i

claimsMappingPolicy

Property Type Description
definition String collection A string collection containing a JSON string that defines the rules and settings for this policy. See Properties of a claims-mapping policy definition for more details about the JSON schema for this property. Required.
displayName String Display name for this policy. Required.
id String Unique identifier for this policy. Read-only.
isOrganizationDefault Boolean Ignore this property. The claims-mapping policy can only be applied to service principals and can't be set globally for the organization.

customSecurityAttributeValue

delegatedPermissionClassification

Property Type Description
classification permissionClassificationType The classification value being given. Possible value: low. Does not support $filter.
id String A unique identifier for the delegatedPermissionClassification Key. Not nullable. Read-only.
permissionId String The unique identifier (id) for the delegated permission listed in the oauth2PermissionScopes collection of the servicePrincipal. Required on create. Does not support $filter.
permissionName String The claim value (**v

directory

Property Type Description
id String A unique identifier for the object; for example, 12345678-9abc-def0-1234-56789abcde. Key. Not nullable. Read-only. Inherited from entity.

directoryObject

Property Type Description
deletedDateTime DateTimeOffset Date and time when this object was deleted. Always null when the object hasn't been deleted.
id String The unique identifier for the object. For example, 12345678-9abc-def0-1234-56789abcde. The value of the **i

extensionproperty

Property Type Description
appDisplayName String Display name of the application object on which this extension property is defined. Read-only.
dataType String Specifies the data type of the value the extension property can hold. Following values are supported. Not nullable.
  • Binary - 256 bytes maximum
  • Boolean
  • DateTime - Must be specified in ISO 8601 format. Will be stored in UTC.
  • Integer - 32-bit value.
  • LargeInteger - 64-bit value.
  • String - 256 characters maximum
deletedDateTime DateTimeOffset Date and time when this object was deleted. Always null when the object hasn't been deleted. Inherited from directoryObject.
isSyncedFromOnPremises Boolean Indicates if this extension property was synced from on-premises active directory using Azure AD Connect. Read-only.
name String Name of the extension property. Not nullable. Supports $filter (eq).
targetObjects String collection Following values are supported. Not nullable.
  • User
  • Group
  • AdministrativeUnit
  • Application
  • Device
  • Organization

federatedIdentityCredential

Property Type Description
audiences String collection The audience that can appear in the external token. This field is mandatory and should be set to api://AzureADTokenExchange for Azure AD. It says what Microsoft identity platform should accept in the aud claim in the incoming token. This value represents Azure AD in your external identity provider and has no fixed value across identity providers - you may 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 String The un-validated, user-provided description of the federated identity credential. It has a limit of 600 characters. Optional.
id String The unique identifier for the federated identity. Required. Read-only.
issuer String The URL of the external identity provider and must match the issuer claim of the external token being exchanged. The combination of the values of issuer and subject must be unique on the app. It has a limit of 600 characters. Required.
name String is the unique identifier for the federated identity credential, which has a limit of 120 characters and must be URL friendly. It is immutable once created. Required. Not nullable. Supports $filter (eq).
subject String Required. The identifier of the external software workload within the external identity provider. Like the audience value, it has no fixed format, as 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 Azure AD. The combination of **i

group

Property Type Description
allowExternalSenders Boolean Indicates if people external to the organization can send messages to the group. Default value is false.

Returned only on $select. Supported only on the Get group API (GET /groups/{ID}).
assignedLabels assignedLabel collection The list of sensitivity label pairs (label ID, label name) associated with a Microsoft 365 group.

Returned only on $select.
assignedLicenses assignedLicense collection The licenses that are assigned to the group.

Returned only on $select. Supports $filter (eq).Read-only.
autoSubscribeNewMembers Boolean Indicates if new members added to the group will be auto-subscribed to receive email notifications. You can set this property in a PATCH request for the group; do not set it in the initial POST request that creates the group. Default value is false.

Returned only on $select. Supported only on the Get group API (GET /groups/{ID}).
classification String Describes a classification for the group (such as low, medium or high business impact). Valid values for this property are defined by creating a ClassificationList setting value, based on the template definition.

Returned by default. Supports $filter (eq, ne, not, ge, le, startsWith).
createdDateTime DateTimeOffset Timestamp of when the group was created. The value cannot be modified and is automatically populated when the group is created. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.

Returned by default. Supports $filter (eq, ne, not, ge, le, in). Read-only.
deletedDateTime DateTimeOffset For some Azure Active Directory objects (user, group, application), if the object is deleted, it is first logically deleted, and this property is updated with the date and time when the object was deleted. Otherwise this property is null. If the object is restored, this property is updated to null.
description String An optional description for the group.

Returned by default. Supports $filter (eq, ne, not, ge, le, startsWith) and $search.
displayName String The display name for the group. This property is required when a group is created and cannot be cleared during updates. Maximum length is 256 characters.

Returned by default. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values), $search, and $orderBy.
expirationDateTime DateTimeOffset Timestamp of when the group is set to expire. The value cannot be modified and is automatically populated when the group is created. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.

Returned by default. Supports $filter (eq, ne, not, ge, le, in). Read-only.
groupTypes String collection Specifies the group type and its membership.

If the collection contains Unified, the group is a Microsoft 365 group; otherwise, it's either a security group or distribution group. For details, see groups overview.

If the collection includes DynamicMembership, the group has dynamic membership; otherwise, membership is static.

Returned by default. Supports $filter (eq, not).
hasMembersWithLicenseErrors Boolean Indicates whether there are members in this group that have license errors from its group-based license assignment.

This property is never returned on a GET operation. You can use it as a $filter argument to get groups that have members with license errors (that is, filter for this property being true). See an example.

Supports $filter (eq).
hideFromAddressLists Boolean True if the group is not displayed in certain parts of the Outlook UI: the Address Book, address lists for selecting message recipients, and the Browse Groups dialog for searching groups; otherwise, false. Default value is false.

Returned only on $select. Supported only on the Get group API (GET /groups/{ID}).
hideFromOutlookClients Boolean True if the group is not displayed in Outlook clients, such as Outlook for Windows and Outlook on the web; otherwise, false. Default value is false.

Returned only on $select. Supported only on the Get group API (GET /groups/{ID}).
id String The unique identifier for the group.

Returned by default. Inherited from directoryObject. Key. Not nullable. Read-only.

Supports $filter (eq, ne, not, in).
isArchived Boolean When a group is associated with a team this property determines whether the team is in read-only mode.
To read this property, use the /group/{groupId}/team endpoint or the Get team API. To update this property, use the archiveTeam and unarchiveTeam APIs.
isAssignableToRole Boolean Indicates whether this group can be assigned to an Azure Active Directory role or not. Optional.

This property can only be set while creating the group and is immutable. If set to true, the securityEnabled property must also be set to true, visibility must be Hidden, and the group cannot be a dynamic group (that is, groupTypes cannot contain DynamicMembership).

Only callers in Global Administrator and Privileged Role Administrator roles can set this property. The caller must also be assigned the RoleManagement.ReadWrite.Directory permission to set this property or update the membership of such groups. For more, see Using a group to manage Azure AD role assignments

Using this feature requires a Azure AD Premium P1 license. Returned by default. Supports $filter (eq, ne, not).
isSubscribedByMail Boolean Indicates whether the signed-in user is subscribed to receive email conversations. Default value is true.

Returned only on $select. Supported only on the Get group API (GET /groups/{ID}).
licenseProcessingState String Indicates status of the group license assignment to all members of the group. Default value is false. Read-only. Possible values: QueuedForProcessing, ProcessingInProgress, and ProcessingComplete.

Returned only on $select. Read-only.
mail String The SMTP address for the group, for example, "[email protected]".

Returned by default. Read-only. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).
mailEnabled Boolean Specifies whether the group is mail-enabled. Required.

Returned by default. Supports $filter (eq, ne, not).
mailNickname String The mail alias for the group, unique for Microsoft 365 groups in the organization. Maximum length is 64 characters. This property can contain only characters in the ASCII character set 0 - 127 except the following: @ () \ [] " ; : <> , SPACE.

Required. Returned by default. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).
membershipRule String The rule that determines members for this group if the group is a dynamic group (groupTypes contains DynamicMembership). For more information about the syntax of the membership rule, see Membership Rules syntax.

Returned by default. Supports $filter (eq, ne, not, ge, le, startsWith).
membershipRuleProcessingState String Indicates whether the dynamic membership processing is on or paused. Possible values are On or Paused.

Returned by default. Supports $filter (eq, ne, not, in).
onPremisesLastSyncDateTime DateTimeOffset Indicates the last time at which the group was synced with the on-premises directory.The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.

Returned by default. Read-only. Supports $filter (eq, ne, not, ge, le, in).
onPremisesProvisioningErrors onPremisesProvisioningError collection Errors when using Microsoft synchronization product during provisioning.

Returned by default. Supports $filter (eq, not).
onPremisesSamAccountName String Contains the on-premises SAM account name synchronized from the on-premises directory. The property is only populated for customers who are synchronizing their on-premises directory to Azure Active Directory via Azure AD Connect.

Returned by default. Supports $filter (eq, ne, not, ge, le, in, startsWith). Read-only.
onPremisesSecurityIdentifier String Contains the on-premises security identifier (SID) for the group that was synchronized from on-premises to the cloud.

Returned by default. Supports $filter (eq including on null values). Read-only.
onPremisesSyncEnabled Boolean true if this group is synced from an on-premises directory; false if this group was originally synced from an on-premises directory but is no longer synced; null if this object has never been synced from an on-premises directory (default).

Returned by default. Read-only. Supports $filter (eq, ne, not, in, and eq on null values).
preferredDataLocation String The preferred data location for the Microsoft 365 group. By default, the group inherits the group creator's preferred data location. To set this property, the calling user must be assigned one of the following Azure AD roles:
  • Global Administrator
  • User Account Administrator
  • Directory Writer
  • Exchange Administrator
  • SharePoint Administrator

For more information about this property, see OneDrive Online Multi-Geo.

Nullable. Returned by default.
preferredLanguage String The preferred language for a Microsoft 365 group. Should follow ISO 639-1 Code; for example en-US.

Returned by default. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).
proxyAddresses String collection Email addresses for the group that direct to the same group mailbox. For example: ["SMTP: [email protected]", "smtp: [email protected]"]. The any operator is required to filter expressions on multi-valued properties.

Returned by default. Read-only. Not nullable. Supports $filter (eq, not, ge, le, startsWith, endsWith, /$count eq 0, /$count ne 0).
renewedDateTime DateTimeOffset Timestamp of when the group was last renewed. This cannot be modified directly and is only updated via the renew service action. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.

Returned by default. Supports $filter (eq, ne, not, ge, le, in). Read-only.
resourceBehaviorOptions String collection Specifies the group behaviors that can be set for a Microsoft 365 group during creation. This can be set only as part of creation (POST). Possible values are AllowOnlyMembersToPost, HideGroupInOutlook, SubscribeNewGroupMembers, WelcomeEmailDisabled. For more information, see Set Microsoft 365 group behaviors and provisioning options.
resourceProvisioningOptions String collection Specifies the group resources that are provisioned as part of Microsoft 365 group creation, that are not normally part of default group creation. Possible value is Team. For more information, see Set Microsoft 365 group behaviors and provisioning options.
securityEnabled Boolean Specifies whether the group is a security group. Required.

Returned by default. Supports $filter (eq, ne, not, in).
securityIdentifier String Security identifier of the group, used in Windows scenarios.

Returned by default.
theme string Specifies a Microsoft 365 group's color theme. Possible values are Teal, Purple, Green, Blue, Pink, Orange or Red.

Returned by default.
unseenCount Int32 Count of conversations that have received new posts since the signed-in user last visited the group.

Returned only on $select. Supported only on the Get group API (GET /groups/{ID}).
visibility String Specifies the group join policy and group content visibility for groups. Possible values are: Private, Public, or HiddenMembership. HiddenMembership can be set only for Microsoft 365 groups, when the groups are created. It can't be updated later. Other values of visibility can be updated after group creation.
If visibility value is not specified during group creation on Microsoft Graph, a security group is created as Private by default and Microsoft 365 group is Public. Groups assignable to roles are always Private. See group visibility options to learn more.

Returned by default. Nullable.

homeRealmDiscoveryPolicy

Property Type Description
definition String collection A string collection containing a JSON string that defines the rules and settings for this policy. See Properties of a home realm discovery policy definition for more details about the JSON schema for this property. Required.
description String Description for this policy.
displayName String Display name for this policy. Required.
id String Unique identifier for this policy. Read-only.
isOrganizationDefault Boolean 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.

informationalUrl

Property Type Description
logoUrl String CDN URL to the application's logo, Read-only.
marketingUrl String Link to the application's marketing page. For example, https://www.contoso.com/app/marketing
privacyStatementUrl String Link to the application's privacy statement. For example, https://www.contoso.com/app/privacy
supportUrl String Link to the application's support page. For example, https://www.contoso.com/app/support
termsOfServiceUrl String Link to the application's terms of service statement. For example, https://www.contoso.com/app/termsofservice

keyCredential

Property Type Description
customKeyIdentifier Binary 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.
displayName String Friendly name for the key. Optional.
endDateTime DateTimeOffset 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.
key Binary 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 is always null.
keyId Guid The unique identifier (GUID) for the key.
startDateTime DateTimeOffset 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.
type String The type of key credential; for example, Symmetric, AsymmetricX509Cert.
usage String A string that describes the purpose for which the key can be used; for example, Verify.

onPremisesPublishing

Property Type Description
alternateUrl String If you are configuring a traffic manager in front of multiple App Proxy applications, the alternateUrl is the user-friendly URL that will point to the traffic manager.
applicationServerTimeout String The duration the connector will wait for a response from the backend application before closing the connection. Possible values are default, long. When set to default, the backend application timeout has a length of 85 seconds. When set to long, the backend timeout is increased to 180 seconds. Use long if your server takes more than 85 seconds to respond to requests or if you are unable to access the application and the error status is "Backend Timeout". Default value is default.
applicationType String Indicates if this application is an Application Proxy configured application. This is pre-set by the system. Read-only.
externalAuthenticationType externalAuthenticationType Details the pre-authentication setting for the application. Pre-authentication enforces that users must authenticate before accessing the app. Passthru does not require authentication. Possible values are: passthru, aadPreAuthentication.
externalUrl String The published external url for the application. For example, https://intranet-contoso.msappproxy.net/.
internalUrl String The internal url of the application. For example, https://intranet/.
isBackendCertificateValidationEnabled Boolean Indicates whether backend SSL certificate validation is enabled for the application. For all new Application Proxy apps, the property will be set to true by default. For all existing apps, the property will be set to false.
isHttpOnlyCookieEnabled Boolean Indicates if the HTTPOnly cookie flag should be set in the HTTP response headers. Set this value to true to have Application Proxy cookies include the HTTPOnly flag in the HTTP response headers. If using Remote Desktop Services, set this value to False. Default value is false.
isOnPremPublishingEnabled Boolean Indicates if the application is currently being published via Application Proxy or not. This is pre-set by the system. Read-only.
isPersistentCookieEnabled Boolean Indicates if the Persistent cookie flag should be set in the HTTP response headers. Keep this value set to false. Only use this setting for applications that can't share cookies between processes. For more information about cookie settings, see Cookie settings for accessing on-premises applications in Azure Active Directory. Default value is false.
isSecureCookieEnabled Boolean Indicates if the Secure cookie flag should be set in the HTTP response headers. Set this value to true to transmit cookies over a secure channel such as an encrypted HTTPS request. Default value is true.
isStateSessionEnabled Boolean Indicates whether validation of the state parameter when the client uses the OAuth 2.0 authorization code grant flow is enabled. This setting allows admins to specify whether they want to enable CSRF protection for their apps.
isTranslateHostHeaderEnabled Boolean Indicates if the application should translate urls in the reponse headers. Keep this value as true unless your application required the original host header in the authentication request. Default value is true.
isTranslateLinksInBodyEnabled Boolean Indicates if the application should translate urls in the application body. Keep this value as false unless you have hardcoded HTML links to other on-premises applications and don't use custom domains. For more information, see Link translation with Application Proxy. Default value is false.
onPremisesApplicationSegments (deprecated) onPremisesApplicationSegment collection Represents the application segment collection for an on-premises wildcard application. This property is deprecated and will stop returning data on June 1, 2023. Use segmentsConfiguration instead.
segmentsConfiguration segmentConfiguration Represents the collection of application segments for an on-premises wildcard application that's published through Azure AD Application Proxy.
singleSignOnSettings onPremisesPublishingSingleSignOn Represents the single sign-on configuration for the on-premises application.
verifiedCustomDomainCertificatesMetadata verifiedCustomDomainCertificatesMetadata Details of the certificate associated with the application when a custom domain is in use. null when using the default domain. Read-only.
verifiedCustomDomainKeyCredential keyCredential The associated key credential for the custom domain used.
verifiedCustomDomainPasswordCredential passwordCredential The associated password credential for the custom domain used.

parentalControlSettings

Property Type Description
countriesBlockedForMinors String collection Specifies the two-letter ISO country codes. Access to the application will be blocked for minors from the countries specified in this list.
legalAgeGroupRule String Specifies the legal age group rule that applies to users of the app. Can be set to one of the following values:
ValueDescription
AllowDefault. Enforces the legal minimum. This means parental consent is required for minors in the European Union and Korea.
RequireConsentForPrivacyServicesEnforces the user to specify date of birth to comply with COPPA rules.
RequireConsentForMinorsRequires parental consent for ages below 18, regardless of country minor rules.
RequireConsentForKidsRequires parental consent for ages below 14, regardless of country minor rules.
BlockMinorsBlocks minors from using the app.

passwordCredential

Property Type Description
customKeyIdentifier Binary Do not use.
displayName String Friendly name for the password. Optional.
endDateTime DateTimeOffset 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.
hint String Contains the first three characters of the password. Read-only.
keyId Guid The unique identifier for the password.
secretText String Read-only; Contains the strong passwords generated by Azure AD 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.
startDateTime DateTimeOffset 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.

passwordSingleSignOnCredentialSet

Property Type Description
credentials credential collection A list of credential objects that define the complete sign in flow.
id String The ID of the user or group this credential set belongs to.

publicClientApplication

Property Type Description
redirectUris String collection Specifies the URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent.

requiredResourceAccess

Property Type Description
resourceAccess resourceAccess collection The list of OAuth2.0 permission scopes and app roles that the application requires from the specified resource.
resourceAppId String The unique identifier for the resource that the application requires access to. This should be equal to the **a

samlSingleSignOnSettings

Property Type Description
relayState String The relative URI the service provider would redirect to after completion of the single sign-on flow.

selfSignedCertificate

Property Type Description
customKeyIdentifier Binary Custom key identifier.
displayName String The friendly name for the key.
endDateTime DateTimeOffset The date and time at which the credential expires. The timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.
key Binary The value for the key credential. Should be a Base-64 encoded value.
keyId Guid The unique identifier (GUID) for the key.
startDateTime DateTimeOffset 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.
type String The type of key credential. "AsymmetricX509Cert".
usage String A string that describes the purpose for which the key can be used. The possible value is Verify.
thumbprint String The thumbprint value for the key.

servicePrincipal

Property Type Description
accountEnabled Boolean true if the service principal account is enabled; otherwise, false. If set to false, then no users will be able to sign in to this app, even if they are assigned to it. Supports $filter (eq, ne, not, in).
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 may set the addIns property for its "FileHandler" functionality. This will let services like Microsoft 365 call the application in the context of a document the user is working on.
alternativeNames String collection 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 String The description exposed by the associated application.
appDisplayName String The display name exposed by the associated application.
appId String The unique identifier for the associated application (its appId property). Supports $filter (eq, ne, not, in, startsWith).
applicationTemplateId String Unique identifier of the applicationTemplate that the servicePrincipal was created from. Read-only. Supports $filter (eq, ne, NOT, startsWith).
appOwnerOrganizationId Guid 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).
appRoleAssignmentRequired Boolean 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 appRole collection The roles exposed by the application which this service principal represents. For more information see the appRoles property definition on the application entity. Not nullable.
deletedDateTime DateTimeOffset The date and time the service principal was deleted. Read-only.
description String Free text field to provide an internal end-user facing description of the service principal. End-user portals such MyApps will display the application description in this field. The maximum allowed size is 1024 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 may 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 service principal. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values), $search, and $orderBy.
homepage String Home page or landing page of the application.
id String The unique identifier for the service principal. Inherited from directoryObject. Key. Not nullable. Read-only. Supports $filter (eq, ne, not, in).
info informationalUrl 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 Azure AD apps.

Supports $filter (eq, ne, not, ge, le, and eq on null values).
keyCredentials keyCredential collection The collection of key credentials associated with the service principal. Not nullable. Supports $filter (eq, not, ge, le).
loginUrl String Specifies the URL where the service provider redirects the user to Azure AD to authenticate. Azure AD uses the URL to launch the application from Microsoft 365 or the Azure AD My Apps. When blank, Azure AD performs IdP-initiated sign-on for applications configured with SAML-based single sign-on. The user launches the application from Microsoft 365, the Azure AD My Apps, or the Azure AD SSO URL.
logoutUrl String Specifies the URL that will be used by Microsoft's authorization service to logout an user using OpenId Connect front-channel, back-channel or SAML logout protocols.
notes String Free text field to capture information about the service principal, typically used for operational purposes. Maximum allowed size is 1024 characters.
notificationEmailAddresses String collection Specifies the list of email addresses where Azure AD 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 Azure AD Gallery applications.
oauth2PermissionScopes permissionScope collection The delegated permissions exposed by the application. For more information see the oauth2PermissionScopes property on the application entity's api property. Not nullable.
passwordCredentials passwordCredential collection The collection of password credentials associated with the application. Not nullable.
preferredSingleSignOnMode string Specifies the single sign-on mode configured for this application. Azure AD uses the preferred single sign-on mode to launch the application from Microsoft 365 or the Azure AD My Apps. The supported values are password, saml, notSupported, and oidc.
preferredTokenSigningKeyThumbprint String Reserved for internal use only. Do not write or otherwise rely on this property. May be removed in future versions.
replyUrls String collection 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 resourceSpecificPermission collection 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 samlSingleSignOnSettings The collection for settings related to saml single sign-on.
servicePrincipalNames String collection 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 Azure AD. For example,
  • Client apps can specify a resource URI which 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 String Identifies whether the service principal represents an application, a managed identity, or a legacy application. This is set by Azure AD 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 are not 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 cannot be updated or modified directly.
  • Legacy - A service principal that represents an app created before app registrations, or through legacy experiences. Legacy service principal can have credentials, service principal names, reply URLs, and other properties which are editable by an authorized user, but does not have an associated app registration. The appId value does not 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.
signInAudience String 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 Azure AD tenant (single-tenant).
  • AzureADMultipleOrgs: Users with a Microsoft work or school account in any organization’s Azure AD tenant (multi-tenant).
  • AzureADandPersonalMicrosoftAccount: Users with a personal Microsoft account, or a work or school account in any organization’s Azure AD tenant.
  • PersonalMicrosoftAccount: Users with a personal Microsoft account only.
tags String collection Custom strings that can be used to categorize and identify the service principal. Not nullable.

Supports $filter (eq, not, ge, le, startsWith).
tokenEncryptionKeyId String Specifies the keyId of a public key from the keyCredentials collection. When configured, Azure AD 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.
verifiedPublisher verifiedPublisher Specifies the verified publisher of the application which this service principal represents.

spaApplication

Property Type Description
redirectUris String collection Specifies the URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent.

attributeDefinition

Property Type Description
anchor Boolean 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.
caseExact Boolean true if value of this attribute should be treated as case-sensitive. This setting affects how the synchronization engine detects changes for the attribute.
flowNullValues Boolean 'true' to allow null values for attributes.
metadata metadataEntry collection Additional extension properties. Unless mentioned explicitly, metadata values should not be changed.
multivalued Boolean true if an attribute can have multiple values. Default is false.
mutability mutability An attribute's mutability. Possible values are: ReadWrite, ReadOnly, Immutable, WriteOnly. Default is ReadWrite.
name String Name of the attribute. Must be unique within the object definition. Not nullable.
required Boolean 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.
referencedObjects referencedObject collection For attributes with reference type, lists referenced objects (for example, the manager attribute would list User as the referenced object).
type attributeType Attribute value type. Possible values are: String, Integer, Reference, Binary, Boolean,DateTime. Default is String.

attributeMappingFunctionSchema

Property Type Description
name String Operator name.
parameters attributeMappingParameterSchema collection Collection of function parameters.

attributeMappingSource

Property Type Description
expression String Equivalent expression representation of this attributeMappingSource object.
name String Name parameter of the mapping source. Depending on the type property value, this can be the name of the function, the name of the source attribute, or a constant value to be used.
parameters stringKeyAttributeMappingSourceValuePair collection If this object represents a function, lists function parameters. Parameters consist of attributeMappingSource objects themselves, allowing for complex expressions. If type is not Function, this property will be null/empty array.
type String The type of this attribute mapping source. Possible values are: Attribute, Constant, Function. Default is Attribute.

directoryDefinition

Property Type Description
id String Directory identifier. Not nullable.
metadata metadataEntry collection Additional extension properties. Unless mentioned explicitly, metadata values should not be changed.
name String Name of the directory. Must be unique within the synchronization schema. Not nullable.
objects objectDefinition collection Collection of objects supported by the directory.
version String Read only value that indicates version discovered. null if discovery has not yet occurred.
discoveryDateTime DateTimeOffset 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.
discoverabilities directoryDefinitionDiscoverabilities Read only value indicating what type of discovery the app supports. Possible values are: AttributeDataTypes, AttributeNames, AttributeReadOnly, None, ReferenceAttributes, UnknownFutureValue.

expressionInputObject

Property Type Description
definition objectDefinition Definition of the test object.
properties stringKeyObjectValuePair collection Property values of the test object.

filter

Property Type Description
categoryFilterGroups filterGroup collection *Experimental* Filter group set used to decide whether given object belongs and should be processed as part of this object mapping. An object is considered in scope if ANY of the groups in the collection is evaluated to true.
groups filterGroup collection Filter group set used to decide whether given object is in scope for provisioning. This is the filter which should be used in most cases. If an object used to satisfy this filter at a given moment, and then the object or the filter was changed so that filter is not satisfied any longer, such object *will get de-provisioned". An object is considered in scope if ANY of the groups in the collection is evaluated to true.
inputFilterGroups filterGroup collection *Experimental* Filter group set used to filter out objects at the early stage of reading them from the directory. If an object doesn't satisfy this filter it will not be processed further. Important to understand is that if an object used to satisfy this filter at a given moment, and then the object or the filter was changed so that filter is no longer satisfied, such object *w

filterOperatorSchema

Property Type Description
arity String Arity of the operator. Possible values are: Binary, Unary. The default is Binary.
multivaluedComparisonType scopeOperatorMultiValuedComparisonType Possible values are: All, Any. Applies only to multivalued attributes. All means that all values must satisfy the condition. Any means that at least one value has to satisfy the condition. The default is All.
name String Operator name.
supportedAttributeTypes String collection Attribute types supported by the operator. Possible values are: Boolean, Binary, Reference, Integer, String.

parseExpressionResponse

Property Type Description
error publicError Error details, if expression evaluation resulted in an error.
evaluationResult String collection A collection of values produced by the evaluation of the expression.
evaluationSucceeded Boolean true if the evaluation was successful.
parsedExpression attributeMappingSource An attributeMappingSource object representing the parsed expression.
parsingSucceeded Boolean true if the expression was parsed successfully.

synchronizationJob

Property Type Description
id String Unique synchronization job identifier. Read-only.
schedule synchronizationSchedule Schedule used to run the job. Read-only.
status synchronizationStatus Status of the job, which includes when the job was last run, current job state, and errors.
synchronizationJobSettings keyValuePair Settings associated with the job. Some settings are inherited from the template.
templateId String Identifier of the synchronization template this job is based on.

synchronizationJobApplicationParameters

Property Type Description
ruleId String The identifier of the synchronizationRule to be applied. This rule ID is defined in the schema for a given synchronization job or template.
subjects synchronizationJobSubject collection The identifiers of one or more objects to which a synchronizationJob is to be applied.

synchronizationJobRestartCriteria

Property Type Description
resetScope String Comma-separated combination of the following values: None, ConnectorDataStore, Escrows, Watermark, QuarantineState, Full, ForceDeletes. The property can also be empty.
  1. None: Starts a paused or quarantined provisioning job. **D

synchronizationSchema

Property Type Description
id String Unique identifier for the schema.
synchronizationRules synchronizationRule collection A collection of synchronization rules configured for the synchronizationJob or synchronizationTemplate.
version String The version of the schema, updated automatically with every schema change.

synchronizationSecretKeyStringValuePair

Property Type Description
key synchronizationSecret Possible values are: None, UserName, Password, SecretToken, AppKey, BaseAddress, ClientIdentifier, ClientSecret, SingleSignOnType, Sandbox, Url, Domain, ConsumerKey, ConsumerSecret, TokenKey, TokenExpiration, Oauth2AccessToken, Oauth2AccessTokenCreationTime, Oauth2RefreshToken, SyncAll, InstanceName, Oauth2ClientId, Oauth2ClientSecret, CompanyId, UpdateKeyOnSoftDelete, SynchronizationSchedule, SystemOfRecord, SandboxName, EnforceDomain, SyncNotificationSettings, Server, PerformInboundEntitlementGrants, HardDeletesEnabled, SyncAgentCompatibilityKey, SyncAgentADContainer, ValidateDomain, Oauth2TokenExchangeUri, Oauth2AuthorizationUri, AuthenticationType, TestReferences, ConnectionString.
value String The value of the secret.

synchronizationTemplate

Property Type Description
id String Unique template identifier.
applicationId String Identifier of the application this template belongs to.
default Boolean true if this template is recommended to be the default for the application.
description String Description of the template.
discoverable String true if this template should appear in the collection of templates available for the application instance (service principal).
factoryTag String 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.
metadata metadataEntry collection Additional extension properties. Unless mentioned explicitly, metadata values should not be changed.

tokenIssuancePolicy

Property Type Description
definition String collection A string collection containing a JSON string that defines the rules and settings for this policy. See below for more details about the JSON schema for this property. Required.
description String Description for this policy.
displayName String Display name for this policy. Required.
id String Unique identifier for this policy. Read-only.
isOrganizationDefault Boolean Ignore this property. The token-issuance policy can only be applied to service principals and can't be set globally for the organization.

tokenLifetimePolicy

Property Type Description
definition String collection A string collection containing a JSON string that defines the rules and settings for this policy. See below for more details about the JSON schema for this property. Required.
description String Description for this policy.
displayName String Display name for this policy. Required.
id String Unique identifier for this policy. Read-only.
isOrganizationDefault Boolean 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.

user

Property Type Description
aboutMe String A freeform text entry field for the user to describe themselves. Returned only on $select.
accountEnabled Boolean 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).
ageGroup ageGroup Sets the age group of the user. Allowed values: null, Minor, NotAdult and Adult. Refer to the legal age group property definitions for further information.

Returned only on $select. Supports $filter (eq, ne, not, and in).
assignedLicenses assignedLicense collection The licenses that are assigned to the user, including inherited (group-based) licenses. This property doesn't differentiate 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 assignedPlan collection The plans that are assigned to the user. Read-only. Not nullable.

Returned only on $select. Supports $filter (eq and not).
birthday DateTimeOffset The birthday of the user. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.

Returned only on $select.
businessPhones String collection The telephone numbers for the user. NOTE: Although this is a string collection, only one number can be set for this property. Read-only for users synced from on-premises directory.

Returned by default. Supports $filter (eq, not, ge, le, startsWith).
city String The city in which 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).
companyName String The company name which the user is associated. This property can be useful for describing the company that an external user 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).
consentProvidedForMinor consentProvidedForMinor Sets whether consent has been obtained for minors. Allowed values: null, Granted, Denied and NotRequired. Refer to the legal age group property definitions for further information.

Returned only on $select. Supports $filter (eq, ne, not, and in).
country String The country/region in which 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).
createdDateTime DateTimeOffset The date and time the user was created, in ISO 8601 format and in UTC time. The value cannot 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 Azure AD. Property is null for some users created before June 2018 and on-premises users that were synced to Azure AD before June 2018. Read-only. Read-only.

Returned only on $select. Supports $filter (eq, ne, not , ge, le, in).
creationType String 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 an external user 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).
deletedDateTime DateTimeOffset The date and time the user was deleted.

Returned only on $select. Supports $filter (eq, ne, not, ge, le, in).
department String The name for 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).
displayName String The name displayed in the address book for the user. This is usually the combination of the user's first name, middle initial and last name. This property is required when a user is created and it cannot 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.
employeeHireDate DateTimeOffset The date and time when the user was hired or will start work in case of a future hire.

Returned only on $select. Supports $filter (eq, ne, not , ge, le, in).
employeeId String 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).
employeeOrgData employeeOrgData Represents organization data (e.g. division and costCenter) associated with a user.

Returned only on $select. Supports $filter (eq, ne, not , ge, le, in).
employeeType String Captures enterprise worker type. For example, Employee, Contractor, Consultant, or Vendor. Returned only on $select. Supports $filter (eq, ne, not , ge, le, in, startsWith).
externalUserState String For an external user 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).
externalUserStateChangeDateTime DateTimeOffset Shows the timestamp for the latest change to the externalUserState property.

Returned only on $select. Supports $filter (eq, ne, not , in).
faxNumber String The fax number of the user.

Returned only on $select. Supports $filter (eq, ne, not , ge, le, in, startsWith, and eq on null values).
givenName String 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).
hireDate DateTimeOffset The hire date of the user. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.

Returned only on $select.
Note: This property is specific to SharePoint Online. We recommend using the native employeeHireDate property to set and update hire date values using Microsoft Graph APIs.
id String The unique identifier for the user. Should be treated as an opaque identifier. Inherited from directoryObject. Key. Not nullable. Read-only.

Returned by default. Supports $filter (eq, ne, not, in).
identities objectIdentity collection Represents the identities that can be used to sign in to this user account. An identity can be provided by Microsoft (also known as a local account), by organizations, or by social identity providers such as Facebook, Google, and Microsoft, and tied to a user account. May contain multiple items with the same signInType value.

Returned only on $select. Supports $filter (eq) including on null values, only where the signInType is not userPrincipalName.
imAddresses String collection 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 String collection A list for the user to describe their interests.

Returned only on $select.
isResourceAccount Boolean Do not use – reserved for future use.
jobTitle String 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).
lastPasswordChangeDateTime DateTimeOffset The time when this Azure AD 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 time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.

Returned only on $select.
legalAgeGroupClassification legalAgeGroupClassification 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, MinorWithOutParentalConsent, MinorWithParentalConsent, MinorNoParentalConsentRequired, NotAdult and Adult. Refer to the legal age group property definitions for further information.

Returned only on $select.
licenseAssignmentStates licenseAssignmentState collection State of license assignments for this user. Also indicates licenses that are directly-assigned and those that the user has inherited through group memberships. Read-only.

Returned only on $select.
mail String The SMTP address for the user, for example, [email protected]. Changes to this property will also update the user's proxyAddresses collection to include the value as an SMTP address. This property cannot contain accent characters.
NOTE: We do not 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).
mailboxSettings mailboxSettings 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 String 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).
mobilePhone String The primary cellular telephone number for the user. Read-only for users synced from 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).
mySite String The URL for the user's personal site.

Returned only on $select.
officeLocation String 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).
onPremisesDistinguishedName String 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 Azure Active Directory via Azure AD Connect. Read-only.

Returned only on $select.
onPremisesDomainName String 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 Azure Active Directory via Azure AD Connect. Read-only.

Returned only on $select.
onPremisesExtensionAttributes onPremisesExtensionAttributes Contains extensionAttributes1-15 for the user. These extension attributes are also known as Exchange custom attributes 1-15.
  • 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 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 String This property is used to associate an on-premises Active Directory user account to their Azure AD user object. This property must be specified when creating a new user account in the Graph if you are using a federated domain for the user's userPrincipalName (UPN) property. NOTE: The $ and _ characters cannot be used when specifying this property.

    Returned only on $select. Supports $filter (eq, ne, not, ge, le, in)..
    onPremisesLastSyncDateTime DateTimeOffset 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 time. 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).
    onPremisesProvisioningErrors onPremisesProvisioningError collection Errors when using Microsoft synchronization product during provisioning.

    Returned only on $select. Supports $filter (eq, not, ge, le).
    onPremisesSamAccountName String 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 Azure Active Directory via Azure AD Connect. Read-only.

    Returned only on $select. Supports $filter (eq, ne, not, ge, le, in, startsWith).
    onPremisesSecurityIdentifier String 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).
    onPremisesSyncEnabled Boolean 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 Azure Active Directory (Azure AD). Read-only.

    Returned only on $select. Supports $filter (eq, ne, not, in, and eq on null values).
    onPremisesUserPrincipalName String 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 Azure Active Directory via Azure AD Connect. Read-only.

    Returned only on $select. Supports $filter (eq, ne, not, ge, le, in, startsWith).
    otherMails String collection A list of additional email addresses for the user; for example: ["[email protected]", "[email protected]"].
    NOTE: This property cannot contain accent characters.

    Returned only on $select. Supports $filter (eq, not, ge, le, in, startsWith, endsWith, /$count eq 0, /$count ne 0).
    passwordPolicies String 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 may be specified together; for example: DisablePasswordExpiration, DisableStrongPassword.

    Returned only on $select. For more information on the default password policies, see Azure AD pasword policies. Supports $filter (ne, not, and eq on null values).
    passwordProfile passwordProfile 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).
    pastProjects String collection A list for the user to enumerate their past projects.

    Returned only on $select.
    postalCode String The postal code for the user's postal address. The postal code is specific to the user's country/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).
    preferredDataLocation String The preferred data location for the user. For more information, see OneDrive Online Multi-Geo.
    preferredLanguage String The preferred language for the user. Should follow ISO 639-1 Code; for example en-US.

    Returned by default. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values)
    preferredName String The preferred name for the user. Not Supported. This attribute returns an empty string.

    Returned only on $select.
    provisionedPlans provisionedPlan collection The plans that are provisioned for the user. Read-only. Not nullable.

    Returned only on $select. Supports $filter (eq, not, ge, le).
    proxyAddresses String collection For example: "SMTP: [email protected]", "smtp: [email protected]"]. Changes to the mail property will also 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 prefixed with smtp are the secondary proxy addresses. For Azure AD B2C accounts, this property has a limit of ten 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).
    refreshTokensValidFromDateTime DateTimeOffset Any refresh tokens or sessions tokens (session cookies) issued before this time are invalid, and applications will get an error when using an invalid refresh or sessions token to acquire a delegated access token (to access APIs such as Microsoft Graph). If this happens, the application will need to acquire a new refresh token by making a request to the authorize endpoint.

    Returned only on $select. Read-only.
    responsibilities String collection A list for the user to enumerate their responsibilities.

    Returned only on $select.
    schools String collection A list for the user to enumerate the schools they have attended.

    Returned only on $select.
    securityIdentifier String Security identifier (SID) of the user, used in Windows scenarios.

    Read-only. Returned by default.
    Supports $select and $filter (eq, not, ge, le, startsWith).
    showInAddressList Boolean 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.
    signInSessionsValidFromDateTime DateTimeOffset Any refresh tokens or sessions tokens (session cookies) issued before this time are invalid, and applications will get an error when using an invalid refresh or sessions token to acquire a delegated access token (to access APIs such as Microsoft Graph). If this happens, the application will need to acquire a new refresh token by making a request to the authorize endpoint. Read-only. Use revokeSignInSessions to reset.

    Returned only on $select.
    skills String collection A list for the user to enumerate their skills.

    Returned only on $select.
    state String 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).
    streetAddress String The street address of the user's place of business. Maximum length is 1024 characters.

    Returned only on $select. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).
    surname String 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).
    usageLocation String A two letter country code (ISO standard 3166). Required for users that will be assigned licenses due to legal requirement to check for availability of services in countries. 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).
    userPrincipalName String The user principal name (UPN) of the user. The UPN is an Internet-style login name for the user based on the Internet standard RFC 822. By convention, this should map to the user's email name. The general format is [email protected], where 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 cannot 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.
    userType String A string value that can be used to classify user types in your directory, such as Member and Guest.

    Returned only on $select. Supports $filter (eq, ne, not, in, and eq on null values). **N

    webApplication

    Property Type Description
    homePageUrl String Home page or landing page of the application.
    implicitGrantSettings implicitGrantSettings Specifies whether this web application can request tokens using the OAuth 2.0 implicit flow.
    logoutUrl String Specifies the URL that will be used by Microsoft's authorization service to logout an user using front-channel, back-channel or SAML logout protocols.
    redirectUris String collection Specifies the URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent.

    windowsApplication

    Property Type Description
    packageSid String The package security identifier that Microsoft has assigned the application. Optional. Read-only.
    redirectUris String collection Specifies the URLs where user tokens are sent for sign-in or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent. Only available for applications that support the PersonalMicrosoftAccount **s
    In This Article
    Back to top Created by merill | Submit feedback