Note
Access to this page requires authorization. You can try signing in or .
Access to this page requires authorization. You can try .
New-MgIdentityB2XUserFlow
Create a new b2xIdentityUserFlow object.
Note
To view the beta release of this cmdlet, view New-MgBetaIdentityB2XUserFlow
Syntax
CreateExpanded (Default)
New-MgIdentityB2XUserFlow
[-ResponseHeadersVariable <string>]
[-AdditionalProperties <hashtable>]
[-ApiConnectorConfiguration <IMicrosoftGraphUserFlowApiConnectorConfiguration>]
[-Id <string>]
[-IdentityProviders <IMicrosoftGraphIdentityProvider[]>]
[-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-MgIdentityB2XUserFlow
-BodyParameter <IMicrosoftGraphB2XIdentityUserFlow>
[-ResponseHeadersVariable <string>]
[-Break]
[-Headers <IDictionary>]
[-HttpPipelineAppend <SendAsyncStep[]>]
[-HttpPipelinePrepend <SendAsyncStep[]>]
[-Proxy <uri>]
[-ProxyCredential <pscredential>]
[-ProxyUseDefaultCredentials]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Parameters
-AdditionalProperties
Additional Parameters
Parameter properties
| Type: | System.Collections.Hashtable |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-ApiConnectorConfiguration
userFlowApiConnectorConfiguration To construct, see NOTES section for APICONNECTORCONFIGURATION properties and create a hash table.
Parameter properties
| Type: | Microsoft.Graph.PowerShell.Models.IMicrosoftGraphUserFlowApiConnectorConfiguration |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-BodyParameter
b2xIdentityUserFlow To construct, see NOTES section for BODYPARAMETER properties and create a hash table.
Parameter properties
| Type: | Microsoft.Graph.PowerShell.Models.IMicrosoftGraphB2XIdentityUserFlow |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-Break
Wait for .NET debugger to attach
Parameter properties
| Type: | System.Management.Automation.SwitchParameter |
| Default value: | False |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-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
-Headers
Optional headers that will be added to the request.
Parameter properties
| Type: | System.Collections.IDictionary |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-HttpPipelineAppend
SendAsync Pipeline Steps to be appended to the front of the pipeline
Parameter properties
| Type: | Microsoft.Graph.PowerShell.Runtime.SendAsyncStep[] |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-HttpPipelinePrepend
SendAsync Pipeline Steps to be prepended to the front of the pipeline
Parameter properties
| Type: | Microsoft.Graph.PowerShell.Runtime.SendAsyncStep[] |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-Id
The unique identifier for an entity. Read-only.
Parameter properties
| Type: | System.String |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-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.PowerShell.Models.IMicrosoftGraphIdentityProvider[] |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-Languages
The languages supported for customization within the user flow. Language customization is enabled by default in self-service sign-up user flow. You can't create custom languages in self-service sign-up user flows. To construct, see NOTES section for LANGUAGES properties and create a hash table.
Parameter properties
| Type: | Microsoft.Graph.PowerShell.Models.IMicrosoftGraphUserFlowLanguageConfiguration[] |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-Proxy
The URI for the proxy server to use
Parameter properties
| Type: | System.Uri |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-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
-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
-ResponseHeadersVariable
Optional Response Headers Variable.
Parameter properties
| Type: | System.String |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | RHV |
Parameter sets
-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.PowerShell.Models.IMicrosoftGraphIdentityUserFlowAttributeAssignment[] |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-UserFlowIdentityProviders
To construct, see NOTES section for USERFLOWIDENTITYPROVIDERS properties and create a hash table.
Parameter properties
| Type: | Microsoft.Graph.PowerShell.Models.IMicrosoftGraphIdentityProviderBase[] |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-UserFlowType
userFlowType
Parameter properties
| Type: | System.String |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-UserFlowTypeVersion
Parameter properties
| Type: | System.Single |
| Default value: | 0 |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-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
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.PowerShell.Models.IMicrosoftGraphB2XIdentityUserFlow
{{ Fill in the Description }}
System.Collections.IDictionary
{{ Fill in the Description }}
Outputs
Microsoft.Graph.PowerShell.Models.IMicrosoftGraphB2XIdentityUserFlow
{{ 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
BODYPARAMETER <IMicrosoftGraphB2XIdentityUserFlow>: b2xIdentityUserFlow
[(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
[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.
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.
[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 enabled by default in self-service sign-up user flow.
You can't create custom languages in self-service sign-up 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 you 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, and 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?>]: 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.
[UserInputType <String>]: identityUserFlowAttributeInputType
[UserFlowIdentityProviders <IMicrosoftGraphIdentityProviderBase[]>]:
[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. 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. [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 enabled by default in self-service sign-up user flow. You can't create custom languages in self-service sign-up 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 you 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, and 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?>]: 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. [UserInputType <String>]: identityUserFlowAttributeInputType
USERFLOWIDENTITYPROVIDERS <IMicrosoftGraphIdentityProviderBase[]>: . [Id <String>]: The unique identifier for an entity. Read-only. [DisplayName <String>]: The display name of the identity provider.