• flow (dict) -- A dict previously generated by initiate_device_flow(). By default, this method's polling effect will block current thread. You can abort the polling loop at any time, by changing the value of the flow's "expires_at" key to 0.
• claims_challenge -- The claims_challenge parameter requests specific claims requested by the resource provider in the form of a claims_challenge directive in the www-authenticate header to be returned from the UserInfo Endpoint and/or in the ID Token and/or Access Token. It is a string of a JSON object which contains lists of claims being requested from these locations.

• A successful response would contain "access_token" key,
• an error response would contain "error" and usually "error_description".

• username (str) -- Typically a UPN in the form of an email address.
• password (str) -- The password.
• scopes (list[str]) -- Scopes requested to access a protected API (a resource).
• claims_challenge -- The claims_challenge parameter requests specific claims requested by the resource provider in the form of a claims_challenge directive in the www-authenticate header to be returned from the UserInfo Endpoint and/or in the ID Token and/or Access Token. It is a string of a JSON object which contains lists of claims being requested from these locations.

• A successful response would contain "access_token" key,
• an error response would contain "error" and usually "error_description".

• scope (list) -- It is a list of case-sensitive strings.
• prompt (str) -- By default, no prompt value will be sent, not even "none". You will have to specify a value explicitly. Its valid values are defined in Open ID Connect specs https://openid.net/specs/openid-connect-core-1_0.html#AuthRequest
• login_hint (str) -- Optional. Identifier of the user. Generally a User Principal Name (UPN).
• domain_hint --

  Can be one of "consumers" or "organizations" or your tenant domain "contoso.com". If included, it will skip the email-based discovery process that user goes through on the sign-in page, leading to a slightly more streamlined user experience. More information on possible values here and here.

