From 483c02ff4aefb78cf55a53f09941778045717cfd Mon Sep 17 00:00:00 2001 From: Elizabeth Healy Date: Wed, 18 Dec 2024 01:05:29 -0500 Subject: [PATCH 1/7] adding examples to policy commands --- docs/man/inspect/_index.md | 76 +++++++++++++++++++ docs/man/policy/attributes/create.md | 22 ++++++ docs/man/policy/attributes/deactivate.md | 22 ++++++ docs/man/policy/attributes/get.md | 23 ++++++ docs/man/policy/attributes/list.md | 18 +++++ .../policy/attributes/namespaces/create.md | 19 +++++ .../attributes/namespaces/deactivate.md | 19 +++++ docs/man/policy/attributes/namespaces/get.md | 19 +++++ docs/man/policy/attributes/namespaces/list.md | 20 +++++ .../attributes/namespaces/unsafe/delete.md | 18 +++++ .../namespaces/unsafe/reactivate.md | 18 +++++ .../attributes/namespaces/unsafe/update.md | 19 +++++ .../policy/attributes/namespaces/update.md | 20 +++++ docs/man/policy/attributes/unsafe/delete.md | 21 +++++ .../policy/attributes/unsafe/reactivate.md | 19 +++++ docs/man/policy/attributes/unsafe/update.md | 23 ++++++ docs/man/policy/attributes/update.md | 20 +++++ docs/man/policy/attributes/values/create.md | 20 +++++ .../policy/attributes/values/deactivate.md | 21 +++++ docs/man/policy/attributes/values/get.md | 20 +++++ docs/man/policy/attributes/values/list.md | 17 +++++ .../policy/attributes/values/unsafe/delete.md | 20 +++++ .../attributes/values/unsafe/reactivate.md | 19 +++++ .../policy/attributes/values/unsafe/update.md | 21 +++++ docs/man/policy/attributes/values/update.md | 21 +++++ docs/man/policy/kas-grants/assign.md | 53 +++++++++++++ docs/man/policy/kas-grants/list.md | 18 +++++ docs/man/policy/kas-grants/unassign.md | 56 ++++++++++++++ docs/man/policy/kas-registry/create.md | 51 +++++++++++++ docs/man/policy/kas-registry/delete.md | 17 +++++ docs/man/policy/kas-registry/get.md | 21 +++++ docs/man/policy/kas-registry/list.md | 19 +++++ docs/man/policy/kas-registry/update.md | 21 +++++ docs/man/policy/resource-mappings/create.md | 21 +++++ docs/man/policy/resource-mappings/delete.md | 19 +++++ docs/man/policy/resource-mappings/get.md | 21 +++++ docs/man/policy/resource-mappings/list.md | 18 +++++ docs/man/policy/resource-mappings/update.md | 21 +++++ 38 files changed, 911 insertions(+) diff --git a/docs/man/inspect/_index.md b/docs/man/inspect/_index.md index d9c36313..543d9117 100644 --- a/docs/man/inspect/_index.md +++ b/docs/man/inspect/_index.md @@ -10,3 +10,79 @@ command: Prints the `manifest.json` of the specified TDF for inspection. This is useful for development and administration. + +## Example + +```shell +$ otdfctl inspect example.tdf + +{ + "manifest": { + "algorithm": "HS256", + "keyAccessType": "split", + "mimeType": "", + "policy": "eyJ1dWlkIjoiOTk0OWJkYTItN2E4MC00NTcwLWJjMTYtMjAxYmM4ZDA3YTE2IiwiYm9keSI6eyJkYXRhQXR0cmlidXRlcyI6W10sImRpc3NlbSI6W119fQ==", + "protocol": "zip", + "segmentHashAlgorithm": "GMAC", + "signature": "MmEyZTIwYzgwYzIyMGNmMDMzNmQ0Y2U2MzU3Y2Q4YTRjYjFkYmNiNzQ0YzFhNjhlNjU0Y2MxNGM3MmMwYzNiZQ==", + "type": "reference", + "method": { + "algorithm": "AES-256-GCM", + "iv": "lUpBdhH8csdbqgAP", + "isStreamable": true + }, + "integrityInformation": { + "rootSignature": { + "alg": "HS256", + "sig": "MmEyZTIwYzgwYzIyMGNmMDMzNmQ0Y2U2MzU3Y2Q4YTRjYjFkYmNiNzQ0YzFhNjhlNjU0Y2MxNGM3MmMwYzNiZQ==" + }, + "segmentHashAlg": "GMAC", + "segmentSizeDefault": 1048576, + "encryptedSegmentSizeDefault": 1048604, + "segments": [ + { + "hash": "Y2RhNWYwMmFhNWE4M2EyYWY5Zjk2OTQ5NjU1MGQ4ODY=", + "segmentSize": 1618, + "encryptedSegmentSize": 1646 + } + ] + }, + "encryptionInformation": { + "type": "split", + "policy": "eyJ1dWlkIjoiOTk0OWJkYTItN2E4MC00NTcwLWJjMTYtMjAxYmM4ZDA3YTE2IiwiYm9keSI6eyJkYXRhQXR0cmlidXRlcyI6W10sImRpc3NlbSI6W119fQ==", + "keyAccess": [ + { + "type": "wrapped", + "url": "http://localhost:8080/kas", + "protocol": "kas", + "wrappedKey": "eEjzpg2XloommzdT6b9EVue6q1Lq/MRoZH9pU7EhcKpmt/+w6VHOUrTfk7rD05orQ2T2s2CjajrT6JNTbwQPXeoGCkKVp2xy2xceuNn8GFRJ5Gfz5rm1yI2vuOcn9xX4xbIHeLHQb7tUHyZnpeDMPc0y222VQfu/3Js1ycOBLE6lmgTgU3fXMYWSwXUIIdvWkrCW43eQxCPwZIO3HCOCo7mpWw/1gnzgJSldH/8vnlqeyeQDOvNq3+TDUwk74BV+0O72SAycaPISe/Vhh4SwSpUnRJdRN5mSngD9iuB/Dd9ChbhmNuwPW9KDzFocyz/SM5GsU3jhmjntMGNCMviR6g==", + "policyBinding": "ODViMjE5N2NiNWQzOWVmZDk0ZmU0OTMxMTM4MDNjNjNlMmZlNGQxYWE2NzIyYTQ3YmRhMTI1NGRhZTdkMmQ5NQ==", + "encryptedMetadata": "eyJjaXBoZXJ0ZXh0IjoibFVwQmRoSDhjc2RicWdBUGwxYkxtOW9kSHVReCtQclFxbUx3R3c9PSIsIml2IjoibFVwQmRoSDhjc2RicWdBUCJ9" + } + ], + "method": { + "algorithm": "AES-256-GCM", + "iv": "lUpBdhH8csdbqgAP", + "isStreamable": true + }, + "integrityInformation": { + "rootSignature": { + "alg": "HS256", + "sig": "MmEyZTIwYzgwYzIyMGNmMDMzNmQ0Y2U2MzU3Y2Q4YTRjYjFkYmNiNzQ0YzFhNjhlNjU0Y2MxNGM3MmMwYzNiZQ==" + }, + "segmentHashAlg": "GMAC", + "segmentSizeDefault": 1048576, + "encryptedSegmentSizeDefault": 1048604, + "segments": [ + { + "hash": "Y2RhNWYwMmFhNWE4M2EyYWY5Zjk2OTQ5NjU1MGQ4ODY=", + "segmentSize": 1618, + "encryptedSegmentSize": 1646 + } + ] + } + } + }, + "attributes": [] +} +``` diff --git a/docs/man/policy/attributes/create.md b/docs/man/policy/attributes/create.md index 5ebdd2cc..255824f8 100644 --- a/docs/man/policy/attributes/create.md +++ b/docs/man/policy/attributes/create.md @@ -53,3 +53,25 @@ If an Attribute is defined with logical rule `HIERARCHY`, an Entity must be mapp compared to a given Value on TDF'd Resource Data. Hierarchical values are considered highest at index 0 and lowest at the last index. For more general information about attributes, see the `attributes` subcommand. + +## Example + +```shell +otdfctl policy attributes create --namespace 3d25d33e-2469-4990-a9ed-fdd13ce74436 --name myattribute --rule ANY_OF +``` + +```shell + SUCCESS Created attributes: 3c51a593-cbf8-419d-b7dc-b656d0bedfbb + +╭─────────────────────────────────────────────────────────────────────────┬────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ +│Property │Value │ +├─────────────────────────────────────────────────────────────────────────┼────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ +│Name │myattribute │ +│Rule │ANY_OF │ +│Values │[] │ +│Namespace │opentdf.io │ +│Created At │Tue Dec 17 18:33:06 UTC 2024 │ +│Updated At │Tue Dec 17 18:33:06 UTC 2024 │ +╰─────────────────────────────────────────────────────────────────────────┴────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ + NOTE Use 'otdfctl policy attributes get --id=3c51a593-cbf8-419d-b7dc-b656d0bedfbb --json' to see all properties +``` diff --git a/docs/man/policy/attributes/deactivate.md b/docs/man/policy/attributes/deactivate.md index 710e0b33..34f03d04 100644 --- a/docs/man/policy/attributes/deactivate.md +++ b/docs/man/policy/attributes/deactivate.md @@ -19,3 +19,25 @@ However, a deactivation of an attribute means its associated values cannot be en For information about reactivation, see the `unsafe reactivate` subcommand. For more general information about attributes, see the `attributes` subcommand. + +## Example + +```shell +otdfctl policy attributes deactivate --id 3c51a593-cbf8-419d-b7dc-b656d0bedfbb +``` + +```shell + SUCCESS Deactivated attributes: 3c51a593-cbf8-419d-b7dc-b656d0bedfbb +╭─────────────────────────────────────────────────────────────────────────┬────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ +│Property │Value │ +├─────────────────────────────────────────────────────────────────────────┼────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ +│Name │myattribute │ +│Rule │ANY_OF │ +│Values │[myvalue1] │ +│Namespace │opentdf.io │ +│Created At │Tue Dec 17 18:33:06 UTC 2024 │ +│Updated At │Tue Dec 17 19:41:47 UTC 2024 │ +│Labels │[hello: world] │ +╰─────────────────────────────────────────────────────────────────────────┴────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ + NOTE Use 'otdfctl policy attributes list --json' to see all properties +``` diff --git a/docs/man/policy/attributes/get.md b/docs/man/policy/attributes/get.md index 0c873c29..72845749 100644 --- a/docs/man/policy/attributes/get.md +++ b/docs/man/policy/attributes/get.md @@ -13,3 +13,26 @@ command: Retrieve an attribute along with its metadata, rule, and values. For more general information about attributes, see the `attributes` subcommand. + +## Example + +```shell +otdfctl policy attributes get --id=3c51a593-cbf8-419d-b7dc-b656d0bedfbb +``` + +```shell + SUCCESS Found attributes: 3c51a593-cbf8-419d-b7dc-b656d0bedfbb + +╭─────────────────────────────────────────────────────────────────────────┬────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ +│Property │Value │ +├─────────────────────────────────────────────────────────────────────────┼────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ +│Id │3c51a593-cbf8-419d-b7dc-b656d0bedfbb │ +│Name │myattribute │ +│Rule │ANY_OF │ +│Values │[] │ +│Namespace │opentdf.io │ +│Created At │Tue Dec 17 18:33:06 UTC 2024 │ +│Updated At │Tue Dec 17 18:33:06 UTC 2024 │ +╰─────────────────────────────────────────────────────────────────────────┴────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ + NOTE Use 'otdfctl policy attributes get --id=3c51a593-cbf8-419d-b7dc-b656d0bedfbb --json' to see all properties +``` diff --git a/docs/man/policy/attributes/list.md b/docs/man/policy/attributes/list.md index ef8e3440..7c716e2f 100644 --- a/docs/man/policy/attributes/list.md +++ b/docs/man/policy/attributes/list.md @@ -24,3 +24,21 @@ command: By default, the list will only provide `active` attributes if unspecified, but the filter can be controlled with the `--state` flag. For more general information about attributes, see the `attributes` subcommand. + +## Example + +```shell +otdfctl policy attributes list +``` + +```shell + SUCCESS Found attributes list +╭──────────────────────────────────────────────────┬────────────────────────────────────────┬──────────────────────────────┬────────────────────┬────────────────────┬────────────────────┬──────────┬──────────┬──────────╮ +│ID │Namespace │Name │Rule │Values │Active │Labels │Created At│Updated At│ +├──────────────────────────────────────────────────┼────────────────────────────────────────┼──────────────────────────────┼────────────────────┼────────────────────┼────────────────────┼──────────┼──────────┼──────────┤ +│3c51a593-cbf8-419d-b7dc-b656d0bedfbb │opentdf.io │myattribute │ANY_OF │[] │true │[] │Tue Dec 1…│Tue Dec 1…│ +│6a261d68-0899-4e17-bb2f-124abba7c09c │example.com │attr1 │ANY_OF │[value1, value2] │true │[] │Fri Nov …│Fri Nov …│ +│e1536f25-d287-43ed-9ad9-2cf4a7698e5f │example.com │attr2 │ALL_OF │[value2, value1] │true │[] │Fri Nov …│Fri Nov …│ +╰──────────────────────────────────────────────────┴────────────────────────────────────────┴──────────────────────────────┴────────────────────┴────────────────────┴────────────────────┴──────────┴──────────┴──────────╯ + NOTE Use 'otdfctl policy attributes get --id= --json' to see all properties +``` diff --git a/docs/man/policy/attributes/namespaces/create.md b/docs/man/policy/attributes/namespaces/create.md index b3a4bbda..cd8b5a9e 100644 --- a/docs/man/policy/attributes/namespaces/create.md +++ b/docs/man/policy/attributes/namespaces/create.md @@ -20,3 +20,22 @@ command: Creation of a `namespace` is required to add attributes or any other policy objects beneath. For more information, see the `namespaces` subcommand. + +## Example + +```shell +otdfctl policy attributes namespaces create --name opentdf.io +``` + +```shell +SUCCESS Created namespaces: 7650f02a-be00-4faa-a1d1-37cded5e23dc +┌────────────────────────────────────────────────────────────────────────────┬─────────────────────────────────────────────────────────────────────────────────────────────────────┐ +│Property │Value │ +├────────────────────────────────────────────────────────────────────────────┼─────────────────────────────────────────────────────────────────────────────────────────────────────┤ +│Name │opentdf.io │ +│Id │7650f02a-be00-4faa-a1d1-37cded5e23dc │ +│Created At │Mon Jun 24 11:02:00 UTC 2024 │ +│Updated At │Mon Jun 24 11:02:00 UTC 2024 │ +└────────────────────────────────────────────────────────────────────────────┴─────────────────────────────────────────────────────────────────────────────────────────────────────┘ +NOTE Use 'namespaces get --id=7650f02a-be00-4faa-a1d1-37cded5e23dc --json' to see all properties +``` diff --git a/docs/man/policy/attributes/namespaces/deactivate.md b/docs/man/policy/attributes/namespaces/deactivate.md index 9227bbf4..0944543b 100644 --- a/docs/man/policy/attributes/namespaces/deactivate.md +++ b/docs/man/policy/attributes/namespaces/deactivate.md @@ -21,3 +21,22 @@ behaviors. For information about reactivation, see the `unsafe reactivate` subcommand. For reactivation, see the `unsafe` command. + +## Example + +```shell +otdfctl policy attributes namespaces deactivate --id 7650f02a-be00-4faa-a1d1-37cded5e23dc +``` + +```shell +SUCCESS Deactivated namespaces: 7650f02a-be00-4faa-a1d1-37cded5e23dc +┌────────────────────────────────────────────────────────────────────────────┬─────────────────────────────────────────────────────────────────────────────────────────────────────┐ +│Property │Value │ +├────────────────────────────────────────────────────────────────────────────┼─────────────────────────────────────────────────────────────────────────────────────────────────────┤ +│Name │opentdf.io │ +│Id │7650f02a-be00-4faa-a1d1-37cded5e23dc │ +│Created At │Mon Jun 24 11:02:00 UTC 2024 │ +│Updated At │Mon Jun 24 11:02:00 UTC 2024 │ +└────────────────────────────────────────────────────────────────────────────┴─────────────────────────────────────────────────────────────────────────────────────────────────────┘ +NOTE Use 'otdfctl policy attributes namespaces list --json' to see all properties +``` diff --git a/docs/man/policy/attributes/namespaces/get.md b/docs/man/policy/attributes/namespaces/get.md index b6d8d11f..c9105c30 100644 --- a/docs/man/policy/attributes/namespaces/get.md +++ b/docs/man/policy/attributes/namespaces/get.md @@ -11,3 +11,22 @@ command: --- For more information, see the `namespaces` subcommand. + +## Example + +```shell +otdfctl policy attributes namespaces get --id=7650f02a-be00-4faa-a1d1-37cded5e23dc +``` + +```shell +SUCCESS Found namespaces: 7650f02a-be00-4faa-a1d1-37cded5e23dc +┌────────────────────────────────────────────────────────────────────────────┬─────────────────────────────────────────────────────────────────────────────────────────────────────┐ +│Property │Value │ +├────────────────────────────────────────────────────────────────────────────┼─────────────────────────────────────────────────────────────────────────────────────────────────────┤ +│Id │7650f02a-be00-4faa-a1d1-37cded5e23dc │ +│Name │opentdf.io │ +│Created At │Mon Jun 24 11:02:00 UTC 2024 │ +│Updated At │Mon Jun 24 11:02:00 UTC 2024 │ +└────────────────────────────────────────────────────────────────────────────┴─────────────────────────────────────────────────────────────────────────────────────────────────────┘ +NOTE Use 'namespaces get --id=7650f02a-be00-4faa-a1d1-37cded5e23dc --json' to see all properties +``` \ No newline at end of file diff --git a/docs/man/policy/attributes/namespaces/list.md b/docs/man/policy/attributes/namespaces/list.md index 4fcc1295..55967209 100644 --- a/docs/man/policy/attributes/namespaces/list.md +++ b/docs/man/policy/attributes/namespaces/list.md @@ -18,3 +18,23 @@ command: --- For more general information, see the `namespaces` subcommand. + +## Example + +```shell +otdfctl policy attributes namespaces list +``` + +```shell +SUCCESS Found namespaces list +╭───────────────────────────────────────────────────────────────────────┬─────────────────────────────────────────────────────────┬───────────────────────────────────────────┬──────────────┬──────────────┬──────────────╮ +│ID │Name │Active │Labels │Created At │Updated At │ +├───────────────────────────────────────────────────────────────────────┼─────────────────────────────────────────────────────────┼───────────────────────────────────────────┼──────────────┼──────────────┼──────────────┤ +│87ba60e1-da12-4889-95fd-267968bf0896 │scenario.com │true │[] │Fri Nov 1 14…│Fri Nov 1 14…│ +│8f1d8839-2851-4bf4-8bf4-5243dbfe517d │example.com │true │[] │Fri Nov 1 14…│Fri Nov 1 14…│ +│d69cf14d-744b-48cf-aab4-43756e97a8e5 │example.net │true │[] │Fri Nov 1 14…│Fri Nov 1 14…│ +│0d94e00a-7bd3-4482-afe3-f1e4b03c1353 │example.org │true │[] │Fri Nov 1 14…│Fri Nov 1 14…│ +│e3802200-7d16-45c4-be55-3f1a2e90adb1 │opentdf.io │true │[] │Tue Dec 17 16…│Tue Dec 17 16…│ +╰───────────────────────────────────────────────────────────────────────┴─────────────────────────────────────────────────────────┴───────────────────────────────────────────┴──────────────┴──────────────┴──────────────╯ + NOTE Use 'otdfctl policy attributes namespaces get --id= --json' to see all properties +``` diff --git a/docs/man/policy/attributes/namespaces/unsafe/delete.md b/docs/man/policy/attributes/namespaces/unsafe/delete.md index 6a27deab..b1802ad0 100644 --- a/docs/man/policy/attributes/namespaces/unsafe/delete.md +++ b/docs/man/policy/attributes/namespaces/unsafe/delete.md @@ -18,3 +18,21 @@ Any existing TDFs containing attributes under this namespace will be rendered in Make sure you know what you are doing. For more general information, see the `namespaces` subcommand. + +## Example + +```shell +otdfctl policy attributes namespaces unsafe delete --id 7650f02a-be00-4faa-a1d1-37cded5e23dc +``` + +```shell +SUCCESS Deleted unsafe: 7650f02a-be00-4faa-a1d1-37cded5e23dc +┌────────────────────────────────────────────────────────────────────────────┬─────────────────────────────────────────────────────────────────────────────────────────────────────┐ +│Property │Value │ +├────────────────────────────────────────────────────────────────────────────┼─────────────────────────────────────────────────────────────────────────────────────────────────────┤ +│Name │opentdf.io │ +│Id │7650f02a-be00-4faa-a1d1-37cded5e23dc │ +│Created At │Mon Jun 24 11:02:00 UTC 2024 │ +│Updated At │Mon Jun 24 11:02:00 UTC 2024 │ +└────────────────────────────────────────────────────────────────────────────┴─────────────────────────────────────────────────────────────────────────────────────────────────────┘ +``` diff --git a/docs/man/policy/attributes/namespaces/unsafe/reactivate.md b/docs/man/policy/attributes/namespaces/unsafe/reactivate.md index f5ae353e..c365bd42 100644 --- a/docs/man/policy/attributes/namespaces/unsafe/reactivate.md +++ b/docs/man/policy/attributes/namespaces/unsafe/reactivate.md @@ -18,3 +18,21 @@ The Active/Inactive state of any Attribute Definitions or Values under this Name Make sure you know what you are doing. For more general information, see the `namespaces` subcommand. + +## Example + +```shell +otdfctl policy attributes namespaces unsafe reactivate --id 7650f02a-be00-4faa-a1d1-37cded5e23dc +``` + +```shell +SUCCESS +┌────────────────────────────────────────────────────────────────────────────┬─────────────────────────────────────────────────────────────────────────────────────────────────────┐ +│Property │Value │ +├────────────────────────────────────────────────────────────────────────────┼─────────────────────────────────────────────────────────────────────────────────────────────────────┤ +│Name │opentdf.io │ +│Id │7650f02a-be00-4faa-a1d1-37cded5e23dc │ +│Created At │Mon Jun 24 11:02:00 UTC 2024 │ +│Updated At │Mon Jun 24 11:02:00 UTC 2024 │ +└────────────────────────────────────────────────────────────────────────────┴─────────────────────────────────────────────────────────────────────────────────────────────────────┘ +``` diff --git a/docs/man/policy/attributes/namespaces/unsafe/update.md b/docs/man/policy/attributes/namespaces/unsafe/update.md index 35da7611..db6a1953 100644 --- a/docs/man/policy/attributes/namespaces/unsafe/update.md +++ b/docs/man/policy/attributes/namespaces/unsafe/update.md @@ -23,3 +23,22 @@ and already created may now become accessible. Make sure you know what you are doing. For more general information, see the `namespaces` subcommand. + +## Example + +```shell +otdfctl policy attributes namespaces unsafe update --id=7650f02a-be00-4faa-a1d1-37cded5e23dc --name opentdf2.io +``` + +```shell +SUCCESS Unsafe updated namespaces: 7650f02a-be00-4faa-a1d1-37cded5e23dc +┌────────────────────────────────────────────────────────────────────────────┬─────────────────────────────────────────────────────────────────────────────────────────────────────┐ +│Property │Value │ +├────────────────────────────────────────────────────────────────────────────┼─────────────────────────────────────────────────────────────────────────────────────────────────────┤ +│Id │7650f02a-be00-4faa-a1d1-37cded5e23dc │ +│Name │opentdf2.io │ +│Created At │Mon Jun 24 11:02:00 UTC 2024 │ +│Updated At │Mon Jun 24 11:02:00 UTC 2024 │ +└────────────────────────────────────────────────────────────────────────────┴─────────────────────────────────────────────────────────────────────────────────────────────────────┘ +NOTE Use 'namespaces get --id=7650f02a-be00-4faa-a1d1-37cded5e23dc --json' to see all properties +``` diff --git a/docs/man/policy/attributes/namespaces/update.md b/docs/man/policy/attributes/namespaces/update.md index 3550d6c3..0483d112 100644 --- a/docs/man/policy/attributes/namespaces/update.md +++ b/docs/man/policy/attributes/namespaces/update.md @@ -21,3 +21,23 @@ command: Attribute Namespace changes can be dangerous, so this command is for updates considered "safe" (currently just mutations to metadata `labels`). For unsafe updates, see the dedicated `unsafe update` command. For more general information, see the `namespaces` subcommand. + +## Example + +```shell +otdfctl policy attributes namespaces update --id=7650f02a-be00-4faa-a1d1-37cded5e23dc --label hello=world +``` + +```shell +SUCCESS Updated namespaces: 7650f02a-be00-4faa-a1d1-37cded5e23dc +┌────────────────────────────────────────────────────────────────────────────┬─────────────────────────────────────────────────────────────────────────────────────────────────────┐ +│Property │Value │ +├────────────────────────────────────────────────────────────────────────────┼─────────────────────────────────────────────────────────────────────────────────────────────────────┤ +│Id │7650f02a-be00-4faa-a1d1-37cded5e23dc │ +│Name │opentdf.io │ +│Created At │Mon Jun 24 11:02:00 UTC 2024 │ +│Updated At │Mon Jun 24 11:02:00 UTC 2024 │ +│Labels │[hello: world] │ +└────────────────────────────────────────────────────────────────────────────┴─────────────────────────────────────────────────────────────────────────────────────────────────────┘ +NOTE Use 'namespaces get --id=7650f02a-be00-4faa-a1d1-37cded5e23dc --json' to see all properties +``` diff --git a/docs/man/policy/attributes/unsafe/delete.md b/docs/man/policy/attributes/unsafe/delete.md index 4e2e4e4c..804f2efe 100644 --- a/docs/man/policy/attributes/unsafe/delete.md +++ b/docs/man/policy/attributes/unsafe/delete.md @@ -18,3 +18,24 @@ Any existing TDFs containing the deleted attribute of this name will be rendered Make sure you know what you are doing. For more general information about attributes, see the `attributes` subcommand. + +## Example + +```shell +otdfctl policy attributes unsafe delete --id 3c51a593-cbf8-419d-b7dc-b656d0bedfbb +``` + +```shell + SUCCESS Deleted unsafe: 3c51a593-cbf8-419d-b7dc-b656d0bedfbb +╭─────────────────────────────────────────────────────────────────────────┬────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ +│Property │Value │ +├─────────────────────────────────────────────────────────────────────────┼────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ +│Deleted │true │ +│Id │3c51a593-cbf8-419d-b7dc-b656d0bedfbb │ +│Name │myattribute │ +│Created At │Tue Dec 17 18:33:06 UTC 2024 │ +│Updated At │Tue Dec 17 19:46:00 UTC 2024 │ +│Labels │[hello: world] │ +╰─────────────────────────────────────────────────────────────────────────┴────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ + NOTE Use 'otdfctl policy attributes list --json' to see all properties +``` diff --git a/docs/man/policy/attributes/unsafe/reactivate.md b/docs/man/policy/attributes/unsafe/reactivate.md index 8a944f71..f818465d 100644 --- a/docs/man/policy/attributes/unsafe/reactivate.md +++ b/docs/man/policy/attributes/unsafe/reactivate.md @@ -18,3 +18,22 @@ The Active/Inactive state of any Attribute Values under this Definition will NOT Make sure you know what you are doing. For more general information about attributes, see the `attributes` subcommand. + +## Example + +```shell +otdfctl policy attributes unsafe reactivate --id 3c51a593-cbf8-419d-b7dc-b656d0bedfbb +``` + +```shell + SUCCESS +╭─────────────────────────────────────────────────────────────────────────┬────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ +│Property │Value │ +├─────────────────────────────────────────────────────────────────────────┼────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ +│Id │3c51a593-cbf8-419d-b7dc-b656d0bedfbb │ +│Name │myattribute │ +│Created At │Tue Dec 17 18:33:06 UTC 2024 │ +│Updated At │Tue Dec 17 19:41:47 UTC 2024 │ +│Labels │[hello: world] │ +╰─────────────────────────────────────────────────────────────────────────┴────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ +``` diff --git a/docs/man/policy/attributes/unsafe/update.md b/docs/man/policy/attributes/unsafe/update.md index 17099c45..22d73545 100644 --- a/docs/man/policy/attributes/unsafe/update.md +++ b/docs/man/policy/attributes/unsafe/update.md @@ -48,3 +48,26 @@ To remove Values from an Attribute Definition, delete them separately via the `v Make sure you know what you are doing. For more general information about attributes, see the `attributes` subcommand. + +## Example + +```shell +otdfctl policy attributes unsafe update --id 3c51a593-cbf8-419d-b7dc-b656d0bedfbb --name mynewname +``` + +```shell + SUCCESS Updated unsafe: 3c51a593-cbf8-419d-b7dc-b656d0bedfbb +╭─────────────────────────────────────────────────────────────────────────┬────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ +│Property │Value │ +├─────────────────────────────────────────────────────────────────────────┼────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ +│Id │3c51a593-cbf8-419d-b7dc-b656d0bedfbb │ +│Name │myattribute │ +│Rule │ANY_OF │ +│Values │[myvalue1] │ +│Value IDs │[355743c1-c0ef-4e8d-9790-d49d883dbc7d] │ +│Created At │Tue Dec 17 18:33:06 UTC 2024 │ +│Updated At │Tue Dec 17 19:42:39 UTC 2024 │ +│Labels │[hello: world] │ +╰─────────────────────────────────────────────────────────────────────────┴────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ + NOTE Use 'otdfctl policy attributes unsafe get --id=3c51a593-cbf8-419d-b7dc-b656d0bedfbb --json' to see all properties +``` diff --git a/docs/man/policy/attributes/update.md b/docs/man/policy/attributes/update.md index 98ede206..40e4d288 100644 --- a/docs/man/policy/attributes/update.md +++ b/docs/man/policy/attributes/update.md @@ -23,3 +23,23 @@ Attribute Definition changes can be dangerous, so this command is for updates co For unsafe updates, see the dedicated `unsafe update` command. For more general information, see the `attributes` subcommand. For more general information about attributes, see the `attributes` subcommand. + +## Example + +```shell +otdfctl policy attributes update --id=3c51a593-cbf8-419d-b7dc-b656d0bedfbb --label hello=world +``` + +```shell + SUCCESS Updated attributes: 3c51a593-cbf8-419d-b7dc-b656d0bedfbb +╭─────────────────────────────────────────────────────────────────────────┬────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ +│Property │Value │ +├─────────────────────────────────────────────────────────────────────────┼────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ +│Id │3c51a593-cbf8-419d-b7dc-b656d0bedfbb │ +│Name │myattribute │ +│Created At │Tue Dec 17 18:33:06 UTC 2024 │ +│Updated At │Tue Dec 17 18:39:26 UTC 2024 │ +│Labels │[hello: world] │ +╰─────────────────────────────────────────────────────────────────────────┴────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ + NOTE Use 'otdfctl policy attributes get --id=3c51a593-cbf8-419d-b7dc-b656d0bedfbb --json' to see all properties +``` diff --git a/docs/man/policy/attributes/values/create.md b/docs/man/policy/attributes/values/create.md index 4cbb232c..164285cd 100644 --- a/docs/man/policy/attributes/values/create.md +++ b/docs/man/policy/attributes/values/create.md @@ -24,3 +24,23 @@ Add a single new value underneath an existing attribute. For a hierarchical attribute, a new value is added in lowest hierarchy (last). For more information on attribute values, see the `values` subcommand. + +## Example + +```shell +otdfctl policy attributes values create --attribute-id 3c51a593-cbf8-419d-b7dc-b656d0bedfbb --value myvalue1 +``` + +```shell + SUCCESS Created values: 355743c1-c0ef-4e8d-9790-d49d883dbc7d +╭─────────────────────────────────────────────────────────────────────────┬────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ +│Property │Value │ +├─────────────────────────────────────────────────────────────────────────┼────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ +│Id │355743c1-c0ef-4e8d-9790-d49d883dbc7d │ +│FQN │https://opentdf.io/attr/myattribute/value/myvalue1 │ +│Value │myvalue1 │ +│Created At │Tue Dec 17 19:06:55 UTC 2024 │ +│Updated At │Tue Dec 17 19:06:55 UTC 2024 │ +╰─────────────────────────────────────────────────────────────────────────┴────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ + NOTE Use 'otdfctl policy attributes values get --id=355743c1-c0ef-4e8d-9790-d49d883dbc7d --json' to see all properties +``` diff --git a/docs/man/policy/attributes/values/deactivate.md b/docs/man/policy/attributes/values/deactivate.md index 13d10eb2..08d158a9 100644 --- a/docs/man/policy/attributes/values/deactivate.md +++ b/docs/man/policy/attributes/values/deactivate.md @@ -15,3 +15,24 @@ However, a deactivation of an attribute value means it cannot be entitled in an For information about reactivation, see the `unsafe reactivate` subcommand. For more information on attribute values, see the `values` subcommand. + +## Example + +```shell +otdfctl policy attributes values deactivate --id 355743c1-c0ef-4e8d-9790-d49d883dbc7d +``` + +```shell + SUCCESS Deactivated values: 355743c1-c0ef-4e8d-9790-d49d883dbc7d +╭─────────────────────────────────────────────────────────────────────────┬────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ +│Property │Value │ +├─────────────────────────────────────────────────────────────────────────┼────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ +│Id │355743c1-c0ef-4e8d-9790-d49d883dbc7d │ +│FQN │https://opentdf.io/attr/myattribute/value/myvalue1 │ +│Value │myvalue1 │ +│Created At │Tue Dec 17 19:06:55 UTC 2024 │ +│Updated At │Tue Dec 17 19:13:38 UTC 2024 │ +│Labels │[hello: world] │ +╰─────────────────────────────────────────────────────────────────────────┴────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ + NOTE Use 'otdfctl policy attributes values list --json' to see all properties +``` diff --git a/docs/man/policy/attributes/values/get.md b/docs/man/policy/attributes/values/get.md index 2cdc5b37..05283cc2 100644 --- a/docs/man/policy/attributes/values/get.md +++ b/docs/man/policy/attributes/values/get.md @@ -13,3 +13,23 @@ command: Retrieve an attribute value along with its metadata. For more general information about attribute values, see the `values` subcommand. + +## Example + +```shell +otdfctl policy attributes values get --id 355743c1-c0ef-4e8d-9790-d49d883dbc7d +``` + +```shell + SUCCESS Found values: 355743c1-c0ef-4e8d-9790-d49d883dbc7d +╭─────────────────────────────────────────────────────────────────────────┬────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ +│Property │Value │ +├─────────────────────────────────────────────────────────────────────────┼────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ +│Id │355743c1-c0ef-4e8d-9790-d49d883dbc7d │ +│FQN │https://opentdf.io/attr/myattribute/value/myvalue1 │ +│Value │myvalue1 │ +│Created At │Tue Dec 17 19:06:55 UTC 2024 │ +│Updated At │Tue Dec 17 19:06:55 UTC 2024 │ +╰─────────────────────────────────────────────────────────────────────────┴────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ + NOTE Use 'otdfctl policy attributes values get --id=355743c1-c0ef-4e8d-9790-d49d883dbc7d --json' to see all properties +``` diff --git a/docs/man/policy/attributes/values/list.md b/docs/man/policy/attributes/values/list.md index 7e7a142c..aa57b66a 100644 --- a/docs/man/policy/attributes/values/list.md +++ b/docs/man/policy/attributes/values/list.md @@ -28,3 +28,20 @@ command: By default, the list will only provide `active` values if unspecified, but the filter can be controlled with the `--state` flag. For more general information about attribute values, see the `values` subcommand. + +## Example + +```shell +otdfctl policy attributes values list --attribute-id 3c51a593-cbf8-419d-b7dc-b656d0bedfbb +``` + +```shell + SUCCESS Found values list +╭───────────────────────────────────────────────────────────────────────┬─────────────────────────────────────────────────────────┬───────────────────────────────────────────┬──────────────┬──────────────┬──────────────╮ +│ID │Fqn │Active │Labels │Created At │Updated At │ +├───────────────────────────────────────────────────────────────────────┼─────────────────────────────────────────────────────────┼───────────────────────────────────────────┼──────────────┼──────────────┼──────────────┤ +│355743c1-c0ef-4e8d-9790-d49d883dbc7d │https://opentdf.io/attr/myattribute/value/myvalue1 │true │[] │Tue Dec 17 19…│Tue Dec 17 19…│ +│b20458b0-1855-4608-8869-3f6199bc2878 │https://opentdf.io/attr/myattribute/value/myvalue2 │true │[] │Tue Dec 17 19…│Tue Dec 17 19…│ +╰───────────────────────────────────────────────────────────────────────┴─────────────────────────────────────────────────────────┴───────────────────────────────────────────┴──────────────┴──────────────┴──────────────╯ + NOTE Use 'otdfctl policy attributes values get --id= --json' to see all properties +``` diff --git a/docs/man/policy/attributes/values/unsafe/delete.md b/docs/man/policy/attributes/values/unsafe/delete.md index 28572b62..a7ac7b19 100644 --- a/docs/man/policy/attributes/values/unsafe/delete.md +++ b/docs/man/policy/attributes/values/unsafe/delete.md @@ -18,3 +18,23 @@ Any existing TDFs containing the deleted attribute of this value will be rendere Make sure you know what you are doing. For more information on attribute values, see the `values` subcommand. + +## Example + +```shell +otdfctl policy attributes values unsafe delete --id b20458b0-1855-4608-8869-3f6199bc2878 +``` + +```shell + SUCCESS Deleted unsafe: b20458b0-1855-4608-8869-3f6199bc2878 +╭─────────────────────────────────────────────────────────────────────────┬────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ +│Property │Value │ +├─────────────────────────────────────────────────────────────────────────┼────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ +│Id │b20458b0-1855-4608-8869-3f6199bc2878 │ +│Value │myvalue2 │ +│Deleted │true │ +│Created At │Tue Dec 17 19:10:37 UTC 2024 │ +│Updated At │Tue Dec 17 19:10:37 UTC 2024 │ +╰─────────────────────────────────────────────────────────────────────────┴────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ + NOTE Use 'otdfctl policy attributes values list --json' to see all properties +``` diff --git a/docs/man/policy/attributes/values/unsafe/reactivate.md b/docs/man/policy/attributes/values/unsafe/reactivate.md index 67868726..c6e91443 100644 --- a/docs/man/policy/attributes/values/unsafe/reactivate.md +++ b/docs/man/policy/attributes/values/unsafe/reactivate.md @@ -18,3 +18,22 @@ The Active/Inactive state of the Attribute Definition and Namespace above this V Make sure you know what you are doing. For more information on attribute values, see the `values` subcommand. + +## Example + +```shell +otdfctl policy attributes values unsafe reactivate --id 355743c1-c0ef-4e8d-9790-d49d883dbc7d +``` + +```shell + SUCCESS +╭─────────────────────────────────────────────────────────────────────────┬────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ +│Property │Value │ +├─────────────────────────────────────────────────────────────────────────┼────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ +│Id │355743c1-c0ef-4e8d-9790-d49d883dbc7d │ +│Value │myvalue1 │ +│Created At │Tue Dec 17 19:06:55 UTC 2024 │ +│Updated At │Tue Dec 17 19:13:38 UTC 2024 │ +│Labels │[hello: world] │ +╰─────────────────────────────────────────────────────────────────────────┴────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ +``` diff --git a/docs/man/policy/attributes/values/unsafe/update.md b/docs/man/policy/attributes/values/unsafe/update.md index 4157a9c8..9e86021d 100644 --- a/docs/man/policy/attributes/values/unsafe/update.md +++ b/docs/man/policy/attributes/values/unsafe/update.md @@ -24,3 +24,24 @@ and already created may now become accessible. Make sure you know what you are doing. For more information on attribute values, see the `values` subcommand. + +## Example + +```shell +otdfctl policy attributes values unsafe update --id 355743c1-c0ef-4e8d-9790-d49d883dbc7d --name mynewvalue1 +``` + +```shell + SUCCESS Updated unsafe: 355743c1-c0ef-4e8d-9790-d49d883dbc7d + +╭─────────────────────────────────────────────────────────────────────────┬────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ +│Property │Value │ +├─────────────────────────────────────────────────────────────────────────┼────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ +│Id │355743c1-c0ef-4e8d-9790-d49d883dbc7d │ +│Value │mynewvalue1 │ +│Created At │Tue Dec 17 19:06:55 UTC 2024 │ +│Updated At │Tue Dec 17 19:14:53 UTC 2024 │ +│Labels │[hello: world] │ +╰─────────────────────────────────────────────────────────────────────────┴────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ + NOTE Use 'otdfctl policy attributes values unsafe get --id=355743c1-c0ef-4e8d-9790-d49d883dbc7d --json' to see all properties +``` diff --git a/docs/man/policy/attributes/values/update.md b/docs/man/policy/attributes/values/update.md index d657722c..224f9ca5 100644 --- a/docs/man/policy/attributes/values/update.md +++ b/docs/man/policy/attributes/values/update.md @@ -23,3 +23,24 @@ Attribute Value changes can be dangerous, so this command is for updates conside For unsafe updates, see the dedicated `unsafe update` command. For more general information, see the `values` subcommand. For more general information about attributes, see the `attributes` subcommand. + +## Example + +```shell +otdfctl policy attributes values update --id 355743c1-c0ef-4e8d-9790-d49d883dbc7d --label hello=world +``` + +```shell + SUCCESS Updated values: 355743c1-c0ef-4e8d-9790-d49d883dbc7d +╭─────────────────────────────────────────────────────────────────────────┬────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ +│Property │Value │ +├─────────────────────────────────────────────────────────────────────────┼────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ +│Id │355743c1-c0ef-4e8d-9790-d49d883dbc7d │ +│FQN │https://opentdf.io/attr/myattribute/value/myvalue1 │ +│Value │myvalue1 │ +│Created At │Tue Dec 17 19:06:55 UTC 2024 │ +│Updated At │Tue Dec 17 19:11:50 UTC 2024 │ +│Labels │[hello: world] │ +╰─────────────────────────────────────────────────────────────────────────┴────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ + NOTE Use 'otdfctl policy attributes values get --id=355743c1-c0ef-4e8d-9790-d49d883dbc7d --json' to see all properties +``` diff --git a/docs/man/policy/kas-grants/assign.md b/docs/man/policy/kas-grants/assign.md index 390c1bed..ee769d6a 100644 --- a/docs/man/policy/kas-grants/assign.md +++ b/docs/man/policy/kas-grants/assign.md @@ -39,3 +39,56 @@ command: Assign a registered Key Access Server (KAS) to an attribute namespace, definition, or value. For more information, see `kas-registry` and `kas-grants` manuals. + +## Example + +Namespace grant: +```shell +otdfctl policy kas-grants assign --namespace-id 3d25d33e-2469-4990-a9ed-fdd13ce74436 --kas-id 62857b55-560c-4b67-96e3-33e4670ecb3b +``` + +```shell + SUCCESS +╭─────────────────────────────────────────────────────────────────────────┬────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ +│Property │Value │ +├─────────────────────────────────────────────────────────────────────────┼────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ +│Namespace ID │3d25d33e-2469-4990-a9ed-fdd13ce74436 │ +│KAS ID │62857b55-560c-4b67-96e3-33e4670ecb3b │ +│Granted KAS URI │http://example.com/kas │ +╰─────────────────────────────────────────────────────────────────────────┴────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ + +``` + +Attribute grant: +```shell +otdfctl policy kas-grants assign --attribute-id a21eb299-3a7d-4035-8a39-c8662c03cb15 --kas-id 62857b55-560c-4b67-96e3-33e4670ecb3b +``` + +```shell + SUCCESS +╭─────────────────────────────────────────────────────────────────────────┬────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ +│Property │Value │ +├─────────────────────────────────────────────────────────────────────────┼────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ +│Attribute ID │a21eb299-3a7d-4035-8a39-c8662c03cb15 │ +│KAS ID │62857b55-560c-4b67-96e3-33e4670ecb3b │ +│Granted KAS URI │http://example.com/kas │ +╰─────────────────────────────────────────────────────────────────────────┴────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ + +``` + +Attribute value grant: +```shell +otdfctl policy kas-grants assign --value-id 0a40b27c-6cc9-49e8-a6ae-663cac2c324b --kas-id 62857b55-560c-4b67-96e3-33e4670ecb3b +``` + +```shell + SUCCESS +╭─────────────────────────────────────────────────────────────────────────┬────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ +│Property │Value │ +├─────────────────────────────────────────────────────────────────────────┼────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ +│Value ID │0a40b27c-6cc9-49e8-a6ae-663cac2c324b │ +│KAS ID │62857b55-560c-4b67-96e3-33e4670ecb3b │ +│Granted KAS URI │http://example.com/kas │ +╰─────────────────────────────────────────────────────────────────────────┴────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ + +``` diff --git a/docs/man/policy/kas-grants/list.md b/docs/man/policy/kas-grants/list.md index e3c27db7..db912d7c 100644 --- a/docs/man/policy/kas-grants/list.md +++ b/docs/man/policy/kas-grants/list.md @@ -25,3 +25,21 @@ Omitting `kas` lists all grants known to platform policy, otherwise results are the KAS URI or ID specified by the flag value. For more information, see `kas-registry` and `kas-grants` manuals. + +## Example + +```shell +otdfctl policy kas-grants list +``` + +```shell + SUCCESS +╭─────────────────────────────────────────────────┬─────────────────────────────────────────────────┬─────────────────┬─────────────────────────────────────────────────┬──────────────────────────────────────────────────╮ +│KAS ID │KAS URI │Assigned To │Granted Object ID │Granted Object FQN │ +├─────────────────────────────────────────────────┼─────────────────────────────────────────────────┼─────────────────┼─────────────────────────────────────────────────┼──────────────────────────────────────────────────┤ +│62857b55-560c-4b67-96e3-33e4670ecb3b │http://example.com/kas │Definition │a21eb299-3a7d-4035-8a39-c8662c03cb15 │https://opentdf.io/attr/myattribute │ +│62857b55-560c-4b67-96e3-33e4670ecb3b │http://example.com/kas │Value │0a40b27c-6cc9-49e8-a6ae-663cac2c324b │https://opentdf.io/attr/myattribute/value/myvalue2│ +│62857b55-560c-4b67-96e3-33e4670ecb3b │http://example.com/kas │Namespace │3d25d33e-2469-4990-a9ed-fdd13ce74436 │https://opentdf.io │ +╰─────────────────────────────────────────────────┴─────────────────────────────────────────────────┴─────────────────┴─────────────────────────────────────────────────┴──────────────────────────────────────────────────╯ + +``` diff --git a/docs/man/policy/kas-grants/unassign.md b/docs/man/policy/kas-grants/unassign.md index bb71e1b7..97b9f9f4 100644 --- a/docs/man/policy/kas-grants/unassign.md +++ b/docs/man/policy/kas-grants/unassign.md @@ -30,3 +30,59 @@ command: Unassign a registered Key Access Server (KAS) to an attribute namespace, definition, or value. For more information, see `kas-registry` and `kas-grants` manuals. + +## Example + +Namespace grant: +```shell +otdfctl policy kas-grants unassign --namespace-id 3d25d33e-2469-4990-a9ed-fdd13ce74436 --kas-id 62857b55-560c-4b67-96e3-33e4670ecb3b +``` + +```shell + SUCCESS +╭─────────────────────────────────────────────────────────────────────────┬────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ +│Property │Value │ +├─────────────────────────────────────────────────────────────────────────┼────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ +│Namespace ID │3d25d33e-2469-4990-a9ed-fdd13ce74436 │ +│Namespace FQN │https://opentdf.io │ +│KAS ID │62857b55-560c-4b67-96e3-33e4670ecb3b │ +│Unassigned Granted KAS URI │http://example.com/kas │ +╰─────────────────────────────────────────────────────────────────────────┴────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ + +``` + +Attribute grant: +```shell +otdfctl policy kas-grants unassign --attribute-id a21eb299-3a7d-4035-8a39-c8662c03cb15 --kas-id 62857b55-560c-4b67-96e3-33e4670ecb3b +``` + +```shell + SUCCESS +╭─────────────────────────────────────────────────────────────────────────┬────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ +│Property │Value │ +├─────────────────────────────────────────────────────────────────────────┼────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ +│Attribute ID │a21eb299-3a7d-4035-8a39-c8662c03cb15 │ +│Attribute FQN │https://opentdf.io/attr/myattribute │ +│KAS ID │62857b55-560c-4b67-96e3-33e4670ecb3b │ +│Unassigned Granted KAS URI │http://example.com/kas │ +╰─────────────────────────────────────────────────────────────────────────┴────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ + +``` + +Attribute value grant: +```shell +otdfctl policy kas-grants unassign --value-id 0a40b27c-6cc9-49e8-a6ae-663cac2c324b --kas-id 62857b55-560c-4b67-96e3-33e4670ecb3b +``` + +```shell + SUCCESS +╭─────────────────────────────────────────────────────────────────────────┬────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ +│Property │Value │ +├─────────────────────────────────────────────────────────────────────────┼────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ +│Value ID │0a40b27c-6cc9-49e8-a6ae-663cac2c324b │ +│Value FQN │https://opentdf.io/attr/myattribute/value/myvalue2 │ +│KAS ID │62857b55-560c-4b67-96e3-33e4670ecb3b │ +│Unassigned Granted KAS URI │http://example.com/kas │ +╰─────────────────────────────────────────────────────────────────────────┴────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ + +``` diff --git a/docs/man/policy/kas-registry/create.md b/docs/man/policy/kas-registry/create.md index c2662e79..1bf1da2a 100644 --- a/docs/man/policy/kas-registry/create.md +++ b/docs/man/policy/kas-registry/create.md @@ -72,3 +72,54 @@ The JSON value passed to the `--public-keys` flag stores the set of public keys Deprecated. For more information about registration of Key Access Servers, see the manual for `kas-registry`. + +## Examples + +```shell +otdfctl policy kas-registry create --uri http://example.com/kas --name example-kas --public-keys '{ + "cached": { + "keys": [ + { + "pem": "-----BEGIN CERTIFICATE-----\nMIIC/TCCAeWgAwIBAgIUSHTJ2bzAh7dQmmF03q6Iq/n0l90wDQYJKoZIhvcNAQEL\nBQAwDjEMMAoGA1UEAwwDa2FzMB4XDTI0MDYwNjE3NDY1NFoXDTI1MDYwNjE3NDY1\nNFowDjEMMAoGA1UEAwwDa2FzMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKC\nAQEAxN3APihTiojcaH6oWj1tMtZMaaZ+IA1qtqFmpy5Fg8D5bEsP736GxzUMFsMV\nshrKEXz8dY9Kp23uIwyeC0RPWLe5xIfTkJUbyLpqGdlEgqj10RQ8kSVq270XPES2\nGZUij2DuJVfwpTpLzcti2PsgEOoOKC6NnnAI0NS1mao/2DxQxs/D9hAJjGdpzymb\nxi2TxGnvYbvofCPd8RdFTCPvgwKLS7+MqBcmic9VdX91QNOPmrP3rIoKtjjd+5PY\nl/z73PAxR3K3SIzIZLvItq2ahobOOMiSxw8soOlOdHNUJTpECcduhRbquqmK6fTw\nVOfrcRQhhU4TkDu92LI7SglOWQIDAQABo1MwUTAdBgNVHQ4EFgQUdgxx7U5AQgfi\niQWu3khi9yneEVowHwYDVR0jBBgwFoAUdgxx7U5AQgfiiQWu3khi9yneEVowDwYD\nVR0TAQH/BAUwAwEB/zANBgkqhkiG9w0BAQsFAAOCAQEATcLYbHomJgLQ/H6iDvcA\nIpISF/Rcxgh7NnIqRkB+Tm4xNlNHIxl4Sz+KkEZEPh0WKItGVDj3293rArROEOXI\ntVmn2OBv9M/5DQkHj76Ru4PQ2TcL0CACl1JKfqXLsMc6HHTp8ZTP8lMdpW4kzEc3\nfVtgvtpJc4WHdUIEzAtTlzYRqIbyyBMWeTjXwa54aMv3RZQdJ+C0ehwWTDQDph7n\nKY3+7G0enNEVtyW4dtxvQQbidMany0JEpr6QpPmxC8e0Z23dMDdkR1IoT99PhdW/\nQC8xMjuLCiREV7a6e2MxCGj3fxrnMXwOIqO3AzNswe2amcoz2ktuoqgDTYlo+FkK\n5w==\n-----END CERTIFICATE-----\n", + "kid": "k1", + "alg": 1 + } + ] + } + }' +``` + +```shell + SUCCESS Created kas-registry: 62857b55-560c-4b67-96e3-33e4670ecb3b +╭─────────────────────────────────────────────────────────────────────────┬────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ +│Property │Value │ +├─────────────────────────────────────────────────────────────────────────┼────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ +│Id │62857b55-560c-4b67-96e3-33e4670ecb3b │ +│URI │http://example.com/kas │ +│PublicKey │cached:{keys:{pem:"-----BEGIN CERTIFICATE-----\nMIIC/TCCAeWgAwIBAgIUSHTJ2bzAh7dQmmF03q6Iq/n0l90wDQYJKoZIhvcNAQEL\nBQAwDjEMMAoGA1UEAwwDa2FzMB4XD…│ +│Name │example-kas │ +│Created At │Wed Dec 18 04:51:22 UTC 2024 │ +│Updated At │Wed Dec 18 04:51:22 UTC 2024 │ +╰─────────────────────────────────────────────────────────────────────────┴────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ + NOTE Use 'otdfctl policy kas-registry get --id=62857b55-560c-4b67-96e3-33e4670ecb3b --json' to see all properties +``` + +With a remote public key: +```shell +otdfctl policy kas-registry create --uri http://example.com/kas2 --name example-kas2 --public-key-remote "https://example.com/kas2/public_key" +``` + +```shell + SUCCESS Created kas-registry: 3c39618a-cd8c-48cf-a60c-e8a2f4be4dd5 +╭─────────────────────────────────────────────────────────────────────────┬────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ +│Property │Value │ +├─────────────────────────────────────────────────────────────────────────┼────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ +│Id │3c39618a-cd8c-48cf-a60c-e8a2f4be4dd5 │ +│URI │http://example.com/kas2 │ +│PublicKey │remote:"https://example.com/kas2/public_key" │ +│Name │example-kas2 │ +│Created At │Wed Dec 18 04:57:51 UTC 2024 │ +│Updated At │Wed Dec 18 04:57:51 UTC 2024 │ +╰─────────────────────────────────────────────────────────────────────────┴────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ + NOTE Use 'otdfctl policy kas-registry get --id=3c39618a-cd8c-48cf-a60c-e8a2f4be4dd5 --json' to see all properties +``` diff --git a/docs/man/policy/kas-registry/delete.md b/docs/man/policy/kas-registry/delete.md index bfff3958..42b39dfb 100644 --- a/docs/man/policy/kas-registry/delete.md +++ b/docs/man/policy/kas-registry/delete.md @@ -20,3 +20,20 @@ type of grants and relevant key splits. Make sure you know what you are doing. For more information about registration of Key Access Servers, see the manual for `kas-registry`. + +## Example + +```shell +otdfctl policy kas-registry delete --id 3c39618a-cd8c-48cf-a60c-e8a2f4be4dd5 +``` + +```shell + SUCCESS Deleted kas-registry: 3c39618a-cd8c-48cf-a60c-e8a2f4be4dd5 +╭─────────────────────────────────────────────────────────────────────────┬────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ +│Property │Value │ +├─────────────────────────────────────────────────────────────────────────┼────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ +│Id │3c39618a-cd8c-48cf-a60c-e8a2f4be4dd5 │ +│URI │http://example.com/kas2 │ +╰─────────────────────────────────────────────────────────────────────────┴────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ + NOTE Use 'otdfctl policy kas-registry list --json' to see all properties +``` diff --git a/docs/man/policy/kas-registry/get.md b/docs/man/policy/kas-registry/get.md index cf19bd38..6e9020fc 100644 --- a/docs/man/policy/kas-registry/get.md +++ b/docs/man/policy/kas-registry/get.md @@ -12,3 +12,24 @@ command: --- For more information about registration of Key Access Servers, see the manual for `kas-registry`. + +## Example + +```shell +otdfctl policy kas-registry get --id=62857b55-560c-4b67-96e3-33e4670ecb3b +``` + +```shell + SUCCESS Found kas-registry: 62857b55-560c-4b67-96e3-33e4670ecb3b +╭─────────────────────────────────────────────────────────────────────────┬────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ +│Property │Value │ +├─────────────────────────────────────────────────────────────────────────┼────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ +│Id │62857b55-560c-4b67-96e3-33e4670ecb3b │ +│URI │http://example.com/kas │ +│PublicKey │cached:{keys:{pem:"-----BEGIN CERTIFICATE-----\nMIIC/TCCAeWgAwIBAgIUSHTJ2bzAh7dQmmF03q6Iq/n0l90wDQYJKoZIhvcNAQEL\nBQAwDjEMMAoGA1UEAwwDa2FzMB4XD…│ +│Name │example-kas │ +│Created At │Wed Dec 18 04:51:22 UTC 2024 │ +│Updated At │Wed Dec 18 04:51:22 UTC 2024 │ +╰─────────────────────────────────────────────────────────────────────────┴────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ + NOTE Use 'otdfctl policy kas-registry get --id=62857b55-560c-4b67-96e3-33e4670ecb3b --json' to see all properties +``` diff --git a/docs/man/policy/kas-registry/list.md b/docs/man/policy/kas-registry/list.md index 9d2101fd..0ca8dc25 100644 --- a/docs/man/policy/kas-registry/list.md +++ b/docs/man/policy/kas-registry/list.md @@ -14,3 +14,22 @@ command: --- For more information about registration of Key Access Servers, see the manual for `kas-registry`. + +## Example + +```shell +otdfctl policy kas-registry list +``` + +```shell + SUCCESS Found kas-registry list + +╭──────────────────────────────────────────────────────────────────┬─────────────────────────────────────────────────────┬────────────────────────────────────────┬────────────────────────────────────────────────────────╮ +│ID │URI │Name │PublicKey │ +├──────────────────────────────────────────────────────────────────┼─────────────────────────────────────────────────────┼────────────────────────────────────────┼────────────────────────────────────────────────────────┤ +│f612b628-5459-4342-b20f-3768b30ad588 │http://localhost:8080/kas │alpha │cached:{keys:{pem:"-----BEGIN PUBLIC KEY-----\\nMIIBIjA…│ +│62857b55-560c-4b67-96e3-33e4670ecb3b │http://example.com/kas │example-kas │cached:{keys:{pem:"-----BEGIN CERTIFICATE-----\nMIIC/TC…│ +│3c39618a-cd8c-48cf-a60c-e8a2f4be4dd5 │http://example.com/kas2 │example-kas2 │remote:"https://example.com/kas2/public_key" │ +╰──────────────────────────────────────────────────────────────────┴─────────────────────────────────────────────────────┴────────────────────────────────────────┴────────────────────────────────────────────────────────╯ + NOTE Use 'otdfctl policy kas-registry get --id= --json' to see all properties +``` diff --git a/docs/man/policy/kas-registry/update.md b/docs/man/policy/kas-registry/update.md index cc64948f..1213e18e 100644 --- a/docs/man/policy/kas-registry/update.md +++ b/docs/man/policy/kas-registry/update.md @@ -39,3 +39,24 @@ type of grants and relevant key splits. Make sure you know what you are doing. For more information about registration of Key Access Servers, see the manual for `kas-registry`. + +## Example + +```shell +otdfctl policy kas-registry update --id 3c39618a-cd8c-48cf-a60c-e8a2f4be4dd5 --name example-kas2-newname --public-key-remote "https://example.com/kas2/new_public_key" +``` + +```shell + SUCCESS Updated kas-registry: 3c39618a-cd8c-48cf-a60c-e8a2f4be4dd5 +╭─────────────────────────────────────────────────────────────────────────┬────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ +│Property │Value │ +├─────────────────────────────────────────────────────────────────────────┼────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ +│Id │3c39618a-cd8c-48cf-a60c-e8a2f4be4dd5 │ +│URI │http://example.com/kas2 │ +│PublicKey │remote:"https://example.com/kas2/new_public_key" │ +│Name │example-kas2-newname │ +│Created At │Wed Dec 18 04:57:51 UTC 2024 │ +│Updated At │Wed Dec 18 05:03:51 UTC 2024 │ +╰─────────────────────────────────────────────────────────────────────────┴────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ + NOTE Use 'otdfctl policy kas-registry get --id=3c39618a-cd8c-48cf-a60c-e8a2f4be4dd5 --json' to see all properties +``` diff --git a/docs/man/policy/resource-mappings/create.md b/docs/man/policy/resource-mappings/create.md index 20ba76f0..b14f6b96 100644 --- a/docs/man/policy/resource-mappings/create.md +++ b/docs/man/policy/resource-mappings/create.md @@ -22,3 +22,24 @@ command: Associate an attribute value with a set of plaintext string terms. For more information about resource mappings, see the `resource-mappings` subcommand. + +## Examples + +```shell +otdfctl policy resource-mappings create --attribute-value-id 891cfe85-b381-4f85-9699-5f7dbfe2a9ab --terms term1,term2 +``` + +```shell + SUCCESS Created resource-mappings: 3ff446fb-8fb1-4c04-8023-47592c90370c +╭─────────────────────────────────────────────────────────────────────────┬────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ +│Property │Value │ +├─────────────────────────────────────────────────────────────────────────┼────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ +│Id │3ff446fb-8fb1-4c04-8023-47592c90370c │ +│Attribute Value Id │891cfe85-b381-4f85-9699-5f7dbfe2a9ab │ +│Attribute Value │myvalue1 │ +│Terms │term1, term2 │ +│Created At │Wed Dec 18 05:53:53 UTC 2024 │ +│Updated At │Wed Dec 18 05:53:53 UTC 2024 │ +╰─────────────────────────────────────────────────────────────────────────┴────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ + NOTE Use 'otdfctl policy resource-mappings get --id=3ff446fb-8fb1-4c04-8023-47592c90370c --json' to see all properties +``` diff --git a/docs/man/policy/resource-mappings/delete.md b/docs/man/policy/resource-mappings/delete.md index 3eba3329..c8c3b91e 100644 --- a/docs/man/policy/resource-mappings/delete.md +++ b/docs/man/policy/resource-mappings/delete.md @@ -11,3 +11,22 @@ command: --- For more information about resource mappings, see the `resource-mappings` subcommand. + +## Examples + +```shell +otdfctl policy resource-mappings delete --id=3ff446fb-8fb1-4c04-8023-47592c90370c +``` + +```shell + SUCCESS Deleted resource-mappings: 3ff446fb-8fb1-4c04-8023-47592c90370c +╭─────────────────────────────────────────────────────────────────────────┬────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ +│Property │Value │ +├─────────────────────────────────────────────────────────────────────────┼────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ +│Id │3ff446fb-8fb1-4c04-8023-47592c90370c │ +│Attribute Value Id │ │ +│Attribute Value │ │ +│Terms │ │ +╰─────────────────────────────────────────────────────────────────────────┴────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ + NOTE Use 'otdfctl policy resource-mappings list --json' to see all properties +``` diff --git a/docs/man/policy/resource-mappings/get.md b/docs/man/policy/resource-mappings/get.md index 22e8c9a4..682c1898 100644 --- a/docs/man/policy/resource-mappings/get.md +++ b/docs/man/policy/resource-mappings/get.md @@ -11,3 +11,24 @@ command: --- For more information about resource mappings, see the `resource-mappings` subcommand. + +## Examples + +```shell +otdfctl policy resource-mappings get --id=3ff446fb-8fb1-4c04-8023-47592c90370c +``` + +```shell + SUCCESS Found resource-mappings: 3ff446fb-8fb1-4c04-8023-47592c90370c +╭─────────────────────────────────────────────────────────────────────────┬────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ +│Property │Value │ +├─────────────────────────────────────────────────────────────────────────┼────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ +│Id │3ff446fb-8fb1-4c04-8023-47592c90370c │ +│Attribute Value Id │891cfe85-b381-4f85-9699-5f7dbfe2a9ab │ +│Attribute Value │myvalue1 │ +│Terms │term1, term2 │ +│Created At │Wed Dec 18 05:53:53 UTC 2024 │ +│Updated At │Wed Dec 18 05:53:53 UTC 2024 │ +╰─────────────────────────────────────────────────────────────────────────┴────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ + NOTE Use 'otdfctl policy resource-mappings get --id=3ff446fb-8fb1-4c04-8023-47592c90370c --json' to see all properties +``` diff --git a/docs/man/policy/resource-mappings/list.md b/docs/man/policy/resource-mappings/list.md index 6dbd6d92..926f41db 100644 --- a/docs/man/policy/resource-mappings/list.md +++ b/docs/man/policy/resource-mappings/list.md @@ -14,3 +14,21 @@ command: --- For more information about resource mappings, see the `resource-mappings` subcommand. + +## Examples + +```shell +otdfctl policy resource-mappings get --id=3ff446fb-8fb1-4c04-8023-47592c90370c +``` + +```shell + SUCCESS Found resource-mappings list + +╭────────────────────────────────────────────────────────┬─────────────────────────────────────────────┬─────────────────────────────────────────────┬─────────────────────────────────┬───────────┬───────────┬───────────╮ +│ID │Attribute Value Id │Attribute Value │Terms │Labels │Created At │Updated At │ +├────────────────────────────────────────────────────────┼─────────────────────────────────────────────┼─────────────────────────────────────────────┼─────────────────────────────────┼───────────┼───────────┼───────────┤ +│3ff446fb-8fb1-4c04-8023-47592c90370c │891cfe85-b381-4f85-9699-5f7dbfe2a9ab │myvalue1 │term1, term2 │[] │Wed Dec 18…│Wed Dec 18…│ +│02092d67-fffa-4030-9775-b5cd5d581e1f │74babca6-016f-4f3e-a99b-4e46ea8d0fd8 │myvalue2 │term2, term4 │[] │Fri Nov 1…│Fri Nov 1…│ +╰────────────────────────────────────────────────────────┴─────────────────────────────────────────────┴─────────────────────────────────────────────┴─────────────────────────────────┴───────────┴───────────┴───────────╯ + NOTE Use 'otdfctl policy resource-mappings get --id= --json' to see all properties +``` diff --git a/docs/man/policy/resource-mappings/update.md b/docs/man/policy/resource-mappings/update.md index 8f367583..f44e64ab 100644 --- a/docs/man/policy/resource-mappings/update.md +++ b/docs/man/policy/resource-mappings/update.md @@ -26,3 +26,24 @@ command: Alter the attribute value associated with a resource mapping's terms, or fully replace the terms in a given resource mapping. For more information about resource mappings, see the `resource-mappings` subcommand. + +## Examples + +```shell +otdfctl policy resource-mappings update --id=3ff446fb-8fb1-4c04-8023-47592c90370c --terms newterm1,newterm2 +``` + +```shell + SUCCESS Updated resource-mappings: 3ff446fb-8fb1-4c04-8023-47592c90370c +╭─────────────────────────────────────────────────────────────────────────┬────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ +│Property │Value │ +├─────────────────────────────────────────────────────────────────────────┼────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ +│Id │3ff446fb-8fb1-4c04-8023-47592c90370c │ +│Attribute Value Id │891cfe85-b381-4f85-9699-5f7dbfe2a9ab │ +│Attribute Value │myvalue1 │ +│Terms │newterm1, newterm2 │ +│Created At │Wed Dec 18 05:53:53 UTC 2024 │ +│Updated At │Wed Dec 18 05:58:11 UTC 2024 │ +╰─────────────────────────────────────────────────────────────────────────┴────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ + NOTE Use 'otdfctl policy resource-mappings get --id=3ff446fb-8fb1-4c04-8023-47592c90370c --json' to see all properties +``` From f05b702959ebfd1c7c42cbe4bc22b4896dfb7d12 Mon Sep 17 00:00:00 2001 From: Elizabeth Healy Date: Wed, 18 Dec 2024 02:08:47 -0500 Subject: [PATCH 2/7] scs examples --- .../policy/subject-condition-sets/create.md | 59 +++++++++++++++++++ .../policy/subject-condition-sets/delete.md | 19 ++++++ docs/man/policy/subject-condition-sets/get.md | 19 ++++++ .../man/policy/subject-condition-sets/list.md | 18 ++++++ .../policy/subject-condition-sets/prune.md | 19 ++++++ .../policy/subject-condition-sets/update.md | 41 +++++++++++++ 6 files changed, 175 insertions(+) diff --git a/docs/man/policy/subject-condition-sets/create.md b/docs/man/policy/subject-condition-sets/create.md index f5605d44..f331e38f 100644 --- a/docs/man/policy/subject-condition-sets/create.md +++ b/docs/man/policy/subject-condition-sets/create.md @@ -94,3 +94,62 @@ the condition set would not resolve to true, and the Subject would not be found to the Attribute Value applicable to this Subject Condition Set via Subject Mapping between. For more information about subject condition sets, see the `subject-condition-sets` subcommand. + +## Examples + +The following subject condition set would resolve to true if the field at `.example.field.one` is +"myvalue" or "myothervalue", or the field at `.example.field.two` is not equal to "notpresentvalue". +```shell +otdfctl policy subject-condition-set create --subject-sets '[ + { + "condition_groups": [ + { + "conditions": [ + { + "operator": 1, + "subject_external_values": ["myvalue", "myothervalue"], + "subject_external_selector_value": ".example.field.one" + }, + { + "operator": 2, + "subject_external_values": ["notpresentvalue"], + "subject_external_selector_value": ".example.field.two" + } + ], + "boolean_operator": 2 + } + ] + } +]' +``` + +```shell + SUCCESS Created subject-condition-sets: bfade235-509a-4a6f-886a-812005c01db5 +╭─────────────────────────────────────────────────────────────────────────┬────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ +│Property │Value │ +├─────────────────────────────────────────────────────────────────────────┼────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ +│Id │bfade235-509a-4a6f-886a-812005c01db5 │ +│SubjectSets │[{"conditionGroups":[{"conditions":[{"subjectExternalSelectorValue":".example.field.one","operator":"SUBJECT_MAPPING_OPERATOR_ENUM_IN","subject…│ +│Created At │Wed Dec 18 06:44:39 UTC 2024 │ +│Updated At │Wed Dec 18 06:44:39 UTC 2024 │ +╰─────────────────────────────────────────────────────────────────────────┴────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ + NOTE Use 'otdfctl policy subject-condition-sets get --id=bfade235-509a-4a6f-886a-812005c01db5 --json' to see all properties +``` + +You can perform the same action with the input contained in a file: +```shell +otdfctl policy subject-condition-set create --subject-sets-file-json scs.json +``` + +```shell + SUCCESS Created subject-condition-sets: bfade235-509a-4a6f-886a-812005c01db5 +╭─────────────────────────────────────────────────────────────────────────┬────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ +│Property │Value │ +├─────────────────────────────────────────────────────────────────────────┼────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ +│Id │bfade235-509a-4a6f-886a-812005c01db5 │ +│SubjectSets │[{"conditionGroups":[{"conditions":[{"subjectExternalSelectorValue":".example.field.one","operator":"SUBJECT_MAPPING_OPERATOR_ENUM_IN","subject…│ +│Created At │Wed Dec 18 06:44:39 UTC 2024 │ +│Updated At │Wed Dec 18 06:44:39 UTC 2024 │ +╰─────────────────────────────────────────────────────────────────────────┴────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ + NOTE Use 'otdfctl policy subject-condition-sets get --id=bfade235-509a-4a6f-886a-812005c01db5 --json' to see all properties +``` diff --git a/docs/man/policy/subject-condition-sets/delete.md b/docs/man/policy/subject-condition-sets/delete.md index 9726e6e0..7fcf0cff 100644 --- a/docs/man/policy/subject-condition-sets/delete.md +++ b/docs/man/policy/subject-condition-sets/delete.md @@ -13,3 +13,22 @@ command: --- For more information about subject condition sets, see the `subject-condition-sets` subcommand. + +## Example + +```shell +otdfctl policy subject-condition-sets delete --id=bfade235-509a-4a6f-886a-812005c01db5 +``` + +```shell + SUCCESS Deleted subject-condition-sets: bfade235-509a-4a6f-886a-812005c01db5 +╭─────────────────────────────────────────────────────────────────────────┬────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ +│Property │Value │ +├─────────────────────────────────────────────────────────────────────────┼────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ +│Id │bfade235-509a-4a6f-886a-812005c01db5 │ +│SubjectSets │[{"conditionGroups":[{"conditions":[{"subjectExternalSelectorValue":".example.field.one","operator":"SUBJECT_MAPPING_OPERATOR_ENUM_IN","subject…│ +│Created At │Wed Dec 18 06:44:39 UTC 2024 │ +│Updated At │Wed Dec 18 06:54:28 UTC 2024 │ +╰─────────────────────────────────────────────────────────────────────────┴────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ + NOTE Use 'otdfctl policy subject-condition-sets list --json' to see all properties +``` diff --git a/docs/man/policy/subject-condition-sets/get.md b/docs/man/policy/subject-condition-sets/get.md index 764b104a..569246a6 100644 --- a/docs/man/policy/subject-condition-sets/get.md +++ b/docs/man/policy/subject-condition-sets/get.md @@ -13,3 +13,22 @@ command: --- For more information about subject condition sets, see the `subject-condition-sets` subcommand. + +## Example + +```shell +otdfctl policy subject-condition-sets get --id=bfade235-509a-4a6f-886a-812005c01db5 +``` + +```shell + SUCCESS Found subject-condition-sets: bfade235-509a-4a6f-886a-812005c01db5 +╭─────────────────────────────────────────────────────────────────────────┬────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ +│Property │Value │ +├─────────────────────────────────────────────────────────────────────────┼────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ +│Id │bfade235-509a-4a6f-886a-812005c01db5 │ +│SubjectSets │[{"conditionGroups":[{"conditions":[{"subjectExternalSelectorValue":".example.field.one","operator":"SUBJECT_MAPPING_OPERATOR_ENUM_IN","subject…│ +│Created At │Wed Dec 18 06:44:39 UTC 2024 │ +│Updated At │Wed Dec 18 06:44:39 UTC 2024 │ +╰─────────────────────────────────────────────────────────────────────────┴────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ + NOTE Use 'otdfctl policy subject-condition-sets get --id=bfade235-509a-4a6f-886a-812005c01db5 --json' to see all properties +``` diff --git a/docs/man/policy/subject-condition-sets/list.md b/docs/man/policy/subject-condition-sets/list.md index 77b9bc26..1af90fe3 100644 --- a/docs/man/policy/subject-condition-sets/list.md +++ b/docs/man/policy/subject-condition-sets/list.md @@ -15,3 +15,21 @@ command: --- For more information about subject condition sets, see the `subject-condition-sets` subcommand. + +## Example + +```shell +otdfctl policy subject-condition-set list +``` + +```shell + SUCCESS Found subject-condition-sets list + +╭──────────────────────────────────────────────────────────────────────────────────────┬─────────────────────────────────────────────────────────────────────┬──────────────────┬──────────────────┬───────────────────────╮ +│ID │SubjectSets │Labels │Created At │Updated At │ +├──────────────────────────────────────────────────────────────────────────────────────┼─────────────────────────────────────────────────────────────────────┼──────────────────┼──────────────────┼───────────────────────┤ +│8b80eb7c-cecb-44d4-91a7-f14ada74d4ce │[{"conditionGroups":[{"conditions":[{"subjectExternalSelectorValue":…│[] │Mon Dec 16 16:00:…│Mon Dec 16 16:00:33 UT…│ +│bfade235-509a-4a6f-886a-812005c01db5 │[{"conditionGroups":[{"conditions":[{"subjectExternalSelectorValue":…│[] │Wed Dec 18 06:44:…│Wed Dec 18 06:44:39 UT…│ +╰──────────────────────────────────────────────────────────────────────────────────────┴─────────────────────────────────────────────────────────────────────┴──────────────────┴──────────────────┴───────────────────────╯ + NOTE Use 'otdfctl policy subject-condition-sets get --id= --json' to see all properties +``` diff --git a/docs/man/policy/subject-condition-sets/prune.md b/docs/man/policy/subject-condition-sets/prune.md index e2842050..13cae24b 100644 --- a/docs/man/policy/subject-condition-sets/prune.md +++ b/docs/man/policy/subject-condition-sets/prune.md @@ -11,3 +11,22 @@ command: This command will delete all Subject Condition Sets that are not utilized within any Subject Mappings and are therefore 'stranded'. For more information about subject condition sets, see the `subject-condition-sets` subcommand. + +## Example + +```shell +otdfctl policy subject-condition-set prune +``` + +```shell + SUCCESS +╭──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ +│ID │ +├──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ +│5ecb1088-9c66-4fad-aa50-1d79fc84a344 │ +│c3167e9e-1987-4200-a45b-35127d86785c │ +│66fe121a-0d14-48d0-aa33-59a5b1934fc6 │ +│524401e1-0ed0-4f70-924f-8978174e224b │ │ +╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ + +``` diff --git a/docs/man/policy/subject-condition-sets/update.md b/docs/man/policy/subject-condition-sets/update.md index 9d5b3d67..4c812fe7 100644 --- a/docs/man/policy/subject-condition-sets/update.md +++ b/docs/man/policy/subject-condition-sets/update.md @@ -31,3 +31,44 @@ command: Replace the existing conditional logic within an SCS with new conditional logic, passing either JSON directly or a JSON file. For more information about subject condition sets, see the `subject-condition-sets` subcommand. + +## Example + +This updates the boolean_operator of the subject condition set created in the `create` example. The following subject condition set would resolve to true if the field at `.example.field.one` is +"myvalue" or "myothervalue" AND the field at `.example.field.two` is not equal to "notpresentvalue". +```shell +otdfctl policy subject-condition-set update --id bfade235-509a-4a6f-886a-812005c01db5 --subject-sets '[ + { + "condition_groups": [ + { + "conditions": [ + { + "operator": 1, + "subject_external_values": ["myvalue", "myothervalue"], + "subject_external_selector_value": ".example.field.one" + }, + { + "operator": 2, + "subject_external_values": ["notpresentvalue"], + "subject_external_selector_value": ".example.field.two" + } + ], + "boolean_operator": 1 + } + ] + } +]' +``` + +```shell + SUCCESS Updated subject-condition-sets: bfade235-509a-4a6f-886a-812005c01db5 +╭─────────────────────────────────────────────────────────────────────────┬────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ +│Property │Value │ +├─────────────────────────────────────────────────────────────────────────┼────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ +│Id │bfade235-509a-4a6f-886a-812005c01db5 │ +│SubjectSets │[{"conditionGroups":[{"conditions":[{"subjectExternalSelectorValue":".example.field.one","operator":"SUBJECT_MAPPING_OPERATOR_ENUM_IN","subject…│ +│Created At │Wed Dec 18 06:44:39 UTC 2024 │ +│Updated At │Wed Dec 18 06:54:28 UTC 2024 │ +╰─────────────────────────────────────────────────────────────────────────┴────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ + NOTE Use 'otdfctl policy subject-condition-sets get --id=bfade235-509a-4a6f-886a-812005c01db5 --json' to see all properties +``` From 543063fe84c6d40306d37bdc34e4f2064ac78bf8 Mon Sep 17 00:00:00 2001 From: Elizabeth Healy Date: Wed, 18 Dec 2024 10:50:52 -0500 Subject: [PATCH 3/7] subject mapping examples --- docs/man/policy/subject-mappings/create.md | 66 ++++++++++++++++++++++ docs/man/policy/subject-mappings/delete.md | 16 ++++++ docs/man/policy/subject-mappings/get.md | 21 +++++++ docs/man/policy/subject-mappings/list.md | 19 +++++++ docs/man/policy/subject-mappings/update.md | 18 ++++++ 5 files changed, 140 insertions(+) diff --git a/docs/man/policy/subject-mappings/create.md b/docs/man/policy/subject-mappings/create.md index 4b24b7e2..e6a6b026 100644 --- a/docs/man/policy/subject-mappings/create.md +++ b/docs/man/policy/subject-mappings/create.md @@ -39,8 +39,74 @@ command: default: '' --- +The possible values for standard actions are DECRYPT and TRANSMIT. + Create a Subject Mapping to entitle an entity (via existing or new Subject Condition Set) to an Attribute Value. For more information about subject mappings, see the `subject-mappings` subcommand. For more information about subject condition sets, see the `subject-condition-sets` subcommand. + +## Examples + +Create a subject mapping linking to an existing subject condition set: +```shell +otdfctl policy subject-mapping create --attribute-value-id 891cfe85-b381-4f85-9699-5f7dbfe2a9ab --action-standard DECRYPT --subject-condition-set-id 8dc98f65-5f0a-4444-bfd1-6a818dc7b447 +``` + +```shell + SUCCESS Created subject-mappings: 39866dd2-368b-41f6-b292-b4b68c01888b +╭─────────────────────────────────────────────────────────────────────────┬────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ +│Property │Value │ +├─────────────────────────────────────────────────────────────────────────┼────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ +│Id │39866dd2-368b-41f6-b292-b4b68c01888b │ +│Attribute Value Id │891cfe85-b381-4f85-9699-5f7dbfe2a9ab │ +│Actions │[{"Value":{"Standard":1}}] │ +│Subject Condition Set: Id │8dc98f65-5f0a-4444-bfd1-6a818dc7b447 │ +│Subject Condition Set │[{"condition_groups":[{"conditions":[{"subject_external_selector_value":".example.field.one","operator":1,"subject_external_values":["myvalue",…│ +│Created At │Wed Dec 18 15:40:50 UTC 2024 │ +│Updated At │Wed Dec 18 15:40:50 UTC 2024 │ +╰─────────────────────────────────────────────────────────────────────────┴────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ + NOTE Use 'otdfctl policy subject-mappings get --id=39866dd2-368b-41f6-b292-b4b68c01888b --json' to see all properties +``` + +Or you can create a mapping that linked to a new subject condition set: +```shell +otdfctl policy subject-mapping create --attribute-value-id 891cfe85-b381-4f85-9699-5f7dbfe2a9ab --action-standard DECRYPT --subject-condition-set-new '[ + { + "condition_groups": [ + { + "conditions": [ + { + "operator": 1, + "subject_external_values": ["myvalue", "myothervalue"], + "subject_external_selector_value": ".example.field.one" + }, + { + "operator": 2, + "subject_external_values": ["notpresentvalue"], + "subject_external_selector_value": ".example.field.two" + } + ], + "boolean_operator": 2 + } + ] + } +]' +``` + +```shell + SUCCESS Created subject-mappings: d71c4028-ce64-453b-8aa7-6edb45fbb848 +╭─────────────────────────────────────────────────────────────────────────┬────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ +│Property │Value │ +├─────────────────────────────────────────────────────────────────────────┼────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ +│Id │d71c4028-ce64-453b-8aa7-6edb45fbb848 │ +│Attribute Value Id │891cfe85-b381-4f85-9699-5f7dbfe2a9ab │ +│Actions │[{"Value":{"Standard":1}}] │ +│Subject Condition Set: Id │738736ee-880d-40da-acae-672d1deff00f │ +│Subject Condition Set │[{"condition_groups":[{"conditions":[{"subject_external_selector_value":".example.field.one","operator":1,"subject_external_values":["myvalue",…│ +│Created At │Wed Dec 18 15:41:55 UTC 2024 │ +│Updated At │Wed Dec 18 15:41:55 UTC 2024 │ +╰─────────────────────────────────────────────────────────────────────────┴────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ + NOTE Use 'otdfctl policy subject-mappings get --id=d71c4028-ce64-453b-8aa7-6edb45fbb848 --json' to see all properties +``` diff --git a/docs/man/policy/subject-mappings/delete.md b/docs/man/policy/subject-mappings/delete.md index c2af25ac..725f6199 100644 --- a/docs/man/policy/subject-mappings/delete.md +++ b/docs/man/policy/subject-mappings/delete.md @@ -17,3 +17,19 @@ Delete a Subject Mapping to remove entitlement of an entity (via Subject Conditi For more information about subject mappings, see the `subject-mappings` subcommand. For more information about subject condition sets, see the `subject-condition-sets` subcommand. + +## Example + +```shell +otdfctl policy subject-mappings delete --id d71c4028-ce64-453b-8aa7-6edb45fbb848 +``` + +```shell + SUCCESS Deleted subject-mappings: d71c4028-ce64-453b-8aa7-6edb45fbb848 +╭─────────────────────────────────────────────────────────────────────────┬────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ +│Property │Value │ +├─────────────────────────────────────────────────────────────────────────┼────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ +│Id │d71c4028-ce64-453b-8aa7-6edb45fbb848 │ +╰─────────────────────────────────────────────────────────────────────────┴────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ + NOTE Use 'otdfctl policy subject-mappings list --json' to see all properties +``` diff --git a/docs/man/policy/subject-mappings/get.md b/docs/man/policy/subject-mappings/get.md index 75e2197c..371a1c5f 100644 --- a/docs/man/policy/subject-mappings/get.md +++ b/docs/man/policy/subject-mappings/get.md @@ -15,3 +15,24 @@ command: Retrieve the specifics of a Subject Mapping. For more information about subject mappings, see the `subject-mappings` subcommand. + +```shell +otdfctl policy subject-mappings get --id 39866dd2-368b-41f6-b292-b4b68c01888b +``` + +```shell + SUCCESS Found subject-mappings: 39866dd2-368b-41f6-b292-b4b68c01888b +╭─────────────────────────────────────────────────────────────────────────┬────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ +│Property │Value │ +├─────────────────────────────────────────────────────────────────────────┼────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ +│Id │39866dd2-368b-41f6-b292-b4b68c01888b │ +│Attribute Value: Id │891cfe85-b381-4f85-9699-5f7dbfe2a9ab │ +│Attribute Value: Value │myvalue1 │ +│Actions │[{"Value":{"Standard":1}}] │ +│Subject Condition Set: Id │8dc98f65-5f0a-4444-bfd1-6a818dc7b447 │ +│Subject Condition Set │[{"condition_groups":[{"conditions":[{"subject_external_selector_value":".example.field.one","operator":1,"subject_external_values":["myvalue",…│ +│Created At │Wed Dec 18 15:40:50 UTC 2024 │ +│Updated At │Wed Dec 18 15:40:50 UTC 2024 │ +╰─────────────────────────────────────────────────────────────────────────┴────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ + NOTE Use 'otdfctl policy subject-mappings get --id=39866dd2-368b-41f6-b292-b4b68c01888b --json' to see all properties +``` diff --git a/docs/man/policy/subject-mappings/list.md b/docs/man/policy/subject-mappings/list.md index 1e13e6af..5ee31e9a 100644 --- a/docs/man/policy/subject-mappings/list.md +++ b/docs/man/policy/subject-mappings/list.md @@ -14,3 +14,22 @@ command: --- For more information about subject mappings, see the `subject-mappings` subcommand. + +## Example + +```shell +otdfctl policy subject-mappings list +``` + +```shell + SUCCESS Found subject-mappings list +╭─────────────────────────────────────────┬─────────────────────────────────┬─────────────────────────┬─────────────────┬─────────────────────────────────┬─────────────────────────┬─────────┬─────────┬──────────────────╮ +│ID │Subject AttrVal: Id │Subject AttrVal: Value │Actions │Subject Condition Set: Id │Subject Condition Set │Labels │Created …│Updated At │ +├─────────────────────────────────────────┼─────────────────────────────────┼─────────────────────────┼─────────────────┼─────────────────────────────────┼─────────────────────────┼─────────┼─────────┼──────────────────┤ +│d71c4028-ce64-453b-8aa7-6edb45fbb848 │891cfe85-b381-4f85-9699-5f7dbfe2…│myvalue1 │[{"Value":{"Stan…│738736ee-880d-40da-acae-672d1def…│[{"condition_groups":[{"…│[] │Wed Dec …│Wed Dec 18 15:41:…│ +│39866dd2-368b-41f6-b292-b4b68c01888b │891cfe85-b381-4f85-9699-5f7dbfe2…│myvalue1 │[{"Value":{"Stan…│8dc98f65-5f0a-4444-bfd1-6a818dc7…│[{"condition_groups":[{"…│[] │Wed Dec …│Wed Dec 18 15:40:…│ +│e6a3f940-e24f-4383-8763-718a1a304948 │2fe8dea1-3555-498c-afe9-99724f35…│value2 │[{"Value":{"Stan…│798aacd2-abaf-4623-975e-3bb8ca43…│[{"condition_groups":[{"…│[] │Fri Nov …│Fri Nov 1 14:46:…│ +│9d06c757-06b9-4713-8fbd-5ef007b1afe2 │74babca6-016f-4f3e-a99b-4e46ea8d…│value1 │[{"Value":{"Stan…│eaf866c0-327f-4826-846a-5041c3c2…│[{"condition_groups":[{"…│[] │Fri Nov …│Fri Nov 1 14:46:…│ +╰─────────────────────────────────────────┴─────────────────────────────────┴─────────────────────────┴─────────────────┴─────────────────────────────────┴─────────────────────────┴─────────┴─────────┴──────────────────╯ + NOTE Use 'otdfctl policy subject-mappings get --id= --json' to see all properties +``` diff --git a/docs/man/policy/subject-mappings/update.md b/docs/man/policy/subject-mappings/update.md index 3f4abf07..3960d791 100644 --- a/docs/man/policy/subject-mappings/update.md +++ b/docs/man/policy/subject-mappings/update.md @@ -44,3 +44,21 @@ At this time, creation of a new SCS during update of a subject mapping is not su For more information about subject mappings, see the `subject-mappings` subcommand. For more information about subject condition sets, see the `subject-condition-sets` subcommand. + +## Example + +```shell +otdfctl policy subject-mappings update --id 39866dd2-368b-41f6-b292-b4b68c01888b --action-standard DECRYPT,TRANSMIT +``` + +```shell + SUCCESS Updated subject-mappings: 39866dd2-368b-41f6-b292-b4b68c01888b +╭─────────────────────────────────────────────────────────────────────────┬────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ +│Property │Value │ +├─────────────────────────────────────────────────────────────────────────┼────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ +│Id │39866dd2-368b-41f6-b292-b4b68c01888b │ +│Created At │Wed Dec 18 15:40:50 UTC 2024 │ +│Updated At │Wed Dec 18 15:46:41 UTC 2024 │ +╰─────────────────────────────────────────────────────────────────────────┴────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ + NOTE Use 'otdfctl policy subject-mappings get --id=39866dd2-368b-41f6-b292-b4b68c01888b --json' to see all properties +``` From d88beb83df8fcdff92d959806df22bfb2384e124 Mon Sep 17 00:00:00 2001 From: Elizabeth Healy Date: Wed, 18 Dec 2024 10:54:15 -0500 Subject: [PATCH 4/7] spellcheck, escape --- docs/man/policy/subject-condition-sets/create.md | 2 +- docs/man/policy/subject-condition-sets/update.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/man/policy/subject-condition-sets/create.md b/docs/man/policy/subject-condition-sets/create.md index f331e38f..73c5f1de 100644 --- a/docs/man/policy/subject-condition-sets/create.md +++ b/docs/man/policy/subject-condition-sets/create.md @@ -98,7 +98,7 @@ For more information about subject condition sets, see the `subject-condition-se ## Examples The following subject condition set would resolve to true if the field at `.example.field.one` is -"myvalue" or "myothervalue", or the field at `.example.field.two` is not equal to "notpresentvalue". +`myvalue` or `myothervalue1`, or the field at `.example.field.two` is not equal to `notpresentvalue`. ```shell otdfctl policy subject-condition-set create --subject-sets '[ { diff --git a/docs/man/policy/subject-condition-sets/update.md b/docs/man/policy/subject-condition-sets/update.md index 4c812fe7..155212c5 100644 --- a/docs/man/policy/subject-condition-sets/update.md +++ b/docs/man/policy/subject-condition-sets/update.md @@ -35,7 +35,7 @@ For more information about subject condition sets, see the `subject-condition-se ## Example This updates the boolean_operator of the subject condition set created in the `create` example. The following subject condition set would resolve to true if the field at `.example.field.one` is -"myvalue" or "myothervalue" AND the field at `.example.field.two` is not equal to "notpresentvalue". +`myvalue` or `myothervalue` AND the field at `.example.field.two` is not equal to `notpresentvalue`. ```shell otdfctl policy subject-condition-set update --id bfade235-509a-4a6f-886a-812005c01db5 --subject-sets '[ { From a1fb912b0d334e672ae0ca82f085c7385f6aebad Mon Sep 17 00:00:00 2001 From: Elizabeth Healy Date: Mon, 6 Jan 2025 15:17:16 -0500 Subject: [PATCH 5/7] remove command outputs --- docs/man/inspect/_index.md | 70 ------------------- docs/man/policy/attributes/create.md | 16 ----- docs/man/policy/attributes/deactivate.md | 16 ----- docs/man/policy/attributes/get.md | 17 ----- docs/man/policy/attributes/list.md | 12 ---- .../policy/attributes/namespaces/create.md | 13 ---- .../attributes/namespaces/deactivate.md | 13 ---- docs/man/policy/attributes/namespaces/get.md | 13 ---- docs/man/policy/attributes/namespaces/list.md | 14 ---- .../attributes/namespaces/unsafe/delete.md | 12 ---- .../namespaces/unsafe/reactivate.md | 12 ---- .../attributes/namespaces/unsafe/update.md | 13 ---- .../policy/attributes/namespaces/update.md | 14 ---- docs/man/policy/attributes/unsafe/delete.md | 15 ---- .../policy/attributes/unsafe/reactivate.md | 13 ---- docs/man/policy/attributes/unsafe/update.md | 17 ----- docs/man/policy/attributes/update.md | 14 ---- docs/man/policy/attributes/values/create.md | 14 ---- .../policy/attributes/values/deactivate.md | 15 ---- docs/man/policy/attributes/values/get.md | 14 ---- docs/man/policy/attributes/values/list.md | 11 --- .../policy/attributes/values/unsafe/delete.md | 14 ---- .../attributes/values/unsafe/reactivate.md | 13 ---- .../policy/attributes/values/unsafe/update.md | 15 ---- docs/man/policy/attributes/values/update.md | 15 ---- docs/man/policy/kas-grants/assign.md | 36 ---------- docs/man/policy/kas-grants/list.md | 12 ---- docs/man/policy/kas-grants/unassign.md | 13 ---- docs/man/policy/kas-registry/create.md | 30 -------- docs/man/policy/kas-registry/delete.md | 11 --- docs/man/policy/kas-registry/get.md | 15 ---- docs/man/policy/kas-registry/list.md | 13 ---- docs/man/policy/kas-registry/update.md | 15 ---- docs/man/policy/resource-mappings/create.md | 15 ---- docs/man/policy/resource-mappings/delete.md | 13 ---- docs/man/policy/resource-mappings/get.md | 15 ---- docs/man/policy/resource-mappings/list.md | 12 ---- docs/man/policy/resource-mappings/update.md | 15 ---- .../policy/subject-condition-sets/create.md | 13 ---- .../policy/subject-condition-sets/delete.md | 13 ---- docs/man/policy/subject-condition-sets/get.md | 13 ---- .../man/policy/subject-condition-sets/list.md | 12 ---- .../policy/subject-condition-sets/prune.md | 13 ---- .../policy/subject-condition-sets/update.md | 13 ---- docs/man/policy/subject-mappings/create.md | 32 --------- docs/man/policy/subject-mappings/delete.md | 10 --- docs/man/policy/subject-mappings/get.md | 17 ----- docs/man/policy/subject-mappings/list.md | 13 ---- docs/man/policy/subject-mappings/update.md | 12 ---- 49 files changed, 781 deletions(-) diff --git a/docs/man/inspect/_index.md b/docs/man/inspect/_index.md index 543d9117..46a1ec73 100644 --- a/docs/man/inspect/_index.md +++ b/docs/man/inspect/_index.md @@ -15,74 +15,4 @@ This is useful for development and administration. ```shell $ otdfctl inspect example.tdf - -{ - "manifest": { - "algorithm": "HS256", - "keyAccessType": "split", - "mimeType": "", - "policy": "eyJ1dWlkIjoiOTk0OWJkYTItN2E4MC00NTcwLWJjMTYtMjAxYmM4ZDA3YTE2IiwiYm9keSI6eyJkYXRhQXR0cmlidXRlcyI6W10sImRpc3NlbSI6W119fQ==", - "protocol": "zip", - "segmentHashAlgorithm": "GMAC", - "signature": "MmEyZTIwYzgwYzIyMGNmMDMzNmQ0Y2U2MzU3Y2Q4YTRjYjFkYmNiNzQ0YzFhNjhlNjU0Y2MxNGM3MmMwYzNiZQ==", - "type": "reference", - "method": { - "algorithm": "AES-256-GCM", - "iv": "lUpBdhH8csdbqgAP", - "isStreamable": true - }, - "integrityInformation": { - "rootSignature": { - "alg": "HS256", - "sig": "MmEyZTIwYzgwYzIyMGNmMDMzNmQ0Y2U2MzU3Y2Q4YTRjYjFkYmNiNzQ0YzFhNjhlNjU0Y2MxNGM3MmMwYzNiZQ==" - }, - "segmentHashAlg": "GMAC", - "segmentSizeDefault": 1048576, - "encryptedSegmentSizeDefault": 1048604, - "segments": [ - { - "hash": "Y2RhNWYwMmFhNWE4M2EyYWY5Zjk2OTQ5NjU1MGQ4ODY=", - "segmentSize": 1618, - "encryptedSegmentSize": 1646 - } - ] - }, - "encryptionInformation": { - "type": "split", - "policy": "eyJ1dWlkIjoiOTk0OWJkYTItN2E4MC00NTcwLWJjMTYtMjAxYmM4ZDA3YTE2IiwiYm9keSI6eyJkYXRhQXR0cmlidXRlcyI6W10sImRpc3NlbSI6W119fQ==", - "keyAccess": [ - { - "type": "wrapped", - "url": "http://localhost:8080/kas", - "protocol": "kas", - "wrappedKey": "eEjzpg2XloommzdT6b9EVue6q1Lq/MRoZH9pU7EhcKpmt/+w6VHOUrTfk7rD05orQ2T2s2CjajrT6JNTbwQPXeoGCkKVp2xy2xceuNn8GFRJ5Gfz5rm1yI2vuOcn9xX4xbIHeLHQb7tUHyZnpeDMPc0y222VQfu/3Js1ycOBLE6lmgTgU3fXMYWSwXUIIdvWkrCW43eQxCPwZIO3HCOCo7mpWw/1gnzgJSldH/8vnlqeyeQDOvNq3+TDUwk74BV+0O72SAycaPISe/Vhh4SwSpUnRJdRN5mSngD9iuB/Dd9ChbhmNuwPW9KDzFocyz/SM5GsU3jhmjntMGNCMviR6g==", - "policyBinding": "ODViMjE5N2NiNWQzOWVmZDk0ZmU0OTMxMTM4MDNjNjNlMmZlNGQxYWE2NzIyYTQ3YmRhMTI1NGRhZTdkMmQ5NQ==", - "encryptedMetadata": "eyJjaXBoZXJ0ZXh0IjoibFVwQmRoSDhjc2RicWdBUGwxYkxtOW9kSHVReCtQclFxbUx3R3c9PSIsIml2IjoibFVwQmRoSDhjc2RicWdBUCJ9" - } - ], - "method": { - "algorithm": "AES-256-GCM", - "iv": "lUpBdhH8csdbqgAP", - "isStreamable": true - }, - "integrityInformation": { - "rootSignature": { - "alg": "HS256", - "sig": "MmEyZTIwYzgwYzIyMGNmMDMzNmQ0Y2U2MzU3Y2Q4YTRjYjFkYmNiNzQ0YzFhNjhlNjU0Y2MxNGM3MmMwYzNiZQ==" - }, - "segmentHashAlg": "GMAC", - "segmentSizeDefault": 1048576, - "encryptedSegmentSizeDefault": 1048604, - "segments": [ - { - "hash": "Y2RhNWYwMmFhNWE4M2EyYWY5Zjk2OTQ5NjU1MGQ4ODY=", - "segmentSize": 1618, - "encryptedSegmentSize": 1646 - } - ] - } - } - }, - "attributes": [] -} ``` diff --git a/docs/man/policy/attributes/create.md b/docs/man/policy/attributes/create.md index 255824f8..ea14d5cb 100644 --- a/docs/man/policy/attributes/create.md +++ b/docs/man/policy/attributes/create.md @@ -59,19 +59,3 @@ For more general information about attributes, see the `attributes` subcommand. ```shell otdfctl policy attributes create --namespace 3d25d33e-2469-4990-a9ed-fdd13ce74436 --name myattribute --rule ANY_OF ``` - -```shell - SUCCESS Created attributes: 3c51a593-cbf8-419d-b7dc-b656d0bedfbb - -╭─────────────────────────────────────────────────────────────────────────┬────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ -│Property │Value │ -├─────────────────────────────────────────────────────────────────────────┼────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ -│Name │myattribute │ -│Rule │ANY_OF │ -│Values │[] │ -│Namespace │opentdf.io │ -│Created At │Tue Dec 17 18:33:06 UTC 2024 │ -│Updated At │Tue Dec 17 18:33:06 UTC 2024 │ -╰─────────────────────────────────────────────────────────────────────────┴────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ - NOTE Use 'otdfctl policy attributes get --id=3c51a593-cbf8-419d-b7dc-b656d0bedfbb --json' to see all properties -``` diff --git a/docs/man/policy/attributes/deactivate.md b/docs/man/policy/attributes/deactivate.md index 34f03d04..3a35fb9f 100644 --- a/docs/man/policy/attributes/deactivate.md +++ b/docs/man/policy/attributes/deactivate.md @@ -25,19 +25,3 @@ For more general information about attributes, see the `attributes` subcommand. ```shell otdfctl policy attributes deactivate --id 3c51a593-cbf8-419d-b7dc-b656d0bedfbb ``` - -```shell - SUCCESS Deactivated attributes: 3c51a593-cbf8-419d-b7dc-b656d0bedfbb -╭─────────────────────────────────────────────────────────────────────────┬────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ -│Property │Value │ -├─────────────────────────────────────────────────────────────────────────┼────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ -│Name │myattribute │ -│Rule │ANY_OF │ -│Values │[myvalue1] │ -│Namespace │opentdf.io │ -│Created At │Tue Dec 17 18:33:06 UTC 2024 │ -│Updated At │Tue Dec 17 19:41:47 UTC 2024 │ -│Labels │[hello: world] │ -╰─────────────────────────────────────────────────────────────────────────┴────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ - NOTE Use 'otdfctl policy attributes list --json' to see all properties -``` diff --git a/docs/man/policy/attributes/get.md b/docs/man/policy/attributes/get.md index 72845749..ef463c6c 100644 --- a/docs/man/policy/attributes/get.md +++ b/docs/man/policy/attributes/get.md @@ -19,20 +19,3 @@ For more general information about attributes, see the `attributes` subcommand. ```shell otdfctl policy attributes get --id=3c51a593-cbf8-419d-b7dc-b656d0bedfbb ``` - -```shell - SUCCESS Found attributes: 3c51a593-cbf8-419d-b7dc-b656d0bedfbb - -╭─────────────────────────────────────────────────────────────────────────┬────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ -│Property │Value │ -├─────────────────────────────────────────────────────────────────────────┼────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ -│Id │3c51a593-cbf8-419d-b7dc-b656d0bedfbb │ -│Name │myattribute │ -│Rule │ANY_OF │ -│Values │[] │ -│Namespace │opentdf.io │ -│Created At │Tue Dec 17 18:33:06 UTC 2024 │ -│Updated At │Tue Dec 17 18:33:06 UTC 2024 │ -╰─────────────────────────────────────────────────────────────────────────┴────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ - NOTE Use 'otdfctl policy attributes get --id=3c51a593-cbf8-419d-b7dc-b656d0bedfbb --json' to see all properties -``` diff --git a/docs/man/policy/attributes/list.md b/docs/man/policy/attributes/list.md index 7c716e2f..8e3af71d 100644 --- a/docs/man/policy/attributes/list.md +++ b/docs/man/policy/attributes/list.md @@ -30,15 +30,3 @@ For more general information about attributes, see the `attributes` subcommand. ```shell otdfctl policy attributes list ``` - -```shell - SUCCESS Found attributes list -╭──────────────────────────────────────────────────┬────────────────────────────────────────┬──────────────────────────────┬────────────────────┬────────────────────┬────────────────────┬──────────┬──────────┬──────────╮ -│ID │Namespace │Name │Rule │Values │Active │Labels │Created At│Updated At│ -├──────────────────────────────────────────────────┼────────────────────────────────────────┼──────────────────────────────┼────────────────────┼────────────────────┼────────────────────┼──────────┼──────────┼──────────┤ -│3c51a593-cbf8-419d-b7dc-b656d0bedfbb │opentdf.io │myattribute │ANY_OF │[] │true │[] │Tue Dec 1…│Tue Dec 1…│ -│6a261d68-0899-4e17-bb2f-124abba7c09c │example.com │attr1 │ANY_OF │[value1, value2] │true │[] │Fri Nov …│Fri Nov …│ -│e1536f25-d287-43ed-9ad9-2cf4a7698e5f │example.com │attr2 │ALL_OF │[value2, value1] │true │[] │Fri Nov …│Fri Nov …│ -╰──────────────────────────────────────────────────┴────────────────────────────────────────┴──────────────────────────────┴────────────────────┴────────────────────┴────────────────────┴──────────┴──────────┴──────────╯ - NOTE Use 'otdfctl policy attributes get --id= --json' to see all properties -``` diff --git a/docs/man/policy/attributes/namespaces/create.md b/docs/man/policy/attributes/namespaces/create.md index cd8b5a9e..073d16dc 100644 --- a/docs/man/policy/attributes/namespaces/create.md +++ b/docs/man/policy/attributes/namespaces/create.md @@ -26,16 +26,3 @@ For more information, see the `namespaces` subcommand. ```shell otdfctl policy attributes namespaces create --name opentdf.io ``` - -```shell -SUCCESS Created namespaces: 7650f02a-be00-4faa-a1d1-37cded5e23dc -┌────────────────────────────────────────────────────────────────────────────┬─────────────────────────────────────────────────────────────────────────────────────────────────────┐ -│Property │Value │ -├────────────────────────────────────────────────────────────────────────────┼─────────────────────────────────────────────────────────────────────────────────────────────────────┤ -│Name │opentdf.io │ -│Id │7650f02a-be00-4faa-a1d1-37cded5e23dc │ -│Created At │Mon Jun 24 11:02:00 UTC 2024 │ -│Updated At │Mon Jun 24 11:02:00 UTC 2024 │ -└────────────────────────────────────────────────────────────────────────────┴─────────────────────────────────────────────────────────────────────────────────────────────────────┘ -NOTE Use 'namespaces get --id=7650f02a-be00-4faa-a1d1-37cded5e23dc --json' to see all properties -``` diff --git a/docs/man/policy/attributes/namespaces/deactivate.md b/docs/man/policy/attributes/namespaces/deactivate.md index 0944543b..a4ced922 100644 --- a/docs/man/policy/attributes/namespaces/deactivate.md +++ b/docs/man/policy/attributes/namespaces/deactivate.md @@ -27,16 +27,3 @@ For reactivation, see the `unsafe` command. ```shell otdfctl policy attributes namespaces deactivate --id 7650f02a-be00-4faa-a1d1-37cded5e23dc ``` - -```shell -SUCCESS Deactivated namespaces: 7650f02a-be00-4faa-a1d1-37cded5e23dc -┌────────────────────────────────────────────────────────────────────────────┬─────────────────────────────────────────────────────────────────────────────────────────────────────┐ -│Property │Value │ -├────────────────────────────────────────────────────────────────────────────┼─────────────────────────────────────────────────────────────────────────────────────────────────────┤ -│Name │opentdf.io │ -│Id │7650f02a-be00-4faa-a1d1-37cded5e23dc │ -│Created At │Mon Jun 24 11:02:00 UTC 2024 │ -│Updated At │Mon Jun 24 11:02:00 UTC 2024 │ -└────────────────────────────────────────────────────────────────────────────┴─────────────────────────────────────────────────────────────────────────────────────────────────────┘ -NOTE Use 'otdfctl policy attributes namespaces list --json' to see all properties -``` diff --git a/docs/man/policy/attributes/namespaces/get.md b/docs/man/policy/attributes/namespaces/get.md index c9105c30..0e746e01 100644 --- a/docs/man/policy/attributes/namespaces/get.md +++ b/docs/man/policy/attributes/namespaces/get.md @@ -16,17 +16,4 @@ For more information, see the `namespaces` subcommand. ```shell otdfctl policy attributes namespaces get --id=7650f02a-be00-4faa-a1d1-37cded5e23dc -``` - -```shell -SUCCESS Found namespaces: 7650f02a-be00-4faa-a1d1-37cded5e23dc -┌────────────────────────────────────────────────────────────────────────────┬─────────────────────────────────────────────────────────────────────────────────────────────────────┐ -│Property │Value │ -├────────────────────────────────────────────────────────────────────────────┼─────────────────────────────────────────────────────────────────────────────────────────────────────┤ -│Id │7650f02a-be00-4faa-a1d1-37cded5e23dc │ -│Name │opentdf.io │ -│Created At │Mon Jun 24 11:02:00 UTC 2024 │ -│Updated At │Mon Jun 24 11:02:00 UTC 2024 │ -└────────────────────────────────────────────────────────────────────────────┴─────────────────────────────────────────────────────────────────────────────────────────────────────┘ -NOTE Use 'namespaces get --id=7650f02a-be00-4faa-a1d1-37cded5e23dc --json' to see all properties ``` \ No newline at end of file diff --git a/docs/man/policy/attributes/namespaces/list.md b/docs/man/policy/attributes/namespaces/list.md index 55967209..c328d95a 100644 --- a/docs/man/policy/attributes/namespaces/list.md +++ b/docs/man/policy/attributes/namespaces/list.md @@ -24,17 +24,3 @@ For more general information, see the `namespaces` subcommand. ```shell otdfctl policy attributes namespaces list ``` - -```shell -SUCCESS Found namespaces list -╭───────────────────────────────────────────────────────────────────────┬─────────────────────────────────────────────────────────┬───────────────────────────────────────────┬──────────────┬──────────────┬──────────────╮ -│ID │Name │Active │Labels │Created At │Updated At │ -├───────────────────────────────────────────────────────────────────────┼─────────────────────────────────────────────────────────┼───────────────────────────────────────────┼──────────────┼──────────────┼──────────────┤ -│87ba60e1-da12-4889-95fd-267968bf0896 │scenario.com │true │[] │Fri Nov 1 14…│Fri Nov 1 14…│ -│8f1d8839-2851-4bf4-8bf4-5243dbfe517d │example.com │true │[] │Fri Nov 1 14…│Fri Nov 1 14…│ -│d69cf14d-744b-48cf-aab4-43756e97a8e5 │example.net │true │[] │Fri Nov 1 14…│Fri Nov 1 14…│ -│0d94e00a-7bd3-4482-afe3-f1e4b03c1353 │example.org │true │[] │Fri Nov 1 14…│Fri Nov 1 14…│ -│e3802200-7d16-45c4-be55-3f1a2e90adb1 │opentdf.io │true │[] │Tue Dec 17 16…│Tue Dec 17 16…│ -╰───────────────────────────────────────────────────────────────────────┴─────────────────────────────────────────────────────────┴───────────────────────────────────────────┴──────────────┴──────────────┴──────────────╯ - NOTE Use 'otdfctl policy attributes namespaces get --id= --json' to see all properties -``` diff --git a/docs/man/policy/attributes/namespaces/unsafe/delete.md b/docs/man/policy/attributes/namespaces/unsafe/delete.md index b1802ad0..e877ba77 100644 --- a/docs/man/policy/attributes/namespaces/unsafe/delete.md +++ b/docs/man/policy/attributes/namespaces/unsafe/delete.md @@ -24,15 +24,3 @@ For more general information, see the `namespaces` subcommand. ```shell otdfctl policy attributes namespaces unsafe delete --id 7650f02a-be00-4faa-a1d1-37cded5e23dc ``` - -```shell -SUCCESS Deleted unsafe: 7650f02a-be00-4faa-a1d1-37cded5e23dc -┌────────────────────────────────────────────────────────────────────────────┬─────────────────────────────────────────────────────────────────────────────────────────────────────┐ -│Property │Value │ -├────────────────────────────────────────────────────────────────────────────┼─────────────────────────────────────────────────────────────────────────────────────────────────────┤ -│Name │opentdf.io │ -│Id │7650f02a-be00-4faa-a1d1-37cded5e23dc │ -│Created At │Mon Jun 24 11:02:00 UTC 2024 │ -│Updated At │Mon Jun 24 11:02:00 UTC 2024 │ -└────────────────────────────────────────────────────────────────────────────┴─────────────────────────────────────────────────────────────────────────────────────────────────────┘ -``` diff --git a/docs/man/policy/attributes/namespaces/unsafe/reactivate.md b/docs/man/policy/attributes/namespaces/unsafe/reactivate.md index c365bd42..5e0ed742 100644 --- a/docs/man/policy/attributes/namespaces/unsafe/reactivate.md +++ b/docs/man/policy/attributes/namespaces/unsafe/reactivate.md @@ -24,15 +24,3 @@ For more general information, see the `namespaces` subcommand. ```shell otdfctl policy attributes namespaces unsafe reactivate --id 7650f02a-be00-4faa-a1d1-37cded5e23dc ``` - -```shell -SUCCESS -┌────────────────────────────────────────────────────────────────────────────┬─────────────────────────────────────────────────────────────────────────────────────────────────────┐ -│Property │Value │ -├────────────────────────────────────────────────────────────────────────────┼─────────────────────────────────────────────────────────────────────────────────────────────────────┤ -│Name │opentdf.io │ -│Id │7650f02a-be00-4faa-a1d1-37cded5e23dc │ -│Created At │Mon Jun 24 11:02:00 UTC 2024 │ -│Updated At │Mon Jun 24 11:02:00 UTC 2024 │ -└────────────────────────────────────────────────────────────────────────────┴─────────────────────────────────────────────────────────────────────────────────────────────────────┘ -``` diff --git a/docs/man/policy/attributes/namespaces/unsafe/update.md b/docs/man/policy/attributes/namespaces/unsafe/update.md index db6a1953..b536e91f 100644 --- a/docs/man/policy/attributes/namespaces/unsafe/update.md +++ b/docs/man/policy/attributes/namespaces/unsafe/update.md @@ -29,16 +29,3 @@ For more general information, see the `namespaces` subcommand. ```shell otdfctl policy attributes namespaces unsafe update --id=7650f02a-be00-4faa-a1d1-37cded5e23dc --name opentdf2.io ``` - -```shell -SUCCESS Unsafe updated namespaces: 7650f02a-be00-4faa-a1d1-37cded5e23dc -┌────────────────────────────────────────────────────────────────────────────┬─────────────────────────────────────────────────────────────────────────────────────────────────────┐ -│Property │Value │ -├────────────────────────────────────────────────────────────────────────────┼─────────────────────────────────────────────────────────────────────────────────────────────────────┤ -│Id │7650f02a-be00-4faa-a1d1-37cded5e23dc │ -│Name │opentdf2.io │ -│Created At │Mon Jun 24 11:02:00 UTC 2024 │ -│Updated At │Mon Jun 24 11:02:00 UTC 2024 │ -└────────────────────────────────────────────────────────────────────────────┴─────────────────────────────────────────────────────────────────────────────────────────────────────┘ -NOTE Use 'namespaces get --id=7650f02a-be00-4faa-a1d1-37cded5e23dc --json' to see all properties -``` diff --git a/docs/man/policy/attributes/namespaces/update.md b/docs/man/policy/attributes/namespaces/update.md index 0483d112..57390939 100644 --- a/docs/man/policy/attributes/namespaces/update.md +++ b/docs/man/policy/attributes/namespaces/update.md @@ -27,17 +27,3 @@ For unsafe updates, see the dedicated `unsafe update` command. For more general ```shell otdfctl policy attributes namespaces update --id=7650f02a-be00-4faa-a1d1-37cded5e23dc --label hello=world ``` - -```shell -SUCCESS Updated namespaces: 7650f02a-be00-4faa-a1d1-37cded5e23dc -┌────────────────────────────────────────────────────────────────────────────┬─────────────────────────────────────────────────────────────────────────────────────────────────────┐ -│Property │Value │ -├────────────────────────────────────────────────────────────────────────────┼─────────────────────────────────────────────────────────────────────────────────────────────────────┤ -│Id │7650f02a-be00-4faa-a1d1-37cded5e23dc │ -│Name │opentdf.io │ -│Created At │Mon Jun 24 11:02:00 UTC 2024 │ -│Updated At │Mon Jun 24 11:02:00 UTC 2024 │ -│Labels │[hello: world] │ -└────────────────────────────────────────────────────────────────────────────┴─────────────────────────────────────────────────────────────────────────────────────────────────────┘ -NOTE Use 'namespaces get --id=7650f02a-be00-4faa-a1d1-37cded5e23dc --json' to see all properties -``` diff --git a/docs/man/policy/attributes/unsafe/delete.md b/docs/man/policy/attributes/unsafe/delete.md index 804f2efe..4b6d0864 100644 --- a/docs/man/policy/attributes/unsafe/delete.md +++ b/docs/man/policy/attributes/unsafe/delete.md @@ -24,18 +24,3 @@ For more general information about attributes, see the `attributes` subcommand. ```shell otdfctl policy attributes unsafe delete --id 3c51a593-cbf8-419d-b7dc-b656d0bedfbb ``` - -```shell - SUCCESS Deleted unsafe: 3c51a593-cbf8-419d-b7dc-b656d0bedfbb -╭─────────────────────────────────────────────────────────────────────────┬────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ -│Property │Value │ -├─────────────────────────────────────────────────────────────────────────┼────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ -│Deleted │true │ -│Id │3c51a593-cbf8-419d-b7dc-b656d0bedfbb │ -│Name │myattribute │ -│Created At │Tue Dec 17 18:33:06 UTC 2024 │ -│Updated At │Tue Dec 17 19:46:00 UTC 2024 │ -│Labels │[hello: world] │ -╰─────────────────────────────────────────────────────────────────────────┴────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ - NOTE Use 'otdfctl policy attributes list --json' to see all properties -``` diff --git a/docs/man/policy/attributes/unsafe/reactivate.md b/docs/man/policy/attributes/unsafe/reactivate.md index f818465d..dad61f81 100644 --- a/docs/man/policy/attributes/unsafe/reactivate.md +++ b/docs/man/policy/attributes/unsafe/reactivate.md @@ -24,16 +24,3 @@ For more general information about attributes, see the `attributes` subcommand. ```shell otdfctl policy attributes unsafe reactivate --id 3c51a593-cbf8-419d-b7dc-b656d0bedfbb ``` - -```shell - SUCCESS -╭─────────────────────────────────────────────────────────────────────────┬────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ -│Property │Value │ -├─────────────────────────────────────────────────────────────────────────┼────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ -│Id │3c51a593-cbf8-419d-b7dc-b656d0bedfbb │ -│Name │myattribute │ -│Created At │Tue Dec 17 18:33:06 UTC 2024 │ -│Updated At │Tue Dec 17 19:41:47 UTC 2024 │ -│Labels │[hello: world] │ -╰─────────────────────────────────────────────────────────────────────────┴────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ -``` diff --git a/docs/man/policy/attributes/unsafe/update.md b/docs/man/policy/attributes/unsafe/update.md index 22d73545..e18cb192 100644 --- a/docs/man/policy/attributes/unsafe/update.md +++ b/docs/man/policy/attributes/unsafe/update.md @@ -54,20 +54,3 @@ For more general information about attributes, see the `attributes` subcommand. ```shell otdfctl policy attributes unsafe update --id 3c51a593-cbf8-419d-b7dc-b656d0bedfbb --name mynewname ``` - -```shell - SUCCESS Updated unsafe: 3c51a593-cbf8-419d-b7dc-b656d0bedfbb -╭─────────────────────────────────────────────────────────────────────────┬────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ -│Property │Value │ -├─────────────────────────────────────────────────────────────────────────┼────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ -│Id │3c51a593-cbf8-419d-b7dc-b656d0bedfbb │ -│Name │myattribute │ -│Rule │ANY_OF │ -│Values │[myvalue1] │ -│Value IDs │[355743c1-c0ef-4e8d-9790-d49d883dbc7d] │ -│Created At │Tue Dec 17 18:33:06 UTC 2024 │ -│Updated At │Tue Dec 17 19:42:39 UTC 2024 │ -│Labels │[hello: world] │ -╰─────────────────────────────────────────────────────────────────────────┴────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ - NOTE Use 'otdfctl policy attributes unsafe get --id=3c51a593-cbf8-419d-b7dc-b656d0bedfbb --json' to see all properties -``` diff --git a/docs/man/policy/attributes/update.md b/docs/man/policy/attributes/update.md index 40e4d288..f523cb7d 100644 --- a/docs/man/policy/attributes/update.md +++ b/docs/man/policy/attributes/update.md @@ -29,17 +29,3 @@ For more general information about attributes, see the `attributes` subcommand. ```shell otdfctl policy attributes update --id=3c51a593-cbf8-419d-b7dc-b656d0bedfbb --label hello=world ``` - -```shell - SUCCESS Updated attributes: 3c51a593-cbf8-419d-b7dc-b656d0bedfbb -╭─────────────────────────────────────────────────────────────────────────┬────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ -│Property │Value │ -├─────────────────────────────────────────────────────────────────────────┼────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ -│Id │3c51a593-cbf8-419d-b7dc-b656d0bedfbb │ -│Name │myattribute │ -│Created At │Tue Dec 17 18:33:06 UTC 2024 │ -│Updated At │Tue Dec 17 18:39:26 UTC 2024 │ -│Labels │[hello: world] │ -╰─────────────────────────────────────────────────────────────────────────┴────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ - NOTE Use 'otdfctl policy attributes get --id=3c51a593-cbf8-419d-b7dc-b656d0bedfbb --json' to see all properties -``` diff --git a/docs/man/policy/attributes/values/create.md b/docs/man/policy/attributes/values/create.md index 164285cd..b2b82cca 100644 --- a/docs/man/policy/attributes/values/create.md +++ b/docs/man/policy/attributes/values/create.md @@ -30,17 +30,3 @@ For more information on attribute values, see the `values` subcommand. ```shell otdfctl policy attributes values create --attribute-id 3c51a593-cbf8-419d-b7dc-b656d0bedfbb --value myvalue1 ``` - -```shell - SUCCESS Created values: 355743c1-c0ef-4e8d-9790-d49d883dbc7d -╭─────────────────────────────────────────────────────────────────────────┬────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ -│Property │Value │ -├─────────────────────────────────────────────────────────────────────────┼────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ -│Id │355743c1-c0ef-4e8d-9790-d49d883dbc7d │ -│FQN │https://opentdf.io/attr/myattribute/value/myvalue1 │ -│Value │myvalue1 │ -│Created At │Tue Dec 17 19:06:55 UTC 2024 │ -│Updated At │Tue Dec 17 19:06:55 UTC 2024 │ -╰─────────────────────────────────────────────────────────────────────────┴────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ - NOTE Use 'otdfctl policy attributes values get --id=355743c1-c0ef-4e8d-9790-d49d883dbc7d --json' to see all properties -``` diff --git a/docs/man/policy/attributes/values/deactivate.md b/docs/man/policy/attributes/values/deactivate.md index 08d158a9..c1cf895d 100644 --- a/docs/man/policy/attributes/values/deactivate.md +++ b/docs/man/policy/attributes/values/deactivate.md @@ -21,18 +21,3 @@ For more information on attribute values, see the `values` subcommand. ```shell otdfctl policy attributes values deactivate --id 355743c1-c0ef-4e8d-9790-d49d883dbc7d ``` - -```shell - SUCCESS Deactivated values: 355743c1-c0ef-4e8d-9790-d49d883dbc7d -╭─────────────────────────────────────────────────────────────────────────┬────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ -│Property │Value │ -├─────────────────────────────────────────────────────────────────────────┼────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ -│Id │355743c1-c0ef-4e8d-9790-d49d883dbc7d │ -│FQN │https://opentdf.io/attr/myattribute/value/myvalue1 │ -│Value │myvalue1 │ -│Created At │Tue Dec 17 19:06:55 UTC 2024 │ -│Updated At │Tue Dec 17 19:13:38 UTC 2024 │ -│Labels │[hello: world] │ -╰─────────────────────────────────────────────────────────────────────────┴────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ - NOTE Use 'otdfctl policy attributes values list --json' to see all properties -``` diff --git a/docs/man/policy/attributes/values/get.md b/docs/man/policy/attributes/values/get.md index 05283cc2..51f41c37 100644 --- a/docs/man/policy/attributes/values/get.md +++ b/docs/man/policy/attributes/values/get.md @@ -19,17 +19,3 @@ For more general information about attribute values, see the `values` subcommand ```shell otdfctl policy attributes values get --id 355743c1-c0ef-4e8d-9790-d49d883dbc7d ``` - -```shell - SUCCESS Found values: 355743c1-c0ef-4e8d-9790-d49d883dbc7d -╭─────────────────────────────────────────────────────────────────────────┬────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ -│Property │Value │ -├─────────────────────────────────────────────────────────────────────────┼────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ -│Id │355743c1-c0ef-4e8d-9790-d49d883dbc7d │ -│FQN │https://opentdf.io/attr/myattribute/value/myvalue1 │ -│Value │myvalue1 │ -│Created At │Tue Dec 17 19:06:55 UTC 2024 │ -│Updated At │Tue Dec 17 19:06:55 UTC 2024 │ -╰─────────────────────────────────────────────────────────────────────────┴────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ - NOTE Use 'otdfctl policy attributes values get --id=355743c1-c0ef-4e8d-9790-d49d883dbc7d --json' to see all properties -``` diff --git a/docs/man/policy/attributes/values/list.md b/docs/man/policy/attributes/values/list.md index aa57b66a..79415aa4 100644 --- a/docs/man/policy/attributes/values/list.md +++ b/docs/man/policy/attributes/values/list.md @@ -34,14 +34,3 @@ For more general information about attribute values, see the `values` subcommand ```shell otdfctl policy attributes values list --attribute-id 3c51a593-cbf8-419d-b7dc-b656d0bedfbb ``` - -```shell - SUCCESS Found values list -╭───────────────────────────────────────────────────────────────────────┬─────────────────────────────────────────────────────────┬───────────────────────────────────────────┬──────────────┬──────────────┬──────────────╮ -│ID │Fqn │Active │Labels │Created At │Updated At │ -├───────────────────────────────────────────────────────────────────────┼─────────────────────────────────────────────────────────┼───────────────────────────────────────────┼──────────────┼──────────────┼──────────────┤ -│355743c1-c0ef-4e8d-9790-d49d883dbc7d │https://opentdf.io/attr/myattribute/value/myvalue1 │true │[] │Tue Dec 17 19…│Tue Dec 17 19…│ -│b20458b0-1855-4608-8869-3f6199bc2878 │https://opentdf.io/attr/myattribute/value/myvalue2 │true │[] │Tue Dec 17 19…│Tue Dec 17 19…│ -╰───────────────────────────────────────────────────────────────────────┴─────────────────────────────────────────────────────────┴───────────────────────────────────────────┴──────────────┴──────────────┴──────────────╯ - NOTE Use 'otdfctl policy attributes values get --id= --json' to see all properties -``` diff --git a/docs/man/policy/attributes/values/unsafe/delete.md b/docs/man/policy/attributes/values/unsafe/delete.md index a7ac7b19..cc0a4841 100644 --- a/docs/man/policy/attributes/values/unsafe/delete.md +++ b/docs/man/policy/attributes/values/unsafe/delete.md @@ -24,17 +24,3 @@ For more information on attribute values, see the `values` subcommand. ```shell otdfctl policy attributes values unsafe delete --id b20458b0-1855-4608-8869-3f6199bc2878 ``` - -```shell - SUCCESS Deleted unsafe: b20458b0-1855-4608-8869-3f6199bc2878 -╭─────────────────────────────────────────────────────────────────────────┬────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ -│Property │Value │ -├─────────────────────────────────────────────────────────────────────────┼────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ -│Id │b20458b0-1855-4608-8869-3f6199bc2878 │ -│Value │myvalue2 │ -│Deleted │true │ -│Created At │Tue Dec 17 19:10:37 UTC 2024 │ -│Updated At │Tue Dec 17 19:10:37 UTC 2024 │ -╰─────────────────────────────────────────────────────────────────────────┴────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ - NOTE Use 'otdfctl policy attributes values list --json' to see all properties -``` diff --git a/docs/man/policy/attributes/values/unsafe/reactivate.md b/docs/man/policy/attributes/values/unsafe/reactivate.md index c6e91443..288aee87 100644 --- a/docs/man/policy/attributes/values/unsafe/reactivate.md +++ b/docs/man/policy/attributes/values/unsafe/reactivate.md @@ -24,16 +24,3 @@ For more information on attribute values, see the `values` subcommand. ```shell otdfctl policy attributes values unsafe reactivate --id 355743c1-c0ef-4e8d-9790-d49d883dbc7d ``` - -```shell - SUCCESS -╭─────────────────────────────────────────────────────────────────────────┬────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ -│Property │Value │ -├─────────────────────────────────────────────────────────────────────────┼────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ -│Id │355743c1-c0ef-4e8d-9790-d49d883dbc7d │ -│Value │myvalue1 │ -│Created At │Tue Dec 17 19:06:55 UTC 2024 │ -│Updated At │Tue Dec 17 19:13:38 UTC 2024 │ -│Labels │[hello: world] │ -╰─────────────────────────────────────────────────────────────────────────┴────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ -``` diff --git a/docs/man/policy/attributes/values/unsafe/update.md b/docs/man/policy/attributes/values/unsafe/update.md index 9e86021d..c7eba02b 100644 --- a/docs/man/policy/attributes/values/unsafe/update.md +++ b/docs/man/policy/attributes/values/unsafe/update.md @@ -30,18 +30,3 @@ For more information on attribute values, see the `values` subcommand. ```shell otdfctl policy attributes values unsafe update --id 355743c1-c0ef-4e8d-9790-d49d883dbc7d --name mynewvalue1 ``` - -```shell - SUCCESS Updated unsafe: 355743c1-c0ef-4e8d-9790-d49d883dbc7d - -╭─────────────────────────────────────────────────────────────────────────┬────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ -│Property │Value │ -├─────────────────────────────────────────────────────────────────────────┼────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ -│Id │355743c1-c0ef-4e8d-9790-d49d883dbc7d │ -│Value │mynewvalue1 │ -│Created At │Tue Dec 17 19:06:55 UTC 2024 │ -│Updated At │Tue Dec 17 19:14:53 UTC 2024 │ -│Labels │[hello: world] │ -╰─────────────────────────────────────────────────────────────────────────┴────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ - NOTE Use 'otdfctl policy attributes values unsafe get --id=355743c1-c0ef-4e8d-9790-d49d883dbc7d --json' to see all properties -``` diff --git a/docs/man/policy/attributes/values/update.md b/docs/man/policy/attributes/values/update.md index 224f9ca5..cc31ef71 100644 --- a/docs/man/policy/attributes/values/update.md +++ b/docs/man/policy/attributes/values/update.md @@ -29,18 +29,3 @@ For more general information about attributes, see the `attributes` subcommand. ```shell otdfctl policy attributes values update --id 355743c1-c0ef-4e8d-9790-d49d883dbc7d --label hello=world ``` - -```shell - SUCCESS Updated values: 355743c1-c0ef-4e8d-9790-d49d883dbc7d -╭─────────────────────────────────────────────────────────────────────────┬────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ -│Property │Value │ -├─────────────────────────────────────────────────────────────────────────┼────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ -│Id │355743c1-c0ef-4e8d-9790-d49d883dbc7d │ -│FQN │https://opentdf.io/attr/myattribute/value/myvalue1 │ -│Value │myvalue1 │ -│Created At │Tue Dec 17 19:06:55 UTC 2024 │ -│Updated At │Tue Dec 17 19:11:50 UTC 2024 │ -│Labels │[hello: world] │ -╰─────────────────────────────────────────────────────────────────────────┴────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ - NOTE Use 'otdfctl policy attributes values get --id=355743c1-c0ef-4e8d-9790-d49d883dbc7d --json' to see all properties -``` diff --git a/docs/man/policy/kas-grants/assign.md b/docs/man/policy/kas-grants/assign.md index ee769d6a..076fb048 100644 --- a/docs/man/policy/kas-grants/assign.md +++ b/docs/man/policy/kas-grants/assign.md @@ -47,48 +47,12 @@ Namespace grant: otdfctl policy kas-grants assign --namespace-id 3d25d33e-2469-4990-a9ed-fdd13ce74436 --kas-id 62857b55-560c-4b67-96e3-33e4670ecb3b ``` -```shell - SUCCESS -╭─────────────────────────────────────────────────────────────────────────┬────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ -│Property │Value │ -├─────────────────────────────────────────────────────────────────────────┼────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ -│Namespace ID │3d25d33e-2469-4990-a9ed-fdd13ce74436 │ -│KAS ID │62857b55-560c-4b67-96e3-33e4670ecb3b │ -│Granted KAS URI │http://example.com/kas │ -╰─────────────────────────────────────────────────────────────────────────┴────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ - -``` - Attribute grant: ```shell otdfctl policy kas-grants assign --attribute-id a21eb299-3a7d-4035-8a39-c8662c03cb15 --kas-id 62857b55-560c-4b67-96e3-33e4670ecb3b ``` -```shell - SUCCESS -╭─────────────────────────────────────────────────────────────────────────┬────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ -│Property │Value │ -├─────────────────────────────────────────────────────────────────────────┼────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ -│Attribute ID │a21eb299-3a7d-4035-8a39-c8662c03cb15 │ -│KAS ID │62857b55-560c-4b67-96e3-33e4670ecb3b │ -│Granted KAS URI │http://example.com/kas │ -╰─────────────────────────────────────────────────────────────────────────┴────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ - -``` - Attribute value grant: ```shell otdfctl policy kas-grants assign --value-id 0a40b27c-6cc9-49e8-a6ae-663cac2c324b --kas-id 62857b55-560c-4b67-96e3-33e4670ecb3b ``` - -```shell - SUCCESS -╭─────────────────────────────────────────────────────────────────────────┬────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ -│Property │Value │ -├─────────────────────────────────────────────────────────────────────────┼────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ -│Value ID │0a40b27c-6cc9-49e8-a6ae-663cac2c324b │ -│KAS ID │62857b55-560c-4b67-96e3-33e4670ecb3b │ -│Granted KAS URI │http://example.com/kas │ -╰─────────────────────────────────────────────────────────────────────────┴────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ - -``` diff --git a/docs/man/policy/kas-grants/list.md b/docs/man/policy/kas-grants/list.md index db912d7c..209b91e2 100644 --- a/docs/man/policy/kas-grants/list.md +++ b/docs/man/policy/kas-grants/list.md @@ -31,15 +31,3 @@ For more information, see `kas-registry` and `kas-grants` manuals. ```shell otdfctl policy kas-grants list ``` - -```shell - SUCCESS -╭─────────────────────────────────────────────────┬─────────────────────────────────────────────────┬─────────────────┬─────────────────────────────────────────────────┬──────────────────────────────────────────────────╮ -│KAS ID │KAS URI │Assigned To │Granted Object ID │Granted Object FQN │ -├─────────────────────────────────────────────────┼─────────────────────────────────────────────────┼─────────────────┼─────────────────────────────────────────────────┼──────────────────────────────────────────────────┤ -│62857b55-560c-4b67-96e3-33e4670ecb3b │http://example.com/kas │Definition │a21eb299-3a7d-4035-8a39-c8662c03cb15 │https://opentdf.io/attr/myattribute │ -│62857b55-560c-4b67-96e3-33e4670ecb3b │http://example.com/kas │Value │0a40b27c-6cc9-49e8-a6ae-663cac2c324b │https://opentdf.io/attr/myattribute/value/myvalue2│ -│62857b55-560c-4b67-96e3-33e4670ecb3b │http://example.com/kas │Namespace │3d25d33e-2469-4990-a9ed-fdd13ce74436 │https://opentdf.io │ -╰─────────────────────────────────────────────────┴─────────────────────────────────────────────────┴─────────────────┴─────────────────────────────────────────────────┴──────────────────────────────────────────────────╯ - -``` diff --git a/docs/man/policy/kas-grants/unassign.md b/docs/man/policy/kas-grants/unassign.md index 97b9f9f4..4028ec13 100644 --- a/docs/man/policy/kas-grants/unassign.md +++ b/docs/man/policy/kas-grants/unassign.md @@ -73,16 +73,3 @@ Attribute value grant: ```shell otdfctl policy kas-grants unassign --value-id 0a40b27c-6cc9-49e8-a6ae-663cac2c324b --kas-id 62857b55-560c-4b67-96e3-33e4670ecb3b ``` - -```shell - SUCCESS -╭─────────────────────────────────────────────────────────────────────────┬────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ -│Property │Value │ -├─────────────────────────────────────────────────────────────────────────┼────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ -│Value ID │0a40b27c-6cc9-49e8-a6ae-663cac2c324b │ -│Value FQN │https://opentdf.io/attr/myattribute/value/myvalue2 │ -│KAS ID │62857b55-560c-4b67-96e3-33e4670ecb3b │ -│Unassigned Granted KAS URI │http://example.com/kas │ -╰─────────────────────────────────────────────────────────────────────────┴────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ - -``` diff --git a/docs/man/policy/kas-registry/create.md b/docs/man/policy/kas-registry/create.md index 1bf1da2a..02d1735a 100644 --- a/docs/man/policy/kas-registry/create.md +++ b/docs/man/policy/kas-registry/create.md @@ -89,37 +89,7 @@ otdfctl policy kas-registry create --uri http://example.com/kas --name example-k }' ``` -```shell - SUCCESS Created kas-registry: 62857b55-560c-4b67-96e3-33e4670ecb3b -╭─────────────────────────────────────────────────────────────────────────┬────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ -│Property │Value │ -├─────────────────────────────────────────────────────────────────────────┼────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ -│Id │62857b55-560c-4b67-96e3-33e4670ecb3b │ -│URI │http://example.com/kas │ -│PublicKey │cached:{keys:{pem:"-----BEGIN CERTIFICATE-----\nMIIC/TCCAeWgAwIBAgIUSHTJ2bzAh7dQmmF03q6Iq/n0l90wDQYJKoZIhvcNAQEL\nBQAwDjEMMAoGA1UEAwwDa2FzMB4XD…│ -│Name │example-kas │ -│Created At │Wed Dec 18 04:51:22 UTC 2024 │ -│Updated At │Wed Dec 18 04:51:22 UTC 2024 │ -╰─────────────────────────────────────────────────────────────────────────┴────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ - NOTE Use 'otdfctl policy kas-registry get --id=62857b55-560c-4b67-96e3-33e4670ecb3b --json' to see all properties -``` - With a remote public key: ```shell otdfctl policy kas-registry create --uri http://example.com/kas2 --name example-kas2 --public-key-remote "https://example.com/kas2/public_key" ``` - -```shell - SUCCESS Created kas-registry: 3c39618a-cd8c-48cf-a60c-e8a2f4be4dd5 -╭─────────────────────────────────────────────────────────────────────────┬────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ -│Property │Value │ -├─────────────────────────────────────────────────────────────────────────┼────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ -│Id │3c39618a-cd8c-48cf-a60c-e8a2f4be4dd5 │ -│URI │http://example.com/kas2 │ -│PublicKey │remote:"https://example.com/kas2/public_key" │ -│Name │example-kas2 │ -│Created At │Wed Dec 18 04:57:51 UTC 2024 │ -│Updated At │Wed Dec 18 04:57:51 UTC 2024 │ -╰─────────────────────────────────────────────────────────────────────────┴────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ - NOTE Use 'otdfctl policy kas-registry get --id=3c39618a-cd8c-48cf-a60c-e8a2f4be4dd5 --json' to see all properties -``` diff --git a/docs/man/policy/kas-registry/delete.md b/docs/man/policy/kas-registry/delete.md index 42b39dfb..d30439c2 100644 --- a/docs/man/policy/kas-registry/delete.md +++ b/docs/man/policy/kas-registry/delete.md @@ -26,14 +26,3 @@ For more information about registration of Key Access Servers, see the manual fo ```shell otdfctl policy kas-registry delete --id 3c39618a-cd8c-48cf-a60c-e8a2f4be4dd5 ``` - -```shell - SUCCESS Deleted kas-registry: 3c39618a-cd8c-48cf-a60c-e8a2f4be4dd5 -╭─────────────────────────────────────────────────────────────────────────┬────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ -│Property │Value │ -├─────────────────────────────────────────────────────────────────────────┼────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ -│Id │3c39618a-cd8c-48cf-a60c-e8a2f4be4dd5 │ -│URI │http://example.com/kas2 │ -╰─────────────────────────────────────────────────────────────────────────┴────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ - NOTE Use 'otdfctl policy kas-registry list --json' to see all properties -``` diff --git a/docs/man/policy/kas-registry/get.md b/docs/man/policy/kas-registry/get.md index 6e9020fc..19968e84 100644 --- a/docs/man/policy/kas-registry/get.md +++ b/docs/man/policy/kas-registry/get.md @@ -18,18 +18,3 @@ For more information about registration of Key Access Servers, see the manual fo ```shell otdfctl policy kas-registry get --id=62857b55-560c-4b67-96e3-33e4670ecb3b ``` - -```shell - SUCCESS Found kas-registry: 62857b55-560c-4b67-96e3-33e4670ecb3b -╭─────────────────────────────────────────────────────────────────────────┬────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ -│Property │Value │ -├─────────────────────────────────────────────────────────────────────────┼────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ -│Id │62857b55-560c-4b67-96e3-33e4670ecb3b │ -│URI │http://example.com/kas │ -│PublicKey │cached:{keys:{pem:"-----BEGIN CERTIFICATE-----\nMIIC/TCCAeWgAwIBAgIUSHTJ2bzAh7dQmmF03q6Iq/n0l90wDQYJKoZIhvcNAQEL\nBQAwDjEMMAoGA1UEAwwDa2FzMB4XD…│ -│Name │example-kas │ -│Created At │Wed Dec 18 04:51:22 UTC 2024 │ -│Updated At │Wed Dec 18 04:51:22 UTC 2024 │ -╰─────────────────────────────────────────────────────────────────────────┴────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ - NOTE Use 'otdfctl policy kas-registry get --id=62857b55-560c-4b67-96e3-33e4670ecb3b --json' to see all properties -``` diff --git a/docs/man/policy/kas-registry/list.md b/docs/man/policy/kas-registry/list.md index 0ca8dc25..6eb8581b 100644 --- a/docs/man/policy/kas-registry/list.md +++ b/docs/man/policy/kas-registry/list.md @@ -20,16 +20,3 @@ For more information about registration of Key Access Servers, see the manual fo ```shell otdfctl policy kas-registry list ``` - -```shell - SUCCESS Found kas-registry list - -╭──────────────────────────────────────────────────────────────────┬─────────────────────────────────────────────────────┬────────────────────────────────────────┬────────────────────────────────────────────────────────╮ -│ID │URI │Name │PublicKey │ -├──────────────────────────────────────────────────────────────────┼─────────────────────────────────────────────────────┼────────────────────────────────────────┼────────────────────────────────────────────────────────┤ -│f612b628-5459-4342-b20f-3768b30ad588 │http://localhost:8080/kas │alpha │cached:{keys:{pem:"-----BEGIN PUBLIC KEY-----\\nMIIBIjA…│ -│62857b55-560c-4b67-96e3-33e4670ecb3b │http://example.com/kas │example-kas │cached:{keys:{pem:"-----BEGIN CERTIFICATE-----\nMIIC/TC…│ -│3c39618a-cd8c-48cf-a60c-e8a2f4be4dd5 │http://example.com/kas2 │example-kas2 │remote:"https://example.com/kas2/public_key" │ -╰──────────────────────────────────────────────────────────────────┴─────────────────────────────────────────────────────┴────────────────────────────────────────┴────────────────────────────────────────────────────────╯ - NOTE Use 'otdfctl policy kas-registry get --id= --json' to see all properties -``` diff --git a/docs/man/policy/kas-registry/update.md b/docs/man/policy/kas-registry/update.md index 1213e18e..cfe5198c 100644 --- a/docs/man/policy/kas-registry/update.md +++ b/docs/man/policy/kas-registry/update.md @@ -45,18 +45,3 @@ For more information about registration of Key Access Servers, see the manual fo ```shell otdfctl policy kas-registry update --id 3c39618a-cd8c-48cf-a60c-e8a2f4be4dd5 --name example-kas2-newname --public-key-remote "https://example.com/kas2/new_public_key" ``` - -```shell - SUCCESS Updated kas-registry: 3c39618a-cd8c-48cf-a60c-e8a2f4be4dd5 -╭─────────────────────────────────────────────────────────────────────────┬────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ -│Property │Value │ -├─────────────────────────────────────────────────────────────────────────┼────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ -│Id │3c39618a-cd8c-48cf-a60c-e8a2f4be4dd5 │ -│URI │http://example.com/kas2 │ -│PublicKey │remote:"https://example.com/kas2/new_public_key" │ -│Name │example-kas2-newname │ -│Created At │Wed Dec 18 04:57:51 UTC 2024 │ -│Updated At │Wed Dec 18 05:03:51 UTC 2024 │ -╰─────────────────────────────────────────────────────────────────────────┴────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ - NOTE Use 'otdfctl policy kas-registry get --id=3c39618a-cd8c-48cf-a60c-e8a2f4be4dd5 --json' to see all properties -``` diff --git a/docs/man/policy/resource-mappings/create.md b/docs/man/policy/resource-mappings/create.md index b14f6b96..fdf427cc 100644 --- a/docs/man/policy/resource-mappings/create.md +++ b/docs/man/policy/resource-mappings/create.md @@ -28,18 +28,3 @@ For more information about resource mappings, see the `resource-mappings` subcom ```shell otdfctl policy resource-mappings create --attribute-value-id 891cfe85-b381-4f85-9699-5f7dbfe2a9ab --terms term1,term2 ``` - -```shell - SUCCESS Created resource-mappings: 3ff446fb-8fb1-4c04-8023-47592c90370c -╭─────────────────────────────────────────────────────────────────────────┬────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ -│Property │Value │ -├─────────────────────────────────────────────────────────────────────────┼────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ -│Id │3ff446fb-8fb1-4c04-8023-47592c90370c │ -│Attribute Value Id │891cfe85-b381-4f85-9699-5f7dbfe2a9ab │ -│Attribute Value │myvalue1 │ -│Terms │term1, term2 │ -│Created At │Wed Dec 18 05:53:53 UTC 2024 │ -│Updated At │Wed Dec 18 05:53:53 UTC 2024 │ -╰─────────────────────────────────────────────────────────────────────────┴────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ - NOTE Use 'otdfctl policy resource-mappings get --id=3ff446fb-8fb1-4c04-8023-47592c90370c --json' to see all properties -``` diff --git a/docs/man/policy/resource-mappings/delete.md b/docs/man/policy/resource-mappings/delete.md index c8c3b91e..3640325b 100644 --- a/docs/man/policy/resource-mappings/delete.md +++ b/docs/man/policy/resource-mappings/delete.md @@ -17,16 +17,3 @@ For more information about resource mappings, see the `resource-mappings` subcom ```shell otdfctl policy resource-mappings delete --id=3ff446fb-8fb1-4c04-8023-47592c90370c ``` - -```shell - SUCCESS Deleted resource-mappings: 3ff446fb-8fb1-4c04-8023-47592c90370c -╭─────────────────────────────────────────────────────────────────────────┬────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ -│Property │Value │ -├─────────────────────────────────────────────────────────────────────────┼────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ -│Id │3ff446fb-8fb1-4c04-8023-47592c90370c │ -│Attribute Value Id │ │ -│Attribute Value │ │ -│Terms │ │ -╰─────────────────────────────────────────────────────────────────────────┴────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ - NOTE Use 'otdfctl policy resource-mappings list --json' to see all properties -``` diff --git a/docs/man/policy/resource-mappings/get.md b/docs/man/policy/resource-mappings/get.md index 682c1898..abc4a0fb 100644 --- a/docs/man/policy/resource-mappings/get.md +++ b/docs/man/policy/resource-mappings/get.md @@ -17,18 +17,3 @@ For more information about resource mappings, see the `resource-mappings` subcom ```shell otdfctl policy resource-mappings get --id=3ff446fb-8fb1-4c04-8023-47592c90370c ``` - -```shell - SUCCESS Found resource-mappings: 3ff446fb-8fb1-4c04-8023-47592c90370c -╭─────────────────────────────────────────────────────────────────────────┬────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ -│Property │Value │ -├─────────────────────────────────────────────────────────────────────────┼────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ -│Id │3ff446fb-8fb1-4c04-8023-47592c90370c │ -│Attribute Value Id │891cfe85-b381-4f85-9699-5f7dbfe2a9ab │ -│Attribute Value │myvalue1 │ -│Terms │term1, term2 │ -│Created At │Wed Dec 18 05:53:53 UTC 2024 │ -│Updated At │Wed Dec 18 05:53:53 UTC 2024 │ -╰─────────────────────────────────────────────────────────────────────────┴────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ - NOTE Use 'otdfctl policy resource-mappings get --id=3ff446fb-8fb1-4c04-8023-47592c90370c --json' to see all properties -``` diff --git a/docs/man/policy/resource-mappings/list.md b/docs/man/policy/resource-mappings/list.md index 926f41db..402865ba 100644 --- a/docs/man/policy/resource-mappings/list.md +++ b/docs/man/policy/resource-mappings/list.md @@ -20,15 +20,3 @@ For more information about resource mappings, see the `resource-mappings` subcom ```shell otdfctl policy resource-mappings get --id=3ff446fb-8fb1-4c04-8023-47592c90370c ``` - -```shell - SUCCESS Found resource-mappings list - -╭────────────────────────────────────────────────────────┬─────────────────────────────────────────────┬─────────────────────────────────────────────┬─────────────────────────────────┬───────────┬───────────┬───────────╮ -│ID │Attribute Value Id │Attribute Value │Terms │Labels │Created At │Updated At │ -├────────────────────────────────────────────────────────┼─────────────────────────────────────────────┼─────────────────────────────────────────────┼─────────────────────────────────┼───────────┼───────────┼───────────┤ -│3ff446fb-8fb1-4c04-8023-47592c90370c │891cfe85-b381-4f85-9699-5f7dbfe2a9ab │myvalue1 │term1, term2 │[] │Wed Dec 18…│Wed Dec 18…│ -│02092d67-fffa-4030-9775-b5cd5d581e1f │74babca6-016f-4f3e-a99b-4e46ea8d0fd8 │myvalue2 │term2, term4 │[] │Fri Nov 1…│Fri Nov 1…│ -╰────────────────────────────────────────────────────────┴─────────────────────────────────────────────┴─────────────────────────────────────────────┴─────────────────────────────────┴───────────┴───────────┴───────────╯ - NOTE Use 'otdfctl policy resource-mappings get --id= --json' to see all properties -``` diff --git a/docs/man/policy/resource-mappings/update.md b/docs/man/policy/resource-mappings/update.md index f44e64ab..0346e49f 100644 --- a/docs/man/policy/resource-mappings/update.md +++ b/docs/man/policy/resource-mappings/update.md @@ -32,18 +32,3 @@ For more information about resource mappings, see the `resource-mappings` subcom ```shell otdfctl policy resource-mappings update --id=3ff446fb-8fb1-4c04-8023-47592c90370c --terms newterm1,newterm2 ``` - -```shell - SUCCESS Updated resource-mappings: 3ff446fb-8fb1-4c04-8023-47592c90370c -╭─────────────────────────────────────────────────────────────────────────┬────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ -│Property │Value │ -├─────────────────────────────────────────────────────────────────────────┼────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ -│Id │3ff446fb-8fb1-4c04-8023-47592c90370c │ -│Attribute Value Id │891cfe85-b381-4f85-9699-5f7dbfe2a9ab │ -│Attribute Value │myvalue1 │ -│Terms │newterm1, newterm2 │ -│Created At │Wed Dec 18 05:53:53 UTC 2024 │ -│Updated At │Wed Dec 18 05:58:11 UTC 2024 │ -╰─────────────────────────────────────────────────────────────────────────┴────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ - NOTE Use 'otdfctl policy resource-mappings get --id=3ff446fb-8fb1-4c04-8023-47592c90370c --json' to see all properties -``` diff --git a/docs/man/policy/subject-condition-sets/create.md b/docs/man/policy/subject-condition-sets/create.md index 73c5f1de..5d3dad7f 100644 --- a/docs/man/policy/subject-condition-sets/create.md +++ b/docs/man/policy/subject-condition-sets/create.md @@ -140,16 +140,3 @@ You can perform the same action with the input contained in a file: ```shell otdfctl policy subject-condition-set create --subject-sets-file-json scs.json ``` - -```shell - SUCCESS Created subject-condition-sets: bfade235-509a-4a6f-886a-812005c01db5 -╭─────────────────────────────────────────────────────────────────────────┬────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ -│Property │Value │ -├─────────────────────────────────────────────────────────────────────────┼────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ -│Id │bfade235-509a-4a6f-886a-812005c01db5 │ -│SubjectSets │[{"conditionGroups":[{"conditions":[{"subjectExternalSelectorValue":".example.field.one","operator":"SUBJECT_MAPPING_OPERATOR_ENUM_IN","subject…│ -│Created At │Wed Dec 18 06:44:39 UTC 2024 │ -│Updated At │Wed Dec 18 06:44:39 UTC 2024 │ -╰─────────────────────────────────────────────────────────────────────────┴────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ - NOTE Use 'otdfctl policy subject-condition-sets get --id=bfade235-509a-4a6f-886a-812005c01db5 --json' to see all properties -``` diff --git a/docs/man/policy/subject-condition-sets/delete.md b/docs/man/policy/subject-condition-sets/delete.md index 7fcf0cff..3f269b93 100644 --- a/docs/man/policy/subject-condition-sets/delete.md +++ b/docs/man/policy/subject-condition-sets/delete.md @@ -19,16 +19,3 @@ For more information about subject condition sets, see the `subject-condition-se ```shell otdfctl policy subject-condition-sets delete --id=bfade235-509a-4a6f-886a-812005c01db5 ``` - -```shell - SUCCESS Deleted subject-condition-sets: bfade235-509a-4a6f-886a-812005c01db5 -╭─────────────────────────────────────────────────────────────────────────┬────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ -│Property │Value │ -├─────────────────────────────────────────────────────────────────────────┼────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ -│Id │bfade235-509a-4a6f-886a-812005c01db5 │ -│SubjectSets │[{"conditionGroups":[{"conditions":[{"subjectExternalSelectorValue":".example.field.one","operator":"SUBJECT_MAPPING_OPERATOR_ENUM_IN","subject…│ -│Created At │Wed Dec 18 06:44:39 UTC 2024 │ -│Updated At │Wed Dec 18 06:54:28 UTC 2024 │ -╰─────────────────────────────────────────────────────────────────────────┴────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ - NOTE Use 'otdfctl policy subject-condition-sets list --json' to see all properties -``` diff --git a/docs/man/policy/subject-condition-sets/get.md b/docs/man/policy/subject-condition-sets/get.md index 569246a6..fefb2842 100644 --- a/docs/man/policy/subject-condition-sets/get.md +++ b/docs/man/policy/subject-condition-sets/get.md @@ -19,16 +19,3 @@ For more information about subject condition sets, see the `subject-condition-se ```shell otdfctl policy subject-condition-sets get --id=bfade235-509a-4a6f-886a-812005c01db5 ``` - -```shell - SUCCESS Found subject-condition-sets: bfade235-509a-4a6f-886a-812005c01db5 -╭─────────────────────────────────────────────────────────────────────────┬────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ -│Property │Value │ -├─────────────────────────────────────────────────────────────────────────┼────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ -│Id │bfade235-509a-4a6f-886a-812005c01db5 │ -│SubjectSets │[{"conditionGroups":[{"conditions":[{"subjectExternalSelectorValue":".example.field.one","operator":"SUBJECT_MAPPING_OPERATOR_ENUM_IN","subject…│ -│Created At │Wed Dec 18 06:44:39 UTC 2024 │ -│Updated At │Wed Dec 18 06:44:39 UTC 2024 │ -╰─────────────────────────────────────────────────────────────────────────┴────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ - NOTE Use 'otdfctl policy subject-condition-sets get --id=bfade235-509a-4a6f-886a-812005c01db5 --json' to see all properties -``` diff --git a/docs/man/policy/subject-condition-sets/list.md b/docs/man/policy/subject-condition-sets/list.md index 1af90fe3..928ea730 100644 --- a/docs/man/policy/subject-condition-sets/list.md +++ b/docs/man/policy/subject-condition-sets/list.md @@ -21,15 +21,3 @@ For more information about subject condition sets, see the `subject-condition-se ```shell otdfctl policy subject-condition-set list ``` - -```shell - SUCCESS Found subject-condition-sets list - -╭──────────────────────────────────────────────────────────────────────────────────────┬─────────────────────────────────────────────────────────────────────┬──────────────────┬──────────────────┬───────────────────────╮ -│ID │SubjectSets │Labels │Created At │Updated At │ -├──────────────────────────────────────────────────────────────────────────────────────┼─────────────────────────────────────────────────────────────────────┼──────────────────┼──────────────────┼───────────────────────┤ -│8b80eb7c-cecb-44d4-91a7-f14ada74d4ce │[{"conditionGroups":[{"conditions":[{"subjectExternalSelectorValue":…│[] │Mon Dec 16 16:00:…│Mon Dec 16 16:00:33 UT…│ -│bfade235-509a-4a6f-886a-812005c01db5 │[{"conditionGroups":[{"conditions":[{"subjectExternalSelectorValue":…│[] │Wed Dec 18 06:44:…│Wed Dec 18 06:44:39 UT…│ -╰──────────────────────────────────────────────────────────────────────────────────────┴─────────────────────────────────────────────────────────────────────┴──────────────────┴──────────────────┴───────────────────────╯ - NOTE Use 'otdfctl policy subject-condition-sets get --id= --json' to see all properties -``` diff --git a/docs/man/policy/subject-condition-sets/prune.md b/docs/man/policy/subject-condition-sets/prune.md index 13cae24b..45806e7b 100644 --- a/docs/man/policy/subject-condition-sets/prune.md +++ b/docs/man/policy/subject-condition-sets/prune.md @@ -17,16 +17,3 @@ For more information about subject condition sets, see the `subject-condition-se ```shell otdfctl policy subject-condition-set prune ``` - -```shell - SUCCESS -╭──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ -│ID │ -├──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ -│5ecb1088-9c66-4fad-aa50-1d79fc84a344 │ -│c3167e9e-1987-4200-a45b-35127d86785c │ -│66fe121a-0d14-48d0-aa33-59a5b1934fc6 │ -│524401e1-0ed0-4f70-924f-8978174e224b │ │ -╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ - -``` diff --git a/docs/man/policy/subject-condition-sets/update.md b/docs/man/policy/subject-condition-sets/update.md index 155212c5..f82783f6 100644 --- a/docs/man/policy/subject-condition-sets/update.md +++ b/docs/man/policy/subject-condition-sets/update.md @@ -59,16 +59,3 @@ otdfctl policy subject-condition-set update --id bfade235-509a-4a6f-886a-812005c } ]' ``` - -```shell - SUCCESS Updated subject-condition-sets: bfade235-509a-4a6f-886a-812005c01db5 -╭─────────────────────────────────────────────────────────────────────────┬────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ -│Property │Value │ -├─────────────────────────────────────────────────────────────────────────┼────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ -│Id │bfade235-509a-4a6f-886a-812005c01db5 │ -│SubjectSets │[{"conditionGroups":[{"conditions":[{"subjectExternalSelectorValue":".example.field.one","operator":"SUBJECT_MAPPING_OPERATOR_ENUM_IN","subject…│ -│Created At │Wed Dec 18 06:44:39 UTC 2024 │ -│Updated At │Wed Dec 18 06:54:28 UTC 2024 │ -╰─────────────────────────────────────────────────────────────────────────┴────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ - NOTE Use 'otdfctl policy subject-condition-sets get --id=bfade235-509a-4a6f-886a-812005c01db5 --json' to see all properties -``` diff --git a/docs/man/policy/subject-mappings/create.md b/docs/man/policy/subject-mappings/create.md index e6a6b026..537631fa 100644 --- a/docs/man/policy/subject-mappings/create.md +++ b/docs/man/policy/subject-mappings/create.md @@ -54,22 +54,6 @@ Create a subject mapping linking to an existing subject condition set: otdfctl policy subject-mapping create --attribute-value-id 891cfe85-b381-4f85-9699-5f7dbfe2a9ab --action-standard DECRYPT --subject-condition-set-id 8dc98f65-5f0a-4444-bfd1-6a818dc7b447 ``` -```shell - SUCCESS Created subject-mappings: 39866dd2-368b-41f6-b292-b4b68c01888b -╭─────────────────────────────────────────────────────────────────────────┬────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ -│Property │Value │ -├─────────────────────────────────────────────────────────────────────────┼────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ -│Id │39866dd2-368b-41f6-b292-b4b68c01888b │ -│Attribute Value Id │891cfe85-b381-4f85-9699-5f7dbfe2a9ab │ -│Actions │[{"Value":{"Standard":1}}] │ -│Subject Condition Set: Id │8dc98f65-5f0a-4444-bfd1-6a818dc7b447 │ -│Subject Condition Set │[{"condition_groups":[{"conditions":[{"subject_external_selector_value":".example.field.one","operator":1,"subject_external_values":["myvalue",…│ -│Created At │Wed Dec 18 15:40:50 UTC 2024 │ -│Updated At │Wed Dec 18 15:40:50 UTC 2024 │ -╰─────────────────────────────────────────────────────────────────────────┴────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ - NOTE Use 'otdfctl policy subject-mappings get --id=39866dd2-368b-41f6-b292-b4b68c01888b --json' to see all properties -``` - Or you can create a mapping that linked to a new subject condition set: ```shell otdfctl policy subject-mapping create --attribute-value-id 891cfe85-b381-4f85-9699-5f7dbfe2a9ab --action-standard DECRYPT --subject-condition-set-new '[ @@ -94,19 +78,3 @@ otdfctl policy subject-mapping create --attribute-value-id 891cfe85-b381-4f85-96 } ]' ``` - -```shell - SUCCESS Created subject-mappings: d71c4028-ce64-453b-8aa7-6edb45fbb848 -╭─────────────────────────────────────────────────────────────────────────┬────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ -│Property │Value │ -├─────────────────────────────────────────────────────────────────────────┼────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ -│Id │d71c4028-ce64-453b-8aa7-6edb45fbb848 │ -│Attribute Value Id │891cfe85-b381-4f85-9699-5f7dbfe2a9ab │ -│Actions │[{"Value":{"Standard":1}}] │ -│Subject Condition Set: Id │738736ee-880d-40da-acae-672d1deff00f │ -│Subject Condition Set │[{"condition_groups":[{"conditions":[{"subject_external_selector_value":".example.field.one","operator":1,"subject_external_values":["myvalue",…│ -│Created At │Wed Dec 18 15:41:55 UTC 2024 │ -│Updated At │Wed Dec 18 15:41:55 UTC 2024 │ -╰─────────────────────────────────────────────────────────────────────────┴────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ - NOTE Use 'otdfctl policy subject-mappings get --id=d71c4028-ce64-453b-8aa7-6edb45fbb848 --json' to see all properties -``` diff --git a/docs/man/policy/subject-mappings/delete.md b/docs/man/policy/subject-mappings/delete.md index 725f6199..1a00549d 100644 --- a/docs/man/policy/subject-mappings/delete.md +++ b/docs/man/policy/subject-mappings/delete.md @@ -23,13 +23,3 @@ For more information about subject condition sets, see the `subject-condition-se ```shell otdfctl policy subject-mappings delete --id d71c4028-ce64-453b-8aa7-6edb45fbb848 ``` - -```shell - SUCCESS Deleted subject-mappings: d71c4028-ce64-453b-8aa7-6edb45fbb848 -╭─────────────────────────────────────────────────────────────────────────┬────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ -│Property │Value │ -├─────────────────────────────────────────────────────────────────────────┼────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ -│Id │d71c4028-ce64-453b-8aa7-6edb45fbb848 │ -╰─────────────────────────────────────────────────────────────────────────┴────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ - NOTE Use 'otdfctl policy subject-mappings list --json' to see all properties -``` diff --git a/docs/man/policy/subject-mappings/get.md b/docs/man/policy/subject-mappings/get.md index 371a1c5f..bc52c6f2 100644 --- a/docs/man/policy/subject-mappings/get.md +++ b/docs/man/policy/subject-mappings/get.md @@ -19,20 +19,3 @@ For more information about subject mappings, see the `subject-mappings` subcomma ```shell otdfctl policy subject-mappings get --id 39866dd2-368b-41f6-b292-b4b68c01888b ``` - -```shell - SUCCESS Found subject-mappings: 39866dd2-368b-41f6-b292-b4b68c01888b -╭─────────────────────────────────────────────────────────────────────────┬────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ -│Property │Value │ -├─────────────────────────────────────────────────────────────────────────┼────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ -│Id │39866dd2-368b-41f6-b292-b4b68c01888b │ -│Attribute Value: Id │891cfe85-b381-4f85-9699-5f7dbfe2a9ab │ -│Attribute Value: Value │myvalue1 │ -│Actions │[{"Value":{"Standard":1}}] │ -│Subject Condition Set: Id │8dc98f65-5f0a-4444-bfd1-6a818dc7b447 │ -│Subject Condition Set │[{"condition_groups":[{"conditions":[{"subject_external_selector_value":".example.field.one","operator":1,"subject_external_values":["myvalue",…│ -│Created At │Wed Dec 18 15:40:50 UTC 2024 │ -│Updated At │Wed Dec 18 15:40:50 UTC 2024 │ -╰─────────────────────────────────────────────────────────────────────────┴────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ - NOTE Use 'otdfctl policy subject-mappings get --id=39866dd2-368b-41f6-b292-b4b68c01888b --json' to see all properties -``` diff --git a/docs/man/policy/subject-mappings/list.md b/docs/man/policy/subject-mappings/list.md index 5ee31e9a..4db94592 100644 --- a/docs/man/policy/subject-mappings/list.md +++ b/docs/man/policy/subject-mappings/list.md @@ -20,16 +20,3 @@ For more information about subject mappings, see the `subject-mappings` subcomma ```shell otdfctl policy subject-mappings list ``` - -```shell - SUCCESS Found subject-mappings list -╭─────────────────────────────────────────┬─────────────────────────────────┬─────────────────────────┬─────────────────┬─────────────────────────────────┬─────────────────────────┬─────────┬─────────┬──────────────────╮ -│ID │Subject AttrVal: Id │Subject AttrVal: Value │Actions │Subject Condition Set: Id │Subject Condition Set │Labels │Created …│Updated At │ -├─────────────────────────────────────────┼─────────────────────────────────┼─────────────────────────┼─────────────────┼─────────────────────────────────┼─────────────────────────┼─────────┼─────────┼──────────────────┤ -│d71c4028-ce64-453b-8aa7-6edb45fbb848 │891cfe85-b381-4f85-9699-5f7dbfe2…│myvalue1 │[{"Value":{"Stan…│738736ee-880d-40da-acae-672d1def…│[{"condition_groups":[{"…│[] │Wed Dec …│Wed Dec 18 15:41:…│ -│39866dd2-368b-41f6-b292-b4b68c01888b │891cfe85-b381-4f85-9699-5f7dbfe2…│myvalue1 │[{"Value":{"Stan…│8dc98f65-5f0a-4444-bfd1-6a818dc7…│[{"condition_groups":[{"…│[] │Wed Dec …│Wed Dec 18 15:40:…│ -│e6a3f940-e24f-4383-8763-718a1a304948 │2fe8dea1-3555-498c-afe9-99724f35…│value2 │[{"Value":{"Stan…│798aacd2-abaf-4623-975e-3bb8ca43…│[{"condition_groups":[{"…│[] │Fri Nov …│Fri Nov 1 14:46:…│ -│9d06c757-06b9-4713-8fbd-5ef007b1afe2 │74babca6-016f-4f3e-a99b-4e46ea8d…│value1 │[{"Value":{"Stan…│eaf866c0-327f-4826-846a-5041c3c2…│[{"condition_groups":[{"…│[] │Fri Nov …│Fri Nov 1 14:46:…│ -╰─────────────────────────────────────────┴─────────────────────────────────┴─────────────────────────┴─────────────────┴─────────────────────────────────┴─────────────────────────┴─────────┴─────────┴──────────────────╯ - NOTE Use 'otdfctl policy subject-mappings get --id= --json' to see all properties -``` diff --git a/docs/man/policy/subject-mappings/update.md b/docs/man/policy/subject-mappings/update.md index 3960d791..f4db14e4 100644 --- a/docs/man/policy/subject-mappings/update.md +++ b/docs/man/policy/subject-mappings/update.md @@ -50,15 +50,3 @@ For more information about subject condition sets, see the `subject-condition-se ```shell otdfctl policy subject-mappings update --id 39866dd2-368b-41f6-b292-b4b68c01888b --action-standard DECRYPT,TRANSMIT ``` - -```shell - SUCCESS Updated subject-mappings: 39866dd2-368b-41f6-b292-b4b68c01888b -╭─────────────────────────────────────────────────────────────────────────┬────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ -│Property │Value │ -├─────────────────────────────────────────────────────────────────────────┼────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ -│Id │39866dd2-368b-41f6-b292-b4b68c01888b │ -│Created At │Wed Dec 18 15:40:50 UTC 2024 │ -│Updated At │Wed Dec 18 15:46:41 UTC 2024 │ -╰─────────────────────────────────────────────────────────────────────────┴────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ - NOTE Use 'otdfctl policy subject-mappings get --id=39866dd2-368b-41f6-b292-b4b68c01888b --json' to see all properties -``` From f82410449c1a87a4b1ed999d61d095d5295acc5b Mon Sep 17 00:00:00 2001 From: Elizabeth Healy Date: Tue, 7 Jan 2025 11:27:08 -0500 Subject: [PATCH 6/7] remove extra output --- docs/man/policy/kas-grants/unassign.md | 13 ------------- docs/man/policy/subject-condition-sets/create.md | 13 ------------- 2 files changed, 26 deletions(-) diff --git a/docs/man/policy/kas-grants/unassign.md b/docs/man/policy/kas-grants/unassign.md index 4028ec13..46fcaa29 100644 --- a/docs/man/policy/kas-grants/unassign.md +++ b/docs/man/policy/kas-grants/unassign.md @@ -56,19 +56,6 @@ Attribute grant: otdfctl policy kas-grants unassign --attribute-id a21eb299-3a7d-4035-8a39-c8662c03cb15 --kas-id 62857b55-560c-4b67-96e3-33e4670ecb3b ``` -```shell - SUCCESS -╭─────────────────────────────────────────────────────────────────────────┬────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ -│Property │Value │ -├─────────────────────────────────────────────────────────────────────────┼────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ -│Attribute ID │a21eb299-3a7d-4035-8a39-c8662c03cb15 │ -│Attribute FQN │https://opentdf.io/attr/myattribute │ -│KAS ID │62857b55-560c-4b67-96e3-33e4670ecb3b │ -│Unassigned Granted KAS URI │http://example.com/kas │ -╰─────────────────────────────────────────────────────────────────────────┴────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ - -``` - Attribute value grant: ```shell otdfctl policy kas-grants unassign --value-id 0a40b27c-6cc9-49e8-a6ae-663cac2c324b --kas-id 62857b55-560c-4b67-96e3-33e4670ecb3b diff --git a/docs/man/policy/subject-condition-sets/create.md b/docs/man/policy/subject-condition-sets/create.md index 5d3dad7f..7ace9291 100644 --- a/docs/man/policy/subject-condition-sets/create.md +++ b/docs/man/policy/subject-condition-sets/create.md @@ -123,19 +123,6 @@ otdfctl policy subject-condition-set create --subject-sets '[ ]' ``` -```shell - SUCCESS Created subject-condition-sets: bfade235-509a-4a6f-886a-812005c01db5 -╭─────────────────────────────────────────────────────────────────────────┬────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ -│Property │Value │ -├─────────────────────────────────────────────────────────────────────────┼────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ -│Id │bfade235-509a-4a6f-886a-812005c01db5 │ -│SubjectSets │[{"conditionGroups":[{"conditions":[{"subjectExternalSelectorValue":".example.field.one","operator":"SUBJECT_MAPPING_OPERATOR_ENUM_IN","subject…│ -│Created At │Wed Dec 18 06:44:39 UTC 2024 │ -│Updated At │Wed Dec 18 06:44:39 UTC 2024 │ -╰─────────────────────────────────────────────────────────────────────────┴────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ - NOTE Use 'otdfctl policy subject-condition-sets get --id=bfade235-509a-4a6f-886a-812005c01db5 --json' to see all properties -``` - You can perform the same action with the input contained in a file: ```shell otdfctl policy subject-condition-set create --subject-sets-file-json scs.json From 2ac78aa153365ac03bd550bcf22bda06c8430155 Mon Sep 17 00:00:00 2001 From: Elizabeth Healy Date: Tue, 7 Jan 2025 11:27:59 -0500 Subject: [PATCH 7/7] remove extra output --- docs/man/policy/kas-grants/unassign.md | 13 ------------- 1 file changed, 13 deletions(-) diff --git a/docs/man/policy/kas-grants/unassign.md b/docs/man/policy/kas-grants/unassign.md index 46fcaa29..7b06c371 100644 --- a/docs/man/policy/kas-grants/unassign.md +++ b/docs/man/policy/kas-grants/unassign.md @@ -38,19 +38,6 @@ Namespace grant: otdfctl policy kas-grants unassign --namespace-id 3d25d33e-2469-4990-a9ed-fdd13ce74436 --kas-id 62857b55-560c-4b67-96e3-33e4670ecb3b ``` -```shell - SUCCESS -╭─────────────────────────────────────────────────────────────────────────┬────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ -│Property │Value │ -├─────────────────────────────────────────────────────────────────────────┼────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ -│Namespace ID │3d25d33e-2469-4990-a9ed-fdd13ce74436 │ -│Namespace FQN │https://opentdf.io │ -│KAS ID │62857b55-560c-4b67-96e3-33e4670ecb3b │ -│Unassigned Granted KAS URI │http://example.com/kas │ -╰─────────────────────────────────────────────────────────────────────────┴────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ - -``` - Attribute grant: ```shell otdfctl policy kas-grants unassign --attribute-id a21eb299-3a7d-4035-8a39-c8662c03cb15 --kas-id 62857b55-560c-4b67-96e3-33e4670ecb3b