Show / Hide Table of Contents

Directory.Read.All

Allows the app to read data in your organization's directory, such as users, groups and apps.

Graph Methods

Type: A = Application Permission, D = Delegate Permission

Ver Type Method
V1 A,D ConsistencyLevel: eventual
V1 A,D GET /administrativeUnits
V1 A,D GET /administrativeUnits/{id}
V1 A,D GET /administrativeUnits/{id}/members
V1 A,D GET /administrativeUnits/{id}/members/{id}
V1 A,D GET /administrativeUnits/{id}/members/$ref
V1 A,D GET /administrativeUnits/{id}/scopedRoleMembers
V1 A,D GET /administrativeUnits/{id}/scopedRoleMembers/{id}
V1 A,D GET /administrativeUnits/delta
V1 D GET /appCatalogs/teamsApps
V1 A,D GET /applications
V1 A,D GET /applications(appId='{appId}')
V1 A,D GET /applications(appId='{appId}')/owners
V1 A,D GET /applications/{application ObjectId}/extensionProperties
V1 D GET /applications/{application ObjectId}/extensionProperties/{extensionPropertyId}
V1 A,D GET /applications/{applicationObjectId}
V1 A,D GET /applications/{id}/owners
V1 D GET /applications/{id}/synchronization/templates/{templateId}/schema
V1 D GET /applications/{id}/synchronization/templates/{templateId}/schema/filterOperators
V1 D GET /applications/{id}/synchronization/templates/{templateId}/schema/functions
V1 A,D GET /applications/delta
V1 A,D GET /auditLogs/directoryaudits
V1 A,D GET /auditLogs/directoryAudits
V1 A,D GET /auditLogs/directoryAudits/{id}
V1 A,D GET /auditLogs/provisioning
V1 A,D GET /auditLogs/signIns/{id}
V1 A,D GET /contacts
V1 A,D GET /contacts/{id}
V1 A,D GET /contacts/{id}/directReports
V1 A,D GET /contacts/{id}/manager
V1 A,D GET /contacts/{id}/memberOf
V1 A,D GET /contacts/{id}/transitiveMemberOf
V1 A,D GET /contacts/{id}/transitiveReports/$count
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(deviceId='{deviceId}')
V1 A,D GET /devices(deviceId='{deviceId}')/memberOf
V1 A,D GET /devices(deviceId='{deviceId}')/registeredOwners
V1 A,D GET /devices(deviceId='{deviceId}')/registeredUsers
V1 A,D GET /devices(deviceId='{deviceId}')/transitiveMemberOf
V1 A,D GET /devices(deviceId='{deviceId}')/usageRights
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
V1 A,D GET /devices/{id}/transitiveMemberOf
V1 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}
V1 A,D GET /directory/deleteditems/{id}
V1 A,D GET /directory/deletedItems/{id}
V1 A,D GET /directory/deletedItems/microsoft.graph.administrativeUnit
V1 A,D GET /directory/deleteditems/microsoft.graph.application
V1 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.servicePrincipal
V1 A,D GET /directory/deletedItems/microsoft.graph.user
V1 A,D GET /directoryObjects/{id}
V1 A,D GET /directoryRoles
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 /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 /directoryRoleTemplates
V1 A,D GET /directoryRoleTemplates/{id}
V1 A,D GET /directorySettingTemplates
V1 A,D GET /directorySettingTemplates/{id}
V1 A,D GET /domains
V1 A,D GET /domains/{id}
V1 A,D GET /education/classes/{id}/group
V1 A,D GET /education/me/user
V1 A,D GET /education/schools/{id}/administrativeUnit
V1 A,D GET /education/users/{id}/user
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
V1 A,D GET /groups/{id}/memberOf
V1 A,D GET /groups/{id}/members
V1 A,D GET /groups/{id}/owners
V1 A,D GET /groups/{id}/photo/$value
V1 A,D GET /groups/{id}/transitiveMemberOf
V1 A,D GET /groups/{id}/transitiveMembers
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/appRoleAssignedResources?$count=true
V1 A,D GET /me/contactfolders/{contactFolderId}/contacts/{id}/photo/$value
V1 A,D GET /me/contacts/{id}/photo/$value
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/oauth2PermissionGrants
V1 A,D GET /me/ownedDevices
V1 A,D GET /me/ownedObjects
V1 A,D GET /me/photo/$value
V1 A,D GET /me/registeredDevices
V1 A,D GET /me/scopedRoleMemberOf
V1 A,D GET /oauth2PermissionGrants
V1 A,D GET /oauth2PermissionGrants/{id}
V1 A,D GET /oauth2PermissionGrants/delta
V1 A,D GET /organization
V1 A,D GET /policies/adminConsentRequestPolicy
V1 A,D GET /policies/claimsMappingPolicies/{id}/appliesTo
V1 A,D GET /policies/homeRealmDiscoveryPolicies/{id}/appliesTo
V1 A,D GET /policies/permissionGrantPolicies/{id}/excludes
V1 A,D GET /policies/permissionGrantPolicies/{id}/includes
V1 A,D GET /policies/tokenIssuancePolicies/{id}/appliesTo
V1 A,D GET /policies/tokenLifetimePolicies/{id}/appliesTo
V1 D GET /privilegedRoleAssignmentRequests
V1 A,D GET /roleManagement/cloudPC/roleDefinitions
V1 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}
V1 A,D GET /roleManagement/directory/roleDefinitions/{unifiedRoleDefinitionId}/assignedPrincipals
V1 A,D GET /roleManagement/directory/transitiveRoleAssignments?$filter=principalId eq '{principalId}'
V1 A,D GET /servicePrincipals
V1 A,D GET /servicePrincipals(appId='{appId}')
V1 A,D GET /servicePrincipals(appId='{appId}')/appRoleAssignedTo
V1 A,D GET /servicePrincipals(appId='{appId}')/appRoleAssignments
V1 A,D GET /servicePrincipals(appId='{appId}')/createdObjects
V1 A,D GET /servicePrincipals(appId='{appId}')/delegatedPermissionClassifications
V1 A,D GET /servicePrincipals(appId='{appId}')/memberOf
V1 A,D GET /servicePrincipals(appId='{appId}')/oauth2PermissionGrants
V1 A,D GET /servicePrincipals(appId='{appId}')/ownedObjects
V1 A,D GET /servicePrincipals(appId='{appId}')/owners
V1 A,D GET /servicePrincipals(appId='{appId}')/transitiveMemberOf
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}/delegatedPermissionClassifications
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
V1 D GET /servicePrincipals/{id}/synchronization/jobs/{jobId}/
V1 D GET /servicePrincipals/{id}/synchronization/jobs/{jobId}/schema
V1 D GET /servicePrincipals/{id}/synchronization/jobs/{jobId}/schema/filterOperators
V1 D GET /servicePrincipals/{id}/synchronization/jobs/{jobId}/schema/functions
V1 D GET /servicePrincipals/{id}/synchronization/templates/{templateId}/schema
V1 D GET /servicePrincipals/{id}/synchronization/templates/{templateId}/schema/filterOperators
V1 D GET /servicePrincipals/{id}/synchronization/templates/{templateId}/schema/functions
V1 A,D GET /servicePrincipals/{id}/transitiveMemberOf
V1 A,D GET /servicePrincipals/delta
V1 A,D GET /settings
V1 A,D GET /settings/{directorySettingId}
V1 A,D GET /subscribedSkus
V1 A,D GET /subscribedSkus/{id}
V1 A,D GET /team/{id}/photo/$value
V1 A,D GET /teams/{id}/channels/{id}/tabs
V1 A,D GET /teams/{id}/installedApps/{id}
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}
V1 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}/appRoleAssignments
V1 A,D GET /users/{id | userPrincipalName}/contactfolders/{contactFolderId}/contacts/{id}/photo/$value
V1 A,D GET /users/{id | userPrincipalName}/contacts/{id}/photo/$value
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}/oauth2PermissionGrants
V1 A,D GET /users/{id | userPrincipalName}/ownedDevices
V1 A,D GET /users/{id | userPrincipalName}/ownedObjects
V1 A,D GET /users/{id | userPrincipalName}/photo/$value
V1 A,D GET /users/{id | userPrincipalName}/registeredDevices
V1 A,D GET /users/{id | userPrincipalName}/transitiveMemberOf
V1 A,D GET /users/{id}/licenseDetails
V1 A,D GET /users/{id}/scopedRoleMemberOf
V1 A,D GET /users/{id}/transitiveReports/$count
V1 A,D GET /users/{userId}/appRoleAssignedResources?$count=true
V1 A,D GET /users/{userId}/usageRights
V1 A,D GET /users/delta
V1 D GET applications/{id}/synchronization/templates
V1 D GET applications/{id}/synchronization/templates/{templateId}
V1 A,D GET auditLogs/signIns
V1 D GET servicePrincipals/{id}/synchronization/templates
V1 D GET servicePrincipals/{id}/synchronization/templates/{templateId}
V1 A,D POST /applications(appId='{appId}')/owners/$ref
V1 A,D POST /applications/{id}/owners/$ref
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/getAvailableExtensionProperties
V1 A,D POST /directoryObjects/getByIds
V1 A,D POST /directoryObjects/validateProperties
V1 D POST /groups/{id}/evaluateDynamicMembership
V1 D POST /groups/evaluateDynamicMembership
V1 D POST /privilegedRoleAssignmentRequests/my
V1 A,D POST /servicePrincipals(appId='{appId}')/appRoleAssignedTo
V1 A,D POST /servicePrincipals(appId='{appId}')/appRoleAssignments
V1 A,D POST /servicePrincipals(appId='{appId}')/createPasswordSingleSignOnCredentials
V1 A,D POST /servicePrincipals(appId='{appId}')/deletePasswordSingleSignOnCredentials
V1 A,D POST /servicePrincipals(appId='{appId}')/getPasswordSingleSignOnCredentials
V1 A,D POST /servicePrincipals(appId='{appId}')/owners/$ref
V1 A,D POST /servicePrincipals(appId='{appId}')/updatePasswordSingleSignOnCredentials
V1 A,D POST /servicePrincipals/{id}/appRoleAssignedTo
V1 A,D POST /servicePrincipals/{id}/appRoleAssignments
V1 A,D POST /servicePrincipals/{id}/createPasswordSingleSignOnCredentials
V1 A,D POST /servicePrincipals/{id}/deletePasswordSingleSignOnCredentials
V1 A,D POST /servicePrincipals/{id}/getPasswordSingleSignOnCredentials
V1 A,D POST /servicePrincipals/{id}/owners/$ref
V1 A,D POST /servicePrincipals/{id}/updatePasswordSingleSignOnCredentials