• claims_challenge -- The claims_challenge parameter requests specific claims requested by the resource provider in the form of a claims_challenge directive in the www-authenticate header to be returned from the UserInfo Endpoint and/or in the ID Token and/or Access Token. It is a string of a JSON object which contains lists of claims being requested from these locations.
• timeout (int) -- This method will block the current thread. This parameter specifies the timeout value in seconds. Default value None means wait indefinitely.
• port (int) -- The port to be used to listen to an incoming auth response. By default we will use a system-allocated port. (The rest of the redirect_uri is hard coded as http://localhost.)
• extra_scopes_to_consent (list) -- "Extra scopes to consent" is a concept only available in AAD. It refers to other resources you might want to prompt to consent for, in the same interaction, but for which you won't get back a token for in this particular operation.

• A dict containing no "error" key, and typically contains an "access_token" key, if cache lookup succeeded.
• A dict containing an "error" key, when token refresh failed.

• A successful response would contain "user_code" key, among others
• an error response would contain some other readable key/value pairs.

• scopes (list[str]) -- (Required) Scopes requested to access a protected API (a resource).
• claims_challenge -- The claims_challenge parameter requests specific claims requested by the resource provider in the form of a claims_challenge directive in the www-authenticate header to be returned from the UserInfo Endpoint and/or in the ID Token and/or Access Token. It is a string of a JSON object which contains lists of claims being requested from these locations.

• A successful response would contain "access_token" key,
• an error response would contain "error" and usually "error_description".

• user_assertion (str) -- The incoming token already received by this app
• scopes (list[str]) -- Scopes required by downstream API (a resource).
• claims_challenge -- The claims_challenge parameter requests specific claims requested by the resource provider in the form of a claims_challenge directive in the www-authenticate header to be returned from the UserInfo Endpoint and/or in the ID Token and/or Access Token. It is a string of a JSON object which contains lists of claims being requested from these locations.

• A successful response would contain "access_token" key,
• an error response would contain "error" and usually "error_description".

• client_id (str) -- Your app has a client_id after you register it on AAD.
• client_credential (str) --

  For PublicClientApplication, you simply use None here. For ConfidentialClientApplication, it can be a string containing client secret, or an X509 certificate container in this form:

{


    "private_key": "...-----BEGIN PRIVATE KEY-----...",


    "thumbprint": "A1B2C3D4E5F6...",


    "public_certificate": "...-----BEGIN CERTIFICATE-----... (Optional. See below.)",


    "passphrase": "Passphrase if the private_key is encrypted (Optional. Added in version 1.6.0)",
}

Added in version 0.5.0: public_certificate (optional) is public key certificate which will be sent through 'x5c' JWT header only for subject name and issuer authentication to support cert auto rolls.

Per specs, "the certificate containing the public key corresponding to the key used to digitally sign the JWS MUST be the first certificate. This MAY be followed by additional certificates, with each subsequent certificate being the one used to certify the previous one." However, your certificate's issuer may use a different order. So, if your attempt ends up with an error AADSTS700027 - "The provided signature value did not match the expected signature value", you may try use only the leaf cert (in PEM/str format) instead.

•

client_claims (dict) --

Added in version 0.5.0: It is a dictionary of extra claims that would be signed by by this ConfidentialClientApplication 's private key. For example, you can use {"client_ip": "x.x.x.x"}. You may also override any of the following default claims:

{


    "aud": the_token_endpoint,


    "iss": self.client_id,


    "sub": same_as_issuer,


    "exp": now + 10_min,


    "iat": now,


    "jti": a_random_uuid
}

• authority (str) -- A URL that identifies a token authority. It should be of the format https://login.microsoftonline.com/your_tenant By default, we will use https://login.microsoftonline.com/common
• validate_authority (bool) -- (optional) Turns authority validation on or off. This parameter default to true.
• cache (TokenCache) -- Sets the token cache used by this ClientApplication instance. By default, an in-memory cache will be created and used.
• http_client -- (optional) Your implementation of abstract class HttpClient <msal.oauth2cli.http.http_client> Defaults to a requests session instance
• verify -- (optional) It will be passed to the verify parameter in the underlying requests library This does not apply if you have chosen to pass your own Http client
• proxies -- (optional) It will be passed to the proxies parameter in the underlying requests library This does not apply if you have chosen to pass your own Http client
• timeout -- (optional) It will be passed to the timeout parameter in the underlying requests library This does not apply if you have chosen to pass your own Http client
• app_name -- (optional) You can provide your application name for Microsoft telemetry purposes. Default value is None, means it will not be passed to Microsoft.
• app_version -- (optional) You can provide your application version for Microsoft telemetry purposes. Default value is None, means it will not be passed to Microsoft.
• client_capabilities (list[str]) --

  (optional) Allows configuration of one or more client capabilities, e.g. ["CP1"].

  Client capability is meant to inform the Microsoft identity platform (STS) what this client is capable for, so STS can decide to turn on certain features. For example, if client is capable to handle claims challenge, STS can then issue CAE access tokens to resources knowing when the resource emits claims challenge the client will be capable to handle.

  Implementation details: Client capability is implemented using "claims" parameter on the wire, for now. MSAL will combine them into

  `claims parameter <https://openid.net/specs/openid-connect-core-1_0-final.html#ClaimsParameter`_

  which you will later provide via one of the acquire-token request.

• auth_code_flow (dict) -- The same dict returned by initiate_auth_code_flow().
• auth_response (dict) -- A dict of the query string received from auth server.
• scopes (list[str]) --

  Scopes requested to access a protected API (a resource).

  Most of the time, you can leave it empty.

  If you requested user consent for multiple resources, here you will need to provide a subset of what you required in initiate_auth_code_flow().

  OAuth2 was designed mostly for singleton services, where tokens are always meant for the same resource and the only changes are in the scopes. In AAD, tokens can be issued for multiple 3rd party resources. You can ask authorization code for multiple resources, but when you redeem it, the token is for only one intended recipient, called audience. So the developer need to specify a scope so that we can restrict the token to be issued for the corresponding audience.

• A dict containing "access_token" and/or "id_token", among others, depends on what scope was used. (See https://tools.ietf.org/html/rfc6749#section-5.1)
• A dict containing "error", optionally "error_description", "error_uri". (It is either this or that)
• Most client-side data error would result in ValueError exception. So the usage pattern could be without any protocol details:

def authorize():  # A controller in a web app


    try:


        result = msal_app.acquire_token_by_auth_code_flow(


            session.get("flow", {}), request.args)


        if "error" in result:


            return render_template("error.html", result)


        use(result)  # Token(s) are available in result and cache


    except ValueError:  # Usually caused by CSRF


        pass  # Simply ignore them


    return redirect(url_for("index"))

• code -- The authorization code returned from Authorization Server.
• scopes (list[str]) --

  (Required) Scopes requested to access a protected API (a resource).

  If you requested user consent for multiple resources, here you will typically want to provide a subset of what you required in AuthCode.

  OAuth2 was designed mostly for singleton services, where tokens are always meant for the same resource and the only changes are in the scopes. In AAD, tokens can be issued for multiple 3rd party resources. You can ask authorization code for multiple resources, but when you redeem it, the token is for only one intended recipient, called audience. So the developer need to specify a scope so that we can restrict the token to be issued for the corresponding audience.

• nonce -- If you provided a nonce when calling get_authorization_request_url(), same nonce should also be provided here, so that we'll validate it. An exception will be raised if the nonce in id token mismatches.
• claims_challenge -- The claims_challenge parameter requests specific claims requested by the resource provider in the form of a claims_challenge directive in the www-authenticate header to be returned from the UserInfo Endpoint and/or in the ID Token and/or Access Token. It is a string of a JSON object which contains lists of claims being requested from these locations.

• A successful response would contain "access_token" key,
• an error response would contain "error" and usually "error_description".

• refresh_token (str) -- The old refresh token, as a string.
• scopes (list) -- The scopes associate with this old RT. Each scope needs to be in the Microsoft identity platform (v2) format. See Scopes not resources.

• A dict contains "error" and some other keys, when error happened.
• A dict contains no "error" key means migration was successful.

• A dict containing no "error" key, and typically contains an "access_token" key, if cache lookup succeeded.
• None when cache lookup does not yield a token.

• scopes (list[str]) -- (Required) Scopes requested to access a protected API (a resource).
• account -- one of the account object returned by get_accounts(), or use None when you want to find an access token for this client.
• force_refresh -- If True, it will skip Access Token look-up, and try to find a Refresh Token to obtain a new Access Token.
• claims_challenge -- The claims_challenge parameter requests specific claims requested by the resource provider in the form of a claims_challenge directive in the www-authenticate header to be returned from the UserInfo Endpoint and/or in the ID Token and/or Access Token. It is a string of a JSON object which contains lists of claims being requested from these locations.

• A dict containing no "error" key, and typically contains an "access_token" key, if cache lookup succeeded.
• None when there is simply no token in the cache.
• A dict containing an "error" key, when token refresh failed.

• scopes (list[str]) -- (Required) Scopes requested to access a protected API (a resource).
• state (str) -- Recommended by OAuth2 for CSRF protection.
• login_hint (str) -- Identifier of the user. Generally a User Principal Name (UPN).
• redirect_uri (str) -- Address to return to upon receiving a response from the authority.
• response_type (str) --

  Default value is "code" for an OAuth2 Authorization Code grant.

  You could use other content such as "id_token" or "token", which would trigger an Implicit Grant, but that is not recommended.

• prompt (str) -- By default, no prompt value will be sent, not even "none". You will have to specify a value explicitly. Its valid values are defined in Open ID Connect specs https://openid.net/specs/openid-connect-core-1_0.html#AuthRequest
• nonce -- A cryptographically random value used to mitigate replay attacks. See also OIDC specs.
• domain_hint --

  Can be one of "consumers" or "organizations" or your tenant domain "contoso.com". If included, it will skip the email-based discovery process that user goes through on the sign-in page, leading to a slightly more streamlined user experience. More information on possible values here and here.

• claims_challenge -- The claims_challenge parameter requests specific claims requested by the resource provider in the form of a claims_challenge directive in the www-authenticate header to be returned from the UserInfo Endpoint and/or in the ID Token and/or Access Token. It is a string of a JSON object which contains lists of claims being requested from these locations.

• scope (list) -- It is a list of case-sensitive strings.
• redirect_uri (str) -- Optional. If not specified, server will use the pre-registered one.
• state (str) -- An opaque value used by the client to maintain state between the request and callback. If absent, this library will automatically generate one internally.
• prompt (str) -- By default, no prompt value will be sent, not even "none". You will have to specify a value explicitly. Its valid values are defined in Open ID Connect specs https://openid.net/specs/openid-connect-core-1_0.html#AuthRequest
• login_hint (str) -- Optional. Identifier of the user. Generally a User Principal Name (UPN).
• domain_hint --

  Can be one of "consumers" or "organizations" or your tenant domain "contoso.com". If included, it will skip the email-based discovery process that user goes through on the sign-in page, leading to a slightly more streamlined user experience. More information on possible values here and here.

1.

somehow store this content, typically inside the current session,

2.

guide the end user (i.e. resource owner) to visit that auth_uri,

3.

and then relay this dict and subsequent auth response to acquire_token_by_auth_code_flow().