identityUserFlowAttribute resource type
Namespace: microsoft.graph
Represents user flow attributes in an Azure Active Directory (Azure AD) tenant.
Configuring user flow attributes in your Azure AD tenant allows you to collect information about a user during sign-up. You can choose to collect a built-in set of attributes. For example, given name, surname, city, and postal code. You can also configure custom user flow attributes to collect information from a user that is not built in to the directory. Custom user flow attributes are an abstraction over Azure Active Directory schema extensions.
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. This cannot be modified after the custom user flow attribute is created. The supported values for dataType are: string , boolean , int64 , stringCollection , dateTime . |
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. |
id | String | The identifier of the user flow attribute. This is a read-only attribute that is automatically created. |
userFlowAttributeType | identityUserFlowAttributeType | The type of the user flow attribute. This is a read-only attribute that is automatically set. Depending on the type of attribute, the values for this property will be builtIn , custom , or required . |
JSON representation
The following is a JSON representation of the resource.
{
"@odata.type": "#microsoft.graph.identityUserFlowAttribute",
"id": "String (identifier)",
"displayName": "String",
"description": "String",
"userFlowAttributeType": "String",
"dataType": "String"
}
Feedback
Submit and view feedback for