|
| 1 | +============ |
| 2 | +Partner Auth |
| 3 | +============ |
| 4 | + |
| 5 | +.. |
| 6 | + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! |
| 7 | + !! This file is generated by oca-gen-addon-readme !! |
| 8 | + !! changes will be overwritten. !! |
| 9 | + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! |
| 10 | + !! source digest: sha256:33a8bc75dc8127331753aa9a54fe3a5b56f7d51a23cc7e9eb0000cc55f78c689 |
| 11 | + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! |
| 12 | +
|
| 13 | +.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png |
| 14 | + :target: https://odoo-community.org/page/development-status |
| 15 | + :alt: Beta |
| 16 | +.. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png |
| 17 | + :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html |
| 18 | + :alt: License: AGPL-3 |
| 19 | +.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Frest--framework-lightgray.png?logo=github |
| 20 | + :target: https://github.com/OCA/rest-framework/tree/18.0/auth_partner |
| 21 | + :alt: OCA/rest-framework |
| 22 | +.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png |
| 23 | + :target: https://translation.odoo-community.org/projects/rest-framework-18-0/rest-framework-18-0-auth_partner |
| 24 | + :alt: Translate me on Weblate |
| 25 | +.. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png |
| 26 | + :target: https://runboat.odoo-community.org/builds?repo=OCA/rest-framework&target_branch=18.0 |
| 27 | + :alt: Try me on Runboat |
| 28 | + |
| 29 | +|badge1| |badge2| |badge3| |badge4| |badge5| |
| 30 | + |
| 31 | +This module adds to the partners the ability to authenticate through |
| 32 | +directories. |
| 33 | + |
| 34 | +This module does not implement any routing, it only provides the basic |
| 35 | +mechanisms in a directory for: |
| 36 | + |
| 37 | + - Registering a partner and sending an welcome email (to validate |
| 38 | + email address): \_signup |
| 39 | + - Authenticating a partner: \_login |
| 40 | + - Validating a partner email using a token: \_validate_email |
| 41 | + - Impersonating: \_impersonate, \_impersonating |
| 42 | + - Resetting the password with a unique token sent by mail: |
| 43 | + \_request_reset_password, \_set_password |
| 44 | + - Sending an invite mail when registering a partner from odoo |
| 45 | + interface for the partner to enter a password: \_send_invite, |
| 46 | + \_set_password |
| 47 | + |
| 48 | +For a routing implementation, see the |
| 49 | +`fastapi_auth_partner <../fastapi_auth_partner>`__ module. |
| 50 | + |
| 51 | +**Table of contents** |
| 52 | + |
| 53 | +.. contents:: |
| 54 | + :local: |
| 55 | + |
| 56 | +Usage |
| 57 | +===== |
| 58 | + |
| 59 | +This module isn't meant to be used standalone but you can still see the |
| 60 | +directories and authenticable partners in: |
| 61 | + |
| 62 | +Settings > Technical > Partner Authentication > Partner |
| 63 | + |
| 64 | +and |
| 65 | + |
| 66 | +Settings > Technical > Partner Authentication > Directory |
| 67 | + |
| 68 | +Bug Tracker |
| 69 | +=========== |
| 70 | + |
| 71 | +Bugs are tracked on `GitHub Issues <https://github.com/OCA/rest-framework/issues>`_. |
| 72 | +In case of trouble, please check there if your issue has already been reported. |
| 73 | +If you spotted it first, help us to smash it by providing a detailed and welcomed |
| 74 | +`feedback <https://github.com/OCA/rest-framework/issues/new?body=module:%20auth_partner%0Aversion:%2018.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_. |
| 75 | + |
| 76 | +Do not contact contributors directly about support or help with technical issues. |
| 77 | + |
| 78 | +Credits |
| 79 | +======= |
| 80 | + |
| 81 | +Authors |
| 82 | +------- |
| 83 | + |
| 84 | +* Akretion |
| 85 | + |
| 86 | +Contributors |
| 87 | +------------ |
| 88 | + |
| 89 | +- `Akretion <https://www.akretion.com>`__: |
| 90 | + |
| 91 | + - Sébastien Beau |
| 92 | + - Florian Mounier |
| 93 | + |
| 94 | +Maintainers |
| 95 | +----------- |
| 96 | + |
| 97 | +This module is maintained by the OCA. |
| 98 | + |
| 99 | +.. image:: https://odoo-community.org/logo.png |
| 100 | + :alt: Odoo Community Association |
| 101 | + :target: https://odoo-community.org |
| 102 | + |
| 103 | +OCA, or the Odoo Community Association, is a nonprofit organization whose |
| 104 | +mission is to support the collaborative development of Odoo features and |
| 105 | +promote its widespread use. |
| 106 | + |
| 107 | +.. |maintainer-paradoxxxzero| image:: https://github.com/paradoxxxzero.png?size=40px |
| 108 | + :target: https://github.com/paradoxxxzero |
| 109 | + :alt: paradoxxxzero |
| 110 | + |
| 111 | +Current `maintainer <https://odoo-community.org/page/maintainer-role>`__: |
| 112 | + |
| 113 | +|maintainer-paradoxxxzero| |
| 114 | + |
| 115 | +This module is part of the `OCA/rest-framework <https://github.com/OCA/rest-framework/tree/18.0/auth_partner>`_ project on GitHub. |
| 116 | + |
| 117 | +You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute. |
0 commit comments