1
0
mirror of https://github.com/oceanprotocol/docs.git synced 2024-11-02 16:25:37 +01:00
docs/content/tutorials/allow-deny-lists.md
Jamie Hewitt 0b179ba210
Document optional fine-grained permissions in market (#682)
* Creating permissions docs

* adding permissions to tutorial list

* Writting introduction

* Adding descriptions of RBAC roles

* Adding images

* RBAC instructions for the market

* Adding content for allow/deny lists

* adding allow deny list images

* Adding steps for submitting allow/ deny list changes

* Fixing spelling mistakes

* formatting h3 titles

* Fixing markdown violation issue

* Adding section - mapping roles to addresses

* Updating tutorials overview

* Minor edits

Co-authored-by: Matthias Kretschmann <m@kretschmann.io>
2021-08-16 12:35:54 +03:00

2.0 KiB

title description
Allow and Deny Lists Restrict access to individual assets

Allow and deny lists are advanced features that allow publishers to control access to individual data assets. Publishers can restrict assets so that they can only be accessed by approved users (allow lists) or they can restrict assets so that they can be accessed by anyone except certain users (deny lists).

Setup

All and deny lists are not enabled by default in Ocean Market. You need to edit the environmental variables to enable this feature in your fork of Ocean Market:

  • To enable allow and deny lists you need to add the following environmental variable to your .env file in your fork of Ocean Market: GATSBY_ALLOW_ADVANCED_SETTINGS="true"
  • Publishers in your market will now have the ability to restrict who can consume their datasets.

Usage

To use allow or deny lists you need to navigate to your data asset and click on "Advance Settings".

Advanced Settings

In order to add a user to a allow or deny list, you need to first know their ethereum address. You can then enter the address of the user into the input section and click the "ADD" button.

Add address to allow list

To remove a user from an all or deny list you can click the cross next to their ethereum address.

Removing a user from allow or deny list

Any changes you make on the advanced settings page need to be submitted and signed in a transaction. To do this, first click the "SUBMIT" button.

Submit changes to allow or deny lists

Next you will need to sign the transaction in Metamask, or the wallet of your choice.

Sign Metamask transaction

When the process of updating the allow or deny lists is complete you will a success message.

Update allow or deny list success