... | @@ -78,6 +78,26 @@ Other general flags exist, but are intended for use by developers of the PEP sys |
... | @@ -78,6 +78,26 @@ Other general flags exist, but are intended for use by developers of the PEP sys |
|
|
|
|
|
# Commands supported by `pepcli`
|
|
# Commands supported by `pepcli`
|
|
|
|
|
|
|
|
## `ama`
|
|
|
|
|
|
|
|
The `ama` command's various sub-commands can be used to perform administrative tasks. While `ama` is short for "Access Manager Administration", it should be noted that the `ama` command is not aimed exclusively at the "access administrator", i.e. the role responsible for access management. Several sub-commands are intended for use by a "data administrator" instead.
|
|
|
|
|
|
|
|
### `ama query`
|
|
|
|
|
|
|
|
The `query` subcommand summarizes the current state of PEP's [data structure](Data-structure) and [access rules](Access-control#access-rules).
|
|
|
|
|
|
|
|
```
|
|
|
|
pepcli ama query
|
|
|
|
```
|
|
|
|
|
|
|
|
This subcommand's output lists
|
|
|
|
|
|
|
|
- The `Columns` that have been defined by data administrator (using `pepcli ama column`).
|
|
|
|
- The `ColumnGroups` that have been defined by data administrator (using `pepcli ama columnGroup create`), and the columns included in each column group (using `pepcli ama column addTo`).
|
|
|
|
- The `ColumnGroupAccessRules` that have been defined by access administrator (using `pepcli ama cgar create`), i.e. which access groups have what type(s) of access to which column groups
|
|
|
|
- The (participant) `Groups` that have been defined by data administrator (using `pepcli ama group create`), and the participants included in each group (using `pepcli ama group addTo`).
|
|
|
|
- The (participant) `GroupAccessRules` that have been defined by access administrator (using `pepcli ama pgar create`).
|
|
|
|
|
|
## `get`
|
|
## `get`
|
|
|
|
|
|
After you have [`list`](#list)ed data, depending on whether data was inlined or not, you have IDs for data entries. You can retrieve the data as follows:
|
|
After you have [`list`](#list)ed data, depending on whether data was inlined or not, you have IDs for data entries. You can retrieve the data as follows:
|
... | | ... | |