@uipath/gov-tool 1.205.0-preview.276 → 1.206.0-preview.279

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/README.md +53 -0
  2. package/dist/tool.js +7798 -7289
  3. package/package.json +2 -2
package/README.md ADDED
@@ -0,0 +1,53 @@
1
+ # @uipath/gov-tool
2
+
3
+ `uip` plugin for UiPath governance. It adds `uip gov`, with three areas:
4
+
5
+ - `aops-policy`: Automation Ops governance policies. Read a product's policy
6
+ template, create and edit policies, assign them to tenants, users and groups,
7
+ and check which policy applies to a subject.
8
+ - `access-policy`: access policies on the Policy Administration Point, and
9
+ decision checks against the Policy Decision Point.
10
+ - `compliance-packs`: browse the compliance pack catalog and turn packs on or
11
+ off for a tenant or organization.
12
+
13
+ More: [docs/tools/gov.md](../../../docs/tools/gov.md).
14
+
15
+ ## Commands
16
+
17
+ | Group | Commands |
18
+ | --- | --- |
19
+ | `gov aops-policy` | `list`, `get`, `create`, `update`, `delete` (policies; `list` and `get` take `--download` to save JSON or a zip) |
20
+ | `gov aops-policy product` / `license-type` | `product list`, `product get`, `license-type list` |
21
+ | `gov aops-policy template` | `get <product-identifier>` (writes a fillable form-data file with `--output-form-data`), `list --output-dir <dir>` (all products) |
22
+ | `gov aops-policy deployment tenant` | `list`, `get`, `configure` (full replace from `--input`), `remove --product-name` |
23
+ | `gov aops-policy deployment user` / `group` | `list`, `get`, `configure` (full replace from `--input`), `delete` |
24
+ | `gov aops-policy deployed-policy` | `get` / `list <license-type> <product-name> <tenant-identifier>`: the effective policy or rules for a subject |
25
+ | `gov access-policy` | `list`, `get`, `create --file`, `update --file`, `delete <policy-id...>`, `evaluate --resource-type <type>` |
26
+ | `gov compliance-packs catalog` | `list`, `get <pack-id>` |
27
+ | `gov compliance-packs state` | `list`, `get`, `enable`, `disable`, `restore`, `coverage`, each taking `<scope> <target-id>` where scope is `tenant` or `organization` |
28
+
29
+ ## Examples
30
+
31
+ ```bash
32
+ # Write a policy for a product: get the blank form, fill it in, create it
33
+ uip gov aops-policy product list
34
+ uip gov aops-policy template get StudioX --output-form-data form-data.json
35
+ uip gov aops-policy create --name "My StudioX policy" --product-name StudioX --input form-data.json
36
+
37
+ # Assign policies to a tenant, then check what applies
38
+ uip gov aops-policy deployment tenant configure <tenant-id> --tenant-name "<tenant-name>" --input tenant-policies.json
39
+ uip gov aops-policy deployed-policy get Attended StudioX <tenant-id>
40
+
41
+ # Access policies
42
+ uip gov access-policy create --file ./policy.json
43
+ uip gov access-policy evaluate --resource-type Agent
44
+
45
+ # Compliance packs
46
+ uip gov compliance-packs catalog list
47
+ uip gov compliance-packs state enable tenant <tenant-id> iso-42001-2023
48
+ ```
49
+
50
+ ## Authentication
51
+
52
+ Run `uip login` first. `access-policy evaluate` needs a login that targets a
53
+ tenant, not only an organization.