diff --git a/README.md b/README.md new file mode 100644 index 0000000..56f67c1 --- /dev/null +++ b/README.md @@ -0,0 +1,52 @@ +# pas.plugins.eea + +Provides user and group enumeration on top of pas.plugins.authomatic + +Features + +- user enumeration +- groups enumeration +- group member enumeration +- user group enumeration + +# Documentation + +This addon depends on [pas.plugins.authomatic](https://github.com/collective/pas.plugins.authomatic). +Upon installation, it will automatically run the setup step for `pas.plugins.authomatic`. + +In order for this plugin to function correctly, the Entra ID application should be granted the following **API +permissions** in the `Microsoft.Graph` scope via the Azure Portal: + +- `Group.Read.All` +- `GroupMember.Read.All` +- `User.Read.All` + +The type for all the permissions is `Application` and _"Admin consent"_ must be granted. + +# Installation + +Install pas.plugins.eea by adding it to your buildout:: + + [buildout] + + ... + + eggs = + pas.plugins.eea + +and then running ``bin/buildout`` + +After enabling the product in Site Setup -> Add-ons, make sure to: + +- go into Site Setup -> Authomatic (OAuth2/OpenID) and make sure that _"Generator for Plone User IDs."_ is set to * + *Provider User ID**. +- update the JSON configuration + +# Contribute + +- Issue Tracker: https://github.com/eea/pas.plugins.eea/issues +- Source Code: https://github.com/eea/pas.plugins.eea + +# License + +The project is licensed under the GPLv2. diff --git a/README.rst b/README.rst deleted file mode 100644 index 8d93704..0000000 --- a/README.rst +++ /dev/null @@ -1,111 +0,0 @@ -.. This README is meant for consumption by humans and PyPI. PyPI can render rst files so please do not use Sphinx features. - If you want to learn more about writing documentation, please check out: http://docs.plone.org/about/documentation_styleguide.html - This text does not appear on PyPI or github. It is a comment. - -.. image:: https://github.com/collective/pas.plugins.eea/actions/workflows/plone-package.yml/badge.svg - :target: https://github.com/collective/pas.plugins.eea/actions/workflows/plone-package.yml - -.. image:: https://coveralls.io/repos/github/collective/pas.plugins.eea/badge.svg?branch=main - :target: https://coveralls.io/github/collective/pas.plugins.eea?branch=main - :alt: Coveralls - -.. image:: https://codecov.io/gh/collective/pas.plugins.eea/branch/master/graph/badge.svg - :target: https://codecov.io/gh/collective/pas.plugins.eea - -.. image:: https://img.shields.io/pypi/v/pas.plugins.eea.svg - :target: https://pypi.python.org/pypi/pas.plugins.eea/ - :alt: Latest Version - -.. image:: https://img.shields.io/pypi/status/pas.plugins.eea.svg - :target: https://pypi.python.org/pypi/pas.plugins.eea - :alt: Egg Status - -.. image:: https://img.shields.io/pypi/pyversions/pas.plugins.eea.svg?style=plastic :alt: Supported - Python Versions - -.. image:: https://img.shields.io/pypi/l/pas.plugins.eea.svg - :target: https://pypi.python.org/pypi/pas.plugins.eea/ - :alt: License - - -=============== -pas.plugins.eea -=============== - -Provides user and group enumeration on top of pas.plugins.authomatic - -Features --------- - -- Can be bullet points - - -Examples --------- - -This add-on can be seen in action at the following sites: -- Is there a page on the internet where everybody can see the features? - - -Documentation -------------- - -Full documentation for end users can be found in the "docs" folder, and is also available online at http://docs.plone.org/foo/bar - - -Translations ------------- - -This product has been translated into - -- Klingon (thanks, K'Plai) - - -Installation ------------- - -Install pas.plugins.eea by adding it to your buildout:: - - [buildout] - - ... - - eggs = - pas.plugins.eea - - -and then running ``bin/buildout`` - - -Authors -------- - -Provided by awesome people ;) - - -Contributors ------------- - -Put your name here, you deserve it! - -- ? - - -Contribute ----------- - -- Issue Tracker: https://github.com/collective/pas.plugins.eea/issues -- Source Code: https://github.com/collective/pas.plugins.eea -- Documentation: https://docs.plone.org/foo/bar - - -Support -------- - -If you are having issues, please let us know. -We have a mailing list located at: project@example.com - - -License -------- - -The project is licensed under the GPLv2.