SignUpAttributesRequiredState class
Base class for the action requried state in an authentication flow.
- Extends
-
SignUpState<SignUpAttributesRequiredStateParameters>
Properties
| state |
The type of the state. |
Methods
| get |
Gets the required attributes for sign-up. |
| submit |
Submits attributes to continue sign-up flow. This methods is used to submit required attributes. These attributes, built in or custom, were configured in the Microsoft Entra admin center by the tenant administrator. |
Constructor Details
SignUpAttributesRequiredState(SignUpAttributesRequiredStateParameters)
new SignUpAttributesRequiredState(stateParameters: SignUpAttributesRequiredStateParameters)Parameters
- stateParameters
-
SignUpAttributesRequiredStateParameters
Property Details
stateType
The type of the state.
stateType: stringProperty Value
string
Method Details
getRequiredAttributes()
Gets the required attributes for sign-up.
function getRequiredAttributes(): UserAttribute[]Returns
UserAttribute[]
The required attributes for sign-up.
submitAttributes(UserAccountAttributes)
Submits attributes to continue sign-up flow. This methods is used to submit required attributes. These attributes, built in or custom, were configured in the Microsoft Entra admin center by the tenant administrator.
function submitAttributes(attributes: UserAccountAttributes): Promise<SignUpSubmitAttributesResult>Parameters
- attributes
- UserAccountAttributes
The attributes to submit.
Returns
Promise<SignUpSubmitAttributesResult>
The result of the operation.