Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions msal/docs-ref-autogen/@azure/msal-browser/AccountInfo.yml
Original file line number Diff line number Diff line change
Expand Up @@ -30,19 +30,23 @@ summary: >-

- tenantProfiles - Map of tenant profile objects for each tenant that
the account has authenticated with in the browser

- dataBoundary - Data boundary extracted from clientInfo
fullName: AccountInfo
remarks: ''
isDeprecated: false
syntax: |
type AccountInfo = {
authorityType?: string
dataBoundary?: DataBoundary
environment: string
homeAccountId: string
idToken?: string
idTokenClaims?: TokenClaims & {
[key: string]: string | number | string[] | object | undefined | unknown
}
localAccountId: string
loginHint?: string
name?: string
nativeAccountId?: string
tenantId: string
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,17 @@ fullName: AuthFlowActionRequiredStateBase<TParameter>
remarks: ''
isDeprecated: false
type: class
constructors:
- name: AuthFlowActionRequiredStateBase<TParameter>(TParameter)
uid: '@azure/msal-browser.AuthFlowActionRequiredStateBase.constructor'
package: '@azure/msal-browser'
summary: Creates a new instance of AuthFlowActionRequiredStateBase.
remarks: ''
isDeprecated: false
syntax:
content: 'new AuthFlowActionRequiredStateBase(stateParameters: TParameter)'
parameters:
- id: stateParameters
type: TParameter
description: The parameters for the auth state.
extends: <xref uid="@azure/msal-browser.AuthFlowStateBase" />
36 changes: 36 additions & 0 deletions msal/docs-ref-autogen/@azure/msal-browser/AuthMethodDetails.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
### YamlMime:TSType
name: AuthMethodDetails
uid: '@azure/msal-browser.AuthMethodDetails'
package: '@azure/msal-browser'
summary: Details for an authentication method to be registered.
fullName: AuthMethodDetails
remarks: ''
isDeprecated: false
type: interface
properties:
- name: authMethodType
uid: '@azure/msal-browser.AuthMethodDetails.authMethodType'
package: '@azure/msal-browser'
summary: The authentication method type to register.
fullName: authMethodType
remarks: ''
isDeprecated: false
syntax:
content: 'authMethodType: AuthenticationMethod'
return:
description: ''
type: <xref uid="@azure/msal-browser.AuthenticationMethod" />
- name: verificationContact
uid: '@azure/msal-browser.AuthMethodDetails.verificationContact'
package: '@azure/msal-browser'
summary: >-
The verification contact (email, phone number) for the authentication
method.
fullName: verificationContact
remarks: ''
isDeprecated: false
syntax:
content: 'verificationContact: string'
return:
description: ''
type: string
Original file line number Diff line number Diff line change
@@ -0,0 +1,100 @@
### YamlMime:TSType
name: AuthMethodRegistrationChallengeMethodError
uid: '@azure/msal-browser.AuthMethodRegistrationChallengeMethodError'
package: '@azure/msal-browser'
summary: Error that occurred during authentication method challenge request.
fullName: AuthMethodRegistrationChallengeMethodError
remarks: ''
isDeprecated: false
type: class
constructors:
- name: AuthMethodRegistrationChallengeMethodError(CustomAuthError)
uid: '@azure/msal-browser.AuthMethodRegistrationChallengeMethodError.constructor'
package: '@azure/msal-browser'
summary: ''
remarks: ''
isDeprecated: false
syntax:
content: >-
new AuthMethodRegistrationChallengeMethodError(errorData:
CustomAuthError)
parameters:
- id: errorData
type: <xref uid="@azure/msal-browser.CustomAuthError" />
description: ''
inheritedProperties:
- name: errorData
uid: '@azure/msal-browser.AuthMethodRegistrationChallengeMethodError.errorData'
package: '@azure/msal-browser'
summary: ''
fullName: errorData
remarks: ''
isDeprecated: false
syntax:
content: 'errorData: CustomAuthError'
return:
description: ''
type: <xref uid="@azure/msal-browser.CustomAuthError" />
inheritanceDescription: <b>Inherited From</b> AuthActionErrorBase.errorData
inheritedMethods:
- name: isRedirectRequired()
uid: >-
@azure/msal-browser.AuthMethodRegistrationChallengeMethodError.isRedirectRequired
package: '@azure/msal-browser'
summary: Check if client app supports the challenge type configured in Entra.
remarks: ''
isDeprecated: false
syntax:
content: 'function isRedirectRequired(): boolean'
return:
description: >-
True if client app doesn't support the challenge type configured in
Entra, "loginPopup" function is required to continue the operation.
type: boolean
inheritanceDescription: <b>Inherited From</b> AuthActionErrorBase.isRedirectRequired
- name: isTokenExpired()
uid: >-
@azure/msal-browser.AuthMethodRegistrationChallengeMethodError.isTokenExpired
package: '@azure/msal-browser'
summary: Checks if the error is due to the expired continuation token.
remarks: ''
isDeprecated: false
syntax:
content: 'function isTokenExpired(): boolean'
return:
description: >-
True if the error is due to the expired continuation token, false
otherwise.
type: boolean
inheritanceDescription: <b>Inherited From</b> AuthActionErrorBase.isTokenExpired
methods:
- name: isInvalidInput()
uid: >-
@azure/msal-browser.AuthMethodRegistrationChallengeMethodError.isInvalidInput
package: '@azure/msal-browser'
summary: Checks if the input for auth method registration is incorrect.
remarks: ''
isDeprecated: false
syntax:
content: 'function isInvalidInput(): boolean'
return:
description: true if the input is incorrect, false otherwise.
type: boolean
- name: isVerificationContactBlocked()
uid: >-
@azure/msal-browser.AuthMethodRegistrationChallengeMethodError.isVerificationContactBlocked
package: '@azure/msal-browser'
summary: >-
Checks if the error is due to the verification contact (e.g., phone number
or email) being blocked. Consider using a different email/phone number or
a different authentication method.
remarks: ''
isDeprecated: false
syntax:
content: 'function isVerificationContactBlocked(): boolean'
return:
description: >-
true if the error is due to the verification contact being blocked,
false otherwise.
type: boolean
extends: AuthActionErrorBase
Original file line number Diff line number Diff line change
@@ -0,0 +1,146 @@
### YamlMime:TSType
name: AuthMethodRegistrationChallengeMethodResult
uid: '@azure/msal-browser.AuthMethodRegistrationChallengeMethodResult'
package: '@azure/msal-browser'
summary: |-
Result of challenging an authentication method for registration.
Uses base state type to avoid circular dependencies.
fullName: AuthMethodRegistrationChallengeMethodResult
remarks: ''
isDeprecated: false
type: class
constructors:
- name: >-
AuthMethodRegistrationChallengeMethodResult(AuthMethodRegistrationChallengeMethodResultState,
CustomAuthAccountData)
uid: >-
@azure/msal-browser.AuthMethodRegistrationChallengeMethodResult.constructor
package: '@azure/msal-browser'
summary: ''
remarks: ''
isDeprecated: false
syntax:
content: >-
new AuthMethodRegistrationChallengeMethodResult(state:
AuthMethodRegistrationChallengeMethodResultState, data?:
CustomAuthAccountData)
parameters:
- id: state
type: >-
<xref
uid="@azure/msal-browser.AuthMethodRegistrationChallengeMethodResultState"
/>
description: ''
- id: data
type: <xref uid="@azure/msal-browser.CustomAuthAccountData" />
description: ''
inheritedProperties:
- name: data
uid: '@azure/msal-browser.AuthMethodRegistrationChallengeMethodResult.data'
package: '@azure/msal-browser'
summary: ''
fullName: data
remarks: ''
isDeprecated: false
syntax:
content: 'data?: CustomAuthAccountData'
return:
description: ''
type: <xref uid="@azure/msal-browser.CustomAuthAccountData" />
inheritanceDescription: <b>Inherited From</b> AuthFlowResultBase.data
- name: error
uid: '@azure/msal-browser.AuthMethodRegistrationChallengeMethodResult.error'
package: '@azure/msal-browser'
summary: ''
fullName: error
remarks: ''
isDeprecated: false
syntax:
content: 'error?: AuthMethodRegistrationChallengeMethodError'
return:
description: ''
type: >-
<xref
uid="@azure/msal-browser.AuthMethodRegistrationChallengeMethodError"
/>
inheritanceDescription: <b>Inherited From</b> AuthFlowResultBase.error
- name: state
uid: '@azure/msal-browser.AuthMethodRegistrationChallengeMethodResult.state'
package: '@azure/msal-browser'
summary: ''
fullName: state
remarks: ''
isDeprecated: false
syntax:
content: 'state: AuthMethodRegistrationChallengeMethodResultState'
return:
description: ''
type: >-
<xref
uid="@azure/msal-browser.AuthMethodRegistrationChallengeMethodResultState"
/>
inheritanceDescription: <b>Inherited From</b> AuthFlowResultBase.state
methods:
- name: createWithError(unknown)
uid: >-
@azure/msal-browser.AuthMethodRegistrationChallengeMethodResult.createWithError
package: '@azure/msal-browser'
summary: Creates an AuthMethodRegistrationChallengeMethodResult with an error.
remarks: ''
isDeprecated: false
syntax:
content: >-
static function createWithError(error: unknown):
AuthMethodRegistrationChallengeMethodResult
parameters:
- id: error
type: unknown
description: The error that occurred.
return:
description: The AuthMethodRegistrationChallengeMethodResult with error.
type: >-
<xref
uid="@azure/msal-browser.AuthMethodRegistrationChallengeMethodResult"
/>
- name: isCompleted()
uid: >-
@azure/msal-browser.AuthMethodRegistrationChallengeMethodResult.isCompleted
package: '@azure/msal-browser'
summary: >-
Checks if the result indicates that registration is completed (fast-pass
scenario).
remarks: ''
isDeprecated: false
syntax:
content: 'function isCompleted(): boolean'
return:
description: true if registration is completed, false otherwise.
type: boolean
- name: isFailed()
uid: '@azure/msal-browser.AuthMethodRegistrationChallengeMethodResult.isFailed'
package: '@azure/msal-browser'
summary: Checks if the result is in a failed state.
remarks: ''
isDeprecated: false
syntax:
content: 'function isFailed(): boolean'
return:
description: true if the result is failed, false otherwise.
type: boolean
- name: isVerificationRequired()
uid: >-
@azure/msal-browser.AuthMethodRegistrationChallengeMethodResult.isVerificationRequired
package: '@azure/msal-browser'
summary: Checks if the result indicates that verification is required.
remarks: ''
isDeprecated: false
syntax:
content: 'function isVerificationRequired(): boolean'
return:
description: true if verification is required, false otherwise.
type: boolean
extends: >-
AuthFlowResultBase&lt;<xref
uid="@azure/msal-browser.AuthMethodRegistrationChallengeMethodResultState" />,
<xref uid="@azure/msal-browser.AuthMethodRegistrationChallengeMethodError" />,
<xref uid="@azure/msal-browser.CustomAuthAccountData" />&gt;
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
### YamlMime:TSTypeAlias
name: AuthMethodRegistrationChallengeMethodResultState
uid: '@azure/msal-browser.AuthMethodRegistrationChallengeMethodResultState'
package: '@azure/msal-browser'
summary: >-
Type definition for possible states in
AuthMethodRegistrationChallengeMethodResult.
fullName: AuthMethodRegistrationChallengeMethodResultState
remarks: ''
isDeprecated: false
syntax: |
type AuthMethodRegistrationChallengeMethodResultState =
| AuthMethodVerificationRequiredState
| AuthMethodRegistrationCompletedState
| AuthMethodRegistrationFailedState
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
### YamlMime:TSType
name: AuthMethodRegistrationCompletedState
uid: '@azure/msal-browser.AuthMethodRegistrationCompletedState'
package: '@azure/msal-browser'
summary: Base class for the state of an authentication flow.
fullName: AuthMethodRegistrationCompletedState
remarks: ''
isDeprecated: false
type: class
extends: <xref uid="@azure/msal-browser.AuthFlowStateBase" />
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
### YamlMime:TSType
name: AuthMethodRegistrationFailedState
uid: '@azure/msal-browser.AuthMethodRegistrationFailedState'
package: '@azure/msal-browser'
summary: Base class for the state of an authentication flow.
fullName: AuthMethodRegistrationFailedState
remarks: ''
isDeprecated: false
type: class
extends: <xref uid="@azure/msal-browser.AuthFlowStateBase" />
Loading