msal.oauth2cli.oidc.Client.yml

### YamlMime:UniversalReference
api_name: []
items:
- children:
  - msal.oauth2cli.oidc.Client.build_auth_request_uri
  - msal.oauth2cli.oidc.Client.decode_id_token
  - msal.oauth2cli.oidc.Client.obtain_token_by_authorization_code
  class: msal.oauth2cli.oidc.Client
  fullName: msal.oauth2cli.oidc.Client
  inheritance:
  - inheritance:
    - inheritance:
      - type: builtins.object
      type: msal.oauth2cli.oauth2.BaseClient
    type: msal.oauth2cli.oauth2.Client
  langs:
  - python
  module: msal.oauth2cli.oidc
  name: Client
  summary: 'OpenID Connect is a layer on top of the OAuth2.


    See its specs at [https://openid.net/connect/](https://openid.net/connect/)'
  syntax:
    content: Client(server_configuration, client_id, on_obtaining_tokens=<function
      Client.<lambda>>, on_removing_rt=<function Client.<lambda>>, on_updating_rt=<function
      Client.<lambda>>, **kwargs)
  type: class
  uid: msal.oauth2cli.oidc.Client
- class: msal.oauth2cli.oidc.Client
  fullName: msal.oauth2cli.oidc.Client.build_auth_request_uri
  langs:
  - python
  module: msal.oauth2cli.oidc
  name: build_auth_request_uri(response_type, nonce=None, **kwargs)
  namewithoutparameters: build_auth_request_uri
  summary: 'Generate an authorization uri to be visited by resource owner.


    Return value and all other parameters are the same as

    <xref:oauth2.Client.build_auth_request_uri>, plus new parameter(s):'
  syntax:
    content: build_auth_request_uri(response_type, nonce=None, **kwargs)
    parameters:
    - description: 'A hard-to-guess string used to mitigate replay attacks. See also

        [OIDC specs](https://openid.net/specs/openid-connect-core-1_0.html#AuthRequest).'
      id: nonce
      isRequired: true
    - defaultValue: None
      id: nonce
  type: method
  uid: msal.oauth2cli.oidc.Client.build_auth_request_uri
- class: msal.oauth2cli.oidc.Client
  fullName: msal.oauth2cli.oidc.Client.decode_id_token
  langs:
  - python
  module: msal.oauth2cli.oidc
  name: decode_id_token(id_token, nonce=None)
  namewithoutparameters: decode_id_token
  summary: See <xref:msal.oauth2cli.oidc.Client.decode_id_token>.
  syntax:
    content: decode_id_token(id_token, nonce=None)
    parameters:
    - id: id_token
      isRequired: true
    - defaultValue: None
      id: nonce
  type: method
  uid: msal.oauth2cli.oidc.Client.decode_id_token
- class: msal.oauth2cli.oidc.Client
  fullName: msal.oauth2cli.oidc.Client.obtain_token_by_authorization_code
  langs:
  - python
  module: msal.oauth2cli.oidc
  name: obtain_token_by_authorization_code(code, nonce=None, **kwargs)
  namewithoutparameters: obtain_token_by_authorization_code
  summary: 'Get a token via authorization code. a.k.a. Authorization Code Grant.


    Return value and all other parameters are the same as

    <xref:oauth2.Client.obtain_token_by_authorization_code>,

    plus new parameter(s):'
  syntax:
    content: obtain_token_by_authorization_code(code, nonce=None, **kwargs)
    parameters:
    - description: 'If you provided a nonce when calling <xref:msal.oauth2cli.oidc.Client.build_auth_request_uri>,

        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.'
      id: nonce
      isRequired: true
    - defaultValue: None
      id: nonce
  type: method
  uid: msal.oauth2cli.oidc.Client.obtain_token_by_authorization_code
references:
- fullName: msal.oauth2cli.oidc.Client.build_auth_request_uri
  isExternal: false
  name: build_auth_request_uri(response_type, nonce=None, **kwargs)
  parent: msal.oauth2cli.oidc.Client
  uid: msal.oauth2cli.oidc.Client.build_auth_request_uri
- fullName: msal.oauth2cli.oidc.Client.decode_id_token
  isExternal: false
  name: decode_id_token(id_token, nonce=None)
  parent: msal.oauth2cli.oidc.Client
  uid: msal.oauth2cli.oidc.Client.decode_id_token
- fullName: msal.oauth2cli.oidc.Client.obtain_token_by_authorization_code
  isExternal: false
  name: obtain_token_by_authorization_code(code, nonce=None, **kwargs)
  parent: msal.oauth2cli.oidc.Client
  uid: msal.oauth2cli.oidc.Client.obtain_token_by_authorization_code