Get b2xIdentityUserFlow
Namespace: microsoft.graph
Retrieve the properties and relationships of a b2xIdentityUserFlow 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.Read.All | IdentityUserFlow.ReadWrite.All |
Delegated (personal Microsoft account) | Not supported. | Not supported. |
Application | IdentityUserFlow.Read.All | IdentityUserFlow.ReadWrite.All |
The work or school account needs to belong to at least the External ID User Flow Administrator Microsoft Entra role.
HTTP request
GET /identity/b2xUserFlows/{id}
Optional query parameters
You can use $expand
to expand specific user flow properties that aren't expanded by default. For more 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 b2xIdentityUserFlow object in the response body.
Example
Request
The following example shows a request.
GET https://graph.microsoft.com/v1.0/identity/b2xUserFlows/B2X_1_PartnerSignUp
Response
The following example shows the response.
HTTP/1.1 200 OK
Content-type: application/json
{
"id": "B2X_1_PartnerSignUp",
"userFlowType": "signUpOrSignIn",
"userFlowTypeVersion": 1
}
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