New-MgBetaIdentityB2CUserFlow
Create a new b2cIdentityUserFlow object.
Syntax
CreateExpanded (Default)
New-MgBetaIdentityB2CUserFlow
[-ResponseHeadersVariable <string>]
[-AdditionalProperties <hashtable>]
[-ApiConnectorConfiguration <IMicrosoftGraphUserFlowApiConnectorConfiguration>]
[-DefaultLanguageTag <string>]
[-Id <string>]
[-IdentityProviders <IMicrosoftGraphIdentityProvider[]>]
[-IsLanguageCustomizationEnabled]
[-Languages <IMicrosoftGraphUserFlowLanguageConfiguration[]>]
[-UserAttributeAssignments <IMicrosoftGraphIdentityUserFlowAttributeAssignment[]>]
[-UserFlowIdentityProviders <IMicrosoftGraphIdentityProviderBase[]>]
[-UserFlowType <string>]
[-UserFlowTypeVersion <float>]
[-Break]
[-Headers <IDictionary>]
[-HttpPipelineAppend <SendAsyncStep[]>]
[-HttpPipelinePrepend <SendAsyncStep[]>]
[-Proxy <uri>]
[-ProxyCredential <pscredential>]
[-ProxyUseDefaultCredentials]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Create
New-MgBetaIdentityB2CUserFlow
-BodyParameter <IMicrosoftGraphB2CIdentityUserFlow>
[-ResponseHeadersVariable <string>]
[-Break]
[-Headers <IDictionary>]
[-HttpPipelineAppend <SendAsyncStep[]>]
[-HttpPipelinePrepend <SendAsyncStep[]>]
[-Proxy <uri>]
[-ProxyCredential <pscredential>]
[-ProxyUseDefaultCredentials]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
Create a new b2cIdentityUserFlow object.
Permissions
| Permission type | Permissions (from least to most privileged) |
|---|---|
| Delegated (work or school account) | IdentityUserFlow.ReadWrite.All, |
| Delegated (personal Microsoft account) | Not supported |
| Application | IdentityUserFlow.ReadWrite.All, |
Examples
Example 1: Using the New-MgBetaIdentityB2CUserFlow Cmdlet
Import-Module Microsoft.Graph.Beta.Identity.SignIns
$params = @{
Id = "UserFlowWithAPIConnector"
UserFlowType = "signUpOrSignIn"
UserFlowTypeVersion = 1
ApiConnectorConfiguration = @{
PostFederationSignup = @{
"@odata.id" = "{apiConnectorId}"
}
PostAttributeCollection = @{
"@odata.id" = "{apiConnectorId}"
}
}
}
New-MgBetaIdentityB2CUserFlow -BodyParameter $params
This example shows how to use the New-MgBetaIdentityB2CUserFlow Cmdlet. To learn about permissions for this resource, see the permissions reference.
Example 2: Using the New-MgBetaIdentityB2CUserFlow Cmdlet
Import-Module Microsoft.Graph.Beta.Identity.SignIns
$params = @{
Id = "Customer"
UserFlowType = "signUpOrSignIn"
UserFlowTypeVersion = 3
IdentityProviders = @(
@{
Id = "Facebook-OAuth"
}
)
}
New-MgBetaIdentityB2CUserFlow -BodyParameter $params
This example shows how to use the New-MgBetaIdentityB2CUserFlow Cmdlet. To learn about permissions for this resource, see the permissions reference.
Example 3: Using the New-MgBetaIdentityB2CUserFlow Cmdlet
Import-Module Microsoft.Graph.Beta.Identity.SignIns
$params = @{
Id = "Customer"
UserFlowType = "signUpOrSignIn"
UserFlowTypeVersion = 3
}
New-MgBetaIdentityB2CUserFlow -BodyParameter $params
This example shows how to use the New-MgBetaIdentityB2CUserFlow Cmdlet. To learn about permissions for this resource, see the permissions reference.
Parameters
-AdditionalProperties
Additional Parameters
Parameter properties
| Type: | System.Collections.Hashtable |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
CreateExpanded
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-ApiConnectorConfiguration
userFlowApiConnectorConfiguration To construct, see NOTES section for APICONNECTORCONFIGURATION properties and create a hash table.
Parameter properties
| Type: | Microsoft.Graph.Beta.PowerShell.Models.IMicrosoftGraphUserFlowApiConnectorConfiguration |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
CreateExpanded
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-BodyParameter
b2cIdentityUserFlow To construct, see NOTES section for BODYPARAMETER properties and create a hash table.
Parameter properties
| Type: | Microsoft.Graph.Beta.PowerShell.Models.IMicrosoftGraphB2CIdentityUserFlow |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
Create
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Break
Wait for .NET debugger to attach
Parameter properties
| Type: | System.Management.Automation.SwitchParameter |
| Default value: | False |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
| Type: | System.Management.Automation.SwitchParameter |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | cf |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-DefaultLanguageTag
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.
Parameter properties
| Type: | System.String |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
CreateExpanded
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Headers
Optional headers that will be added to the request.
Parameter properties
| Type: | System.Collections.IDictionary |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-HttpPipelineAppend
SendAsync Pipeline Steps to be appended to the front of the pipeline
Parameter properties
| Type: | Microsoft.Graph.Beta.PowerShell.Runtime.SendAsyncStep[] |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-HttpPipelinePrepend
SendAsync Pipeline Steps to be prepended to the front of the pipeline
Parameter properties
| Type: | Microsoft.Graph.Beta.PowerShell.Runtime.SendAsyncStep[] |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Id
The unique identifier for an entity. Read-only.
Parameter properties
| Type: | System.String |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
CreateExpanded
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-IdentityProviders
The identity providers included in the user flow. To construct, see NOTES section for IDENTITYPROVIDERS properties and create a hash table.
Parameter properties
| Type: | Microsoft.Graph.Beta.PowerShell.Models.IMicrosoftGraphIdentityProvider[] |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
CreateExpanded
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-IsLanguageCustomizationEnabled
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.
Parameter properties
| Type: | System.Management.Automation.SwitchParameter |
| Default value: | False |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
CreateExpanded
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Languages
The languages supported for customization within the user flow. Language customization is not enabled by default in B2C user flows. To construct, see NOTES section for LANGUAGES properties and create a hash table.
Parameter properties
| Type: | Microsoft.Graph.Beta.PowerShell.Models.IMicrosoftGraphUserFlowLanguageConfiguration[] |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
CreateExpanded
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Proxy
The URI for the proxy server to use
Parameter properties
| Type: | System.Uri |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-ProxyCredential
Credentials for a proxy server to use for the remote call
Parameter properties
| Type: | System.Management.Automation.PSCredential |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-ProxyUseDefaultCredentials
Use the default credentials for the proxy
Parameter properties
| Type: | System.Management.Automation.SwitchParameter |
| Default value: | False |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-ResponseHeadersVariable
Optional Response Headers Variable.
Parameter properties
| Type: | System.String |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | RHV |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-UserAttributeAssignments
The user attribute assignments included in the user flow. To construct, see NOTES section for USERATTRIBUTEASSIGNMENTS properties and create a hash table.
Parameter properties
| Type: | Microsoft.Graph.Beta.PowerShell.Models.IMicrosoftGraphIdentityUserFlowAttributeAssignment[] |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
CreateExpanded
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-UserFlowIdentityProviders
The identity providers included in the user flow. To construct, see NOTES section for USERFLOWIDENTITYPROVIDERS properties and create a hash table.
Parameter properties
| Type: | Microsoft.Graph.Beta.PowerShell.Models.IMicrosoftGraphIdentityProviderBase[] |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
CreateExpanded
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-UserFlowType
userFlowType
Parameter properties
| Type: | System.String |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
CreateExpanded
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-UserFlowTypeVersion
Create a new b2cIdentityUserFlow object.
Permissions
| Permission type | Permissions (from least to most privileged) |
|---|---|
| Delegated (work or school account) | IdentityUserFlow.ReadWrite.All, |
| Delegated (personal Microsoft account) | Not supported |
| Application | IdentityUserFlow.ReadWrite.All, |
Parameter properties
| Type: | System.Single |
| Default value: | 0 |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
CreateExpanded
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-WhatIf
Runs the command in a mode that only reports what would happen without performing the actions.
Parameter properties
| Type: | System.Management.Automation.SwitchParameter |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | wi |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Inputs
Microsoft.Graph.Beta.PowerShell.Models.IMicrosoftGraphB2CIdentityUserFlow
{{ Fill in the Description }}
System.Collections.IDictionary
{{ Fill in the Description }}
Outputs
Microsoft.Graph.Beta.PowerShell.Models.IMicrosoftGraphB2CIdentityUserFlow
{{ Fill in the Description }}
Notes
COMPLEX PARAMETER PROPERTIES
To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables.
APICONNECTORCONFIGURATION <IMicrosoftGraphUserFlowApiConnectorConfiguration>: userFlowApiConnectorConfiguration
[(Any) <Object>]: This indicates any property can be added to this object.
[PostAttributeCollection <IMicrosoftGraphIdentityApiConnector>]: identityApiConnector
[(Any) <Object>]: This indicates any property can be added to this object.
[Id <String>]: The unique identifier for an entity.
Read-only.
[AuthenticationConfiguration <IMicrosoftGraphApiAuthenticationConfigurationBase>]: apiAuthenticationConfigurationBase
[(Any) <Object>]: This indicates any property can be added to this object.
[DisplayName <String>]: The name of the API connector.
[TargetUrl <String>]: The URL of the API endpoint to call.
[PostFederationSignup <IMicrosoftGraphIdentityApiConnector>]: identityApiConnector
[PreTokenIssuance <IMicrosoftGraphIdentityApiConnector>]: identityApiConnector
BODYPARAMETER <IMicrosoftGraphB2CIdentityUserFlow>: b2cIdentityUserFlow
[(Any) <Object>]: This indicates any property can be added to this object.
[UserFlowType <String>]: userFlowType
[UserFlowTypeVersion <Single?>]:
[Id <String>]: The unique identifier for an entity.
Read-only.
[ApiConnectorConfiguration <IMicrosoftGraphUserFlowApiConnectorConfiguration>]: userFlowApiConnectorConfiguration
[(Any) <Object>]: This indicates any property can be added to this object.
[PostAttributeCollection <IMicrosoftGraphIdentityApiConnector>]: identityApiConnector
[(Any) <Object>]: This indicates any property can be added to this object.
[Id <String>]: The unique identifier for an entity.
Read-only.
[AuthenticationConfiguration <IMicrosoftGraphApiAuthenticationConfigurationBase>]: apiAuthenticationConfigurationBase
[(Any) <Object>]: This indicates any property can be added to this object.
[DisplayName <String>]: The name of the API connector.
[TargetUrl <String>]: The URL of the API endpoint to call.
[PostFederationSignup <IMicrosoftGraphIdentityApiConnector>]: identityApiConnector
[PreTokenIssuance <IMicrosoftGraphIdentityApiConnector>]: identityApiConnector
[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.
[IdentityProviders <IMicrosoftGraphIdentityProvider[]>]: The identity providers included in the user flow.
[Id <String>]: The unique identifier for an entity.
Read-only.
[ClientId <String>]: The client ID for the application obtained when registering the application with the identity provider.
This is a required field.
Required.
Not nullable.
[ClientSecret <String>]: The client secret for the application obtained when registering the application with the identity provider.
This is write-only.
A read operation returns .
This is a required field.
Required.
Not nullable.
[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.
[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.
[Languages <IMicrosoftGraphUserFlowLanguageConfiguration[]>]: The languages supported for customization within the user flow.
Language customization is not enabled by default in B2C user flows.
[Id <String>]: The unique identifier for an entity.
Read-only.
[DefaultPages <IMicrosoftGraphUserFlowLanguagePage[]>]: Collection of pages with the default content to display in a user flow for a specified language.
This collection doesn't allow any kind of modification.
[Id <String>]: The unique identifier for an entity.
Read-only.
[DisplayName <String>]: The language name to display.
This property is read-only.
[IsEnabled <Boolean?>]: Indicates whether the language is enabled within the user flow.
[OverridesPages <IMicrosoftGraphUserFlowLanguagePage[]>]: Collection of pages with the overrides messages to display in a user flow for a specified language.
This collection only allows to modify the content of the page, any other modification isn't allowed (creation or deletion of pages).
[UserAttributeAssignments <IMicrosoftGraphIdentityUserFlowAttributeAssignment[]>]: The user attribute assignments included in the user flow.
[Id <String>]: The unique identifier for an entity.
Read-only.
[DisplayName <String>]: The display name of the identityUserFlowAttribute within a user flow.
[IsOptional <Boolean?>]: Determines whether the identityUserFlowAttribute is optional.
true means the user doesn't have to provide a value.
false means the user can't 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.
[UserAttribute <IMicrosoftGraphIdentityUserFlowAttribute>]: identityUserFlowAttribute
[(Any) <Object>]: This indicates any property can be added to this object.
[Id <String>]: The unique identifier for an entity.
Read-only.
[DataType <String>]: identityUserFlowAttributeDataType
[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.
Supports $filter (eq, ne).
[UserFlowAttributeType <String>]: identityUserFlowAttributeType
[UserAttributeValues <IMicrosoftGraphUserAttributeValuesItem[]>]: The input options for the user flow attribute.
Only applicable when the userInputType is radioSingleSelect, dropdownSingleSelect, or checkboxMultiSelect.
[IsDefault <Boolean?>]: Used to set the value as the default.
[Name <String>]: The display name of the property displayed to the end user in the user flow.
[Value <String>]: The value that is set when this item is selected.
[UserInputType <String>]: identityUserFlowAttributeInputType
[UserFlowIdentityProviders <IMicrosoftGraphIdentityProviderBase[]>]: The identity providers included in the user flow.
[Id <String>]: The unique identifier for an entity.
Read-only.
[DisplayName <String>]: The display name of the identity provider.
IDENTITYPROVIDERS <IMicrosoftGraphIdentityProvider[]>: The identity providers included in the user flow. [Id <String>]: The unique identifier for an entity. Read-only. [ClientId <String>]: The client ID for the application obtained when registering the application with the identity provider. This is a required field. Required. Not nullable. [ClientSecret <String>]: The client secret for the application obtained when registering the application with the identity provider. This is write-only. A read operation returns . This is a required field. Required. Not nullable. [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.
LANGUAGES <IMicrosoftGraphUserFlowLanguageConfiguration[]>: The languages supported for customization within the user flow. Language customization is not enabled by default in B2C user flows. [Id <String>]: The unique identifier for an entity. Read-only. [DefaultPages <IMicrosoftGraphUserFlowLanguagePage[]>]: Collection of pages with the default content to display in a user flow for a specified language. This collection doesn't allow any kind of modification. [Id <String>]: The unique identifier for an entity. Read-only. [DisplayName <String>]: The language name to display. This property is read-only. [IsEnabled <Boolean?>]: Indicates whether the language is enabled within the user flow. [OverridesPages <IMicrosoftGraphUserFlowLanguagePage[]>]: Collection of pages with the overrides messages to display in a user flow for a specified language. This collection only allows to modify the content of the page, any other modification isn't allowed (creation or deletion of pages).
USERATTRIBUTEASSIGNMENTS <IMicrosoftGraphIdentityUserFlowAttributeAssignment[]>: The user attribute assignments included in the user flow. [Id <String>]: The unique identifier for an entity. Read-only. [DisplayName <String>]: The display name of the identityUserFlowAttribute within a user flow. [IsOptional <Boolean?>]: Determines whether the identityUserFlowAttribute is optional. true means the user doesn't have to provide a value. false means the user can't 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. [UserAttribute <IMicrosoftGraphIdentityUserFlowAttribute>]: identityUserFlowAttribute [(Any) <Object>]: This indicates any property can be added to this object. [Id <String>]: The unique identifier for an entity. Read-only. [DataType <String>]: identityUserFlowAttributeDataType [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. Supports $filter (eq, ne). [UserFlowAttributeType <String>]: identityUserFlowAttributeType [UserAttributeValues <IMicrosoftGraphUserAttributeValuesItem[]>]: The input options for the user flow attribute. Only applicable when the userInputType is radioSingleSelect, dropdownSingleSelect, or checkboxMultiSelect. [IsDefault <Boolean?>]: Used to set the value as the default. [Name <String>]: The display name of the property displayed to the end user in the user flow. [Value <String>]: The value that is set when this item is selected. [UserInputType <String>]: identityUserFlowAttributeInputType
USERFLOWIDENTITYPROVIDERS <IMicrosoftGraphIdentityProviderBase[]>: The identity providers included in the user flow. [Id <String>]: The unique identifier for an entity. Read-only. [DisplayName <String>]: The display name of the identity provider.