IdentityUserFlow.ReadWrite.All
Allows the app to read or write 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 |
DELETE /identity/b2cUserFlows/{id} |
V1 |
A,D |
DELETE /identity/b2cUserFlows/{id}/identityProviders/{id}/$ref |
V1 |
A,D |
DELETE /identity/b2cUserFlows/{id}/languages/{id} |
V1 |
A,D |
DELETE /identity/b2cUserFlows/{id}/languages/{id}/overridesPages/$value |
V1 |
A,D |
DELETE /identity/b2cUserFlows/{id}/userAttributeAssignments/{id} |
V1 |
A,D |
DELETE /identity/b2cUserFlows/{userflow-id}/userflowIdentityProviders/{identityProvider-id}/$ref |
V1 |
A,D |
DELETE /identity/b2xUserFlows/{id} |
V1 |
A,D |
DELETE /identity/b2xUserFlows/{id}/identityProviders/{id}/$ref |
V1 |
A,D |
DELETE /identity/b2xUserFlows/{id}/languages/{id}/overridesPages/$value |
V1 |
A,D |
DELETE /identity/b2xUserFlows/{id}/userAttributeAssignments/{id} |
V1 |
A,D |
DELETE /identity/userFlowAttributes/{id} |
V1 |
A,D |
DELETE /identity/userFlows/{id} |
V1 |
A,D |
DELETE/identity/b2xUserFlows/{userflow-id}/userflowIdentityProviders/{id}/$ref |
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}/identityProviders |
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/b2cUserFlows/{userflow-id}/userflowIdentityProviders |
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}/identityProviders |
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/b2xUserFlows/{userflow-id}/userflowIdentityProviders |
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}/apiConnectorConfiguration |
V1 |
A,D |
GET identity/b2cUserFlows/{id}/languages/{id} |
V1 |
A,D |
GET identity/b2xUserFlows/{id}/apiConnectorConfiguration |
V1 |
A,D |
GET identity/b2xUserFlows/{id}/languages/{id} |
V1 |
A,D |
PATCH /identity/b2cUserFlows/{id} |
V1 |
A,D |
PATCH /identity/b2cUserFlows/{id}/userAttributeAssignments/{id} |
V1 |
A,D |
PATCH /identity/b2cUserFlows/{userflow-id}/userflowIdentityProviders/$ref |
V1 |
A,D |
PATCH /identity/b2xUserFlows/{id}/userAttributeAssignments/{id} |
V1 |
A,D |
PATCH /identity/b2xUserFlows/{userflow-id}/userflowIdentityProviders/$ref |
V1 |
A,D |
PATCH /identity/userFlowAttributes/{id} |
V1 |
A,D |
POST /identity/b2cUserFlows |
V1 |
A,D |
POST /identity/b2cUserFlows/{b2cIdentityUserFlowId}/userAttributeAssignments/setOrder |
V1 |
A,D |
POST /identity/b2cUserFlows/{id}/identityProviders/$ref |
V1 |
A,D |
POST /identity/b2cUserFlows/{id}/userAttributeAssignments |
V1 |
A,D |
POST /identity/b2xUserFlows |
V1 |
A,D |
POST /identity/b2xUserFlows/{b2xIdentityUserFlowId}/userAttributeAssignments/setOrder |
V1 |
A,D |
POST /identity/b2xUserFlows/{id}/identityProviders/$ref |
V1 |
A,D |
POST /identity/b2xUserFlows/{id}/userAttributeAssignments |
V1 |
A,D |
POST /identity/userFlowAttributes |
V1 |
A,D |
POST /identity/userFlows |
V1 |
A,D |
PUT /identity/b2cUserFlows/{b2cUserFlowId}/apiConnectorConfiguration/{step}/$ref |
V1 |
A,D |
PUT /identity/b2cUserFlows/{id}/languages/{id} |
V1 |
A,D |
PUT /identity/b2cUserFlows/{id}/languages/{id}/overridesPages/{id}/$value |
V1 |
A,D |
PUT /identity/b2xUserFlows/{b2xUserFlowId}/apiConnectorConfiguration/{step}/$ref |
V1 |
A,D |
PUT /identity/b2xUserFlows/{id}/languages/{id}/overridesPages/{id}/$value |
Delegate Permission
|
|
Id |
281892cc-4dbf-4e3a-b6cc-b21029bb4e82 |
Consent Type |
Admin |
Display String |
Read and write all identity user flows |
Description |
Allows the app to read or write your organization's user flows, on behalf of the signed-in user. |
Application Permission
|
|
Id |
65319a09-a2be-469d-8782-f6b07debf789 |
Display String |
Read and write all identity user flows |
Description |
Allows the app to read or write 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 |
authenticationConfiguration |
apiAuthenticationConfigurationBase |
The object which describes the authentication configuration details for calling the API. Basic and PKCS 12 client certificate are supported. |
displayName |
String |
The name of the API connector. |
id |
String |
The randomly generated identifier of the API connector. |
targetUrl |
String |
The URL of the API endpoint to call. |
Property |
Type |
Description |
clientId |
String |
The client ID for the application. This is the client ID obtained when registering the application with the identity provider. Required. Not nullable. |
clientSecret |
String |
The client secret for the application. This is the client secret obtained when registering the application with the identity provider. This is write-only. A read operation will return **** . Required. Not nullable. |
id |
String |
The ID of the identity provider. |
name |
String |
The display name of the identity provider. Not nullable. |
type |
String |
The identity provider type is a required field. For B2B scenario: Google , Facebook . For B2C scenario: Microsoft , Google , Amazon , LinkedIn , Facebook , GitHub , Twitter , Weibo , QQ , WeChat , OpenIDConnect . Not nullable. |
Property |
Type |
Description |
displayName |
String |
The display name of the identity provider. |
id |
String |
The identifier of the identity provider. |
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 |
isDefault |
Boolean |
Determines whether the value is set as the default. |
name |
String |
The display name of the property displayed to the user in the user flow. |
value |
String |
The value that is set when this item is selected. |
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. |