cert management: move some headings a level up for better visibility

[pve-docs.git] / pveum.1-synopsis.adoc

diff --git a/pveum.1-synopsis.adoc b/pveum.1-synopsis.adoc
index 6f0d58b09b9278c5a446ec4d3ec9180184f0349a..5278b395d8e2483b1dbad306f64de867f0db11bf 100644 (file)
--- a/pveum.1-synopsis.adoc
+++ b/pveum.1-synopsis.adoc
@@ -20,10 +20,18 @@ Allow to propagate (inherit) permissions.
 
 List of roles.
 
+`--tokens` `<string>` ::
+
+List of API tokens.
+
 `--users` `<string>` ::
 
 List of users.
 
+*pveum acl list* `[FORMAT_OPTIONS]`
+
+Get Access Control List (ACLs).
+
 *pveum acl modify* `<path> --roles <string>` `[OPTIONS]`
 
 Update Access Control List (add or remove permissions).
@@ -44,6 +52,10 @@ Allow to propagate (inherit) permissions.
 
 List of roles.
 
+`--tokens` `<string>` ::
+
+List of API tokens.
+
 `--users` `<string>` ::
 
 List of users.
@@ -76,6 +88,10 @@ Delete group.
 
 no description available
 
+*pveum group list* `[FORMAT_OPTIONS]`
+
+Group index.
+
 *pveum group modify* `<groupid>` `[OPTIONS]`
 
 Update group data.
@@ -140,6 +156,10 @@ Delete role.
 
 no description available
 
+*pveum role list* `[FORMAT_OPTIONS]`
+
+Role index.
+
 *pveum role modify* `<roleid>` `[OPTIONS]`
 
 Update an existing role.
@@ -250,6 +270,18 @@ Delete user.
 
 User ID
 
+*pveum user list* `[OPTIONS]` `[FORMAT_OPTIONS]`
+
+User index.
+
+`--enabled` `<boolean>` ::
+
+Optional filter for enable property.
+
+`--full` `<boolean>` ('default =' `0`)::
+
+Include group and token information.
+
 *pveum user modify* `<userid>` `[OPTIONS]`
 
 Update user configuration.
@@ -296,6 +328,103 @@ Keys for two factor auth (yubico).
 
 no description available
 
+*pveum user permissions* `[<userid>]` `[OPTIONS]` `[FORMAT_OPTIONS]`
+
+Retrieve effective permissions of given user/token.
+
+`<userid>`: `(?^:^(?^:[^\s:/]+)\@(?^:[A-Za-z][A-Za-z0-9\.\-_]+)(?:!(?^:[A-Za-z][A-Za-z0-9\.\-_]+))?$)` ::
+
+User ID or full API token ID
+
+`--path` `<string>` ::
+
+Only dump this specific path, not the whole tree.
+
+*pveum user token add* `<userid> <tokenid>` `[OPTIONS]` `[FORMAT_OPTIONS]`
+
+Generate a new API token for a specific user. NOTE: returns API token
+value, which needs to be stored as it cannot be retrieved afterwards!
+
+`<userid>`: `<string>` ::
+
+User ID
+
+`<tokenid>`: `(?^:[A-Za-z][A-Za-z0-9\.\-_]+)` ::
+
+User-specific token identifier.
+
+`--comment` `<string>` ::
+
+no description available
+
+`--expire` `<integer> (0 - N)` ('default =' `same as user`)::
+
+API token expiration date (seconds since epoch). '0' means no expiration date.
+
+`--privsep` `<boolean>` ('default =' `1`)::
+
+Restrict API token privileges with separate ACLs (default), or give full privileges of corresponding user.
+
+*pveum user token list* `<userid>` `[FORMAT_OPTIONS]`
+
+Get user API tokens.
+
+`<userid>`: `<string>` ::
+
+User ID
+
+*pveum user token modify* `<userid> <tokenid>` `[OPTIONS]` `[FORMAT_OPTIONS]`
+
+Update API token for a specific user.
+
+`<userid>`: `<string>` ::
+
+User ID
+
+`<tokenid>`: `(?^:[A-Za-z][A-Za-z0-9\.\-_]+)` ::
+
+User-specific token identifier.
+
+`--comment` `<string>` ::
+
+no description available
+
+`--expire` `<integer> (0 - N)` ('default =' `same as user`)::
+
+API token expiration date (seconds since epoch). '0' means no expiration date.
+
+`--privsep` `<boolean>` ('default =' `1`)::
+
+Restrict API token privileges with separate ACLs (default), or give full privileges of corresponding user.
+
+*pveum user token permissions* `<userid> <tokenid>` `[OPTIONS]` `[FORMAT_OPTIONS]`
+
+Retrieve effective permissions of given token.
+
+`<userid>`: `<string>` ::
+
+User ID
+
+`<tokenid>`: `(?^:[A-Za-z][A-Za-z0-9\.\-_]+)` ::
+
+User-specific token identifier.
+
+`--path` `<string>` ::
+
+Only dump this specific path, not the whole tree.
+
+*pveum user token remove* `<userid> <tokenid>` `[FORMAT_OPTIONS]`
+
+Remove API token for a specific user.
+
+`<userid>`: `<string>` ::
+
+User ID
+
+`<tokenid>`: `(?^:[A-Za-z][A-Za-z0-9\.\-_]+)` ::
+
+User-specific token identifier.
+
 *pveum useradd*
 
 An alias for 'pveum user add'.