user_flow_attributes

Creates, updates, deletes, gets or lists a user_flow_attributes resource.

Overview

Name	user_flow_attributes
Type	Resource
Id	entra_id.identity.user_flow_attributes

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.
dataType	string	(string, boolean, int64, stringCollection, dateTime, unknownFutureValue) (title: identityUserFlowAttributeDataType)
description	string	The description of the user flow attribute that's shown to the user at the time of sign up.
displayName	string	The display name of the user flow attribute. Supports $filter (eq, ne).
userFlowAttributeType	string	(builtIn, custom, required, unknownFutureValue) (title: identityUserFlowAttributeType)

list

Retrieved collection

Name	Datatype	Description
id	string	The unique identifier for an entity. Read-only.
dataType	string	(string, boolean, int64, stringCollection, dateTime, unknownFutureValue) (title: identityUserFlowAttributeDataType)
description	string	The description of the user flow attribute that's shown to the user at the time of sign up.
displayName	string	The display name of the user flow attribute. Supports $filter (eq, ne).
userFlowAttributeType	string	(builtIn, custom, required, unknownFutureValue) (title: identityUserFlowAttributeType)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	identity_user_flow_attribute_id		Retrieve the properties and relationships of a identityUserFlowAttribute object.
list	select			Retrieve a list of identityUserFlowAttribute objects.
insert	insert			Create a new custom identityUserFlowAttribute object.
update	update	identity_user_flow_attribute_id		Update the properties of a custom identityUserFlowAttribute object.
delete	delete	identity_user_flow_attribute_id	If-Match	Delete a custom identityUserFlowAttribute.

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

SELECT examples

get

Retrieve the properties and relationships of a identityUserFlowAttribute object.

SELECT
id,
dataType,
description,
displayName,
userFlowAttributeType
FROM entra_id.identity.user_flow_attributes
WHERE identity_user_flow_attribute_id = '{{ identity_user_flow_attribute_id }}' -- required
;

list

Retrieve a list of identityUserFlowAttribute objects.

SELECT
id,
dataType,
description,
displayName,
userFlowAttributeType
FROM entra_id.identity.user_flow_attributes
;

INSERT examples

insert

Create a new custom identityUserFlowAttribute object.

INSERT INTO entra_id.identity.user_flow_attributes (
id,
dataType,
description,
displayName,
userFlowAttributeType
)
SELECT 
'{{ id }}',
'{{ dataType }}',
'{{ description }}',
'{{ displayName }}',
'{{ userFlowAttributeType }}'
RETURNING
id,
dataType,
description,
displayName,
userFlowAttributeType
;

Manifest

# Description fields are for documentation purposes
- name: user_flow_attributes
props:
  - name: id
    value: "{{ id }}"
    description: |
      The unique identifier for an entity. Read-only.
  - name: dataType
    value: "{{ dataType }}"
    valid_values: ['string', 'boolean', 'int64', 'stringCollection', 'dateTime', 'unknownFutureValue']
  - name: description
    value: "{{ description }}"
    description: |
      The description of the user flow attribute that's shown to the user at the time of sign up.
  - name: displayName
    value: "{{ displayName }}"
    description: |
      The display name of the user flow attribute.  Supports $filter (eq, ne).
  - name: userFlowAttributeType
    value: "{{ userFlowAttributeType }}"
    valid_values: ['builtIn', 'custom', 'required', 'unknownFutureValue']

UPDATE examples

update

Update the properties of a custom identityUserFlowAttribute object.

UPDATE entra_id.identity.user_flow_attributes
SET 
id = '{{ id }}',
dataType = '{{ dataType }}',
description = '{{ description }}',
displayName = '{{ displayName }}',
userFlowAttributeType = '{{ userFlowAttributeType }}'
WHERE 
identity_user_flow_attribute_id = '{{ identity_user_flow_attribute_id }}' --required
RETURNING
id,
dataType,
description,
displayName,
userFlowAttributeType;

DELETE examples

delete

Delete a custom identityUserFlowAttribute.

DELETE FROM entra_id.identity.user_flow_attributes
WHERE identity_user_flow_attribute_id = '{{ identity_user_flow_attribute_id }}' --required
AND If-Match = '{{ If-Match }}'
;