Skip to content
This repository was archived by the owner on Nov 19, 2024. It is now read-only.

Commit 284c0cb

Browse files
committed
Merge pull request #1 from paliarush/patch-3
Update gs-authentication.md
2 parents 9e25fa4 + ebb885b commit 284c0cb

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

guides/v1.0/get-started/authentication/gs-authentication.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,9 @@ Before you can make web API calls, you must authenticate your identity and have
1818
</p>
1919

2020
<h3 id="accessible-resources">Accessible resources</h3>
21-
<p>The resources that you can access depend on your user type and the configured permission of the resource in the <code>webapi.xml</code> file. This table lists the resources that each user type can access:</p>
21+
<p>The list of resources that you can access depends on your user type. All customers have the same permissions, and as a result the same resources accessible. Previous statement is true for guest users as well.
22+
Each admin or integration user can have a unique set of permissions which is configured in the admin panel.
23+
Permissions required to access particular resource are configured in the <code>webapi.xml</code> file. This table lists the resources that each user type can access:</p>
2224
<table style="width:100%">
2325
<tr bgcolor="lightgray">
2426
<th>User type</th>
@@ -28,7 +30,7 @@ Before you can make web API calls, you must authenticate your identity and have
2830
<td>
2931
<p>Admin or Integration</p>
3032
</td>
31-
<td>e
33+
<td>
3234
<p>Resources for which admins or integrations are authorized. For example, if admins are authorized for the <code>Magento_Customer::group</code> resource, they can make a <code>GET&nbsp;/V1/customerGroups/:id</code> call.</p>
3335
</td>
3436
</tr>
@@ -56,7 +58,7 @@ acl.xml files across all Magento modules are consolidated to build an ACL tree w
5658
Overall <a href="http://www.magentocommerce.com/api/rest/permission_settings/permission_settings.html#PermissionSettings-Authorization">ACL concept</a> remains same as Magento 1, its just been extended to cover WebAPIs.
5759
</p>
5860
<h4 id="acl-webapi-relation">Sample customer acl.xml</h4>
59-
e.g.: Account management, customer configuration, and customer group resource permissions are defined in the below customer acl.xml
61+
e.g., Account management, customer configuration, and customer group resource permissions are defined in the below customer acl.xml
6062
```xml
6163
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../../../lib/internal/Magento/Framework/Acl/etc/acl.xsd">
6264
<acl>
@@ -81,7 +83,7 @@ e.g.: Account management, customer configuration, and customer group resource pe
8183
</config>
8284
```
8385

84-
When a developer creates the Web API configuration file : webapi.xml, the permissions defined in acl.xml are referenced to create access rights for each API.
86+
When a developer creates the Web API configuration file (webapi.xml), the permissions defined in acl.xml are referenced to create access rights for each API resource.
8587
<h4 id="acl-webapi-relation">Sample (truncated) customer webapi.xml</h4>
8688
```xml
8789
<routes xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
@@ -128,7 +130,7 @@ When a developer creates the Web API configuration file : webapi.xml, the permis
128130
.....
129131
...
130132
```
131-
e.g.:
133+
e.g.,
132134
In the above sample webapi.xml, for the customerGroups resource, only a user with a "Magento_Customer::group" can access the GET /V1/customerGroups/:id API. On the other hand, POST /V1/customers (customer creation) can be accessed anonymously (or by a guest) without a need for presenting the identity.
133135

134136
The user here can be an admin (or an Integration) defined in the backend with the customer group selected as one of the resource in the ACL tree.

0 commit comments

Comments
 (0)