IdentityUserFlow.Read.All
Allows the app to read your organization's user flows, on behalf of the signed-in user.
Graph Methods
Type: A = Application Permission, D = Delegate Permission
| Ver |
Type |
Method |
| V1 |
A,D |
GET /identity/b2cUserFlows |
| V1 |
A,D |
GET /identity/b2cUserFlows/{b2cIdentityUserFlowId}/userAttributeAssignments/getOrder |
| V1 |
A,D |
GET /identity/b2cUserFlows/{id} |
| V1 |
A,D |
GET /identity/b2cUserFlows/{id}/languages |
| V1 |
A,D |
GET /identity/b2cUserFlows/{id}/languages/{id}/defaultPages |
| V1 |
A,D |
GET /identity/b2cUserFlows/{id}/languages/{id}/defaultPages/{id}/$value |
| V1 |
A,D |
GET /identity/b2cUserFlows/{id}/languages/{id}/overridesPages |
| V1 |
A,D |
GET /identity/b2cUserFlows/{id}/languages/{id}/overridesPages/{id}/$value |
| V1 |
A,D |
GET /identity/b2cUserFlows/{id}/userAttributeAssignments |
| V1 |
A,D |
GET /identity/b2cUserFlows/{id}/userAttributeAssignments/{id} |
| V1 |
A,D |
GET /identity/b2xUserFlows |
| V1 |
A,D |
GET /identity/b2xUserFlows/{b2xIdentityUserFlowId}/userAttributeAssignments/getOrder |
| V1 |
A,D |
GET /identity/b2xUserFlows/{id} |
| V1 |
A,D |
GET /identity/b2xUserFlows/{id}/languages |
| V1 |
A,D |
GET /identity/b2xUserFlows/{id}/languages/{id}/defaultPages |
| V1 |
A,D |
GET /identity/b2xUserFlows/{id}/languages/{id}/defaultPages/{id}/$value |
| V1 |
A,D |
GET /identity/b2xUserFlows/{id}/languages/{id}/overridesPages |
| V1 |
A,D |
GET /identity/b2xUserFlows/{id}/languages/{id}/overridesPages/{id}/$value |
| V1 |
A,D |
GET /identity/b2xUserFlows/{id}/userAttributeAssignments |
| V1 |
A,D |
GET /identity/b2xUserFlows/{id}/userAttributeAssignments/{id} |
| V1 |
A,D |
GET /identity/userFlowAttributes |
| V1 |
A,D |
GET /identity/userFlowAttributes/{id} |
| V1 |
A,D |
GET /identity/userFlows |
| V1 |
A,D |
GET /identity/userFlows/{id} |
| V1 |
A,D |
GET identity/b2cUserFlows/{id}/languages/{id} |
| V1 |
A,D |
GET identity/b2xUserFlows/{id}/languages/{id} |
Delegate Permission
|
|
| Id |
2903d63d-4611-4d43-99ce-a33f3f52e343 |
| Consent Type |
Admin |
| Display String |
Read all identity user flows |
| Description |
Allows the app to read your organization's user flows, on behalf of the signed-in user. |
Application Permission
|
|
| Id |
1b0c317f-dd31-4305-9932-259a8b6e8099 |
| Display String |
Read all identity user flows |
| Description |
Allows the app to read your organization's user flows, without a signed-in user. |
Resources
| Property |
Type |
Description |
| order |
String collection |
A list of identityUserFlowAttribute object identifiers that determine the order in which attributes should be collected within a user flow. |
| Property |
Type |
Description |
| id |
String |
The name of the user flow. This is a required value and is immutable after it's created. The name will be prefixed with the value of B2C_1_ after creation. |
| userFlowType |
userFlowType |
The type of user flow. The supported values for userFlowType are: signUp, signIn, signUpOrSignIn, passwordReset, profileUpdate, resourceOwner. |
| userFlowTypeVersion |
Single |
The version of the user flow. |
| isLanguageCustomizationEnabled |
Boolean |
The property that determines whether language customization is enabled within the B2C user flow. Language customization is not enabled by default for B2C user flows. |
| defaultLanguageTag |
String |
Indicates the default language of the b2cIdentityUserFlow that is used when no ui_locale tag is specified in the request. This field is RFC 5646 compliant. |
| apiConnectorConfiguration |
userFlowApiConnectorConfiguration |
Configuration for enabling an API connector for use as part of the user flow. You can only obtain the value of this object using Get userFlowApiConnectorConfiguration. |
| Property |
Type |
Description |
| apiConnectorConfiguration |
userFlowApiConnectorConfiguration |
Configuration for enabling an API connector for use as part of the self-service sign-up user flow. You can only obtain the value of this object using Get userFlowApiConnectorConfiguration. |
| id |
String |
The name of the user flow. This is a required value and is immutable after it's created. The name will be prefixed with the value of B2X_1_ after creation. |
| userFlowType |
userFlowType |
The type of user flow. For self-service sign-up user flows, the value can only be signUpOrSignIn and cannot be modified after creation. |
| userFlowTypeVersion |
Single |
The version of the user flow. For self-service sign-up user flows, the version is always 1. |
| Property |
Type |
Description |
| id |
String |
The identifier of the user flow. The prefix of B2C_1_ is added to the value that you provide. |
| userFlowType |
userFlowType |
Possible values are: signUp, signIn, signUpOrSignIn, passwordReset, profileUpdate, resourceOwner, unknownFutureValue. |
| userFlowTypeVersion |
Single |
This is the version of the user flow type. Each user flow type can have different possible versions such as 1, 1.1 or 2. |
| 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. |
| Property |
Type |
Description |
| displayName |
String |
The display name of the identityUserFlowAttribute within a user flow. |
| id |
String |
The identifier of the identityUserFlowAttributeAssignment. This identifier is immutable after it is created. This is a read-only property. |
| isOptional |
Boolean |
Determines whether the identityUserFlowAttribute is optional. true means the user doesn't have to provide a value. false means the user cannot complete sign-up without providing a value. |
| requiresVerification |
Boolean |
Determines whether the identityUserFlowAttribute requires verification. This is only used for verifying the user's phone number or email address. |
| userAttributeValues |
userAttributeValuesItem collection |
The input options for the user flow attribute. Only applicable when the userInputType is radioSingleSelect, dropdownSingleSelect, or checkboxMultiSelect. |
| userInputType |
identityUserFlowAttributeInputType |
The input type of the user flow attribute. Possible values are: textBox, dateTimeDropdown, radioSingleSelect, dropdownSingleSelect, emailBox, checkboxMultiSelect. |
| Property |
Type |
Description |
| displayName |
String |
The language name to display. This property is read-only. |
| id |
String |
The identifier of the language. This field is Language ID tag RFC 5646 compliant and must be a documented Language ID. |
| isEnabled |
Boolean |
Indicates whether the language is enabled within the user flow. |
| Property |
Type |
Description |
| id |
String |
The identifier of the userFlowLanguage page. |