authentication_strength_policies

Creates, updates, deletes, gets or lists an authentication_strength_policies resource.

Overview

Name	authentication_strength_policies
Type	Resource
Id	entra_id.policies.authentication_strength_policies

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.
allowedCombinations	array	A collection of authentication method modes that are required be used to satify this authentication strength.
combinationConfigurations	array	Settings that may be used to require specific types or instances of an authentication method to be used when authenticating with a specified combination of authentication methods.
createdDateTime	string (date-time)	The datetime when this policy was created. (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])$)
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).
modifiedDateTime	string (date-time)	The datetime when this policy was last modified. (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])$)
policyType	string	(builtIn, custom, unknownFutureValue) (title: authenticationStrengthPolicyType)
requirementsSatisfied	string	(none, mfa, unknownFutureValue) (title: authenticationStrengthRequirements)

list

Retrieved collection

Name	Datatype	Description
id	string	The unique identifier for an entity. Read-only.
allowedCombinations	array	A collection of authentication method modes that are required be used to satify this authentication strength.
combinationConfigurations	array	Settings that may be used to require specific types or instances of an authentication method to be used when authenticating with a specified combination of authentication methods.
createdDateTime	string (date-time)	The datetime when this policy was created. (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])$)
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).
modifiedDateTime	string (date-time)	The datetime when this policy was last modified. (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])$)
policyType	string	(builtIn, custom, unknownFutureValue) (title: authenticationStrengthPolicyType)
requirementsSatisfied	string	(none, mfa, unknownFutureValue) (title: authenticationStrengthRequirements)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	authentication_strength_policy_id		Read the properties and relationships of an authenticationStrengthPolicy object.
list	select			Get a list of the authenticationStrengthPolicy objects and their properties. This API returns both built-in and custom policies.
insert	insert			Create a new custom authenticationStrengthPolicy object.
update	update	authentication_strength_policy_id		Update the properties of an authenticationStrengthPolicy object. You cannot update the allowed auth method combinations using this request. To do so, use the Update allowed combinations action.
delete	delete	authentication_strength_policy_id	If-Match	Delete a custom authenticationStrengthPolicy object.
update_allowed_combinations	exec	authentication_strength_policy_id		Update the allowedCombinations property of an authenticationStrengthPolicy object. To update other properties of an authenticationStrengthPolicy object, use the Update authenticationStrengthPolicy method.

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
authentication_strength_policy_id	string	The unique identifier of authenticationStrengthPolicy
If-Match	string	ETag

SELECT examples

get

Read the properties and relationships of an authenticationStrengthPolicy object.

SELECT
id,
allowedCombinations,
combinationConfigurations,
createdDateTime,
description,
displayName,
modifiedDateTime,
policyType,
requirementsSatisfied
FROM entra_id.policies.authentication_strength_policies
WHERE authentication_strength_policy_id = '{{ authentication_strength_policy_id }}' -- required
;

list

Get a list of the authenticationStrengthPolicy objects and their properties. This API returns both built-in and custom policies.

SELECT
id,
allowedCombinations,
combinationConfigurations,
createdDateTime,
description,
displayName,
modifiedDateTime,
policyType,
requirementsSatisfied
FROM entra_id.policies.authentication_strength_policies
;

INSERT examples

insert

Create a new custom authenticationStrengthPolicy object.

INSERT INTO entra_id.policies.authentication_strength_policies (
id,
allowedCombinations,
createdDateTime,
description,
displayName,
modifiedDateTime,
policyType,
requirementsSatisfied,
combinationConfigurations
)
SELECT 
'{{ id }}',
'{{ allowedCombinations }}',
'{{ createdDateTime }}',
'{{ description }}',
'{{ displayName }}',
'{{ modifiedDateTime }}',
'{{ policyType }}',
'{{ requirementsSatisfied }}',
'{{ combinationConfigurations }}'
RETURNING
id,
allowedCombinations,
combinationConfigurations,
createdDateTime,
description,
displayName,
modifiedDateTime,
policyType,
requirementsSatisfied
;

Manifest

# Description fields are for documentation purposes
- name: authentication_strength_policies
props:
  - name: id
    value: "{{ id }}"
    description: |
      The unique identifier for an entity. Read-only.
  - name: allowedCombinations
    value:
      - "{{ allowedCombinations }}"
    description: |
      A collection of authentication method modes that are required be used to satify this authentication strength.
  - name: createdDateTime
    value: "{{ createdDateTime }}"
    description: |
      The datetime when this policy was created.
  - name: description
    value: "{{ description }}"
    description: |
      The human-readable description of this policy.
  - name: displayName
    value: "{{ displayName }}"
    description: |
      The human-readable display name of this policy. Supports $filter (eq, ne, not , and in).
  - name: modifiedDateTime
    value: "{{ modifiedDateTime }}"
    description: |
      The datetime when this policy was last modified.
  - name: policyType
    value: "{{ policyType }}"
    valid_values: ['builtIn', 'custom', 'unknownFutureValue']
  - name: requirementsSatisfied
    value: "{{ requirementsSatisfied }}"
    valid_values: ['none', 'mfa', 'unknownFutureValue']
  - name: combinationConfigurations
    description: |
      Settings that may be used to require specific types or instances of an authentication method to be used when authenticating with a specified combination of authentication methods.
    value:
      - id: "{{ id }}"
        appliesToCombinations: "{{ appliesToCombinations }}"

UPDATE examples

update

Update the properties of an authenticationStrengthPolicy object. You cannot update the allowed auth method combinations using this request. To do so, use the Update allowed combinations action.

UPDATE entra_id.policies.authentication_strength_policies
SET 
id = '{{ id }}',
allowedCombinations = '{{ allowedCombinations }}',
createdDateTime = '{{ createdDateTime }}',
description = '{{ description }}',
displayName = '{{ displayName }}',
modifiedDateTime = '{{ modifiedDateTime }}',
policyType = '{{ policyType }}',
requirementsSatisfied = '{{ requirementsSatisfied }}',
combinationConfigurations = '{{ combinationConfigurations }}'
WHERE 
authentication_strength_policy_id = '{{ authentication_strength_policy_id }}' --required
RETURNING
id,
allowedCombinations,
combinationConfigurations,
createdDateTime,
description,
displayName,
modifiedDateTime,
policyType,
requirementsSatisfied;

DELETE examples

delete

Delete a custom authenticationStrengthPolicy object.

DELETE FROM entra_id.policies.authentication_strength_policies
WHERE authentication_strength_policy_id = '{{ authentication_strength_policy_id }}' --required
AND If-Match = '{{ If-Match }}'
;

Lifecycle Methods

update_allowed_combinations

Update the allowedCombinations property of an authenticationStrengthPolicy object. To update other properties of an authenticationStrengthPolicy object, use the Update authenticationStrengthPolicy method.

EXEC entra_id.policies.authentication_strength_policies.update_allowed_combinations 
@authentication_strength_policy_id='{{ authentication_strength_policy_id }}' --required 
@@json=
'{
"allowedCombinations": "{{ allowedCombinations }}"
}'
;