... | ... | @@ -34,13 +34,20 @@ pepcli ama query --help # Output mentions the <em>--col |
|
|
pepcli ama query --column-group ShortPseudonyms # The completed command line
|
|
|
</pre>
|
|
|
|
|
|
## Enrollment
|
|
|
|
|
|
Most of `pepcli`'s commands will connect to one or more of the PEP servers, and most server requests will require the user to be [enrolled](Access-control#enrollment). There are two primary methods get enrolled for `pepcli` usage:
|
|
|
|
|
|
- Have an [OAuth token](Access-control#oauth-token) issued and present it to `pepcli`'s [`--oauth-token` switch](#general-flags). Contact the [PEP support team](support@pep.cs.ru.nl) for more information on obtaining such a prefab OAuth token.
|
|
|
- From the directory where you intend to use `pepcli`, run the `pepLogon` utility and log on interactively. Your enrollment data will be stored to a file and will remain valid for a period of 12 hours. During this period, you can use `pepcli` in the role for which you have been enrolled.
|
|
|
|
|
|
## General flags
|
|
|
|
|
|
Most of `pepcli`'s commands will connect to one or more of the PEP servers, and most server requests will require the user to be [enrolled](Access-control#enrollment). The utility's general flags can be used to indicate how to connect and enroll:
|
|
|
The `pepcli` utility's general flags can be used to indicate how to connect to and [enroll with](#authentication-and-enrollment) the PEP system:
|
|
|
|
|
|
- `--client-working-directory` specifies a directory containing configuration files specifying how to connect to PEP's servers. If not specified, these configuration files are assumed to be located in the directory containing the `pepcli` executable file.
|
|
|
- `--client-config-name` specifies the name of the main (client) configuration file. If not specified, the file is assumed to be named `ClientConfig.json`.
|
|
|
- `--oauth-token` specifies an OAuth token to be used for [enrollment](Access-control#enrollment), or the path to a file containing such an OAuth token. If not specified, the user is assumed to have been enrolled prior to `pepcli`'s invocation, e.g. by means of the `pepLogon` utility.
|
|
|
- `--oauth-token` specifies an OAuth token to be used for [enrollment](Access-control#enrollment), or the path to a file containing such an OAuth token. If not specified, the user is assumed to [have been enrolled](#enrollment) prior to `pepcli`'s invocation, e.g. by means of the `pepLogon` utility.
|
|
|
|
|
|
For brevity, these general flags will not be mentioned in the documentation of individual commands, or in the examples below. But they may be included with any command issued to `pepcli`, e.g.:
|
|
|
|
... | ... | |