... | ... | @@ -293,16 +293,47 @@ Important flags are: |
|
|
|
|
|
## `query`
|
|
|
|
|
|
Use the `pepcli query` command to query the system. It currently only supports a single sub-command, which lists the columns accessible to you:
|
|
|
Use the `pepcli query` command to retrieve information about your access to the system. Note that such access depends on the access group for which you are enrolled. Enroll for a specific access group:
|
|
|
|
|
|
- either by means of a prior call to `pepLogon`,
|
|
|
- or by [passing an appropriate OAuth token](#general-flags) to `pepcli`.
|
|
|
|
|
|
### `query column-access`
|
|
|
|
|
|
The `column-access` subcommand lists the columns and column groups that are accessible to you.
|
|
|
|
|
|
```
|
|
|
pepcli query column-access
|
|
|
```
|
|
|
|
|
|
The output will include all columns and column groups accessible to you, as well as whether you have read and/or write access. Note that such access depends on the access group for which you are enrolled. Enroll for a specific access group:
|
|
|
The output will include all accessible columns and column groups, as well as whether you have read and/or write access.
|
|
|
|
|
|
- either by means of a prior call to `pepLogon`,
|
|
|
- or by [passing an appropriate OAuth token](#general-flags) to `pepcli`.
|
|
|
### `query participant-group-access`
|
|
|
|
|
|
The `participant-group-access` subcommand lists the columns and column groups that are accessible to you.
|
|
|
|
|
|
```
|
|
|
pepcli query participant-group-access
|
|
|
```
|
|
|
|
|
|
The output will include whether you have `access` and/or `enumerate` privileges for each participant group.
|
|
|
|
|
|
- the `access` privilege allows you to retrieve data from rows included in the group.
|
|
|
- the `enumerate` privilege allows you to list the rows included in the group.
|
|
|
|
|
|
Most actions require the user to hold both privileges. E.g. when specifying a `-P groupname` to [`pepcli pull`](#pull), you'll want to list the rows included in the group *and* retrieve data from them.
|
|
|
|
|
|
Members of the `Data Administrator` user group automatically have full access to all participant groups.
|
|
|
|
|
|
### `query enrollment`
|
|
|
|
|
|
Use the `enrollment` subcommand to find out how you're [enrolled](#enrollment) into the PEP system.
|
|
|
|
|
|
```
|
|
|
pepcli query enrollment
|
|
|
```
|
|
|
|
|
|
The output will include your user name (ID) and the user group to which you belong. The command will produce an error if you haven't enrolled yet, or if your enrollment has expired.
|
|
|
|
|
|
## `store`
|
|
|
|
... | ... | |