Create identityUserFlowAttribute
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.
Create a new custom identityUserFlowAttribute object.
This API is available in the following national cloud deployments.
Global service | US Government L4 | US Government L5 (DOD) | China operated by 21Vianet |
---|---|---|---|
✅ | ✅ | ✅ | ✅ |
Permissions
Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.
Permission type | Least privileged permissions | Higher privileged permissions |
---|---|---|
Delegated (work or school account) | IdentityUserFlow.ReadWrite.All | Not available. |
Delegated (personal Microsoft account) | Not supported. | Not supported. |
Application | IdentityUserFlow.ReadWrite.All | Not available. |
For delegated scenarios, the administrator needs at least the External ID User Flow Attribute Administrator Microsoft Entra role.
HTTP request
POST /identity/userFlowAttributes
Request headers
Name | Description |
---|---|
Authorization | Bearer {token}. Required. Learn more about authentication and authorization. |
Content-Type | application/json. Required. |
Request body
In the request body, provide a JSON representation of identityUserFlowAttribute.
Property | Type | Description |
---|---|---|
id | String | The identifier of the user flow attribute. This is a read-only attribute that is automatically created. |
displayName | String | The display name of the user flow attribute. |
description | String | The description of the user flow attribute. It's shown to the user at the time of sign-up. |
userFlowAttributeType | String | 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 are builtIn or custom . |
dataType | String | The data type of the user flow attribute. This can't be modified once the custom user flow attribute is created. The supported values for dataType are:
|
Response
If successful, this method returns a 201 Created
response code and identityUserFlowAttribute object in the response body. If unsuccessful, a 4xx
error is returned with specific details.
Examples
Request
The following example shows a request.
POST https://graph.microsoft.com/beta/identity/userFlowAttributes
Content-type: application/json
{
"displayName": "Hobby",
"description": "Your hobby",
"dataType": "string"
}
Response
The following example shows the response.
Note: The response object shown here might be shortened for readability.
HTTP/1.1 201 Created
Location: "/identity/userFlowAttributes('extension_d09380e2b4c642b9a203fb816a04a7ad_Hobby')"
Content-type: application/json
{
"id": "extension_d09380e2b4c642b9a203fb816a04a7ad_Hobby",
"displayName": "Hobby",
"description": "Your hobby",
"userFlowAttributeType": "custom",
"dataType": "string"
}
Feedback
https://aka.ms/ContentUserFeedback.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see:Submit and view feedback for