Show / Hide Table of Contents

Directory.ReadWrite.All

Allows the app to read and write data in your organization's directory, such as users, and groups. It does not allow the app to delete users or groups, or reset user passwords.

Graph Methods

Type: A = Application Permission, D = Delegate Permission

Ver Type Method
V1 D DELETE /appCatalogs/teamsApps/{id}
Beta A,D DELETE /applications/{application ObjectId}/extensionProperties/{id}
Beta A,D DELETE /applications/{id}
V1 A,D DELETE /applications/{id}/owners/{id}/$ref
Beta A,D DELETE /applications/{id}/synchronization/templates/{templateId}/schema
Beta D DELETE /directory/deleteditems/{id}
V1 D DELETE /directory/deletedItems/{id}
V1 A,D DELETE /groupLifecyclePolicies/{id}
V1 A,D DELETE /groups/{id}/members/{id}/$ref
V1 A,D DELETE /groups/{id}/owners/{id}/$ref
V1 A,D DELETE /groupSettings/{groupSettingId}
Beta A,D DELETE /oauth2PermissionGrants/{id}
V1 A,D DELETE /oAuth2PermissionGrants/{id}
Beta D DELETE /onPremisesPublishingProfiles/{publishingType}/agents/{id1}/agentGroups/{id2}/$ref
Beta D DELETE /onPremisesPublishingProfiles/applicationProxy/connectorGroups/{id}
V1 D DELETE /policies/featureRolloutPolicies/{id}
V1 D DELETE /policies/featureRolloutPolicies/{policyId}/appliesTo/{directoryObjectId}/$ref
Beta A,D DELETE /roleManagement/deviceManagement/roleDefinitions/{id}
V1 A DELETE /schemaExtensions/{id}
Beta A,D DELETE /servicePrincipals/{id}
V1 A,D DELETE /servicePrincipals/{id}/owners/{id}/$ref
Beta A,D DELETE /servicePrincipals/{id}/synchronization/jobs/{jobId}/
Beta A,D DELETE /servicePrincipals/{id}/synchronization/jobs/{jobId}/schema
Beta A,D DELETE /settings/{directorySettingId}
V1 A,D DELETE /teams/{team-id}/channels/{channel-id}
V1 A,D DELETE /teams/{team-id}/channels/{channel-id}/tabs/{tab-id}
V1 A,D DELETE /teams/{team-id}/installedApps/{app-installation-id}
Beta D DELETE ~/onPremisesPublishingProfiles/{publishingType}/agentGroups/{id1}
Beta A,D GET /administrativeUnits
Beta A,D GET /administrativeUnits/{id}
Beta A,D GET /administrativeUnits/{id}/members
Beta A,D GET /administrativeUnits/{id}/members/{id}
Beta A,D GET /administrativeUnits/{id}/members/$ref
Beta A,D GET /administrativeUnits/{id}/scopedRoleMembers
Beta A,D GET /administrativeUnits/{id}/scopedRoleMembers/{id}
Beta D GET /administrativeUnits/delta
V1 D GET /appCatalogs/teamsApps
Beta D GET /applications
Beta A,D GET /applications/{application ObjectId}/extensionProperties
Beta A,D GET /applications/{id}
V1 A,D GET /applications/{id}/owners
Beta A GET /applications/{id}/synchronization/templates/{templateId}/schema
Beta A GET /applications/{id}/synchronization/templates/{templateId}/schema/filterOperators
Beta A GET /applications/{id}/synchronization/templates/{templateId}/schema/functions
V1 A,D GET /applications/delta
V1 A,D GET /contacts
V1 A,D GET /contacts/{id}
Beta A,D GET /contacts/{id}/directReports
Beta A,D GET /contacts/{id}/manager
Beta A,D GET /contacts/{id}/memberOf
V1 A,D GET /contacts/delta
V1 A,D GET /contracts
V1 A,D GET /contracts/{id}
V1 A,D GET /devices
V1 A,D GET /devices/{id | userPrincipalName}/transitiveMemberOf
V1 A,D GET /devices/{id}
V1 A,D GET /devices/{id}/memberOf
V1 A,D GET /devices/{id}/registeredOwners
V1 A,D GET /devices/{id}/registeredUsers
Beta A,D GET /devices/{id}/transitiveMemberOf
Beta A,D GET /devices/{objectId}/usageRights
V1 A,D GET /directory/administrativeUnits
V1 A,D GET /directory/administrativeUnits/{id}
V1 A,D GET /directory/administrativeUnits/{id}/members
V1 A,D GET /directory/administrativeUnits/{id}/members/{id}
V1 A,D GET /directory/administrativeUnits/{id}/members/$ref
V1 A,D GET /directory/administrativeUnits/{id}/scopedRoleMembers
V1 A,D GET /directory/administrativeUnits/{id}/scopedRoleMembers/{id}
Beta A,D GET /directory/deleteditems/{id}
V1 A,D GET /directory/deletedItems/{id}
V1 A,D GET /directory/deleteditems/microsoft.graph.application
V1 A,D GET /directory/deletedItems/microsoft.graph.device
Beta A,D GET /directory/deleteditems/microsoft.graph.group
V1 A,D GET /directory/deletedItems/microsoft.graph.group
V1 A,D GET /directory/deletedItems/microsoft.graph.user
V1 A,D GET /directoryRoles
V1 A,D GET /directoryRoles/{role-id}
V1 A,D GET /directoryRoles/{role-id}/members
V1 A,D GET /directoryroles/{role-id}/scopedMembers
V1 A,D GET /directoryRoles/delta
V1 A,D GET /directoryRoles/roleTemplateId={roleTemplateId}
V1 A,D GET /directoryRoles/roleTemplateId={roleTemplateId}/members
V1 A,D GET /directoryroles/roleTemplateId={roleTemplateId}/scopedMembers
V1 A,D GET /directoryRoleTemplates
V1 A,D GET /directoryRoleTemplates/{id}
Beta A,D GET /directorySettingTemplates
Beta A,D GET /directorySettingTemplates/{id}
V1 A,D GET /groupLifecyclePolicies
V1 A,D GET /groupLifecyclePolicies/{id}
V1 A,D GET /groups
V1 A,D GET /groups/{id}
V1 A,D GET /groups/{id}/appRoleAssignments
V1 A,D GET /groups/{id}/groupLifecyclePolicies
Beta A,D GET /groups/{id}/memberOf
V1 A,D GET /groups/{id}/transitiveMemberOf
V1 A,D GET /groups/delta
V1 A,D GET /groupSettings
V1 A,D GET /groupSettings/{groupSettingId}
V1 A,D GET /groupSettingTemplates
V1 A,D GET /groupSettingTemplates/{id}
V1 A,D GET /me
V1 A,D GET /me/createdObjects
V1 A,D GET /me/directReports
V1 A,D GET /me/joinedTeams
V1 A,D GET /me/licenseDetails
V1 A,D GET /me/manager
V1 A,D GET /me/memberOf
V1 A,D GET /me/ownedDevices
V1 A,D GET /me/ownedObjects
V1 A,D GET /me/registeredDevices
Beta A,D GET /me/scopedRoleMemberOf
V1 A,D GET /oauth2PermissionGrants
V1 A,D GET /oauth2PermissionGrants/{id}
V1 A,D GET /oauth2PermissionGrants/delta
Beta D GET /onPremisesPublishingProfiles/{publishingType}/agentGroups/{id}
Beta D GET /onPremisesPublishingProfiles/{publishingType}/agents
Beta D GET /onPremisesPublishingProfiles/{publishingType}/agents/{id1}/?$expand=agentGroups
Beta D GET /onPremisesPublishingProfiles/applicationProxy/connectorGroups
Beta D GET /onPremisesPublishingProfiles/applicationProxy/connectorGroups/{id}
Beta D GET /onPremisesPublishingProfiles/applicationProxy/connectorGroups/{id}/applications
Beta D GET /onPremisesPublishingProfiles/applicationProxy/connectorGroups/{id}/members
Beta D GET /onPremisesPublishingProfiles/applicationProxy/connectors
Beta D GET /onPremisesPublishingProfiles/applicationProxy/connectors/{id}
Beta D GET /onPremisesPublishingProfiles/applicationProxy/connectors/{id}/memberOf
V1 A,D GET /organization
V1 A,D GET /policies/adminConsentRequestPolicy
V1 D GET /policies/featureRolloutPolicies
V1 D GET /policies/featureRolloutPolicies/{id}
Beta A,D GET /roleManagement/cloudPC/roleDefinitions
Beta A,D GET /roleManagement/cloudPC/roleDefinitions/{id}
V1 A,D GET /roleManagement/directory/roleAssignments?$filter=principalId eq '{principal id}'
V1 A,D GET /roleManagement/directory/roleAssignments?$filter=roleDefinitionId eq '{roleDefinition id}'
V1 A,D GET /roleManagement/directory/roleAssignments/{id}
V1 A,D GET /roleManagement/directory/roleDefinitions
V1 A,D GET /roleManagement/directory/roleDefinitions/{id}
Beta A,D GET /roleManagement/directory/transitiveRoleAssignments?$filter=principalId eq '{principalId}'
V1 D GET /servicePrincipals
V1 A,D GET /servicePrincipals/{id}
V1 A,D GET /servicePrincipals/{id}/appRoleAssignedTo
V1 A,D GET /servicePrincipals/{id}/appRoleAssignments
V1 A,D GET /servicePrincipals/{id}/createdObjects
V1 A,D GET /servicePrincipals/{id}/memberOf
V1 A,D GET /servicePrincipals/{id}/oauth2PermissionGrants
V1 A,D GET /servicePrincipals/{id}/ownedObjects
V1 A,D GET /servicePrincipals/{id}/owners
Beta A,D GET /servicePrincipals/{id}/synchronization/jobs/
Beta A GET /servicePrincipals/{id}/synchronization/jobs/{jobId}/
Beta A GET /servicePrincipals/{id}/synchronization/jobs/{jobId}/schema
Beta A GET /servicePrincipals/{id}/synchronization/jobs/{jobId}/schema/filterOperators
Beta A GET /servicePrincipals/{id}/synchronization/jobs/{jobId}/schema/functions
Beta A GET /servicePrincipals/{id}/synchronization/templates/{templateId}/schema
Beta A GET /servicePrincipals/{id}/synchronization/templates/{templateId}/schema/filterOperators
Beta A GET /servicePrincipals/{id}/synchronization/templates/{templateId}/schema/functions
V1 A,D GET /servicePrincipals/{id}/transitiveMemberOf
V1 A,D GET /servicePrincipals/delta
Beta A,D GET /settings
Beta A,D GET /settings/{directorySettingId}
V1 A,D GET /subscribedSkus
V1 A,D GET /subscribedSkus/{id}
V1 A,D GET /teams/{id}/channels/{id}/tabs
V1 A,D GET /teams/{id}/installedApps/{id}
Beta A,D GET /teams/{id}/photo
V1 A,D GET /teams/{team-id}
V1 A,D GET /teams/{team-id}/channels
V1 A,D GET /teams/{team-id}/channels/{channel-id}
Beta A,D GET /teams/{team-id}/channels/{channel-id}/tabs
V1 A,D GET /teams/{team-id}/channels/{channel-id}/tabs/{tab-id}
V1 A,D GET /teams/{team-id}/installedApps
V1 A,D GET /users
V1 A,D GET /users/{id | user-principal-name}/joinedTeams
V1 A,D GET /users/{id | userPrincipalName}
V1 A,D GET /users/{id | userPrincipalName}/createdObjects
V1 A,D GET /users/{id | userPrincipalName}/directReports
V1 A,D GET /users/{id | userPrincipalName}/manager
V1 A,D GET /users/{id | userPrincipalName}/memberOf
V1 A,D GET /users/{id | userPrincipalName}/ownedDevices
V1 A,D GET /users/{id | userPrincipalName}/ownedObjects
V1 A,D GET /users/{id | userPrincipalName}/registeredDevices
V1 A,D GET /users/{id | userPrincipalName}/transitiveMemberOf
V1 A,D GET /users/{id}/licenseDetails
Beta A,D GET /users/{id}/scopedRoleMemberOf
Beta A,D GET /users/{userId}/usageRights
V1 A,D GET /users/delta
Beta D GET ~/onPremisesPublishingProfiles/{publishingType}/
Beta D GET ~/onPremisesPublishingProfiles/{publishingType}/agentGroups
Beta A GET applications/{id}/synchronization/templates
Beta A GET applications/{id}/synchronization/templates/{templateId}
Beta A GET servicePrincipals/{id}/synchronization/templates
Beta A GET servicePrincipals/{id}/synchronization/templates/{templateId}
Beta A,D PATCH /applications/{id}
V1 A PATCH /devices/{id}
V1 A,D PATCH /groupLifecyclePolicies/{id}
V1 A,D PATCH /groups/{id}
V1 A,D PATCH /groupSettings/{groupSettingId}
V1 A,D PATCH /oauth2PermissionGrants/{id}
Beta D PATCH /onPremisesPublishingProfiles/applicationProxy/connectorGroups/{id}
V1 D PATCH /policies/featureRolloutPolicies/{id}
Beta A,D PATCH /roleManagement/deviceManagement/roleDefinitions/{id}
V1 A PATCH /schemaExtensions/{id}
Beta A,D PATCH /servicePrincipals/{id}
Beta A,D PATCH /settings/{directorySettingId}
Beta A,D PATCH /teams/{id}/channels/{id}/members/{id}
Beta A,D PATCH /teams/{id}/members/{id}
V1 A,D PATCH /teams/{team-id}
V1 A,D PATCH /teams/{team-id}/channels/{channel-id}
V1 A,D PATCH /teams/{team-id}/channels/{channel-id}/tabs/{tab-id}
V1 A,D PATCH /users/{id | userPrincipalName}
Beta D PATCH ~/onPremisesPublishingProfiles/{publishingType}/agentGroups
Beta D PATCH ~/onPremisesPublishingProfiles/{publishingType}/hybridAgentUpdaterConfiguration
Beta A,D PATCH applications/{id}/synchronization/templates/{templateId}
Beta A,D POST /administrativeUnits/{id}/members/$ref
V1 D POST /appCatalogs/teamsApps
V1 D POST /appCatalogs/teamsApps/{id}/appDefinitions
Beta A,D POST /applications
Beta A,D POST /applications/{application ObjectId}/extensionProperties
Beta A,D POST /applications/{applicationsId}/synchronization/acquireAccessToken
Beta A,D POST /applications/{id}/addPassword
Beta A,D POST /applications/{id}/owners/$ref
Beta A,D POST /applications/{id}/removePassword
V1 A,D POST /applicationTemplates/{applicationTemplate-id}/instantiate
Beta A,D POST /applicationTemplates/{id}/instantiate
V1 A,D POST /directoryObjects/{id}/checkMemberGroups
V1 A,D POST /directoryObjects/{id}/checkMemberObjects
V1 A,D POST /directoryObjects/{id}/getMemberGroups
V1 A,D POST /directoryObjects/{id}/getMemberObjects
V1 A,D POST /directoryObjects/validateProperties
V1 A,D POST /groupLifecyclePolicies
V1 A,D POST /groupLifecyclePolicies/{id}/addGroup
V1 A,D POST /groupLifecyclePolicies/{id}/removeGroup
Beta A,D POST /groupLifecyclePolicies/renewGroup
V1 A,D POST /groups
V1 A,D POST /groups/{group-id}/members/$ref
V1 A,D POST /groups/{id}/assignLicense
V1 A,D POST /groups/{id}/owners/$ref
V1 A,D POST /groups/{id}/renew
V1 A,D POST /groupSettings
V1 A,D POST /invitations
Beta D POST /me/invalidateAllRefreshTokens
V1 A,D POST /me/revokeSignInSessions
V1 A,D POST /oauth2PermissionGrants
Beta D POST /onPremisesPublishingProfiles/{publishingType}/agents/{id1}/agentGroups/$ref
Beta A,D POST /onPremisesPublishingProfiles/applicationProxy/connectorGroups
Beta D POST /onPremisesPublishingProfiles/applicationProxy/connectorGroups/{id}/members/$ref
Beta D POST /onPremisesPublishingProfiles/applicationProxy/connectors/{id}/memberOf/$ref
Beta A,D POST /organization/{organizationId}/activateService
V1 D POST /policies/featureRolloutPolicies
V1 D POST /policies/featureRolloutPolicies/{id}/appliesTo/$ref
Beta A,D POST /roleManagement/deviceManagement/roleDefinitions
V1 A POST /schemaExtensions
Beta A,D POST /servicePrincipals
V1 A,D POST /servicePrincipals/{id}/addKey
Beta A,D POST /servicePrincipals/{id}/addPassword
V1 A,D POST /servicePrincipals/{id}/addTokenSigningCertificate
V1 A,D POST /servicePrincipals/{id}/appRoleAssignedTo
V1 A,D POST /servicePrincipals/{id}/appRoleAssignments
Beta A,D POST /servicePrincipals/{id}/createPasswordSingleSignOnCredentials
Beta A,D POST /servicePrincipals/{id}/deletePasswordSingleSignOnCredentials
Beta A,D POST /servicePrincipals/{id}/getPasswordSingleSignOnCredentials
Beta A,D POST /servicePrincipals/{id}/owners/$ref
Beta A,D POST /serviceprincipals/{id}/removeKey
V1 A,D POST /servicePrincipals/{id}/removeKey
Beta A,D POST /servicePrincipals/{id}/removePassword
Beta A,D POST /servicePrincipals/{id}/synchronization/jobs/
Beta A,D POST /servicePrincipals/{id}/synchronization/jobs/{id}/schema/parseExpression
Beta A,D POST /servicePrincipals/{id}/synchronization/jobs/{id}/validateCredentials
Beta A,D POST /servicePrincipals/{id}/synchronization/jobs/{jobId}/pause
Beta A,D POST /servicePrincipals/{id}/synchronization/jobs/{jobId}/restart
Beta A,D POST /servicePrincipals/{id}/synchronization/jobs/{jobId}/schema/directories/{directoryId}/discover
Beta A,D POST /servicePrincipals/{id}/synchronization/jobs/{jobId}/start
Beta A,D POST /servicePrincipals/{id}/synchronization/templates/{id}/schema/parseExpression
Beta A,D POST /servicePrincipals/{id}/updatePasswordSingleSignOnCredentials
Beta A,D POST /servicePrincipals/{servicePrincipalsId}/synchronization/acquireAccessToken
Beta A,D POST /servicePrincipals/{servicePrincipalsId}/synchronization/jobs/{synchronizationJobId}/provisionOnDemand
Beta A,D POST /settings
V1 A,D POST /teams
V1 A,D POST /teams/{id}/archive
Beta A,D POST /teams/{id}/channels/{id}/tabs
V1 A,D POST /teams/{id}/clone
V1 A,D POST /teams/{id}/unarchive
V1 A,D POST /teams/{team-id}/channels
V1 A,D POST /teams/{team-id}/channels/{channel-id}/tabs
V1 A,D POST /teams/{team-id}/installedApps
V1 A,D POST /teams/{team-id}/installedApps/{app-installation-id}/upgrade
V1 A,D POST /users
Beta A,D POST /users/{id | userPrincipalName}/activateServicePlan
V1 A,D POST /users/{id | userPrincipalName}/assignLicense
Beta D POST /users/{id | userPrincipalName}/invalidateAllRefreshTokens
V1 A,D POST /users/{id | userPrincipalName}/revokeSignInSessions
V1 A,D POST /users/{id}/reprocessLicenseAssignment
Beta D POST ~/onPremisesPublishingProfiles/{publishingType}/agentGroups/{id}/agents
Beta D PUT /applications/{id}/connectorGroup/$ref
Beta A,D PUT /applications/{id}/synchronization/templates/{templateId}/schema
V1 A,D PUT /groups/{id}/team
V1 A,D PUT /policies/adminConsentRequestPolicy
Beta A,D PUT /policies/adminConsentRequestPolicy
Beta A,D PUT /servicePrincipals/{id}/synchronization/jobs/{jobId}/schema
Beta A,D PUT /servicePrincipals/{id}/synchronization/secrets
V1 A,D PUT /users/{id}/manager/$ref

