diff --git a/README.rst b/README.rst index c9403da..aa4dfc4 100644 --- a/README.rst +++ b/README.rst @@ -7,8 +7,8 @@ Overview A Python Social Auth backend for [WP OAuth](https://wp-oauth.com/), mostly used for Open edX but can be used elsewhere. This package was originally cloned from https://github.com/appsembler/trinity-oauth-backend. -Setup ------ +Open edX Setup +-------------- General Python/Django ~~~~~~~~~~~~~~~~~~~~~ @@ -68,6 +68,16 @@ Cookiecutter openedx_devops deployment --set OPENEDX_WPOAUTH_BACKEND_CLIENT_ID="${{ secrets.WPOAUTH_BACKEND_CLIENT_ID }}" \ --set OPENEDX_WPOAUTH_BACKEND_CLIENT_SECRET="${{ secrets.WPOAUTH_BACKEND_CLIENT_SECRET }}" +WP Oauth Plugin Configuration +----------------------------- + +This plugin enable your Open edX installation to authenticate against the WP Oauth plugin provider +in https://stepwisemath.ai/, configured as follows: + +.. image:: doc/wp-oauth-config.png + :width: 100% + :alt: WP Oauth configuration page + Developer Notes ------------- diff --git a/data/get_user_details.json b/data/get_user_details.json new file mode 100644 index 0000000..cbe4b84 --- /dev/null +++ b/data/get_user_details.json @@ -0,0 +1,15 @@ +{ + "date_joined": "2022-10-04 00:46:37", + "email": "lpm0073@gmail.com", + "first_name": "Lawrence", + "fullname": "Lawrence McDaniel", + "id": 6, + "is_staff": true, + "is_superuser": true, + "last_name": "McDaniel", + "refresh_token": "", + "scope": "", + "token_type": "", + "user_status": "0", + "username": "mcdaniel" +} diff --git a/data/wp-oauth-return-dict.json b/data/wp-oauth-return-dict.json new file mode 100644 index 0000000..2138831 --- /dev/null +++ b/data/wp-oauth-return-dict.json @@ -0,0 +1,98 @@ +{ + "ID": "6", + "capabilities": { + "access_white_label_branding": true, + "activate_plugins": true, + "administrator": true, + "copy_posts": true, + "create_roles": true, + "create_users": true, + "delete_others_pages": true, + "delete_others_posts": true, + "delete_pages": true, + "delete_plugins": true, + "delete_posts": true, + "delete_private_pages": true, + "delete_private_posts": true, + "delete_published_pages": true, + "delete_published_posts": true, + "delete_roles": true, + "delete_themes": true, + "delete_users": true, + "edit_dashboard": true, + "edit_files": true, + "edit_others_pages": true, + "edit_others_posts": true, + "edit_pages": true, + "edit_plugins": true, + "edit_posts": true, + "edit_private_pages": true, + "edit_private_posts": true, + "edit_published_pages": true, + "edit_published_posts": true, + "edit_roles": true, + "edit_theme_options": true, + "edit_themes": true, + "edit_users": true, + "export": true, + "import": true, + "install_plugins": true, + "install_themes": true, + "level_0": true, + "level_1": true, + "level_10": true, + "level_2": true, + "level_3": true, + "level_4": true, + "level_5": true, + "level_6": true, + "level_7": true, + "level_8": true, + "level_9": true, + "list_roles": true, + "list_users": true, + "manage_categories": true, + "manage_links": true, + "manage_options": true, + "moderate_comments": true, + "promote_users": true, + "publish_pages": true, + "publish_posts": true, + "read": true, + "read_private_pages": true, + "read_private_posts": true, + "remove_users": true, + "restrict_content": true, + "rocket_manage_options": true, + "rocket_preload_cache": true, + "rocket_purge_cache": true, + "rocket_purge_cloudflare_cache": true, + "rocket_purge_opcache": true, + "rocket_purge_posts": true, + "rocket_purge_sucuri_cache": true, + "rocket_purge_terms": true, + "rocket_purge_users": true, + "rocket_regenerate_critical_css": true, + "rocket_remove_unused_css": true, + "switch_themes": true, + "unfiltered_html": true, + "unfiltered_upload": true, + "update_core": true, + "update_plugins": true, + "update_themes": true, + "upload_files": true, + "wf2fa_activate_2fa_others": true, + "wf2fa_activate_2fa_self": true, + "wf2fa_manage_settings": true, + "wpseo_manage_options": true + }, + "display_name": "Lawrence McDaniel", + "user_email": "lpm0073@gmail.com", + "user_login": "mcdaniel", + "user_nicename": "mcdaniel", + "user_registered": "2022-10-04 00:46:37", + "user_roles": [ + "administrator" + ], + "user_status": "0" +} diff --git a/doc/wp-oauth-config.png b/doc/wp-oauth-config.png new file mode 100644 index 0000000..4875796 Binary files /dev/null and b/doc/wp-oauth-config.png differ