Skip to main content

authentication_flows_policy

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

Overview

Nameauthentication_flows_policy
TypeResource
Identra_id.policies.authentication_flows_policy

Fields

The following fields are returned by SELECT queries:

Retrieved navigation property

NameDatatypeDescription
idstringThe unique identifier for an entity. Read-only.
descriptionstringInherited property. A description of the policy. Optional. Read-only.
displayNamestringInherited property. The human-readable name of the policy. Optional. Read-only.
selfServiceSignUpContains selfServiceSignUpAuthenticationFlowConfiguration settings that convey whether self-service sign-up is enabled or disabled. Optional. Read-only.

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectRead the properties and relationships of an authenticationFlowsPolicy object.
updateupdateUpdate the selfServiceSignUp property of an authenticationFlowsPolicy object. The properties id, type, and description cannot be modified.
deletedeleteIf-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.

NameDatatypeDescription
If-MatchstringETag

SELECT examples

Read the properties and relationships of an authenticationFlowsPolicy object.

SELECT
id,
description,
displayName,
selfServiceSignUp
FROM entra_id.policies.authentication_flows_policy
;

UPDATE examples

Update the selfServiceSignUp property of an authenticationFlowsPolicy object. The properties id, type, and description cannot be modified.

UPDATE entra_id.policies.authentication_flows_policy
SET
id = '{{ id }}',
description = '{{ description }}',
displayName = '{{ displayName }}',
selfServiceSignUp = '{{ selfServiceSignUp }}'
RETURNING
id,
description,
displayName,
selfServiceSignUp;

DELETE examples

No description available.

DELETE FROM entra_id.policies.authentication_flows_policy
WHERE If-Match = '{{ If-Match }}'
;