Delegate Permission

Id 06da0dbc-49e2-44d2-8312-53f166ab848a
Consent Type Admin
Display String Read directory data
Description Allows the app to read data in your organization's directory, such as users, groups and apps.

Application Permission

Id 7ab1d382-f21e-4acd-a863-ba3e13f7da61
Display String Read directory data
Description Allows the app to read data in your organization's directory, such as users, groups and apps, without a signed-in user.

Resources

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.

application

Property Type Description
addIns addIn collection Defines custom behavior that a consuming service can use to call an app in specific contexts. For example, applications that can render file streams may set the addIns property for its "FileHandler" functionality. This will let services like Office 365 call the application in the context of a document the user is working on.
api apiApplication Specifies settings for an application that implements a web API.
appId String The unique identifier for the application that is assigned to an application by Azure AD. Not nullable. Read-only. Supports $filter (eq).
applicationTemplateId String Unique identifier of the applicationTemplate. Supports $filter (eq, not, ne).
appRoles appRole collection The collection of roles defined for the application. With app role assignments, these roles can be assigned to users, groups, or service principals associated with other applications. Not nullable.
certification certification Specifies the certification status of the application.
createdDateTime DateTimeOffset The date and time the application was registered. The DateTimeOffset type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.

Supports $filter (eq, ne, not, ge, le, in, and eq on null values) and $orderBy.
deletedDateTime DateTimeOffset The date and time the application was deleted. The DateTimeOffset type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.
description String Free text field to provide a description of the application object to end users. The maximum allowed size is 1024 characters. Supports $filter (eq, ne, not, ge, le, startsWith) and $search.
disabledByMicrosoftStatus String Specifies whether Microsoft has disabled the registered application. Possible values are: null (default value), NotDisabled, and DisabledDueToViolationOfServicesAgreement (reasons may include suspicious, abusive, or malicious activity, or a violation of the Microsoft Services Agreement).

Supports $filter (eq, ne, not).
displayName String The display name for the application. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values), $search, and $orderBy.
groupMembershipClaims String Configures the groups claim issued in a user or OAuth 2.0 access token that the application expects. To set this attribute, use one of the following valid string values: None, SecurityGroup (for security groups and Azure AD roles), All (this gets all of the security groups, distribution groups, and Azure AD directory roles that the signed-in user is a member of).
id String Unique identifier for the application object. This property is referred to as Object ID in the Azure portal. Inherited from directoryObject. Key. Not nullable. Read-only. Supports $filter (eq, ne, not, in).
identifierUris String collection Also known as App ID URI, this value is set when an application is used as a resource app. The identifierUris acts as the prefix for the scopes you'll reference in your API's code, and it must be globally unique. You can use the default value provided, which is in the form api://<application-client-id>, or specify a more readable URI like https://contoso.com/api. For more information on valid identifierUris patterns and best practices, see Azure AD application registration security best practices. Not nullable.

Supports $filter (eq, ne, ge, le, startsWith).
info informationalUrl Basic profile information of the application such as app's marketing, support, terms of service and privacy statement URLs. The terms of service and privacy statement are surfaced to users through the user consent experience. For more info, see How to: Add Terms of service and privacy statement for registered Azure AD apps.