Delegate Permission

Id c5366453-9fb0-48a5-a156-24f0c49a4b84
Consent Type Admin
Display String Read and write directory data
Description Allows the app to read and write data in your organization's directory, such as users, and groups. It does not allow the app to delete users or groups, or reset user passwords.

Application Permission

Id 19dbc75e-c2e2-444c-a770-ec69d8559fc7
Display String Read and write directory data
Description Allows the app to read and write data in your organization's directory, such as users, and groups, without a signed-in user. Does not allow user or group deletion.

Resources

accessReviewReviewerScope

Property Type Description
query String The query specifying who will be the reviewer. See table for examples.
queryType String The type of query. Examples include MicrosoftGraph and ARM.
queryRoot String In the scenario where reviewers need to be specified dynamically, this property is used to indicate the relative source of the query. This property is only required if a relative query, for example, ./manager, is specified. Possible value: decisions.

addIn

Property Type Description
id guid
properties keyValue collection
type string

adminConsentRequestPolicy

Property Type Description
isEnabled Boolean Specifies whether the admin consent request feature is enabled or disabled. Required.
notifyReviewers Boolean Specifies whether reviewers will receive notifications. Required.
remindersEnabled Boolean Specifies whether reviewers will receive reminder emails. Required.
requestDurationInDays Int32 Specifies the duration the request is active before it automatically expires if no decision is applied.
reviewers accessReviewReviewerScope collection The list of reviewers for the admin consent. Required.
version Int32 Specifies the version of this policy. When the policy is updated, this version is updated. Read-only.

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.
applicationTemplateId String Unique identifier of the applicationTemplate. Supports $filter (eq, not, ne).
appRoles appRole collection The collection of roles assigned to the application. With app role assignments, these roles can be assigned to users, groups, or service principals associated with other applications. Not nullable.
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 The unique identifier for the application. 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. Not nullable.

