Edit

Share via

identityUserFlowAttribute resource type

  • Article

Namespace: microsoft.graph

Important

APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.

Represents attributes that can be added to a user flow in a Microsoft Entra workforce tenant, a Microsoft Entra ID for customers tenant, and an Azure AD B2C tenant.

Configuring user flow attributes in your Microsoft Entra ID or Azure AD B2C tenant allows you to collect information about a user during sign-up. You can choose to collect a built-in set of attribute; for example, Given Name, Surname, City, and Postal Code; or you can configure custom user flow attributes. Custom user flow attributes are an abstraction over directory extensions.

identityBuiltInUserFlowAttributes and identityCustomUserFlowAttributes both inherit from this base type.

Methods

Method Return Type Description
List identityUserFlowAttributes collection Retrieve all built-in and custom user flow attributes.
Create identityUserFlowAttribute Create a new custom user flow attribute.
Get identityUserFlowAttribute Retrieve properties of a user flow attribute.
Update None Update a custom user flow attribute.
Delete None Delete a custom user flow attribute.

Properties

Property Type Description
dataType identityUserFlowAttributeDataType The data type of the user flow attribute. Can't be modified after the custom user flow attribute is created. The supported values for dataType are: string , boolean , int64 , stringCollection , dateTime, unknownFutureValue.

Supports $filter (eq, ne).
displayName String The display name of the user flow attribute.

Supports $filter (eq, ne).
description String The description of the user flow attribute that's shown to the user at the time of sign up.
id String The identifier of the user flow attribute. Read-only.

Supports $filter (eq, ne).
userFlowAttributeType identityUserFlowAttributeType The type of the user flow attribute. Read-only. Depending on the type of attribute, the values for this property are builtIn, custom, required, unknownFutureValue.

Supports $filter (eq, ne).

JSON representation

The following JSON representation shows the resource type.

{
    "@odata.type": "#microsoft.graph.identityUserFlowAttribute",
    "id": "String (identifier)",
    "displayName": "String",
    "description": "String",
    "userFlowAttributeType": "String",
    "dataType": "String"
}