Supports $filter (eq, ne, not, ge, le, and eq on null values).
isDeviceOnlyAuthSupported Boolean Specifies whether this application supports device authentication without a user. The default is false.
isFallbackPublicClient Boolean Specifies the fallback application type as public client, such as an installed application running on a mobile device. The default value is false which means the fallback application type is confidential client such as a web app. There are certain scenarios where Azure AD cannot determine the client application type. For example, the ROPC flow where it is configured without specifying a redirect URI. In those cases Azure AD interprets the application type based on the value of this property.
keyCredentials keyCredential collection The collection of key credentials associated with the application. Not nullable. Supports $filter (eq, not, ge, le).
logo Stream The main logo for the application. Not nullable.
notes String Notes relevant for the management of the application.
oauth2RequiredPostResponse Boolean Specifies whether, as part of OAuth 2.0 token requests, Azure AD allows POST requests, as opposed to GET requests. The default is false, which specifies that only GET requests are allowed.
optionalClaims optionalClaims Application developers can configure optional claims in their Azure AD applications to specify the claims that are sent to their application by the Microsoft security token service. For more information, see How to: Provide optional claims to your app.
parentalControlSettings parentalControlSettings Specifies parental control settings for an application.
passwordCredentials passwordCredential collection The collection of password credentials associated with the application. Not nullable.
publicClient publicClientApplication Specifies settings for installed clients such as desktop or mobile devices.
publisherDomain String The verified publisher domain for the application. Read-only. For more information, see How to: Configure an application's publisher domain. Supports $filter (eq, ne, ge, le, startsWith).
requiredResourceAccess requiredResourceAccess collection Specifies the resources that the application needs to access. This property also specifies the set of delegated permissions and application roles that it needs for each of those resources. This configuration of access to the required resources drives the consent experience.

No more than 50 resource services (APIs) can be configured. Beginning mid-October 2021, the total number of required permissions must not exceed 400. For more information, see Limits on requested permissions per app. Not nullable.

Supports $filter (eq, not, ge, le).
samlMetadataUrl String The URL where the service exposes SAML metadata for federation. This property is valid only for single-tenant applications. Nullable.
serviceManagementReference String References application or service contact information from a Service or Asset Management database. Nullable.
signInAudience String Specifies the Microsoft accounts that are supported for the current application. The possible values are: AzureADMyOrg, AzureADMultipleOrgs, AzureADandPersonalMicrosoftAccount (default), and PersonalMicrosoftAccount. See more in the table.

The value of this object also limits the number of permissions an app can request. For more information, see Limits on requested permissions per app.

The value for this property has implications on other app object properties. As a result, if you change this property, you may need to change other properties first. For more information, see Validation differences for signInAudience.

Supports $filter (eq, ne, not).
spa spaApplication Specifies settings for a single-page application, including sign out URLs and redirect URIs for authorization codes and access tokens.
tags String collection Custom strings that can be used to categorize and identify the application. Not nullable.

Supports $filter (eq, not, ge, le, startsWith).
tokenEncryptionKeyId String Specifies the keyId of a public key from the keyCredentials collection. When configured, Azure AD encrypts all the tokens it emits by using the key this property points to. The application code that receives the encrypted token must use the matching private key to decrypt the token before it can be used for the signed-in user.
verifiedPublisher verifiedPublisher Specifies the verified publisher of the application. For more information about how publisher verification helps support application security, trustworthiness, and compliance, see Publisher verification.
web webApplication Specifies settings for a web application.

appRoleAssignment

Property Type Description
appRoleId Guid The identifier (id) for the app role which is assigned to the principal. This app role must be exposed in the appRoles property on the resource application's service principal (resourceId). If the resource application has not declared any app roles, a default app role ID of 00000000-0000-0000-0000-000000000000 can be specified to signal that the principal is assigned to the resource app without any specific app roles. Required on create.
createdDateTime DateTimeOffset The time when the app role assignment was created. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.
id String A unique identifier for the appRoleAssignment key. Not nullable. Read-only.
principalDisplayName String The display name of the user, group, or service principal that was granted the app role assignment. Read-only. Supports $filter (eq and startswith).
principalId Guid The unique identifier (id) for the user, security group, or service principal being granted the app role. Security groups with dynamic memberships are supported. Required on create.
principalType String The type of the assigned principal. This can either be User, Group, or ServicePrincipal. Read-only.
resourceDisplayName String The display name of the resource app's service principal to which the assignment is made.
resourceId Guid The unique identifier (**i

channel

Property Type Description
createdDateTime dateTimeOffset Read only. Timestamp at which the channel was created.
description String Optional textual description for the channel.
displayName String Channel name as it will appear to the user in Microsoft Teams. The maximum length is 50 characters.
email String The email address for sending messages to the channel. Read-only.
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.
membershipType channelMembershipType The type of the channel. Can be set during creation and can't be changed. The possible values are: standard, private, unknownFutureValue, shared. The default value is standard. Note that you must use the Prefer: include-unknown-enum-members request header to get the following value in this evolvable enum: shared.
tenantId string The ID of the Azure Active Directory tenant.
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.

claimsMappingPolicy

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

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

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.

delegatedPermissionClassification

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

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. This is an alternate key that can be used to reference the device object. 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,/$count eq 0, /$count ne 0).
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 (/$count eq 0, /$count ne 0).
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.

directoryAudit

