Configuratiebestand voor Android Microsoft Authentication Library

De Android-Microsoft Authentication Library (MSAL) wordt geleverd met een standaardconfiguratie-JSON-bestand dat u aanpast om het gedrag van uw openbare client-app te definiëren voor zaken zoals de standaardinstantie, welke autoriteiten u gaat gebruiken, enzovoort.

Dit artikel helpt u inzicht te krijgen in de verschillende instellingen in het configuratiebestand en hoe u het configuratiebestand opgeeft dat moet worden gebruikt in uw MSAL-app.

Configuratie-instellingen

Algemene instellingen

client_id

De client-id of app-id die is gemaakt toen u uw toepassing registreerde.

omleidings_uri

De omleidings-URI die u hebt geregistreerd toen u uw toepassing registreerde. Als de omleidings-URI naar een broker-app is, raadpleegt u omleidings-URI voor openbare client-apps om ervoor te zorgen dat u de juiste omleidings-URI-indeling gebruikt voor uw broker-app.

broker_redirect_uri_registered

Als u brokered verificatie wilt gebruiken, moet de broker_redirect_uri_registered eigenschap worden ingesteld op true. Als de toepassing in een brokered-verificatiescenario niet de juiste indeling heeft om met de broker te communiceren, zoals beschreven in omleidings-URI voor openbare client-apps, valideert de toepassing uw omleidings-URI en genereert een uitzondering wanneer deze wordt gestart.

authorities

De lijst met autoriteiten die door u bekend en vertrouwd zijn. Naast de hier vermelde autoriteiten vraagt MSAL ook Microsoft om een lijst op te halen met clouds en autoriteiten die bekend zijn bij Microsoft. Geef in deze lijst met instanties het type autoriteit en eventuele aanvullende optionele parameters op, zoals "audience", die moeten worden afgestemd op het publiek van uw app op basis van de registratie van uw app. Hier volgt een voorbeeld van een lijst met bronvermeldingen:

// Example AzureAD and Personal Microsoft Account
{
    "type": "AAD",
    "audience": {
        "type": "AzureADandPersonalMicrosoftAccount"
    },
    "default": true // Indicates that this is the default to use if not provided as part of the acquireToken call
},
// Example AzureAD My Organization
{
    "type": "AAD",
    "audience": {
        "type": "AzureADMyOrg",
        "tenant_id": "contoso.com" // Provide your specific tenant ID here
    }
},
// Example AzureAD Multiple Organizations
{
    "type": "AAD",
    "audience": {
        "type": "AzureADMultipleOrgs"
    }
},
//Example PersonalMicrosoftAccount
{
    "type": "AAD",
    "audience": {
        "type": "PersonalMicrosoftAccount"
    }
}

Microsoft Entra autoriteit en doelgroep toewijzen aan Microsoft identity platform eindpunten

Eigenschappen van de instantie

Eigenschappen van doelgroep

authorization_user_agent

Geeft aan of u een ingesloten webweergave of de standaardbrowser op het apparaat gebruikt bij het aanmelden bij een account of het autoriseren van toegang tot een resource.

Mogelijke waarden:

• DEFAULT: Geeft de voorkeur aan de systeembrowser. Maakt gebruik van de ingesloten webweergave als een browser niet beschikbaar is op het apparaat.
• WEBVIEW: Gebruik de ingesloten webweergave.
• BROWSER: gebruikt de standaardbrowser op het apparaat.

multiple_clouds_supported

Geef op voor clients die meerdere nationale clouds trueondersteunen. De Microsoft identity platform wordt vervolgens automatisch omgeleid naar de juiste nationale cloud tijdens autorisatie en inwisseling van tokens. U kunt de nationale cloud van het aangemelde account bepalen door de instantie te onderzoeken die is gekoppeld aan de AuthenticationResult. Houd er rekening mee dat het AuthenticationResult nationale cloudspecifieke eindpuntadres van de resource waarvoor u een token aanvraagt niet opgeeft.

broker_redirect_uri_registered

Een Booleaanse waarde die aangeeft of u een Microsoft Identity Broker-compatibele omleidings-URI voor broker gebruikt. Ingesteld op false als u de broker niet in uw app wilt gebruiken.

Als u de Microsoft Entra Instantie gebruikt waarop doelgroep is ingesteld"MicrosoftPersonalAccount", wordt de broker niet gebruikt.

http

Globale instellingen configureren voor HTTP-time-outs, zoals:

logging

De volgende algemene instellingen zijn bedoeld voor logboekregistratie:

account_mode

Hiermee geeft u op hoeveel accounts in uw app tegelijk kunnen worden gebruikt. Mogelijke waarden zijn:

• MULTIPLE (standaard)
• SINGLE

Als u een PublicClientApplication accountmodus maakt die niet overeenkomt met deze instelling, resulteert dit in een uitzondering.

Zie Apps voor één en meerdere accounts voor meer informatie over de verschillen tussen één en meerdere accounts.

browser_safelist

Een acceptatielijst met browsers die compatibel zijn met MSAL. Deze browsers verwerken correct omleidingen naar aangepaste intenties. U kunt toevoegen aan deze lijst. De standaardwaarde wordt opgegeven in de standaardconfiguratie die hieronder wordt weergegeven. ``

Het standaard MSAL-configuratiebestand