Supports $filter (eq, not, ge, le).
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 below.

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, group, or service principal being granted the app role. 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

assignedLabel

Property Type Description
labelId String The unique identifier of the label.
displayName String The display name of the label. Read-only.

assignedLicense

Property Type Description
disabledPlans Guid collection A collection of the unique identifiers for plans that have been disabled.
skuId Guid The unique identifier for the SKU.

channel

Property Type Description
description String Optional textual description for the channel.
displayName String Channel name as it will appear to the user in Microsoft Teams.
id String The channel's unique identifier. Read-only.
isFavoriteByDefault Boolean Indicates whether the channel should automatically be marked 'favorite' for all members of the team. Can only be set programmatically with Create team. Default: false.
email String The email address for sending messages to the channel. Read-only.
webUrl String A hyperlink that will go to the channel in Microsoft Teams. This is the URL that you get when you right-click a channel in Microsoft Teams and select Get link to channel. This URL should be treated as an opaque blob, and not parsed. Read-only.
membershipType channelMembershipType The type of the channel. Can be set during creation and can't be changed. Possible values are: standard - Channel inherits the list of members of the parent team; private - Channel can have members that are a subset of all the members on the parent team.
createdDateTime dateTimeOffset Read only. Timestamp at which the channel was created.

channelModerationSettings

