Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

V6 - manage the web api permissions update #1099

Open
wants to merge 3 commits into
base: v6
Choose a base branch
from
Open

V6 - manage the web api permissions update #1099

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a129de9
manage the web api permissions update
meganelepalud-akeneo Mar 22, 2022
b5e0e7d
typo fix
meganelepalud-akeneo Mar 24, 2022
d6ee0d2
fix
meganelepalud-akeneo Sep 27, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
113 changes: 70 additions & 43 deletions content/md/permissions-settings/manage-the-web-api-permissions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,47 +37,74 @@ You can also be more precise in terms of endpoints you want your API users to ca

The following tables sum up the permissions you will find to restrict the access to the API, endpoint by endpoint.

| Channel endpoints | |
| Assets | |
|:--------------|:------------------------------------------------|
| List channels | Gives permission to GET on the channel endpoint |
| Create and update channels | Gives permission to POST and PATCH on the channel endpoint |

| Locale endpoints | |
|:-------------|:-----------------------------------------------|
| List locales | Gives permission to GET on the locale endpoint |

| Currency endpoints | |
|:-------------|:-----------------------------------------------|
| List currencies | Gives permission to GET on the currency endpoint |

| Family endpoints | |
|:------------------------|:--------------------------------------|
| List families | Gives permission to GET on the family endpoint |
| Create and update families | Gives permission to POST and PATCH on the family endpoint |

| Attribute endpoints | |
|:------------------------|:--------------------------------------|
| List attributes | Gives permission to GET on the attribute endpoint |
| Create and update attributes | Gives permission to POST and PATCH on the attribute endpoint |

| Attribute option endpoints | |
|:------------------------|:--------------------------------------|
| List attribute options | Gives permission to GET on the attribute options endpoint |
| Create and update attribute options | Gives permission to POST and PATCH on the attribute options endpoint |

| Attribute group endpoints | |
|:------------------------|:--------------------------------------|
| List attribute groups | Gives permission to GET on the attribute groups endpoint |
| Create and update attribute groups | Gives permission to POST and PATCH on the attribute groups endpoint |

| Category endpoints | |
|:------------------------|:--------------------------------------|
| List categories | Gives permission to GET on the category endpoint |
| Create and update categories | Gives permission to POST and PATCH on the category endpoint |

| Association type endpoints | |
|:------------------------|:--------------------------------------|
| List association types | Gives permission to GET on the association type endpoint |
| Create and update association types | Gives permission to POST and PATCH on the association type endpoint |

For more details about these permissions, have a look to our [dedicated section](https://api.akeneo.com/documentation/permissions.html#permissions) in the API documentation.
| List assets | Gives permission to retrieve assets using the API |
| Create and update assets | Gives permission to create and update assets using the API |
| Delete assets | Gives permission to delete assets using the API |
| List asset families | Gives permission to retrieve asset families using the API |
| Create and update asset families | Gives permission to create and update asset families using the API |

| Attributes | |
|:--------------|:------------------------------------------------|
| List attributes | Gives permission to retrieve attributes using the API |
| Create and update attributes | Gives permission to create and update attributes using the API |

| Attribute options | |
|:--------------|:------------------------------------------------|
| List attribute options | Gives permission to retrieve attribute options using the API |
| Create and update attribute options | Gives permission to create and update attribute options using the API |

| Categories | |
|:--------------|:------------------------------------------------|
| List categories | Gives permission to retrieve categories using the API |
| Create and update categories | Gives permission to create and update categories using the API |

| Families | |
|:--------------|:------------------------------------------------|
| List families | Gives permission to retrieve families using the API |
| Create and update families | Gives permission to create and update families using the API |

| Family variants | |
|:--------------|:------------------------------------------------|
| List family variants | Gives permission to retrieve family variants using the API |
| Create and update family variants | Gives permission to create and update family variants using the API |

| Channels | |
|:--------------|:------------------------------------------------|
| List channels | Gives permission to retrieve channels using the API |
| Create and update channels | Gives permission to create and update channels using the API |

| Locales | |
|:--------------|:------------------------------------------------|
| List locales | Gives permission to retrieve locales using the API |

| Attribute groups | |
|:--------------|:------------------------------------------------|
| List attribute groups | Gives permission to retrieve attribute groups using the API |
| Create and update attribute groups | Gives permission to create and update attribute groups using the API |

| Currencies | |
|:--------------|:------------------------------------------------|
| List currencies | Gives permission to retrieve currencies using the API |

| Association types | |
|:--------------|:------------------------------------------------|
| List association types | Gives permission to retrieve association types using the API |
| Create and update association types | Gives permission to create and update association types using the API |

| Products | |
|:--------------|:------------------------------------------------|
| List products | Gives permission to retrieve products (products and product models) using the API |
| Create and update products | Gives permission to create and update products (products and product models) using the API |
| Delete products | Gives permission to delete products (products and product models) using the API |

| Reference entities | |
|:--------------|:------------------------------------------------|
| List reference entity records | Gives permission to retrieve reference entity records using the API |
| Create and update reference entity records | Gives permission to create and update reference entity records using the API |
| Delete reference entity records | Gives permission to delete reference entity records using the API |
| List reference entities | Gives permission to retrieve reference entities using the API |
| Create and update reference entities | Gives permission to create and update reference entities using the API |

For more details about these permissions, have a look to our [dedicated section](https://api.akeneo.com/documentation/permissions.html#permissions) in the API documentation.