Property Type Description
activityDateTime DateTimeOffset Indicates the date and time the activity was performed. The Timestamp type is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.
activityDisplayName String Indicates the activity name or the operation name (examples: "Create User" and "Add member to group"). For full list, see Azure AD activity list.
additionalDetails keyValue collection Indicates additional details on the activity.
category String Indicates which resource category that's targeted by the activity. For example: UserManagement, GroupManagement, ApplicationManagement, RoleManagement.
correlationId Guid Indicates a unique ID that helps correlate activities that span across various services. Can be used to trace logs across services.
id String Indicates the unique ID for the activity. This is a GUID.
initiatedBy auditActivityInitiator Indicates information about the user or app initiated the activity.
loggedByService String Indicates information on which service initiated the activity (For example: Self-service Password Management, Core Directory, B2C, Invited Users, Microsoft Identity Manager, Privileged Identity Management.
operationType String Indicates the type of operation that was performed. The possible values include but are not limited to the following: Add, Assign, Update, Unassign, and Delete.
result operationResult Indicates the result of the activity. Possible values are: success, failure, timeout, unknownFutureValue.
resultReason String Indicates the reason for failure if the result is failure or timeout.
targetResources targetResource collection Indicates information on which resource was changed due to the activity. Target Resource Type can be User, Device, Directory, App, Role, Group, Policy or Other.

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

directoryObjectPartnerReference

Property Type Description
description String Description of the object returned. Read-only.
displayName String Name of directory object being returned, like group or application. Read-only.
externalPartnerTenantId Guid The tenant identifier for the partner tenant. Read-only.
id String The unique identifier for the resource. Inherited from directoryObject. Read-only.
objectType String The type of the referenced object in the partner tenant. Read-only.

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.

domain

Property Type Description
authenticationType String Indicates the configured authentication type for the domain. The value is either Managed or Federated. Managed indicates a cloud managed domain where Azure AD performs user authentication. Federated indicates authentication is federated with an identity provider such as the tenant's on-premises Active Directory via Active Directory Federation Services. This property is read-only and is not nullable.
availabilityStatus String This property is always null except when the verify action is used. When the verify action is used, a domain entity is returned in the response. The availabilityStatus property of the domain entity in the response is either AvailableImmediately or EmailVerifiedDomainTakeoverScheduled.
id String The fully qualified name of the domain. Key, immutable, not nullable, unique.
isAdminManaged Boolean The value of the property is false if the DNS record management of the domain has been delegated to Microsoft 365. Otherwise, the value is true. Not nullable
isDefault Boolean true if this is the default domain that is used for user creation. There is only one default domain per company. Not nullable
isInitial Boolean true if this is the initial domain created by Microsoft Online Services (companyname.onmicrosoft.com). There is only one initial domain per company. Not nullable
isRoot Boolean true if the domain is a verified root domain. Otherwise, false if the domain is a subdomain or unverified. Not nullable
isVerified Boolean true if the domain has completed domain ownership verification. Not nullable
passwordNotificationWindowInDays Int32 Specifies the number of days before a user receives notification that their password will expire. If the property is not set, a default value of 14 days will be used.
passwordValidityPeriodInDays Int32 Specifies the length of time that a password is valid before it must be changed. If the property is not set, a default value of 90 days will be used.
state domainState Status of asynchronous operations scheduled for the domain.
supportedServices String collection The capabilities assigned to the domain. Can include 0, 1 or more of following values: Email, Sharepoint, EmailInternalRelayOnly, OfficeCommunicationsOnline, SharePointDefaultDomain, FullRedelegation, SharePointPublic, OrgIdAuthentication, Yammer, Intune. The values which you can add/remove using Graph API include: Email, OfficeCommunicationsOnline, Yammer. Not nullable.

evaluateDynamicMembershipResult

Property Type Description
membershipRule String If a group ID is provided, the value is the membership rule for the group. If a group ID is not provided, the value is the membership rule that was provided as a parameter. For more information, see Dynamic membership rules for groups in Azure Active Directory.
membershipRuleEvaluationDetails expressionEvaluationDetails Provides a detailed anaylsis of the membership evaluation result.
membershipRuleEvaluationResult Boolean The value is true if the user or device is a member of the group. The value can also be true if a membership rule was provided and the user or device passes the rule evaluation; otherwise false.

extensionproperty

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

group

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Returned by default. Nullable.

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

groups-overview

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.

homeRealmDiscoveryPolicy

Property Type Description
definition String collection A string collection containing a JSON string that defines the rules and settings for this policy. See Properties of a home realm discovery policy definition for more details about the JSON schema for this property. Required.
description String Description for this policy.
displayName String Display name for this policy. Required.
id String Unique identifier for this policy. Read-only.
isOrganizationDefault Boolean If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false.

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
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).
id String Unique identifier for the oAuth2PermissionGrant. Read-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. Supports $filter (eq only).
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. Supports $filter (eq only).
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

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.
defaultUsageLocation String Two-letter ISO 3166 country code indicating the default service usage location of an organization.
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.
tenantType String Not nullable. The tenant type option that was selected when the tenant was created. The possible values are:
  • AAD - An enterprise identity access management (IAM) service that serves business-to-employee and business-to-business (B2B) scenarios.
  • AAD B2C A customer identity access management (CIAM) service that serves business-to-consumer (B2C) scenarios.
  • 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 for 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 for null values).
    displayName String Display name for this organizational contact. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq for null values), $search, and $orderBy.
    givenName String First name for this organizational contact. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq for 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 for 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 for 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 for 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 for category and propertyCausingError), /$count eq 0, /$count ne 0.
    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 for 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, /$count eq 0, /$count ne 0).
    surname String Last name for this organizational contact. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq for null values).

    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.

    permissionGrantConditionSet

    Property Type Description
    clientApplicationsFromVerifiedPublisherOnly Boolean Set to true to only match on client applications with a verified publisher. Set to false to match on any client app, even if it does not have a verified publisher. Default is false.
    clientApplicationIds String collection A list of appId values for the client applications to match with, or a list with the single value all to match any client application. Default is the single value all.
    clientApplicationPublisherIds String collection A list of Microsoft Partner Network (MPN) IDs for verified publishers of the client application, or a list with the single value all to match with client apps from any publisher. Default is the single value all.
    clientApplicationTenantIds String collection A list of Azure Active Directory tenant IDs in which the client application is registered, or a list with the single value all to match with client apps registered in any tenant. Default is the single value all.
    id String The unique identifier for the permission grant condition set. Key. Read-only.
    permissionClassification String The permission classification for the permission being granted, or all to match with any permission classification (including permissions which are not classified). Default is all.
    permissions String collection The list of id values for the specific permissions to match with, or a list with the single value all to match with any permission. The id of delegated permissions can be found in the oauth2PermissionScopes property of the API's servicePrincipal object. The id of application permissions can be found in the appRoles property of the API's servicePrincipal object. The id of resource-specific application permissions can be found in the resourceSpecificApplicationPermissions property of the API's servicePrincipal object. Default is the single value all.
    permissionType permissionType The permission type of the permission being granted. Possible values: application for application permissions (e.g. app roles), or delegated for delegated permissions. The value delegatedUserConsentable indicates delegated permissions which have not been configured by the API publisher to require admin consent—this value may be used in built-in permission grant policies, but cannot be used in custom permission grant policies. Required.
    resourceApplication String The **a

    permissionGrantPolicy

    Property Type Description
    displayName String The display name for the permission grant policy.
    description String The description for the permission grant policy.
    excludes permissionGrantConditionSet collection Condition sets which are excluded in this permission grant policy. Automatically expanded on GET.
    id String The unique identifier for the permission grant policy. The id prefix microsoft- is reserved for built-in permission grant policies, and may not be used in a custom permission grant policy. Only letters, numbers, hyphens (-) and underscores (_) are allowed. Key. Not nullable. Required on create. Immutable.
    includes permissionGrantConditionSet collection Condition sets which are *i

    privilegedroleassignmentrequest

    Property Type Description
    id String Read-only. The id of the role assignment request.
    assignmentState String The state of the assignment. The value can be Eligible for eligible assignment Active - if it is directly assigned Active by administrators, or activated on an eligible assignment by the users.
    duration String The duration of a role assignment.
    reason String The reason for the role assignment.
    requestedDateTime DateTimeOffset Read-only. The request create time. 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.
    roleId String The id of the role.
    schedule governanceSchedule The schedule object of the role assignment request.
    status String Read-only.The status of the role assignment request. The value can be NotStarted,Completed,RequestedApproval,Scheduled,Approved,ApprovalDenied,ApprovalAborted,Cancelling,Cancelled,Revoked,RequestExpired.
    ticketNumber String The ticketNumber for the role assignment.
    ticketSystem String The ticketSystem for the role assignment.
    type String Representing the type of the operation on the role assignment. The value can be AdminAdd: Administrators add users to roles;UserAdd: Users add role assignments.
    userId String The id of the user.

    profilePhoto

    Property Type Description
    id string Read-only.
    height int32 The height of the photo. Read-only.
    width int32 The width of the photo. Read-only.

    provisioningObjectSummary

    Property Type Description
    activityDateTime 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
    changeId String Unique ID of this change in this cycle.
    cycleId String Unique ID per job iteration.
    durationInMilliseconds Int32 Indicates how long this provisioning action took to finish. Measured in milliseconds.
    id String Indicates the unique ID for the activity. This is a read-only GUID.
    initiatedBy initiator Details of who initiated this provisioning.
    jobId String The unique ID for the whole provisioning job.
    modifiedProperties modifiedProperty collection Details of each property that was modified in this provisioning action on this object.
    provisioningAction provisioningAction Indicates the activity name or the operation name. Possible values are: create, update, delete, stageddelete, disable, other and unknownFutureValue. For a list of activities logged, refer to Azure AD activity list.
    provisioningStatusInfo provisioningStatusInfo Details of provisioning status.
    provisioningSteps provisioningStep collection Details of each step in provisioning.
    servicePrincipal servicePrincipal collection Represents the service principal used for provisioning.
    sourceIdentity provisionedIdentity Details of source object being provisioned.
    sourceSystem provisioningSystem Details of source system of the object being provisioned.
    targetIdentity provisionedIdentity Details of target object being provisioned.
    targetSystem provisioningSystem Details of target system of the object being provisioned.
    tenantId String Unique Azure AD tenant ID.

    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.

    servicePrincipal

    Property Type Description
    accountEnabled Boolean true if the service principal account is enabled; otherwise, false. If set to false, then no users will be able to sign in to this app, even if they are assigned to it. Supports $filter (eq, ne, not, in).
    addIns addIn collection Defines custom behavior that a consuming service can use to call an app in specific contexts. For example, applications that can render file streams may set the addIns property for its "FileHandler" functionality. This will let services like Microsoft 365 call the application in the context of a document the user is working on.
    alternativeNames String collection Used to retrieve service principals by subscription, identify resource group and full resource ids for managed identities. Supports $filter (eq, not, ge, le, startsWith).
    appDescription String The description exposed by the associated application.
    appDisplayName String The display name exposed by the associated application.
    appId String The unique identifier for the associated application (its appId property). Supports $filter (eq, ne, not, in, startsWith).
    applicationTemplateId String Unique identifier of the applicationTemplate that the servicePrincipal was created from. Read-only. Supports $filter (eq, ne, NOT, startsWith).
    appOwnerOrganizationId Guid Contains the tenant id where the application is registered. This is applicable only to service principals backed by applications. Supports $filter (eq, ne, NOT, ge, le).
    appRoleAssignmentRequired Boolean Specifies whether users or other service principals need to be granted an app role assignment for this service principal before users can sign in or apps can get tokens. The default value is false. Not nullable.

    Supports $filter (eq, ne, NOT).
    appRoles appRole collection The roles exposed by the application which this service principal represents. For more information see the appRoles property definition on the application entity. Not nullable.
    deletedDateTime DateTimeOffset The date and time the service principal was deleted. Read-only.
    description String Free text field to provide an internal end-user facing description of the service principal. End-user portals such MyApps will display the application description in this field. The maximum allowed size is 1024 characters. Supports $filter (eq, ne, not, ge, le, startsWith) and $search.
    disabledByMicrosoftStatus String Specifies whether Microsoft has disabled the registered application. Possible values are: null (default value), NotDisabled, and DisabledDueToViolationOfServicesAgreement (reasons may include suspicious, abusive, or malicious activity, or a violation of the Microsoft Services Agreement).

    Supports $filter (eq, ne, not).
    displayName String The display name for the service principal. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values), $search, and $orderBy.
    homepage String Home page or landing page of the application.
    id String The unique identifier for the service principal. Inherited from directoryObject. Key. Not nullable. Read-only. Supports $filter (eq, ne, not, in).
    info informationalUrl Basic profile information of the acquired application such as app's marketing, support, terms of service and privacy statement URLs. The terms of service and privacy statement are surfaced to users through the user consent experience. For more info, see How to: Add Terms of service and privacy statement for registered Azure AD apps.

    Supports $filter (eq, ne, not, ge, le, and eq on null values).
    keyCredentials keyCredential collection The collection of key credentials associated with the service principal. Not nullable. Supports $filter (eq, not, ge, le).
    loginUrl String Specifies the URL where the service provider redirects the user to Azure AD to authenticate. Azure AD uses the URL to launch the application from Microsoft 365 or the Azure AD My Apps. When blank, Azure AD performs IdP-initiated sign-on for applications configured with SAML-based single sign-on. The user launches the application from Microsoft 365, the Azure AD My Apps, or the Azure AD SSO URL.
    logoutUrl String Specifies the URL that will be used by Microsoft's authorization service to logout an user using OpenId Connect front-channel, back-channel or SAML logout protocols.
    notes String Free text field to capture information about the service principal, typically used for operational purposes. Maximum allowed size is 1024 characters.
    notificationEmailAddresses String collection Specifies the list of email addresses where Azure AD sends a notification when the active certificate is near the expiration date. This is only for the certificates used to sign the SAML token issued for Azure AD Gallery applications.
    oauth2PermissionScopes permissionScope collection The delegated permissions exposed by the application. For more information see the oauth2PermissionScopes property on the application entity's api property. Not nullable.
    passwordCredentials passwordCredential collection The collection of password credentials associated with the application. Not nullable.
    preferredSingleSignOnMode string Specifies the single sign-on mode configured for this application. Azure AD uses the preferred single sign-on mode to launch the application from Microsoft 365 or the Azure AD My Apps. The supported values are password, saml, notSupported, and oidc.
    preferredTokenSigningKeyThumbprint String Reserved for internal use only. Do not write or otherwise rely on this property. May be removed in future versions.
    replyUrls String collection The URLs that user tokens are sent to for sign in with the associated application, or the redirect URIs that OAuth 2.0 authorization codes and access tokens are sent to for the associated application. Not nullable.
    resourceSpecificApplicationPermissions resourceSpecificPermission collection The resource-specific application permissions exposed by this application. Currently, resource-specific permissions are only supported for Teams apps accessing to specific chats and teams using Microsoft Graph. Read-only.
    samlSingleSignOnSettings samlSingleSignOnSettings The collection for settings related to saml single sign-on.
    servicePrincipalNames String collection Contains the list of identifiersUris, copied over from the associated application. Additional values can be added to hybrid applications. These values can be used to identify the permissions exposed by this app within Azure AD. For example,
    • Client apps can specify a resource URI which is based on the values of this property to acquire an access token, which is the URI returned in the “aud” claim.

    The any operator is required for filter expressions on multi-valued properties. Not nullable.

    Supports $filter (eq, not, ge, le, startsWith).
    servicePrincipalType String Identifies whether the service principal represents an application, a managed identity, or a legacy application. This is set by Azure AD internally. The servicePrincipalType property can be set to three different values:
    • Application - A service principal that represents an application or service. The appId property identifies the associated app registration, and matches the appId of an application, possibly from a different tenant. If the associated app registration is missing, tokens are not issued for the service principal.
    • ManagedIdentity - A service principal that represents a managed identity. Service principals representing managed identities can be granted access and permissions, but cannot be updated or modified directly.
    • Legacy - A service principal that represents an app created before app registrations, or through legacy experiences. Legacy service principal can have credentials, service principal names, reply URLs, and other properties which are editable by an authorized user, but does not have an associated app registration. The appId value does not associate the service principal with an app registration. The service principal can only be used in the tenant where it was created.
    • SocialIdp - For internal use.
    signInAudience String Specifies the Microsoft accounts that are supported for the current application. Read-only.

    Supported values are:
    • AzureADMyOrg: Users with a Microsoft work or school account in my organization’s Azure AD tenant (single-tenant).
    • AzureADMultipleOrgs: Users with a Microsoft work or school account in any organization’s Azure AD tenant (multi-tenant).
    • AzureADandPersonalMicrosoftAccount: Users with a personal Microsoft account, or a work or school account in any organization’s Azure AD tenant.
    • PersonalMicrosoftAccount: Users with a personal Microsoft account only.
    tags String collection Custom strings that can be used to categorize and identify the service principal. Not nullable.

    Supports $filter (eq, not, ge, le, startsWith).
    tokenEncryptionKeyId String Specifies the keyId of a public key from the keyCredentials collection. When configured, Azure AD issues tokens for this application encrypted using the key specified by this property. The application code that receives the encrypted token must use the matching private key to decrypt the token before it can be used for the signed-in user.
    verifiedPublisher verifiedPublisher Specifies the verified publisher of the application which this service principal represents.

    signIn

    Property Type Description
    appDisplayName String App name displayed in the Azure Portal. Supports $filter (eq and startsWith operators only).
    appId String Unique GUID representing the app ID in the Azure Active Directory. Supports $filter (eq operator only).
    appliedConditionalAccessPolicies appliedConditionalAccessPolicy collection Provides a list of conditional access policies that are triggered by the corresponding sign-in activity.
    clientAppUsed String Identifies the client used for the sign-in activity. Modern authentication clients include Browser and modern clients. Legacy authentication clients include Exchange ActiveSync, IMAP, MAPI, SMTP, POP, and other clients. Supports $filter (eq operator only).
    conditionalAccessStatus conditionalAccessStatus Reports status of an activated conditional access policy. Possible values are: success, failure, notApplied, and unknownFutureValue. Supports $filter (eq operator only).
    correlationId String The request ID sent from the client when the sign-in is initiated; used to troubleshoot sign-in activity. Supports $filter (eq operator only).
    createdDateTime DateTimeOffset Date and time (UTC) the sign-in was initiated. Example: midnight on Jan 1, 2014 is reported as 2014-01-01T00:00:00Z. Supports $orderby and $filter (eq, le, and ge operators only).
    deviceDetail deviceDetail Device information from where the sign-in occurred; includes device ID, operating system, and browser. Supports $filter (eq and startsWith operators only) on browser and operatingSytem properties.
    id String Unique ID representing the sign-in activity. Supports $filter (eq operator only).
    ipAddress String IP address of the client used to sign in. Supports $filter (eq and startsWith operators only).
    isInteractive Boolean Indicates if a sign-in is interactive or not.
    location signInLocation Provides the city, state, and country code where the sign-in originated. Supports $filter (eq and startsWith operators only) on city, state, and countryOrRegion properties.
    resourceDisplayName String Name of the resource the user signed into. Supports $filter (eq operator only).
    resourceId String ID of the resource that the user signed into. Supports $filter (eq operator only).
    riskDetail riskDetail Provides the 'reason' behind a specific state of a risky user, sign-in or a risk event. The possible values are: none, adminGeneratedTemporaryPassword, userPerformedSecuredPasswordChange, userPerformedSecuredPasswordReset, adminConfirmedSigninSafe, aiConfirmedSigninSafe, userPassedMFADrivenByRiskBasedPolicy, adminDismissedAllRiskForUser, adminConfirmedSigninCompromised, unknownFutureValue. The value none means that no action has been performed on the user or sign-in so far. Supports $filter (eq operator only).
    Note: Details for this property require an Azure AD Premium P2 license. Other licenses return the value hidden.
    riskEventTypes riskEventType collection Risk event types associated with the sign-in. The possible values are: unlikelyTravel, anonymizedIPAddress, maliciousIPAddress, unfamiliarFeatures, malwareInfectedIPAddress, suspiciousIPAddress, leakedCredentials, investigationsThreatIntelligence, generic, and unknownFutureValue. Supports $filter (eq operator only).
    riskEventTypes_v2 String collection The list of risk event types associated with the sign-in. Possible values: unlikelyTravel, anonymizedIPAddress, maliciousIPAddress, unfamiliarFeatures, malwareInfectedIPAddress, suspiciousIPAddress, leakedCredentials, investigationsThreatIntelligence, generic, or unknownFutureValue. Supports $filter (eq and startsWith operators only).
    riskLevelAggregated riskLevel Aggregated risk level. The possible values are: none, low, medium, high, hidden, and unknownFutureValue. The value hidden means the user or sign-in was not enabled for Azure AD Identity Protection. Supports $filter (eq operator only).
    Note: Details for this property are only available for Azure AD Premium P2 customers. All other customers will be returned hidden.
    riskLevelDuringSignIn riskLevel Risk level during sign-in. The possible values are: none, low, medium, high, hidden, and unknownFutureValue. The value hidden means the user or sign-in was not enabled for Azure AD Identity Protection. Supports $filter (eq operator only).
    Note: Details for this property are only available for Azure AD Premium P2 customers. All other customers will be returned hidden.
    riskState riskState Reports status of the risky user, sign-in, or a risk event. The possible values are: none, confirmedSafe, remediated, dismissed, atRisk, confirmedCompromised, unknownFutureValue. Supports $filter (eq operator only).
    status signInStatus Sign-in status. Includes the error code and description of the error (in case of a sign-in failure). Supports $filter (eq operator only) on errorCode property.
    userDisplayName String Display name of the user that initiated the sign-in. Supports $filter (eq and startsWith operators only).
    userId String ID of the user that initiated the sign-in. Supports $filter (eq operator only).
    userPrincipalName String User principal name of the user that initiated the sign-in. Supports $filter (eq and startsWith operators only).

    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.

    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.

    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.

    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.

    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.

    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
    id string The unique identifier of the team. The group has the same ID as the team. This property is read-only, and is inherited from the base entity type.
    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.
    classSettings teamClassSettings Configure settings of a class. Available only when the team represents a class.
    createdDateTime dateTimeOffset Timestamp at which the team was created.
    description string An optional description for the team. Maximum length: 1024 characters.
    displayName string The name of the team.
    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.
    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.
    summary teamSummary Contains summary information about the team, including number of owners, members, and guests.
    tenantId string The ID of the Azure Active Directory tenant.
    visibility teamVisibilityType The visibility of the group and team. Defaults to Public.
    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 **G

    teamsApp

    Property Type Description
    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.
    externalId string The ID of the catalog provided by the app developer in the Microsoft Teams zip app package.
    id string The catalog app's generated app ID (different from the developer-provided ID in the Microsoft Teams zip app package.

    teamsAppInstallation

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

    teamsTab

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

    teamworkBot

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

    tokenIssuancePolicy

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

    tokenLifetimePolicy

    Property Type Description
    definition String collection A string collection containing a JSON string that defines the rules and settings for this policy. See below for more details about the JSON schema for this property. Required.
    description String Description for this policy.
    displayName String Display name for this policy. Required.
    id String Unique identifier for this policy. Read-only.
    isOrganizationDefault Boolean If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false.

    unifiedRoleAssignment

    Property Type Description
    appScopeId String Identifier of the app-specific scope when the assignment scope is app-specific. Either this property or directoryScopeId is required. App scopes are scopes that are defined and understood by this application only. Use / for tenant-wide app scopes. Use directoryScopeId to limit the scope to particular directory objects, for example, administrative units. 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).
    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).

    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

    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. This property doesn't differentiate directly-assigned and inherited licenses. Use the licenseAssignmentStates property to identify the directly-assigned and inherited licenses. Not nullable. Returned only on $select. Supports $filter (eq, not, /$count eq 0, /$count ne 0).
    assignedPlans assignedPlan collection The plans that are assigned to the user. Read-only. Not nullable.

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

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

    Returned by default. Supports $filter (eq, not, ge, le, startsWith).
    city String The city in which the user is located. Maximum length is 128 characters.

    Returned only on $select. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).
    companyName String The company name which the user is associated. This property can be useful for describing the company that an external user comes from. The maximum length is 64 characters.

    Returned only on $select. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).
    consentProvidedForMinor consentProvidedForMinor Sets whether consent has been obtained for minors. Allowed values: null, Granted, Denied and NotRequired. Refer to the legal age group property definitions for further information.

    Returned only on $select. Supports $filter (eq, ne, not, and in).
    country String The country/region in which the user is located; for example, US or UK. Maximum length is 128 characters.

    Returned only on $select. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).
    createdDateTime DateTimeOffset The date and time the user was created, in ISO 8601 format and in UTC time. The value cannot be modified and is automatically populated when the entity is created. Nullable. For on-premises users, the value represents when they were first created in Azure AD. Property is null for some users created before June 2018 and on-premises users that were synced to Azure AD before June 2018. Read-only. Read-only.

    Returned only on $select. Supports $filter (eq, ne, not , ge, le, in).
    creationType String Indicates whether the user account was created through one of the following methods:
    • As a regular school or work account (null).
    • As an external account (Invitation).
    • As a local account for an Azure Active Directory B2C tenant (LocalAccount).
    • Through self-service sign-up by an internal user using email verification (EmailVerified).
    • Through self-service sign-up by an external user signing up through a link that is part of a user flow (SelfServiceSignUp).

    Read-only.
    Returned only on $select. Supports $filter (eq, ne, not, in).
    deletedDateTime DateTimeOffset The date and time the user was deleted.

    Returned only on $select. Supports $filter (eq, ne, not, ge, le, in).
    department String The name for the department in which the user works. Maximum length is 64 characters.

    Returned only on $select. Supports $filter (eq, ne, not , ge, le, in, and eq on null values).
    displayName String The name displayed in the address book for the user. This is usually the combination of the user's first name, middle initial and last name. This property is required when a user is created and it cannot be cleared during updates. Maximum length is 256 characters.

    Returned by default. Supports $filter (eq, ne, not , ge, le, in, startsWith, and eq on null values), $orderBy, and $search.
    employeeHireDate DateTimeOffset The date and time when the user was hired or will start work in case of a future hire.

    Returned only on $select. Supports $filter (eq, ne, not , ge, le, in).
    employeeId String The employee identifier assigned to the user by the organization. The maximum length is 16 characters.

    Returned only on $select. Supports $filter (eq, ne, not , ge, le, in, startsWith, and eq on null values).
    employeeOrgData employeeOrgData Represents organization data (e.g. division and costCenter) associated with a user.

    Returned only on $select. Supports $filter (eq, ne, not , ge, le, in).
    employeeType String Captures enterprise worker type. For example, Employee, Contractor, Consultant, or Vendor. Returned only on $select. Supports $filter (eq, ne, not , ge, le, in, startsWith).
    externalUserState String For an external user invited to the tenant using the invitation API, this property represents the invited user's invitation status. For invited users, the state can be PendingAcceptance or Accepted, or null for all other users.

    Returned only on $select. Supports $filter (eq, ne, not , in).
    externalUserStateChangeDateTime DateTimeOffset Shows the timestamp for the latest change to the externalUserState property.

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

    Returned only on $select. Supports $filter (eq, ne, not , ge, le, in, startsWith, and eq on null values).
    givenName String The given name (first name) of the user. Maximum length is 64 characters.

    Returned by default. Supports $filter (eq, ne, not , ge, le, in, startsWith, and eq on null values).
    hireDate DateTimeOffset The hire date of the user. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.

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

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

    Returned only on $select. Supports $filter (eq) including on null values, only where the signInType is not userPrincipalName.
    imAddresses String collection The instant message voice over IP (VOIP) session initiation protocol (SIP) addresses for the user. Read-only.

    Returned only on $select. Supports $filter (eq, not, ge, le, startsWith).
    interests String collection A list for the user to describe their interests.

    Returned only on $select.
    isResourceAccount Boolean Do not use – reserved for future use.
    jobTitle String The user's job title. Maximum length is 128 characters.

    Returned by default. Supports $filter (eq, ne, not , ge, le, in, startsWith, and eq on null values).
    lastPasswordChangeDateTime DateTimeOffset The time when this Azure AD user last changed their password or when their password was created, whichever date the latest action was performed. The date and time information uses ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.

    Returned only on $select.
    legalAgeGroupClassification legalAgeGroupClassification Used by enterprise applications to determine the legal age group of the user. This property is read-only and calculated based on ageGroup and consentProvidedForMinor properties. Allowed values: null, MinorWithOutParentalConsent, MinorWithParentalConsent, MinorNoParentalConsentRequired, NotAdult and Adult. Refer to the legal age group property definitions for further information.

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

    Returned only on $select.
    mail String The SMTP address for the user, for example, [email protected]. Changes to this property will also update the user's proxyAddresses collection to include the value as an SMTP address. This property cannot contain accent characters.
    NOTE: We do not recommend updating this property for Azure AD B2C user profiles. Use the otherMails property instead.

    Returned by default. Supports $filter (eq, ne, not, ge, le, in, startsWith, endsWith, and eq on null values).
    mailboxSettings mailboxSettings Settings for the primary mailbox of the signed-in user. You can get or update settings for sending automatic replies to incoming messages, locale and time zone.

    Returned only on $select.
    mailNickname String The mail alias for the user. This property must be specified when a user is created. Maximum length is 64 characters.

    Returned only on $select. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).
    mobilePhone String The primary cellular telephone number for the user. Read-only for users synced from on-premises directory. Maximum length is 64 characters.

    Returned by default. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).
    mySite String The URL for the user's personal site.

    Returned only on $select.
    officeLocation String The office location in the user's place of business.

    Returned by default. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).
    onPremisesDistinguishedName String Contains the on-premises Active Directory distinguished name or DN. The property is only populated for customers who are synchronizing their on-premises directory to Azure Active Directory via Azure AD Connect. Read-only.

    Returned only on $select.
    onPremisesDomainName String Contains the on-premises domainFQDN, also called dnsDomainName synchronized from the on-premises directory. The property is only populated for customers who are synchronizing their on-premises directory to Azure Active Directory via Azure AD Connect. Read-only.

    Returned only on $select.
    onPremisesExtensionAttributes onPremisesExtensionAttributes Contains extensionAttributes1-15 for the user. These extension attributes are also known as Exchange custom attributes 1-15.
  • For an onPremisesSyncEnabled user, the source of authority for this set of properties is the on-premises and is read-only.
  • For a cloud-only user (where onPremisesSyncEnabled is false), these properties can be set during creation or update of a user object.
  • For a cloud-only user previously synced from on-premises Active Directory, these properties are read-only in Microsoft Graph but can be fully managed through the Exchange Admin Center or the Exchange Online V2 module in PowerShell.

  • Returned only on $select. Supports $filter (eq, ne, not, in).
    onPremisesImmutableId String This property is used to associate an on-premises Active Directory user account to their Azure AD user object. This property must be specified when creating a new user account in the Graph if you are using a federated domain for the user's userPrincipalName (UPN) property. NOTE: The $ and _ characters cannot be used when specifying this property.

    Returned only on $select. Supports $filter (eq, ne, not, ge, le, in)..
    onPremisesLastSyncDateTime DateTimeOffset Indicates the last time at which the object was synced with the on-premises directory; for example: 2013-02-16T03:04:54Z. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.

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

    Returned only on $select. Supports $filter (eq, not, ge, le).
    onPremisesSamAccountName String Contains the on-premises samAccountName synchronized from the on-premises directory. The property is only populated for customers who are synchronizing their on-premises directory to Azure Active Directory via Azure AD Connect. Read-only.

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

    Returned only on $select. Supports $filter (eq including on null values).
    onPremisesSyncEnabled Boolean true if this user object is currently being synced from an on-premises Active Directory (AD); otherwise the user isn't being synced and can be managed in Azure Active Directory (Azure AD). Read-only.

    Returned only on $select. Supports $filter (eq, ne, not, in, and eq on null values).
    onPremisesUserPrincipalName String Contains the on-premises userPrincipalName synchronized from the on-premises directory. The property is only populated for customers who are synchronizing their on-premises directory to Azure Active Directory via Azure AD Connect. Read-only.

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

    Returned only on $select. Supports $filter (eq, not, ge, le, in, startsWith, endsWith, /$count eq 0, /$count ne 0).
    passwordPolicies String Specifies password policies for the user. This value is an enumeration with one possible value being DisableStrongPassword, which allows weaker passwords than the default policy to be specified. DisablePasswordExpiration can also be specified. The two may be specified together; for example: DisablePasswordExpiration, DisableStrongPassword.

    Returned only on $select. For more information on the default password policies, see Azure AD pasword policies. Supports $filter (ne, not, and eq on null values).
    passwordProfile passwordProfile Specifies the password profile for the user. The profile contains the user’s password. This property is required when a user is created. The password in the profile must satisfy minimum requirements as specified by the passwordPolicies property. By default, a strong password is required.

    Returned only on $select. Supports $filter (eq, ne, not, in, and eq on null values).
    pastProjects String collection A list for the user to enumerate their past projects.

    Returned only on $select.
    postalCode String The postal code for the user's postal address. The postal code is specific to the user's country/region. In the United States of America, this attribute contains the ZIP code. Maximum length is 40 characters.

    Returned only on $select. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).
    preferredDataLocation String The preferred data location for the user. For more information, see OneDrive Online Multi-Geo.
    preferredLanguage String The preferred language for the user. Should follow ISO 639-1 Code; for example en-US.

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

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

    Returned only on $select. Supports $filter (eq, not, ge, le).
    proxyAddresses String collection For example: "SMTP: [email protected]", "smtp: [email protected]"]. Changes to the mail property will also update this collection to include the value as an SMTP address. For more information, see [mail and proxyAddresses properties. The proxy address prefixed with SMTP (capitalized) is the primary proxy address while those prefixed with smtp are the secondary proxy addresses. For Azure AD B2C accounts, this property has a limit of ten unique addresses. Read-only in Microsoft Graph; you can update this property only through the Microsoft 365 admin center. Not nullable.

    Returned only on $select. Supports $filter (eq, not, ge, le, startsWith, endsWith, /$count eq 0, /$count ne 0).
    refreshTokensValidFromDateTime DateTimeOffset Any refresh tokens or sessions tokens (session cookies) issued before this time are invalid, and applications will get an error when using an invalid refresh or sessions token to acquire a delegated access token (to access APIs such as Microsoft Graph). If this happens, the application will need to acquire a new refresh token by making a request to the authorize endpoint.

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

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

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

    Read-only. Returned by default.
    Supports $select and $filter (eq, not, ge, le, startsWith).
    showInAddressList Boolean Do not use in Microsoft Graph. Manage this property through the Microsoft 365 admin center instead. Represents whether the user should be included in the Outlook global address list. See Known issue.
    signInSessionsValidFromDateTime DateTimeOffset Any refresh tokens or sessions tokens (session cookies) issued before this time are invalid, and applications will get an error when using an invalid refresh or sessions token to acquire a delegated access token (to access APIs such as Microsoft Graph). If this happens, the application will need to acquire a new refresh token by making a request to the authorize endpoint. Read-only. Use revokeSignInSessions to reset.

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

    Returned only on $select.
    state String The state or province in the user's address. Maximum length is 128 characters.

    Returned only on $select. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).
    streetAddress String The street address of the user's place of business. Maximum length is 1024 characters.

    Returned only on $select. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).
    surname String The user's surname (family name or last name). Maximum length is 64 characters.

    Returned by default. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).
    usageLocation String A two letter country code (ISO standard 3166). Required for users that will be assigned licenses due to legal requirement to check for availability of services in countries. Examples include: US, JP, and GB. Not nullable.

    Returned only on $select. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).
    userPrincipalName String The user principal name (UPN) of the user. The UPN is an Internet-style login name for the user based on the Internet standard RFC 822. By convention, this should map to the user's email name. The general format is [email protected], where domain must be present in the tenant's collection of verified domains. This property is required when a user is created. The verified domains for the tenant can be accessed from the verifiedDomains property of organization.
    NOTE: This property cannot contain accent characters. Only the following characters are allowed A - Z, a - z, 0 - 9, ' . - _ ! # ^ ~. For the complete list of allowed characters, see username policies.

    Returned by default. Supports $filter (eq, ne, not, ge, le, in, startsWith, endsWith) and $orderBy.
    userType String A string value that can be used to classify user types in your directory, such as Member and Guest.

    Returned only on $select. Supports $filter (eq, ne, not, in, and eq on null values). **N
    In This Article
    Back to top Created by merill | Submit feedback