https://github.com/aligent/magento2-introspection-auth
https://github.com/aligent/magento2-introspection-auth
Last synced: 4 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/aligent/magento2-introspection-auth
- Owner: aligent
- License: gpl-3.0
- Created: 2023-11-23T05:58:38.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-07-04T04:57:52.000Z (almost 2 years ago)
- Last Synced: 2025-04-02T23:46:08.712Z (about 1 year ago)
- Language: PHP
- Size: 23.4 KB
- Stars: 2
- Watchers: 14
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# magento2-introspection-auth
Magento 2 module to handle authorisation of GraphQL introspection queries.
## Functionality
In Magento 2, GraphQL introspection can be enabled/disabled globally.
This module adds functionality so that when enabled, introspection queries can only be made by authorised users.
## Installation
1. Install the package via composer
```bash
composer require aligent/magento2-introspection-auth
```
2. Enable the module
```bash
bin/magento module:enable Aligent_IntrospectionAuth
```
3. Run the `setup:upgrade` command
```bash
bin/magento setup:upgrade
```
## Configuration
The authorisation functionality can be enabled/disabled via `Stores -> Configuration -> Advanced -> System -> Security -> Enable Introspection Authorisation`
Note that authorisation will only work is GraphQL introspection is enabled. If it is disabled, it will be disabled for all users, regardless of authorisation.
## Permission
In order to be authorised, users/integrations will need the `Aligent_Introspection::introspection_allowed` permission