Property Type Description
allowNewMessageFromBots Boolean Indicates whether bots are allowed to post messages.
allowNewMessageFromConnectors Boolean Indicates whether connectors are allowed to post messages.
replyRestriction replyRestriction Indicates who is allowed to reply to the teams channel. Possible values are: everyone, authorAndModerators, unknownFutureValue.
userNewMessageRestriction userNewMessageRestriction Indicates who is allowed to post messages to teams channel. Possible values are: everyone, everyoneExceptGuests, moderators, unknownFutureValue.

clonableteamparts

connector

Property Type Description
externalIp String The external IP address as detected by the the connector server. Read-only.
id String Unique identifier of the connector. Read-only.
machineName String The machine name the connector is installed and running on.
status connectorStatus Indicates the status of the connector. Possible values are: active, inactive. Read-only.

connectorGroup

Property Type Description
connectorGroupType connectorGroupType Indicates the type of hybrid agent. This pre-set by the system. Possible values are: applicationProxy. Read-only.
id string Unique identifier for this connectorGroup. Read-only.
isDefault boolean Indicates if the connectorGroup is the default connectorGroup. Only a single connector group can be the default connectorGroup and this is pre-set by the system. Read-only.
name string The name associated with the connectorGroup.
region connectorGroupRegion The region the connectorGroup is assigned to and will optimize traffic for. This region can only be set if **n

Contract

Property Type Description
contractType String Type of contract. Possible values are: SyndicationPartner, BreadthPartner, ResellerPartner. See more in the table below.
customerId Guid The unique identifier for the customer tenant referenced by this partnership. Corresponds to the id property of the customer tenant's organization resource.
defaultDomainName String A copy of the customer tenant's default domain name. The copy is made when the partnership with the customer is established. It is not automatically updated if the customer tenant's default domain name changes.
displayName String A copy of the customer tenant's display name. The copy is made when the partnership with the customer is established. It is not automatically updated if the customer tenant's display name changes.
id String The unique identifier for the partnership. Key, read-only

conversationMember

Property Type Description
id String Read-only. Unique ID of the user.
displayName string The display name of the user.
roles string collection The roles for that user.
visibleHistoryStartDateTime DateTimeOffset The timestamp denoting how far back a conversation's history is shared with the conversation member. This property is settable only for members of a chat.

credential

Property Type Description
fieldId String The name of the field for this credential. e.g, username or password or phoneNumber. This is defined by the application. Must match what is in the html field on singleSignOnSettings/password object.
type String The type for this credential. Valid values: username, password, or other.
value String The value for this credential. e.g, mysuperhiddenpassword. Note the value for passwords is write-only, the value can never be read back.

customSecurityAttributeValue

device

Property Type Description
accountEnabled Boolean true if the account is enabled; otherwise, false. Required. Default is true.

Supports $filter (eq, ne, not, in). Only callers in Global Administrator and Cloud Device Administrator roles can set this property.
alternativeSecurityIds alternativeSecurityId collection For internal use only. Not nullable. Supports $filter (eq, not, ge, le).
approximateLastSignInDateTime DateTimeOffset The timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. Supports $filter (eq, ne, not, ge, le, and eq on null values) and $orderBy.
complianceExpirationDateTime DateTimeOffset The timestamp when the device is no longer deemed compliant. The timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.
deviceId String Unique identifier set by Azure Device Registration Service at the time of registration. Supports $filter (eq, ne, not, startsWith).
deviceMetadata String For internal use only. Set to null.
deviceVersion Int32 For internal use only.
displayName String The display name for the device. Required. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values), $search, and $orderBy.
extensionAttributes onPremisesExtensionAttributes Contains extension attributes 1-15 for the device. The individual extension attributes are not selectable. These properties are mastered in cloud and can be set during creation or update of a device object in Azure AD.

