magpie.api.login.wso2
=====================

.. py:module:: magpie.api.login.wso2


Attributes
----------

.. autoapisummary::

   magpie.api.login.wso2.PROVIDER_ID_MAP


Classes
-------

.. autoapisummary::

   magpie.api.login.wso2.WSO2


Module Contents
---------------

.. py:class:: WSO2(*args, **kwargs)

   Bases: :py:obj:`authomatic.providers.oauth2.OAuth2`


   Base class for |oauth2|_ providers.

   Accepts additional keyword arguments:

   :param list scope:
       List of strings specifying requested permissions as described
       in the
       `OAuth 2.0 spec <http://tools.ietf.org/html/rfc6749#section-3.3>`_.

   :param bool offline:
       If ``True`` the **provider** will be set up to request an
       *offline access token*.
       Default is ``False``.

   :param str certificate_file:
       Certificate file to employ for HTTPS connection where needed.

   :param bool ssl_verify:
       Certificate file to employ for HTTPS connection where needed.

   As well as those inherited from :class:`.AuthorizationProvider`
   constructor.



   .. py:attribute:: access_token_url
      :value: ''


      :class:`str` URL where we can get the *access token* to access
      **protected resources** of a **user**. See
      http://tools.ietf.org/html/rfc6749#section-4.1.3 and
      http://oauth.net/core/1.0a/#auth_step3.



   .. py:attribute:: user_authorization_url
      :value: ''


      :class:`str` URL to which we redirect the **user** to grant our app
      i.e. the **consumer** an **authorization** to access his
      **protected resources**. See
      http://tools.ietf.org/html/rfc6749#section-4.1.1 and
      http://oauth.net/core/1.0a/#auth_step2.



   .. py:attribute:: user_info_url
      :value: ''


      :class:`str` URL where we can get the **user** info.
      see http://tools.ietf.org/html/rfc6749#section-7 and
      http://oauth.net/core/1.0a/#anchor12.



   .. py:attribute:: url
      :value: ''



   .. py:attribute:: _x_use_authorization_header
      :value: False



   .. py:attribute:: hostname


   .. py:attribute:: user_info_scope


   .. py:attribute:: scope


   .. py:attribute:: cert


   .. py:attribute:: verify


   .. py:attribute:: _logger


   .. py:attribute:: supported_user_attributes


   .. py:method:: _x_user_parser(user, data)
      :staticmethod:


      Handles different structure of user info data by different providers.

      :param user:
          :class:`.User`
      :param dict data:
          User info data returned by provider.




.. py:data:: PROVIDER_ID_MAP