authenticationMethodsPolicy resource type
Namespace: microsoft.graph
Defines authentication methods and the users that are allowed to use them to sign in and perform multifactor authentication (MFA) in Microsoft Entra ID.
Methods
Method | Return type | Description |
---|---|---|
Get | authenticationMethodsPolicy | Read the properties and relationships of an authenticationMethodsPolicy object. |
Update | authenticationMethodsPolicy | Update the properties of an authenticationMethodsPolicy object. |
Properties
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. |
Relationships
Relationship | Type | Description |
---|---|---|
authenticationMethodConfigurations | authenticationMethodConfiguration collection | Represents the settings for each authentication method. Automatically expanded on GET /policies/authenticationMethodsPolicy . |
JSON representation
The following JSON representation shows the resource type.
{
"@odata.type": "#microsoft.graph.authenticationMethodsPolicy",
"description": "String",
"displayName": "String",
"id": "String (identifier)",
"lastModifiedDateTime": "String (timestamp)",
"policyVersion": "String",
"policyMigrationState": "String",
"registrationEnforcement": {
"@odata.type": "microsoft.graph.registrationEnforcement"
}
}