Supports $filter (eq, not, startsWith, and eq on null values).
id String The unique identifier for the device. Inherited from directoryObject. Key, Not nullable. Read-only. Supports $filter (eq, ne, not, in).
isCompliant Boolean true if the device complies with Mobile Device Management (MDM) policies; otherwise, false. Read-only. This can only be updated by Intune for any device OS type or by an approved MDM app for Windows OS devices. Supports $filter (eq, ne, not).
isManaged Boolean true if the device is managed by a Mobile Device Management (MDM) app; otherwise, false. This can only be updated by Intune for any device OS type or by an approved MDM app for Windows OS devices. Supports $filter (eq, ne, not).
manufacturer String Manufacturer of the device. Read-only.
mdmAppId String Application identifier used to register device into MDM. Read-only. Supports $filter (eq, ne, not, startsWith).
model String Model of the device. Read-only.
onPremisesLastSyncDateTime DateTimeOffset The last time at which the object was synced with the on-premises directory. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z Read-only. Supports $filter (eq, ne, not, ge, le, in).
onPremisesSyncEnabled Boolean true if this object is synced from an on-premises directory; false if this object was originally synced from an on-premises directory but is no longer synced; null if this object has never been synced from an on-premises directory (default). Read-only. Supports $filter (eq, ne, not, in, and eq on null values).
operatingSystem String The type of operating system on the device. Required. Supports $filter (eq, ne, not, ge, le, startsWith, and eq on null values).
operatingSystemVersion String The version of the operating system on the device. Required. Supports $filter (eq, ne, not, ge, le, startsWith, and eq on null values).
physicalIds String collection For internal use only. Not nullable. Supports $filter (eq, not, ge, le, startsWith, and counting empty collections).
profileType deviceProfileType The profile type of the device. Possible values: RegisteredDevice (default), SecureVM, Printer, Shared, IoT.
systemLabels String collection List of labels applied to the device by the system. Supports $filter (eq when counting empty collections).
trustType String Type of trust for the joined device. Read-only. Possible values: Workplace (indicates *b

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

directoryRole

Property Type Description
description String The description for the directory role. Read-only. Supports $filter (eq), $search, $select.
displayName String The display name for the directory role. Read-only. Supports $filter (eq), $search, $select.
id String The unique identifier for the directory role. Inherited from directoryObject. Key, Not nullable, Read-only. Supports $filter (eq), $select.
roleTemplateId String The **i

directoryRoleTemplate

Property Type Description
description String The description to set for the directory role. Read-only.
displayName String The display name to set for the directory role. Read-only.
id String The unique identifier for the template. Inherited from directoryObject. You specify the **i

directorySetting

Property Type Description
displayName string Display name of this group of settings, which comes from the associated template. Read-only.
id string Unique identifier for these settings. Read-only.
templateId string Unique identifier for the template used to create this group of settings. Read-only.
values settingValue collection Collection of name-value pairs corresponding to the name and defaultValue properties in the referenced directorySettingTemplates object.

directorySettingTemplate

Property Type Description
description string Description of the template. Read-only.
displayName string Display name of the template. Read-only.
id string Unique identifier for the template. Read-only.
values settingTemplateValue collection Collection of settingTemplateValues that list the set of available settings, defaults and types that make up this template. Read-only.

enums

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.
targetObjects String collection Following values are supported. Not nullable.
  • User
  • Group
  • Organization
  • Device
  • Application

extensionSchemaProperty

Property Type Description
name String The name of the strongly-typed property defined as part of a schema extension.
type String The type of the property that is defined as part of a schema extension. Allowed values are *B

featureRolloutPolicy

Property Type Description
description String A description for this feature rollout policy.
displayName String The display name for this feature rollout policy.
feature stagedFeatureName Possible values are: passthroughAuthentication, seamlessSso, passwordHashSync, emailAsAlternateId, unknownFutureValue.
id String Read-only.
isAppliedToOrganization Boolean Indicates whether this feature rollout policy should be applied to the entire organization.
isEnabled Boolean Indicates whether the feature rollout is enabled.

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. Read-only.
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.

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 deternunes whether the team is in read-only mode.
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 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 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

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, and counting empty collections).
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.

groupLifecyclePolicy

Property Type Description
alternateNotificationEmails String List of email address to send notifications for groups without owners. Multiple email address can be defined by separating email address with a semicolon.
groupLifetimeInDays Int32 Number of days before a group expires and needs to be renewed. Once renewed, the group expiration is extended by the number of days defined.
id String A unique identifier for a policy. Read-only.
managedGroupTypes String The group type for which the expiration policy applies. Possible values are **A

groupSetting

Property Type Description
displayName String Display name of this group of settings, which comes from the associated template.
id String Unique identifier for these settings. Read-only.
templateId String Unique identifier for the tenant-level groupSettingTemplates object that's been customized for this group-level settings object. Read-only.
values settingValue collection Collection of name-value pairs corresponding to the **n

groupSettingTemplate

Property Type Description
description String Description of the template.
displayName String Display name of the template. The template named Group.Unified can be used to configure tenant-wide Microsoft 365 group settings, while the template named Group.Unified.Guest can be used to configure group-specific settings.
id String Unique identifier for the template. Read-only.
values settingTemplateValue collection Collection of settingTemplateValues that list the set of available settings, defaults and types that make up this template.

hybridAgentUpdaterConfiguration

Property Type Description
allowUpdateConfigurationOverride Boolean Indicates if updater configuration will be skipped and the agent will receive an update when the next version of the agent is available.
deferUpdateDateTime DateTimeOffset 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
updateWindow updateWindow

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

invitation