Hieronder ziet u de standaard MSAL-configuratie die wordt geleverd met MSAL. U ziet de nieuwste versie op GitHub.

Deze configuratie wordt aangevuld met waarden die u opgeeft. De waarden die u opgeeft, overschrijven de standaardwaarden.

{
  "authorities": [
    {
      "type": "AAD",
      "audience": {
        "type": "AzureADandPersonalMicrosoftAccount"
      },
      "default": true
    }
  ],
  "authorization_user_agent": "DEFAULT",
  "multiple_clouds_supported": false,
  "broker_redirect_uri_registered": false,
  "http": {
    "connect_timeout": 10000,
    "read_timeout": 30000
  },
  "logging": {
    "pii_enabled": false,
    "log_level": "WARNING",
    "logcat_enabled": false
  },
  "shared_device_mode_supported": false,
  "account_mode": "MULTIPLE",
  "browser_safelist": [
    {
      "browser_package_name": "com.android.chrome",
      "browser_signature_hashes": [
        "7fmdu...2NDJg=="
      ],
      "browser_use_customTab" : true,
      "browser_version_lower_bound": "45"
    },
    {
      "browser_package_name": "com.android.chrome",
      "browser_signature_hashes": [
        "7fmdu...2NDJg=="
      ],
      "browser_use_customTab" : false
    },
    {
      "browser_package_name": "org.mozilla.firefox",
      "browser_signature_hashes": [
        "2gCe6...idpVQ=="
      ],
      "browser_use_customTab" : false
    },
    {
      "browser_package_name": "org.mozilla.firefox",
      "browser_signature_hashes": [
        "2gCe6...idpVQ=="
      ],
      "browser_use_customTab" : true,
      "browser_version_lower_bound": "57"
    },
    {
      "browser_package_name": "com.sec.android.app.sbrowser",
      "browser_signature_hashes": [
        "ABi2f...4O1Xgg=="
      ],
      "browser_use_customTab" : true,
      "browser_version_lower_bound": "4.0"
    },
    {
      "browser_package_name": "com.sec.android.app.sbrowser",
      "browser_signature_hashes": [
        "ABi2f...O1Xgg=="
      ],
      "browser_use_customTab" : false
    },
    {
      "browser_package_name": "com.cloudmosa.puffinFree",
      "browser_signature_hashes": [
        "1WqG8...Mn8Ag=="
      ],
      "browser_use_customTab" : false
    },
    {
      "browser_package_name": "com.duckduckgo.mobile.android",
      "browser_signature_hashes": [
        "S5Av4...jAi4Q=="
      ],
      "browser_use_customTab" : false
    },
    {
      "browser_package_name": "com.explore.web.browser",
      "browser_signature_hashes": [
        "BzDzB...YHCag=="
      ],
      "browser_use_customTab" : false
    },

    {
      "browser_package_name": "com.ksmobile.cb",
      "browser_signature_hashes": [
        "lFDYx...7nouw=="
      ],
      "browser_use_customTab" : false
    },

    {
      "browser_package_name": "com.microsoft.emmx",
      "browser_signature_hashes": [
        "Ivy-R...A6fVQ=="
      ],
      "browser_use_customTab" : false
    },

    {
      "browser_package_name": "com.opera.browser",
      "browser_signature_hashes": [
        "FIJ3I...jWJWw=="
      ],
      "browser_use_customTab" : false
    },

    {
      "browser_package_name": "com.opera.mini.native",
      "browser_signature_hashes": [
        "TOTyH...mmUYQ=="
      ],
      "browser_use_customTab" : false
    },

    {
      "browser_package_name": "mobi.mgeek.TunnyBrowser",
      "browser_signature_hashes": [
        "RMVoX...bkyyQ=="
      ],
      "browser_use_customTab" : false
    },

    {
      "browser_package_name": "org.mozilla.focus",
      "browser_signature_hashes": [
        "L72dT...q0oYA=="
      ],
      "browser_use_customTab" : false
    }
  ]
}

Voorbeeld van basisconfiguratie

In het volgende voorbeeld ziet u een basisconfiguratie waarmee de client-id, omleidings-URI wordt opgegeven, of een brokeromleiding is geregistreerd en een lijst met instanties.

{
  "client_id" : "00001111-aaaa-2222-bbbb-3333cccc4444",
  "redirect_uri" : "msauth://com.microsoft.identity.client.sample.local/1wIqXSqBj7w%2Bh11ZifsnqwgyKrY%3D",
  "broker_redirect_uri_registered": true,
  "authorities" : [
    {
      "type": "AAD",
      "audience": {
        "type": "AzureADandPersonalMicrosoftAccount"
      }
      "default": true
    }
  ]
}

Een configuratiebestand gebruiken

1. Maak een configuratiebestand. U wordt aangeraden uw aangepaste configuratiebestand te maken in res/raw/auth_config.json. Maar je kunt het overal plaatsen waar je wilt.

2. Laat MSAL weten waar u naar uw configuratie moet zoeken wanneer u de PublicClientApplicationconfiguratie maakt. Voorbeeld:

   //On Worker Thread
   IMultipleAccountPublicClientApplication sampleApp = null; 
   sampleApp = new PublicClientApplication.createMultipleAccountPublicClientApplication(getApplicationContext(), R.raw.auth_config);