List userAttributeAssignments
Namespace: microsoft.graph
Get the identityUserFlowAttributeAssignment resources from the userAttributeAssignments navigation property in a b2cIdentityUserFlow.
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.Read.All | IdentityUserFlow.ReadWrite.All |
Delegated (personal Microsoft account) | Not supported. | Not supported. |
Application | IdentityUserFlow.Read.All | IdentityUserFlow.ReadWrite.All |
HTTP request
GET /identity/b2cUserFlows/{id}/userAttributeAssignments
Optional query parameters
This method supports the $select
and $expand
parameters to get the details of the user flow attribute. For general information, see OData query parameters.
Request headers
Name | Description |
---|---|
Authorization | Bearer {token}. Required. Learn more about authentication and authorization. |
Request body
Don't supply a request body for this method.
Response
If successful, this method returns a 200 OK
response code and a collection of identityUserFlowAttributeAssignment objects in the response body.
Examples
Example 1: List userAttributeAssignments in a b2cIdentityUserFlow
Request
GET https://graph.microsoft.com/beta/identity/b2cUserFlows/{id}/userAttributeAssignments?
Response
Note: The response object shown here might be shortened for readability.
HTTP/1.1 200 OK
Content-Type: application/json
{
"@odata.type": "#microsoft.graph.identityUserFlowAttributeAssignment",
"value": [
{
"id": "City",
"isOptional": false,
"requiresVerification": false,
"userInputType": "RadioSingleSelect",
"displayName": "City",
"userAttributeValues": [
{
"name": "S",
"value": "1",
"isDefault": true
}
]
},
{
"id": "extension_guid_shoeSize",
"isOptional": false,
"requiresVerification": false,
"userInputType": "TextBox",
"displayName": "Shoe size",
"userFlowId": "B2C_1_Consumer",
"userAttributeValues": []
}
]
}
Example 2: List userAttributeAssignments in a b2cIdentityUserFlow and expand userAttribute
Request
GET https://graph.microsoft.com/beta/identity/b2cUserFlows/{id}/userAttributeAssignments?$expand=userAttribute
Response
Note: The response object shown here might be shortened for readability.
HTTP/1.1 200 OK
Content-Type: application/json
{
"@odata.type": "#microsoft.graph.identityUserFlowAttributeAssignment",
"value": [
{
"id": "City",
"isOptional": false,
"requiresVerification": false,
"userInputType": "RadioSingleSelect",
"displayName": "City",
"userAttributeValues": [
{
"name": "S",
"value": "1",
"isDefault": true
}
],
"userAttribute": {
"@odata.type": "#Microsoft.Graph.BuiltInUserFlowAttribute",
"id": "City",
"displayName": "City",
"description": "your city",
"userFlowAttributeType": "builtIn",
"dataType": "string"
}
},
{
"id": "extension_guid_shoeSize",
"isOptional": false,
"requiresVerification": false,
"userInputType": "TextBox",
"displayName": "Shoe size",
"userFlowId": "B2C_1_Consumer",
"userAttributeValues": [],
"userAttribute": {
"@odata.type": "#Microsoft.Graph.CustomUserFlowAttribute",
"id": "extension_guid_shoeSize",
"displayName": "Shoe size",
"description": "Your shoe size",
"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