Property Type Description
invitedUserDisplayName String The display name of the user being invited.
invitedUserEmailAddress String The email address of the user being invited. Required. The following special characters are not permitted in the email address:
  • Tilde (~)
  • Exclamation point (!)
  • Number sign (#)
  • Dollar sign ($)
  • Percent (%)
  • Circumflex (^)
  • Ampersand (&)
  • Asterisk (*)
  • Parentheses (( ))
  • Plus sign (+)
  • Equal sign (=)
  • Brackets ([ ])
  • Braces ({ })
  • Backslash (\)
  • Slash mark (/)
  • Pipe (\|)
  • Semicolon (;)
  • Colon (:)
  • Quotation marks (")
  • Angle brackets (< >)
  • Question mark (?)
  • Comma (,)

However, the following exceptions apply:
  • A period (.) or a hyphen (-) is permitted anywhere in the user name, except at the beginning or end of the name.
  • An underscore (_) is permitted anywhere in the user name. This includes at the beginning or end of the name.
invitedUserMessageInfo invitedUserMessageInfo Additional configuration for the message being sent to the invited user, including customizing message text, language and cc recipient list.
sendInvitationMessage Boolean Indicates whether an email should be sent to the user being invited. The default is false.
inviteRedirectUrl String The URL the user should be redirected to once the invitation is redeemed. Required.
inviteRedeemUrl String The URL the user can use to redeem their invitation. Read-only.
invitedUserType String The userType of the user being invited. By default, this is Guest. You can invite as Member if you are a company administrator.
status String The status of the invitation. Possible values are: PendingAcceptance, Completed, InProgress, and Error.

invitedusermessageinfo

Property Type Description
ccRecipients Recipient collection Additional recipients the invitation message should be sent to. Currently only 1 additional recipient is supported.
customizedMessageBody String Customized message body you want to send if you don't want the default message.
messageLanguage String The language you want to send the default message in. If the customizedMessageBody is specified, this property is ignored, and the message is sent using the customizedMessageBody. The language format should be in ISO 639. The default is en-US.

keyCredential

Property Type Description
customKeyIdentifier Binary Custom key identifier
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.

licenseDetails

Property Type Description
id String The unique identifier for the license detail object. Read-only, Key, Not nullable
servicePlans servicePlanInfo collection Information about the service plans assigned with the license. Read-only, Not nullable
skuId Guid Unique identifier (GUID) for the service SKU. Equal to the skuId property on the related SubscribedSku object. Read-only
skuPartNumber String Unique SKU display name. Equal to the skuPartNumber on the related SubscribedSku object; for example: "AAD_Premium". Read-only

oAuth2PermissionGrant

Property Type Description
id String Unique identifier for the oAuth2PermissionGrant. Read-only.
clientId String The id of the client service principal for the application which is authorized to act on behalf of a signed-in user when accessing an API. Required. Supports $filter (eq only).
consentType String Indicates if authorization is granted for the client application to impersonate all users or only a specific user. AllPrincipals indicates authorization to impersonate all users. Principal indicates authorization to impersonate a specific user. Consent on behalf of all users can be granted by an administrator. Non-admin users may be authorized to consent on behalf of themselves in some cases, for some delegated permissions. Required. Supports $filter (eq only).
principalId String The id of the user on behalf of whom the client is authorized to access the resource, when consentType is Principal. If consentType is AllPrincipals this value is null. Required when consentType is Principal.
resourceId String The id of the resource service principal to which access is authorized. This identifies the API which the client is authorized to attempt to call on behalf of a signed-in user.
scope String A space-separated list of the claim values for delegated permissions which should be included in access tokens for the resource application (the API). For example, openid User.Read GroupMember.Read.All. Each claim value should match the **v

objectIdentity

Property Type Description
signInType String Specifies the user sign-in types in your directory, such as emailAddress, userName, federated, or userPrincipalName. federated represents a unique identifier for a user from an issuer, that can be in any format chosen by the issuer. Setting or updating a userPrincipalName identity will update the value of the userPrincipalName property on the user object. The validations performed on the userPrincipalName property on the user object, for example, verified domains and acceptable characters, will be performed when setting or updating a userPrincipalName identity. Additional validation is enforced on issuerAssignedId when the sign-in type is set to emailAddress or userName. This property can also be set to any custom string.
issuer string Specifies the issuer of the identity, for example facebook.com.
For local accounts (where signInType is not federated), this property is the local B2C tenant default domain name, for example contoso.onmicrosoft.com.
For external users from other Azure AD organization, this will be the domain of the federated organization, for example contoso.com.

Supports $filter. 512 character limit.
issuerAssignedId string Specifies the unique identifier assigned to the user by the issuer. The combination of **i

onPremisesAgent

Property Type Description
externalIp String The external IP address as detected by the service for the agent machine. Read-only
id String The object id of the onPremisesAgent. Read-only.
machineName String The name of the machine that the aggent is running on. Read-only
status agentStatus Possible values are: active, inactive.
publishingType String Possible values are: applicationProxy, exchangeOnline, authentication, provisioning, adAdministration.

onPremisesAgentGroup

Property Type Description
displayName String Display name of the onPremisesAgentGroup.
id String The object ID of the onPremisesAgentGroup. Read-only.
isDefault Boolean Indicates if the onPremisesAgentGroup is the default agent group. Only a single agent group can be the default onPremisesAgentGroup and is set by the system.
publishingType String Possible values are: applicationProxy, exchangeOnline, authentication, provisioning, adAdministration.

onPremisesExtensionAttributes

Property Type Description
extensionAttribute1 String First customizable extension attribute.
extensionAttribute2 String Second customizable extension attribute.
extensionAttribute3 String Third customizable extension attribute.
extensionAttribute4 String Fourth customizable extension attribute.
extensionAttribute5 String Fifth customizable extension attribute.
extensionAttribute6 String Sixth customizable extension attribute.
extensionAttribute7 String Seventh customizable extension attribute.
extensionAttribute8 String Eighth customizable extension attribute.
extensionAttribute9 String Ninth customizable extension attribute.
extensionAttribute10 String Tenth customizable extension attribute.
extensionAttribute11 String Eleventh customizable extension attribute.
extensionAttribute12 String Twelfth customizable extension attribute.
extensionAttribute13 String Thirteenth customizable extension attribute.
extensionAttribute14 String Fourteenth customizable extension attribute.
extensionAttribute15 String Fifteenth customizable extension attribute.

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.
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.

onPremisesPublishingProfile

Property Type Description
hybridAgentUpdaterConfiguration hybridAgentUpdaterConfiguration Represents a hybridAgentUpdaterConfiguration object.
id String Represents a publishing type. Possible values are: applicationProxy, exchangeOnline, authentication, provisioning, adAdministration. Read-only.
isEnabled Boolean Represents if Azure AD Application Proxy is enabled for the tenant.

organization

Property Type Description
assignedPlans assignedPlan collection The collection of service plans associated with the tenant. Not nullable.
businessPhones String collection Telephone number for the organization. Although this is a string collection, only one number can be set for this property.
city String City name of the address for the organization.
country String Country/region name of the address for the organization.
countryLetterCode String Country or region abbreviation for the organization in ISO 3166-2 format.
createdDateTime DateTimeOffset Timestamp of when the organization was created. The value cannot be modified and is automatically populated when the organization 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. Read-only.
deletedDateTime DateTimeOffset Represents date and time of when the Azure AD tenant was deleted 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.
displayName String The display name for the tenant.
id String The tenant ID, a unique identifier representing the organization (or tenant). Inherited from directoryObject. Key. Not nullable. Read-only.
isMultipleDataLocationsForServicesEnabled Boolean true if organization is Multi-Geo enabled; false if organization is not Multi-Geo enabled; null (default). Read-only. For more information, see OneDrive Online Multi-Geo.
marketingNotificationEmails String collection Not nullable.
onPremisesLastSyncDateTime DateTimeOffset The time and date at which the tenant was last synced with the on-premises directory. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.
onPremisesSyncEnabled Boolean true if this object is synced from an on-premises directory; false if this object was originally synced from an on-premises directory but is no longer synced. Nullable. null if this object has never been synced from an on-premises directory (default).
postalCode String Postal code of the address for the organization.
preferredLanguage String The preferred language for the organization. Should follow ISO 639-1 Code; for example, en.
privacyProfile privacyProfile The privacy profile of an organization.
provisionedPlans ProvisionedPlan collection Not nullable.
securityComplianceNotificationMails String collection
securityComplianceNotificationPhones String collection
state String State name of the address for the organization.
street String Street name of the address for organization.
technicalNotificationMails String collection Not nullable.
verifiedDomains VerifiedDomain collection The collection of domains associated with this tenant. Not nullable.

orgContact

Property Type Description
addresses physicalOfficeAddress collection Postal addresses for this organizational contact. For now a contact can only have one physical address.
companyName String Name of the company that this organizational contact belongs to. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).
department String The name for the department in which the contact works. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).
displayName String Display name for this organizational contact. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values), $search, and $orderBy.
givenName String First name for this organizational contact. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).
id String Unique identifier for this organizational contact. Supports $filter (eq, ne, not, in).
jobTitle String Job title for this organizational contact. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).
mail String The SMTP address for the contact, for example, "[email protected]". Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).
mailNickname String Email alias (portion of email address pre-pending the @ symbol) for this organizational contact. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).
onPremisesLastSyncDateTime DateTimeOffset Date and time when this organizational contact was last synchronized from on-premises AD. This 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. Supports $filter (eq, ne, not, ge, le, in).
onPremisesProvisioningErrors onPremisesProvisioningError collection List of any synchronization provisioning errors for this organizational contact. Supports $filter (eq, not).
onPremisesSyncEnabled Boolean true if this object is synced from an on-premises directory; false if this object was originally synced from an on-premises directory but is no longer synced and now mastered in Exchange; null if this object has never been synced from an on-premises directory (default).

