Azure-docs: ADALError to MsalException ErrorCode documentation seems missing

Created on 17 Aug 2020 · 5Comments · Source: MicrosoftDocs/azure-docs

[Enter feedback here]

Document Details

⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

ID: 3f3073d5-376e-44af-6057-79019456b3f5
Version Independent ID: bf455a28-2792-e1ce-ba03-e86ded9947cc
Content: ADAL to MSAL migration guide for Android
Content Source: articles/active-directory/develop/migrate-android-adal-msal.md
Service: active-directory
Sub-service: develop
GitHub Login: @mmacy
Microsoft Alias: marsma

Pri2 active-directorsvc assigned-to-author develosubsvc doc-bug triaged

Source

samsil

All 5 comments

@samsil
Thanks for your feedback! We will investigate and update as appropriate.

JamesTran-MSFT on 17 Aug 2020

@hamiltonha Haley, as @samsil calls out, it seems we have an empty ADALError to MsalException ErrorCode section in this doc - looks like it was missed on initial publish. Assigning over to you for investigation: #reassign:hamiltonha

Instead of filling out that section, though, what about adding an ADALError equivalent column to the table in the previous section? Not sure they translate one-to-one, however, so if completing the ADALError to MsalException ErrorCode section makes more sense, we should go that route.

Something like this:

Migrate to the new exceptions

In ADAL, there's one type of exception, AuthenticationException, which includes a method for retrieving the ADALError enum value. In MSAL, there's a hierarchy of exceptions, and each has its own set of associated error codes.

The following table shows a mapping between ADALErrors and their MsalException equivalents.

| MsalException | Description | ADALError equivalent |
|:-------------------------------------------------|:--------------------------------------------------------------------|:---------------------|
| MsalException | Default checked exception thrown by MSAL. | {ADALError here} |
| MsalClientException | Thrown if the error is client side. | {ADALError here} |
| MsalArgumentException | Thrown if one or more inputs arguments are invalid. | {ADALError here} |
| MsalClientException | Thrown if the error is client side. | {ADALError here} |
| MsalServiceException | Thrown if the error is server side. | {ADALError here} |
| MsalUserCancelException | Thrown if the user canceled the authentication flow. | {ADALError here} |
| MsalUiRequiredException | Thrown if the token can't be refreshed silently. | {ADALError here} |
| MsalDeclinedScopeException | Thrown if one or more requested scopes were declined by the server. | {ADALError here} |
| MsalIntuneAppProtectionPolicyRequiredException | Thrown if the resource has MAMCA protection policy enabled. | {ADALError here} |

mmacy on 17 Aug 2020

👍1

@hamiltonha Ping on this Haley, we still have an empty section on this doc.

If you can provide an MSAL-to-ADAL mapping for me for the errors in the table above that section, I can update the doc with the new column in the table as proposed in https://github.com/MicrosoftDocs/azure-docs/issues/61007#issuecomment-674972923.

mmacy on 8 Oct 2020

@mmacy acked - will get to it shortly

hamiltonha on 8 Oct 2020

👍1

@samsil This section has been populated and now appears as such:

ADALError to MsalException translation

| If you're catching these errors in ADAL... | ...catch these MSAL exceptions: |
|--------------------------------------------------|---------------------------------------------------------------------|
| No equivalent ADALError | MsalArgumentException |
|