[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[taler-docs] branch master updated: document ‘libeufin-cli permissions’
From: |
gnunet |
Subject: |
[taler-docs] branch master updated: document ‘libeufin-cli permissions’ commands |
Date: |
Tue, 22 Feb 2022 10:20:43 +0100 |
This is an automated email from the git hooks/post-receive script.
ttn pushed a commit to branch master
in repository docs.
The following commit(s) were added to refs/heads/master by this push:
new b52db47 document ‘libeufin-cli permissions’ commands
b52db47 is described below
commit b52db4750ce0e6e19fcdaa6ad121e6feaa278b2e
Author: Thien-Thi Nguyen <ttn@gnuvola.org>
AuthorDate: Mon Feb 21 21:49:04 2022 -0500
document ‘libeufin-cli permissions’ commands
specifically:
- permissions
- permissions list
- permissions grant
- permissions revoke
---
manpages/libeufin-cli.1.rst | 79 ++++++++++++++++++++++++++++++++++++++++-----
1 file changed, 71 insertions(+), 8 deletions(-)
diff --git a/manpages/libeufin-cli.1.rst b/manpages/libeufin-cli.1.rst
index 4458a5b..b6a175f 100644
--- a/manpages/libeufin-cli.1.rst
+++ b/manpages/libeufin-cli.1.rst
@@ -640,22 +640,85 @@ For example:
permissions
-----------
-WRITEME
-
-permissions revoke
-^^^^^^^^^^^^^^^^^^
-
-WRITEME
+The ``libeufin-cli permissions`` command manages permissions
+for operations on Nexus.
+It has three subcommands: list, grant, revoke.
+All three commands can only be issued by the superuser.
permissions list
^^^^^^^^^^^^^^^^
-WRITEME
+The ``permissions list`` command lists the granted permissions.
+At the beginning of a session, there are none:
+
+.. code-block:: console
+
+ $ libeufin-cli permissions list
+ {
+ "permissions" : [ ]
+ }
+
permissions grant
^^^^^^^^^^^^^^^^^
-WRITEME
+The ``permissions grant`` command adds a permission to the list
+of granted permissions.
+It takes five arguments: ``SUBJECT_TYPE``, ``SUBJECT_ID``,
+``RESOURCE_TYPE``, ``RESOURCE_ID``, ``PERMISSION_NAME``.
+
+FIXME: The subject type and id, resource type and id, are ...
+
+The ``PERMISSION_NAME`` is one of the following:
+
+- ``facade.talerwiregateway.history``
+- ``facade.talerwiregateway.transfer``
+- ``facade.anastasis.history``
+
+For example:
+
+.. code-block:: console
+
+ $ libeufin-cli permissions grant \
+ some-subject-type some-subject-id \
+ some-resource-type some-resource-id \
+ facade.anastasis.history
+ { }
+ $ libeufin-cli permissions list
+ {
+ "permissions" : [ {
+ "subjectType" : "some-subject-type",
+ "subjectId" : "some-subject-id",
+ "resourceType" : "some-resource-type",
+ "resourceId" : "some-resource-id",
+ "permissionName" : "facade.anastasis.history"
+ } ]
+ }
+
+permissions revoke
+^^^^^^^^^^^^^^^^^^
+
+The ``permissions revoke`` command does the opposite of the
+``permissions grant`` command.
+It takes the same arguments as the ``permissions grant`` command:
+``SUBJECT_TYPE``, ``SUBJECT_ID``, ``RESOURCE_TYPE``, ``RESOURCE_ID``,
+``PERMISSION_NAME``.
+
+For example:
+
+.. code-block:: console
+
+ $ libeufin-cli permissions revoke \
+ some-subject-type some-subject-id \
+ some-resource-type some-resource-id \
+ facade.anastasis.history
+ { }
+ $ libeufin-cli permissions list
+ {
+ "permissions" : [ ]
+ }
+
+This example undoes the effect of the previous (``permissions grant``) example.
accounts
--
To stop receiving notification emails like this one, please contact
gnunet@gnunet.org.
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- [taler-docs] branch master updated: document ‘libeufin-cli permissions’ commands,
gnunet <=