Supports $filter (eq, ne, not, in, and eq on null values).
phones phone collection List of phones for this organizational contact. Phone types can be mobile, business, and businessFax. Only one of each type can ever be present in the collection.
proxyAddresses String collection For example: "SMTP: [email protected]", "smtp: [email protected]". The any operator is required for filter expressions on multi-valued properties. Supports $filter (eq, not, ge, le, startsWith, and counting empty collections).
surname String Last name for this organizational contact. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).

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.

passwordProfile

Property Type Description
forceChangePasswordNextSignIn Boolean true if the user must change her password on the next login; otherwise false. If not set, default is false. NOTE: For Azure B2C tenants, set to false and instead use custom policies and user flows to force password reset at first sign in. See Force password reset at first logon.
forceChangePasswordNextSignInWithMfa Boolean If true, at next sign-in, the user must perform a multi-factor authentication (MFA) before being forced to change their password. The behavior is identical to forceChangePasswordNextSignIn except that the user is required to first perform a multi-factor authentication before password change. After a password change, this property will be automatically reset to false. If not set, default is false.
password String The password for the user. This property is required when a user is created. It can be updated, but the user will be required to change the password on the next login. The password must satisfy minimum requirements as specified by the user’s **p

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.

schemaextension

Property Type Description
description String Description for the schema extension. Supports $filter (eq).
id String The unique identifier for the schema extension definition.
You can assign a value in one of two ways:
  • Concatenate the name of one of your verified domains with a name for the schema extension to form a unique string in this format, {domainName}_{schemaName}. As an example, contoso_mySchema.
  • Provide a schema name, and let Microsoft Graph use that schema name to complete the id assignment in this format: ext{8-random-alphanumeric-chars}_{schema-name}. An example would be extkvbmkofy_mySchema.
This property cannot be changed after creation. Supports $filter (eq). Note: We recommend that your id starts with an alphabetic letter between A-Z because query capabilities might be limited for IDs that begin with integers.
owner String The appId of the application that is the owner of the schema extension. This property can be supplied on creation, to set the owner. If not supplied, then the calling application's appId will be set as the owner. In either case, the signed-in user must be the owner of the application. So, for example, if creating a new schema extension definition using Graph Explorer, you must supply the owner property. Once set, this property is read-only and cannot be changed. Supports $filter (eq).
properties extensionSchemaProperty collection The collection of property names and types that make up the schema extension definition.
status String The lifecycle state of the schema extension. Possible states are InDevelopment, Available, and Deprecated. Automatically set to InDevelopment on creation. Schema extensions provides more information on the possible state transitions and behaviors. Supports $filter (eq).
targetTypes String collection Set of Microsoft Graph types (that can support extensions) that the schema extension can be applied to. Select from **c

scopedRoleMembership

Property Type Description
administrativeUnitId string Unique identifier for the administrative unit that the directory role is scoped to
id string Unique identifier for the scoped-role membership. Read-only.
roleId string Unique identifier for the directory role that the member is in.
roleMemberInfo identity Role member identity information. Represents the user that is a member of this scoped-role.

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.
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.
key Binary The value for the key credential. Should be a Base-64 encoded value.
thumbprint String The thumbprint value for the key.

servicePrincipal

Property Type Description
accountEnabled Boolean true if the service principal account is enabled; otherwise, false. 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.
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.

settingValue

Property Type Description
name String Name of the setting (as defined by the groupSettingTemplate).
value String Value of the setting.

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.

subscribedSku

Property Type Description
appliesTo String For example, "User" or "Company".
capabilityStatus String Possible values are: Enabled, Warning, Suspended, Deleted, LockedOut. The capabilityStatus is Enabled if the prepaidUnits property has at least 1 unit that is enabled, and LockedOut if the customer cancelled their subscription.
consumedUnits Int32 The number of licenses that have been assigned.
id String The unique identifier for the subscribed sku object. Key, not nullable.
prepaidUnits licenseUnitsDetail Information about the number and status of prepaid licenses.
servicePlans servicePlanInfo collection Information about the service plans that are available with the SKU. Not nullable
skuId Guid The unique identifier (GUID) for the service SKU.
skuPartNumber String The SKU part number; for example: "AAD_PREMIUM" or "RMSBASIC". To get a list of commercial subscriptions that an organization has acquired, see List subscribedSkus.

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: Full, QuarantineState, Watermark, Escrows, ConnectorDataStore. Use Full if you want all of the options.

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.

team

