Policy.ReadWrite.AuthenticationMethod
Allows the app to read and write the authentication method policies, on behalf of the signed-in user.
Merill's Note
For an app to access data in Microsoft Graph, the user or administrator must grant it the permissions it needs. This article lists all the Microsoft Graph APIs and your tenant data that can be accessed by the application (vendor/developer) if you consent to the
Policy.ReadWrite.AuthenticationMethod
permission.If you need to create an audit report of the permissions granted to all the apps in your tenant, you can run the
Export-MsIdAppConsentGrantReport
command. See How To: Run a quick OAuth app audit of your tenant
Category | Application | Delegated |
---|---|---|
Identifier | 29c18626-4985-4dcd-85c0-193eef327366 | 7e823077-d88e-468f-a337-e18f1f0e6c7c |
DisplayText | Read and write all authentication method policies | Read and write authentication method policies |
Description | Allows the app to read and write all authentication method policies for the tenant, without a signed-in user. | Allows the app to read and write the authentication method policies, on behalf of the signed-in user. |
AdminConsentRequired | Yes | Yes |
Graph Methods
→ API supports delegated access (access on behalf of a user)
→ API supports app-only access (access without a user)
Methods | |
---|---|
→ API supports delegated access (access on behalf of a user)
→ API supports app-only access (access without a user)
Methods | |
---|---|
→ Command supports delegated access (access on behalf of a user)
→ Command supports app-only access (access without a user)
Commands | |
---|---|
→ Command supports delegated access (access on behalf of a user)
→ Command supports app-only access (access without a user)
Commands | |
---|---|
Resources
Granting this permission allows the calling application to access (and/or update) the following information in your tenant.
- authenticationCombinationConfiguration
- authenticationMethodConfiguration
- authenticationMethodModeDetail
- authenticationmethodspolicies-overview
- authenticationMethodsPolicy
- authenticationMethodTarget
- authenticationStrengthPolicy
- authenticationStrengthUsage
- b2cAuthenticationMethodsPolicy
- emailAuthenticationMethodConfiguration
- excludeTarget
- externalAuthenticationMethodConfiguration
- fido2AuthenticationMethodConfiguration
- fido2CombinationConfiguration
- hardwareOathAuthenticationMethodConfiguration
- hardwareOathTokenAuthenticationMethodDevice
- identity
- microsoftAuthenticatorAuthenticationMethodConfiguration
- openIdConnectSetting
- registrationEnforcement
- reportSuspiciousActivitySettings
- smsAuthenticationMethodConfiguration
- softwareOathAuthenticationMethodConfiguration
- strongAuthenticationRequirements
- systemCredentialPreferences
- temporaryAccessPassAuthenticationMethodConfiguration
- updateAllowedCombinationsResult
- user
- voiceAuthenticationMethodConfiguration
- x509CertificateAuthenticationMethodConfiguration
- x509CertificateAuthenticationModeConfiguration
- x509CertificateCombinationConfiguration
- x509CertificateIssuerHintsConfiguration
- x509CertificateUserBinding
Graph reference: authenticationCombinationConfiguration
Property | Type | Description |
---|---|---|
appliesToCombinations | authenticationMethodModes collection | Which authentication method combinations this configuration applies to. Must be an allowedCombinations object, part of the authenticationStrengthPolicy. The only possible value for fido2combinationConfigurations is "fido2" . |
id | String | A unique system-generated identifier. |
Graph reference: authenticationMethodConfiguration
Property | Type | Description |
---|---|---|
excludeTargets | excludeTarget collection | Groups of users that are excluded from a policy. |
id | String | The policy name. |
state | authenticationMethodState | The state of the policy. Possible values are: enabled , disabled . |
Graph reference: authenticationMethodModeDetail
Property | Type | Description |
---|---|---|
authenticationMethod | baseAuthenticationMethod | The authentication method that this mode modifies. The possible values are: password , voice , hardwareOath , softwareOath , sms , fido2 , windowsHelloForBusiness , microsoftAuthenticator , temporaryAccessPass , email , x509Certificate , federation , unknownFutureValue . |
displayName | String | The display name of this mode |
id | String | The system-generated identifier for this mode. |
Graph reference: authenticationmethodspolicies-overview
Graph reference: authenticationMethodsPolicy
Property | Type | Description |
---|---|---|
description | String | A description of the policy. Read-only. |
displayName | String | The name of the policy. Read-only. |
id | String | The identifier of the policy. Inherited from entity. |
lastModifiedDateTime | DateTimeOffset | The date and time of the last update to the policy. Read-only. |
policyVersion | String | The version of the policy in use. Read-only. |
registrationEnforcement | registrationEnforcement | Enforce registration at sign-in time. This property can be used to remind users to set up targeted authentication methods. |
policyMigrationState | authenticationMethodsPolicyMigrationState | The state of migration of the authentication methods policy from the legacy multifactor authentication and self-service password reset (SSPR) policies. The possible values are: premigration - means the authentication methods policy is used for authentication only, legacy policies are respected. migrationInProgress - means the authentication methods policy is used for both authentication and SSPR, legacy policies are respected. migrationComplete - means the authentication methods policy is used for authentication and SSPR, legacy policies are ignored. unknownFutureValue - Evolvable enumeration sentinel value. Do not use. |
Graph reference: authenticationMethodTarget
Property | Type | Description |
---|---|---|
id | String | Object Id of a Microsoft Entra user or group. |
isRegistrationRequired | Boolean | Determines if the user is enforced to register the authentication method. |
targetType | authenticationMethodTargetType | Possible values are: user , group . |
Graph reference: authenticationStrengthPolicy
Property | Type | Description |
---|---|---|
allowedCombinations | authenticationMethodModes collection | A collection of authentication method modes that are required be used to satify this authentication strength. |
createdDateTime | DateTimeOffset | The datetime when this policy was created. |
description | String | The human-readable description of this policy. |
displayName | String | The human-readable display name of this policy. Supports $filter (eq , ne , not , and in ). |
id | String | The system-generated identifier for this mode. |
modifiedDateTime | DateTimeOffset | The datetime when this policy was last modified. |
policyType | authenticationStrengthPolicyType | A descriptor of whether this policy is built into Microsoft Entra ID or created by an admin for the tenant. The possible values are: builtIn , custom , unknownFutureValue . Supports $filter (eq , ne , not , and in ). |
requirementsSatisfied | authenticationStrengthRequirements | A descriptor of whether this authentication strength grants the MFA claim upon successful satisfaction. The possible values are: none , mfa , unknownFutureValue . |
Graph reference: authenticationStrengthUsage
Property | Type | Description |
---|---|---|
mfa | conditionalAccessPolicy collection | A collection of Conditional Access policies that reference the specified authentication strength policy and that require an MFA claim. |
none | conditionalAccessPolicy collection | A collection of Conditional Access policies that reference the specified authentication strength policy and that do not require an MFA claim. |
Graph reference: b2cAuthenticationMethodsPolicy
Property | Type | Description |
---|---|---|
id | String | The ID of the B2C authentication methods policy. This is a read only property and the key. |
isEmailPasswordAuthenticationEnabled | Boolean | The tenant admin can configure local accounts using email if the email and password authentication method is enabled. |
isUserNameAuthenticationEnabled | Boolean | The tenant admin can configure local accounts using username if the username and password authentication method is enabled. |
isPhoneOneTimePasswordAuthenticationEnabled | Boolean | The tenant admin can configure local accounts using phone number if the phone number and one-time password authentication method is enabled. |
Graph reference: emailAuthenticationMethodConfiguration
Property | Type | Description |
---|---|---|
allowExternalIdToUseEmailOtp | externalEmailOtpState | Determines whether email OTP is usable by external users for authentication. Possible values are: default , enabled , disabled , unknownFutureValue . Tenants in the default state who didn't use public preview have email OTP enabled beginning in October 2021. |
excludeTargets | excludeTarget collection | Groups of users that are excluded from the policy. |
id | String | The authentication method policy identifier. Inherited from authenticationMethodConfiguration. |
state | authenticationMethodState | Indicates whether this authentication method is enabled or not. Possible values are: enabled , disabled . |
Graph reference: excludeTarget
Property | Type | Description |
---|---|---|
id | String | The object identifier of a Microsoft Entra user or group. |
targetType | authenticationMethodTargetType | The type of the authentication method target. Possible values are: user , group , unknownFutureValue . |
Graph reference: externalAuthenticationMethodConfiguration
Property | Type | Description |
---|---|---|
appId | String | appId for the app registration in Microsoft Entra ID representing the integration with the external provider. |
displayName | String | Display name for the external authentication method. This name is shown to users during sign-in. |
excludeTargets | excludeTarget collection | Groups of users excluded from the policy. Inherited from authenticationMethodConfiguration. |
id | String | The unique identifier for this object. Read-only. Inherited from entity. |
openIdConnectSetting | openIdConnectSetting | Open ID Connection settings used by this external authentication method. |
state | authenticationMethodState | The state of the method in the policy. Inherited from authenticationMethodConfiguration. The possible values are: enabled , disabled . |
Graph reference: fido2AuthenticationMethodConfiguration
Property | Type | Description |
---|---|---|
excludeTargets | excludeTarget collection | Groups of users that are excluded from the policy. |
id | String | The authentication method policy identifier. |
isAttestationEnforced | Boolean | Determines whether attestation must be enforced for FIDO2 security key registration. |
isSelfServiceRegistrationAllowed | Boolean | Determines if users can register new FIDO2 security keys. |
keyRestrictions | fido2KeyRestrictions | Controls whether key restrictions are enforced on FIDO2 security keys, either allowing or disallowing certain key types as defined by Authenticator Attestation GUID (AAGUID), an identifier that indicates the type (e.g. make and model) of the authenticator. |
state | authenticationMethodState | Possible values are: enabled , disabled . |
Graph reference: fido2CombinationConfiguration
Property | Type | Description |
---|---|---|
allowedAAGUIDs | String collection | A list of AAGUIDs allowed to be used as part of the specified authentication method combinations. |
appliesToCombinations | authenticationMethodModes collection | Which authentication method combinations this configuration applies to. The only possible value is "fido2" . Inherited from authenticationCombinationConfiguration. |
id | String | A system-generated identifier. Inherited from entity. |
Graph reference: hardwareOathAuthenticationMethodConfiguration
Property | Type | Description |
---|---|---|
excludeTargets | excludeTarget collection | Groups of users that are excluded from the policy. Inherited from authenticationMethodConfiguration. |
id | String | The authentication method policy identifier. Inherited from entity. |
state | authenticationMethodState | Possible values are: enabled , disabled . Inherited from authenticationMethodConfiguration. |
Graph reference: hardwareOathTokenAuthenticationMethodDevice
Property | Type | Description |
---|---|---|
assignedTo | identity | User the token is assigned to. Nullable. Supports $filter (eq ). |
displayName | String | Name that can be provided to the hardware OATH token. Inherited from authenticationMethodDevice. |
hashFunction | hardwareOathTokenHashFunction | Hash function of the hardrware token. The possible values are: hmacsha1 or hmacsha256 . Default value is: hmacsha1 . Supports $filter (eq ). |
id | String | Unique identifier of the hardware OATH token. Inherited from entity. |
manufacturer | String | Manufacturer name of the hardware token. Supports $filter (eq ). |
model | String | Model name of the hardware token. Supports $filter (eq ). |
secretKey | String | Secret key of the specific hardware token, provided by the vendor. |
serialNumber | String | Serial number of the specific hardware token, often found on the back of the device. Supports $select and $filter (eq ). |
status | hardwareOathTokenStatus | Status of the hardware OATH token.The possible values are: available , assigned , activated , failedActivation . Supports $filter (eq ). |
timeIntervalInSeconds | Int32 | Refresh interval of the 6-digit verification code, in seconds. The possible values are: 30 or 60. Supports $filter (eq ). |
Graph reference: identity
Property | Type | Description |
---|---|---|
displayName | String | The display name of the identity. For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don't show up as changed when using delta. |
id | String | Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that's subject to review. |
tenantId | String | Unique identity of the tenant. Optional. |
thumbnails | thumbnailSet | Keyed collection of thumbnail resources. Optional. Applies to drive items, for example. |
Graph reference: microsoftAuthenticatorAuthenticationMethodConfiguration
Property | Type | Description |
---|---|---|
excludeTargets | excludeTarget collection | Groups of users that are excluded from the policy. |
id | String | The authentication method policy identifier. |
featureSettings | microsoftAuthenticatorFeatureSettings | A collection of Microsoft Authenticator settings such as application context and location context, and whether they are enabled for all users or specific users only. |
state | authenticationMethodState | Possible values are: enabled , disabled . |
Graph reference: openIdConnectSetting
Property | Type | Description |
---|---|---|
clientId | String | The Microsoft Entra ID's client ID as generated by the provider or admin to identify Microsoft Entra ID. In OIDC parlance, this is the client_id that external identity provider assigns to Microsoft Entra ID, which is also a recipient of a token from the external identity provider. |
discoveryUrl | String | The host URL of the external identity provider's OIDC discovery endpoint. This endpoint must support the OIDC discovery process. |
Graph reference: registrationEnforcement
Property | Type | Description |
---|---|---|
authenticationMethodsRegistrationCampaign | authenticationMethodsRegistrationCampaign | Run campaigns to remind users to set up targeted authentication methods. |
Graph reference: reportSuspiciousActivitySettings
Property | Type | Description |
---|---|---|
includeTarget | includeTarget | Group IDs in scope for report suspicious activity. |
state | advancedConfigState | Specifies the state of the reportSuspiciousActivitySettings object. The possible values are: default , enabled , disabled , unknownFutureValue . Setting to default results in a disabled state. |
voiceReportingCode | Int32 | Specifies the number the user enters on their phone to report the MFA prompt as suspicious. |
Graph reference: smsAuthenticationMethodConfiguration
Property | Type | Description |
---|---|---|
excludeTargets | excludeTarget collection | Groups of users that are excluded from the policy. |
id | String | The authentication method policy identifier. |
state | authenticationMethodState | Possible values are: enabled , disabled . |
Graph reference: softwareOathAuthenticationMethodConfiguration
Property | Type | Description |
---|---|---|
excludeTargets | excludeTarget collection | Groups of users that are excluded from the policy. |
id | String | The authentication method policy identifier. |
state | authenticationMethodState | Represents whether users can register this authentication method. The possible values are: enabled , disabled . |
Graph reference: strongAuthenticationRequirements
Property | Type | Description |
---|---|---|
perUserMfaState | perUserMfaState | Sets the per-user MFA state for the user. The possible values are: disabled , enforced , enabled , unknownFutureValue . When you update a user's MFA state to enabled and the user has already registered an MFA method, their state changes automatically to enforced . |
Graph reference: systemCredentialPreferences
Property | Type | Description |
---|---|---|
excludeTargets | excludeTarget collection | Users and groups excluded from the preferred authentication method experience of the system. |
includeTargets | includeTarget collection | Users and groups included in the preferred authentication method experience of the system. |
state | advancedConfigState | Indicates whether the feature is enabled or disabled. Possible values are: default , enabled , disabled , unknownFutureValue . The default value is used when the configuration hasn't been explicitly set, and uses the default behavior of Microsoft Entra ID for the setting. The default value is disabled . |
Graph reference: temporaryAccessPassAuthenticationMethodConfiguration
Property | Type | Description |
---|---|---|
defaultLength | Int | Default length in characters of a Temporary Access Pass object. Must be between 8 and 48 characters. |
defaultLifetimeInMinutes | Int | Default lifetime in minutes for a Temporary Access Pass. Value can be any integer between the minimumLifetimeInMinutes and maximumLifetimeInMinutes. |
excludeTargets | excludeTarget collection | Groups of users that are excluded from the policy. |
id | String | The identifier of the authentication method policy. Inherited from entity. |
isUsableOnce | Boolean | If true , all the passes in the tenant will be restricted to one-time use. If false , passes in the tenant can be created to be either one-time use or reusable. |
maximumLifetimeInMinutes | Int | Maximum lifetime in minutes for any Temporary Access Pass created in the tenant. Value can be between 10 and 43200 minutes (equivalent to 30 days). |
minimumLifetimeInMinutes | Int | Minimum lifetime in minutes for any Temporary Access Pass created in the tenant. Value can be between 10 and 43200 minutes (equivalent to 30 days). |
state | authenticationMethodState | Whether the Temporary Access Pass method is enabled in the tenant. Possible values are: enabled , disabled . Inherited from authenticationMethodConfiguration. |
Graph reference: updateAllowedCombinationsResult
Property | Type | Description |
---|---|---|
additionalInformation | String | Information about why the updateAllowedCombinations action was successful or failed. |
conditionalAccessReferences | String collection | References to existing Conditional Access policies that use this authentication strength. |
currentCombinations | authenticationMethodModes collection | The list of current authentication method combinations allowed by the authentication strength. |
previousCombinations | authenticationMethodModes collection | The list of former authentication method combinations allowed by the authentication strength before they were updated through the updateAllowedCombinations action. |
Graph reference: 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 . For more information, see legal age group property definitions. 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 between 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. 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 it's a string collection, only one number can be set for this property. Read-only for users synced from the on-premises directory. Returned by default. Supports $filter (eq , not , ge , le , startsWith ). |
city | String | The city where 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 name of the company that the user is associated with. This property can be useful for describing the company that a guest 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 was obtained for minors. Allowed values: null , Granted , Denied , and NotRequired . For more information, see legal age group property definitions. Returned only on $select . Supports $filter (eq , ne , not , and in ). |
country | String | The country/region where 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 UTC. The value can't 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 Microsoft Entra ID. Property is null for some users created before June 2018 and on-premises users that were synced to Microsoft Entra ID before June 2018. 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:
Read-only. Returned only on $select . Supports $filter (eq , ne , not , in ). |
customSecurityAttributes | customSecurityAttributeValue | An open complex type that holds the value of a custom security attribute that is assigned to a directory object. Nullable. Returned only on $select . Supports $filter (eq , ne , not , startsWith ). The filter value is case-sensitive. |
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 of 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 value is usually the combination of the user's first name, middle initial, and family name. This property is required when a user is created and it can't 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 a future hire. Returned only on $select . Supports $filter (eq , ne , not , ge , le , in ). |
employeeLeaveDateTime | DateTimeOffset | The date and time when the user left or will leave the organization. Supports $filter (eq , ne , not , ge , le , in ). For more information, see Configure the employeeLeaveDateTime property for a user. |
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 (for example, 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 a guest 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. 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 in Microsoft 365. 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. Microsoft (also known as a local account), organizations, or social identity providers such as Facebook, Google, and Microsoft can provide identity and tie it to a user account. It might contain multiple items with the same signInType value. Returned only on $select . Supports $filter (eq ) with limitations. |
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 | Don't 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 Microsoft Entra 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. 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 , Undefined , MinorWithOutParentalConsent , MinorWithParentalConsent , MinorNoParentalConsentRequired , NotAdult , and Adult . For more information, see legal age group property definitions. Returned only on $select . |
licenseAssignmentStates | licenseAssignmentState collection | State of license assignments for this user. Also indicates licenses that are directly assigned or the user inherited through group memberships. Read-only. Returned only on $select . |
String | The SMTP address for the user, for example, [email protected] . Changes to this property update the user's proxyAddresses collection to include the value as an SMTP address. This property can't contain accent characters. NOTE: We don't 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 the 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) and $search . |
mySite | String | The URL for the user's 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 Microsoft Entra ID via Microsoft Entra 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 Microsoft Entra ID via Microsoft Entra 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. Each attribute can store up to 1024 characters. false ), these properties can be set during the creation or update of a user object. 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 Microsoft Entra user object. This property must be specified when creating a new user account in the Graph if you're using a federated domain for the user's userPrincipalName (UPN) property. NOTE: The $ and _ characters can't 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. 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 Microsoft Entra ID via Microsoft Entra 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 Microsoft Entra ID. 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 Microsoft Entra ID via Microsoft Entra Connect. Read-only. Returned only on $select . Supports $filter (eq , ne , not , ge , le , in , startsWith ). |
otherMails | String collection | A list of other email addresses for the user; for example: ["[email protected]", "[email protected]"] . NOTE: This property can't 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 might be specified together; for example: DisablePasswordExpiration, DisableStrongPassword . Returned only on $select . For more information on the default password policies, see Microsoft Entra password 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). To update this property: |
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. The preferred language format is based on RFC 4646. The name is a combination of an ISO 639 two-letter lowercase culture code associated with the language, and an ISO 3166 two-letter uppercase subculture code associated with the country or region. Example: "en-US", or "es-ES". 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 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 addresses prefixed with smtp are the secondary proxy addresses. For Azure AD B2C accounts, this property has a limit of 10 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 session tokens (session cookies) issued before this time are invalid. Applications get an error when using an invalid refresh or session token to acquire a delegated access token (to access APIs such as Microsoft Graph). If this happens, the application needs to acquire a new refresh token by requesting the authorized endpoint. Returned only on $select . Read-only. |
responsibilities | String collection | A list for the user to enumerate their responsibilities. Returned only on $select . |
serviceProvisioningErrors | serviceProvisioningError collection | Errors published by a federated service describing a nontransient, service-specific error regarding the properties or link from a user object. Supports $filter (eq , not , for isResolved and serviceInstance). |
schools | String collection | A list for the user to enumerate the schools they 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. |
signInActivity | signInActivity | Get the last signed-in date and request ID of the sign-in for a given user. Read-only. Returned only on $select . Supports $filter (eq , ne , not , ge , le ) but not with any other filterable properties. Note: |
signInSessionsValidFromDateTime | DateTimeOffset | Any refresh tokens or session tokens (session cookies) issued before this time are invalid. Applications get an error when using an invalid refresh or session token to acquire a delegated access token (to access APIs such as Microsoft Graph). If this happens, the application needs to acquire a new refresh token by requesting the authorized 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 1,024 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 are assigned licenses due to legal requirements 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 sign-in name for the user based on the Internet standard RFC 822. By convention, this value should map to the user's email name. The general format is alias@domain, where the 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 can't 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. The possible values are Member and Guest . Returned only on $select . Supports $filter (eq , ne , not , in , and eq on null values). **N |
Graph reference: voiceAuthenticationMethodConfiguration
Property | Type | Description |
---|---|---|
excludeTargets | excludeTarget collection | Groups of users that are excluded from the policy. |
id | String | The authentication method policy identifier. |
isOfficePhoneAllowed | Boolean | true if users can register office phones, otherwise, false . |
state | authenticationMethodState | Represents whether users can register this authentication method. The possible values are: enabled , disabled . |
Graph reference: x509CertificateAuthenticationMethodConfiguration
Property | Type | Description |
---|---|---|
authenticationModeConfiguration | x509CertificateAuthenticationModeConfiguration | Defines strong authentication configurations. This configuration includes the default authentication mode and the different rules for strong authentication bindings. |
certificateUserBindings | x509CertificateUserBinding collection | Defines fields in the X.509 certificate that map to attributes of the Microsoft Entra user object in order to bind the certificate to the user. The priority of the object determines the order in which the binding is carried out. The first binding that matches will be used and the rest ignored. |
excludeTargets | excludeTarget collection | Groups of users that are excluded from the policy. |
id | String | The identifier for the authentication method policy. The value is always X509Certificate . Inherited from |
state | authenticationMethodState | The possible values are: enabled , disabled . Inherited from authenticationMethodConfiguration. |
Graph reference: x509CertificateAuthenticationModeConfiguration
Property | Type | Description |
---|---|---|
rules | x509CertificateRule collection | Rules are configured in addition to the authentication mode to bind a specific x509CertificateRuleType to an x509CertificateAuthenticationMode. For example, bind the policyOID with identifier 1.32.132.343 to x509CertificateMultiFactor authentication mode. |
x509CertificateAuthenticationDefaultMode | x509CertificateAuthenticationMode | The type of strong authentication mode. The possible values are: x509CertificateSingleFactor , x509CertificateMultiFactor , unknownFutureValue . |
Graph reference: x509CertificateCombinationConfiguration
Property | Type | Description |
---|---|---|
allowedIssuerSkis | String collection | A list of allowed subject key identifier values. |
allowedPolicyOIDs | String collection | A list of allowed policy OIDs. |
appliesToCombinations | authenticationMethodModes collection | Which authentication method combinations this configuration applies to. The possible values for x509certificatecombinationconfiguration are "x509CertificateSingleFactor" or "x509CertificateMultiFactor" . Inherited from authenticationCombinationConfiguration. |
id | String | A system-generated identifier. Inherited from entity. |
Graph reference: x509CertificateIssuerHintsConfiguration
Property | Type | Description |
---|---|---|
state | x509CertificateIssuerHintsState | The possible values are: disabled , enabled , unknownFutureValue . |
Graph reference: x509CertificateUserBinding
Property | Type | Description |
---|---|---|
priority | Int32 | The priority of the binding. Microsoft Entra ID uses the binding with the highest priority. This value must be a non-negative integer and unique in the collection of objects in the certificateUserBindings property of an x509CertificateAuthenticationMethodConfiguration object. Required |
userProperty | String | Defines the Microsoft Entra user property of the user object to use for the binding. The possible values are: userPrincipalName , onPremisesUserPrincipalName , certificateUserIds . Required. |
x509CertificateField | String | The field on the X.509 certificate to use for the binding. The possible values are: PrincipalName , RFC822Name , SubjectKeyIdentifier , SHA1PublicKey . |