authentication_methods_policy
Creates, updates, deletes, gets or lists an authentication_methods_policy resource.
Overview
| Name | authentication_methods_policy |
| Type | Resource |
| Id | entra_id.policies.authentication_methods_policy |
Fields
The following fields are returned by SELECT queries:
- get
Retrieved navigation property
| Name | Datatype | Description |
|---|---|---|
id | string | The unique identifier for an entity. Read-only. |
authenticationMethodConfigurations | array | Represents the settings for each authentication method. Automatically expanded on GET /policies/authenticationMethodsPolicy. |
description | string | A description of the policy. Read-only. |
displayName | string | The name of the policy. Read-only. |
lastModifiedDateTime | string (date-time) | The date and time of the last update to the policy. Read-only. (pattern: ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$) |
policyMigrationState | | 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. |
policyVersion | string | The version of the policy in use. Read-only. |
reconfirmationInDays | number (int32) | |
registrationEnforcement | | Enforce registration at sign-in time. This property can be used to remind users to set up targeted authentication methods. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | Read the properties and relationships of an authenticationMethodsPolicy object. | ||
update | update | Update the properties of an authenticationMethodsPolicy object. | ||
delete | delete | If-Match |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
If-Match | string | ETag |
SELECT examples
- get
Read the properties and relationships of an authenticationMethodsPolicy object.
SELECT
id,
authenticationMethodConfigurations,
description,
displayName,
lastModifiedDateTime,
policyMigrationState,
policyVersion,
reconfirmationInDays,
registrationEnforcement
FROM entra_id.policies.authentication_methods_policy
;
UPDATE examples
- update
Update the properties of an authenticationMethodsPolicy object.
UPDATE entra_id.policies.authentication_methods_policy
SET
id = '{{ id }}',
description = '{{ description }}',
displayName = '{{ displayName }}',
lastModifiedDateTime = '{{ lastModifiedDateTime }}',
policyMigrationState = '{{ policyMigrationState }}',
policyVersion = '{{ policyVersion }}',
reconfirmationInDays = {{ reconfirmationInDays }},
registrationEnforcement = '{{ registrationEnforcement }}',
authenticationMethodConfigurations = '{{ authenticationMethodConfigurations }}'
RETURNING
id,
authenticationMethodConfigurations,
description,
displayName,
lastModifiedDateTime,
policyMigrationState,
policyVersion,
reconfirmationInDays,
registrationEnforcement;
DELETE examples
- delete
No description available.
DELETE FROM entra_id.policies.authentication_methods_policy
WHERE If-Match = '{{ If-Match }}'
;