Property Type Description
displayName string The name of the team.
description string An optional description for the team. Maximum length: 1024 characters.
classification string An optional label. Typically describes the data or business sensitivity of the team. Must match one of a pre-configured set in the tenant's directory.
specialization teamSpecialization Optional. Indicates whether the team is intended for a particular use case. Each team specialization has access to unique behaviors and experiences targeted to its use case.
visibility teamVisibilityType The visibility of the group and team. Defaults to Public.
funSettings teamFunSettings Settings to configure use of Giphy, memes, and stickers in the team.
guestSettings teamGuestSettings Settings to configure whether guests can create, update, or delete channels in the team.
internalId string A unique ID for the team that has been used in a few places such as the audit log/Office 365 Management Activity API.
isArchived Boolean Whether this team is in read-only mode.
memberSettings teamMemberSettings Settings to configure whether members can perform certain actions, for example, create channels and add bots, in the team.
messagingSettings teamMessagingSettings Settings to configure messaging and mentions in the team.
webUrl string (readonly) A hyperlink that will go to the team in the Microsoft Teams client. This is the URL that you get when you right-click a team in the Microsoft Teams client and select Get link to team. This URL should be treated as an opaque blob, and not parsed.
createdDateTime dateTimeOffset Timestamp at which the team was created.

teamsApp

Property Type Description
id string The catalog app's generated app ID (different from the developer-provided ID in the Microsoft Teams zip app package.
externalId string The ID of the catalog provided by the app developer in the Microsoft Teams zip app package.
displayName string The name of the catalog app provided by the app developer in the Microsoft Teams zip app package.
distributionMethod teamsAppDistributionMethod The method of distribution for the app. Read-only.

teamsAppDefinition

Property Type Description
id string A unique ID (not the Teams app ID).
teamsAppId string The ID from the Teams app manifest.
publishingState string The published status of a specific version of a Teams app. Possible values are:
submitted — The specific version of the Teams app has been submitted and is under review.
published — The request to publish the specific version of the Teams app has been approved by the admin and the app is published.
rejected — The request to publish the specific version of the Teams app was rejected by the admin.
displayName string The name of the app provided by the app developer.
version string The version number of the application.
shortDescription string Short description of the application.
description string Verbose description of the application.

teamsAppInstallation

Property Type Description
id string A unique ID (not the Teams app ID).

teamsAsyncOperation

Property Type Description
id string Unique operation id.
operationType teamsAsyncOperationType Denotes which type of operation is being described.
createdDateTime DateTimeOffset Time when the operation was created.
status teamsAsyncOperationStatus Operation status.
lastActionDateTime DateTimeOffset Time when the async operation was last updated.
attemptsCount Int32 Number of times the operation was attempted before being marked successful or failed.
targetResourceId guid The ID of the object that's created or modified as result of this async operation, typically a team.
targetResourceLocation string The location of the object that's created or modified as result of this async operation. This URL should be treated as an opaque value and not parsed into its component paths.
error operationError Any error that causes the async operation to fail.

teamsTab

Property Type Description
id string Identifier that uniquely identifies a specific instance of a channel tab. Read only.
displayName string Name of the tab.
webUrl string Deep link URL of the tab instance. Read only.
configuration teamsTabConfiguration Container for custom settings applied to a tab. The tab is considered configured only once this property is set.

teamvisibilitytype

teamworkBot

Property Type Description
id String The ID of the bot associated with the specific teamsAppDefinition. This value is usually a GUID.

unifiedRoleAssignment

Property Type Description
id String The unique identifier for the role assignment. Key, not nullable, Read-only. Inherited from entity.
roleDefinitionId String Identifier of the role definition the assignment is for. Read only. Supports $filter (eq, in).
principalId String Identifier of the principal to which the assignment is granted. Supports $filter (eq, in).
directoryScopeId String Identifier of the directory object representing the scope of the assignment. Either this property or appScopeId is required. The scope of an assignment determines the set of resources for which the principal has been granted access. Directory scopes are shared scopes stored in the directory that are understood by multiple applications. Use / for tenant-wide scope. Use appScopeId to limit the scope to an application only. Supports $filter (eq, in).
appScopeId String Identifier of the app-specific scope when the assignment scope is app-specific. Either this property or **d

unifiedRoleDefinition

Property Type Description
description String The description for the unifiedRoleDefinition. Read-only when isBuiltIn is true.
displayName String The display name for the unifiedRoleDefinition. Read-only when isBuiltIn is true. Required. Supports $filter (eq, in).
id String The unique identifier for the role definition. Key, not nullable, Read-only. Inherited from entity. Supports $filter (eq, in).
isBuiltIn Boolean Flag indicating whether the role definition is part of the default set included in Azure Active Directory (Azure AD) or a custom definition. Read-only. Supports $filter (eq, in).
isEnabled Boolean Flag indicating whether the role is enabled for assignment. If false the role is not available for assignment. Read-only when isBuiltIn is true.
resourceScopes String collection List of the scopes or permissions the role definition applies to. Currently only / is supported. Read-only when isBuiltIn is true. DO NOT USE. This will be deprecated soon. Attach scope to role assignment.
rolePermissions unifiedRolePermission collection List of permissions included in the role. Read-only when isBuiltIn is true. Required.
templateId String Custom template identifier that can be set when isBuiltIn is false but is read-only when isBuiltIn is true. This identifier is typically used if one needs an identifier to be the same across different directories.
version String Indicates version of the role definition. Read-only when **i

unifiedRolePermission

Property Type Description
allowedResourceActions String collection Set of tasks that can be performed on a resource. Required.
condition String Optional constraints that must be met for the permission to be effective.
excludedResourceActions String collection Set of tasks that may not be performed on a resource. Not yet supported.

usageRight

Property Type Description
catalogId String Product id corresponding to the usage right.
id String The id of the usage right.
serviceIdentifier String Identifier of the service corresponding to the usage right.
state usageRightState The state of the usage right. Possible values are: active, inactive, warning, suspended.

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. Not nullable. Returned only on $select. Supports $filter (eq, not, and counting empty collections).
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 created date of the user object. 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. 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. For Azure AD B2C accounts, this property can be updated up to only ten times with unique SMTP addresses. This property cannot contain accent characters.

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. The individual extension attributes are neither selectable nor filterable.
  • 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.

  • These extension attributes are also known as Exchange custom attributes 1-15.
    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 object is synced from an on-premises directory; false if this object was originally synced from an on-premises directory but is no longer synced; null if this object has never been synced from an on-premises directory (default). Read-only.

    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, and counting empty collections).
    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. NOTE: For Azure B2C tenants, the forceChangePasswordNextSignIn property should be set to false and instead use custom policies and user flows to force password reset at first logon. See Force password reset at first logon.

    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.

    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, and counting empty collections).
    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.
    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.
    skills String collection A list for the user to enumerate their skills.

    Returned only on $select.
    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.
    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