@transcend-io/cli 7.0.0-alpha.4 → 7.0.0-alpha.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +788 -0
- package/dist/bin/bash-complete.js +1 -1
- package/dist/bin/cli.js +1 -1
- package/dist/bin/deprecated-command.js +5 -5
- package/dist/{chunk-LB26GOGN.js → chunk-6RCR5ICJ.js} +1 -1
- package/dist/{chunk-SNE53JL2.js → chunk-CS6MRI6K.js} +1 -1
- package/dist/{chunk-DDYFIYCC.js → chunk-ENFEJNL6.js} +1 -1
- package/dist/{chunk-VH4PAOVV.js → chunk-IKR6UVU4.js} +1 -1
- package/dist/{chunk-QPPYCG3K.js → chunk-ILAP7QZC.js} +1 -1
- package/dist/{chunk-J2A7ZQZK.js → chunk-KV3K4JMM.js} +1 -1
- package/dist/{chunk-IX57OTFV.js → chunk-PGK2CKUL.js} +1 -1
- package/dist/{chunk-UJC7455L.js → chunk-QYTCLNZ7.js} +9 -9
- package/dist/{chunk-RIVSSQAD.js → chunk-TAH6ELB3.js} +1 -1
- package/dist/{chunk-BHDQRYCC.js → chunk-VQCJGKAI.js} +1 -1
- package/dist/{chunk-36OYCQAH.js → chunk-WTUT47OZ.js} +1 -1
- package/dist/{chunk-2U7DMWVM.js → chunk-XIARI2AK.js} +1 -1
- package/dist/chunk-ZU3IU5OT.js +1 -0
- package/dist/{impl-FQ4JY3PM.js → impl-2JGCSM5O.js} +1 -1
- package/dist/{impl-MSPLKNAC.js → impl-2YCE2D74.js} +1 -1
- package/dist/{impl-TOCVOZ7D.js → impl-3PQTSYDH.js} +1 -1
- package/dist/{impl-LEORLG3G.js → impl-3XRYCJFT.js} +1 -1
- package/dist/{impl-UAO73YJW.js → impl-57NMZUTX.js} +1 -1
- package/dist/{impl-5JQWZE22.js → impl-6ODC2EKH.js} +1 -1
- package/dist/{impl-23A44LMH.js → impl-7CNLLLYG.js} +1 -1
- package/dist/{impl-P36LWMYL.js → impl-7XM7ZTU2.js} +3 -3
- package/dist/{impl-JMDCSKFW.js → impl-ARGVBVLO.js} +1 -1
- package/dist/{impl-LQ4FGFCT.js → impl-AUECLWIQ.js} +1 -1
- package/dist/{impl-57MM7K6S.js → impl-DTTZJZP6.js} +1 -1
- package/dist/{impl-VSIEMKCJ.js → impl-EFPJLZZR.js} +1 -1
- package/dist/{impl-BUGOJ622.js → impl-FETIWTDE.js} +1 -1
- package/dist/{impl-IRPIOI7A.js → impl-GHND2SIW.js} +1 -1
- package/dist/{impl-SE4W22MX.js → impl-GUPQO6QP.js} +1 -1
- package/dist/{impl-HI7GPKJS.js → impl-H7IPYWZN.js} +1 -1
- package/dist/{impl-3O7U2A5Z.js → impl-HTUHEZIA.js} +1 -1
- package/dist/{impl-LR3KH6HF.js → impl-J2IFOOJA.js} +1 -1
- package/dist/{impl-YUZJV3RL.js → impl-JG2FKNHG.js} +1 -1
- package/dist/{impl-TWDD35U4.js → impl-KQWYFNW6.js} +1 -1
- package/dist/{impl-CQWNM6M6.js → impl-M3H7IS5R.js} +1 -1
- package/dist/{impl-PIVVUTJ5.js → impl-MDSL64U2.js} +1 -1
- package/dist/{impl-GURN665S.js → impl-MX7XDUTI.js} +1 -1
- package/dist/{impl-FTOWS4LT.js → impl-Q6KORRPH.js} +1 -1
- package/dist/{impl-WWUVCY2C.js → impl-QTDYR7UU.js} +1 -1
- package/dist/{impl-V2POCVEM.js → impl-S5DCAN3C.js} +1 -1
- package/dist/{impl-R4TN5WE6.js → impl-SK7Y2LHH.js} +1 -1
- package/dist/{impl-L7FPB5XK.js → impl-SNMVE4PF.js} +1 -1
- package/dist/{impl-NCQGE4HN.js → impl-TB3T5L3R.js} +1 -1
- package/dist/{impl-ZZTFBASI.js → impl-U7CNU3TK.js} +1 -1
- package/dist/{impl-IIR7UIYH.js → impl-V2TQGX3T.js} +1 -1
- package/dist/{impl-BT4YFJXD.js → impl-VMJNP54F.js} +1 -1
- package/dist/{impl-GTNPTYRN.js → impl-W2HOHRDF.js} +1 -1
- package/dist/{impl-6TW2ZJGW.js → impl-WOGVE6TG.js} +1 -1
- package/dist/{impl-UAP5BU4W.js → impl-XRSPZZNB.js} +1 -1
- package/dist/{impl-Z4MBWRSS.js → impl-XWLNP7GV.js} +1 -1
- package/dist/{impl-JD3GTCZX.js → impl-YGOTUBUV.js} +1 -1
- package/dist/index.js +1 -1
- package/package.json +2 -2
- package/dist/chunk-PC5LFPCL.js +0 -1
package/README.md
CHANGED
|
@@ -378,6 +378,794 @@ data-silos:
|
|
|
378
378
|
|
|
379
379
|
## Usage
|
|
380
380
|
|
|
381
|
+
<!-- COMMANDS_START -->
|
|
382
|
+
## transcend request approve
|
|
383
|
+
|
|
384
|
+
```bash
|
|
385
|
+
USAGE
|
|
386
|
+
transcend request approve (--auth value) (--actions AUTOMATED_DECISION_MAKING_OPT_OUT|USE_OF_SENSITIVE_INFORMATION_OPT_OUT|CONTACT_OPT_OUT|SALE_OPT_OUT|TRACKING_OPT_OUT|CUSTOM_OPT_OUT|AUTOMATED_DECISION_MAKING_OPT_IN|USE_OF_SENSITIVE_INFORMATION_OPT_IN|SALE_OPT_IN|TRACKING_OPT_IN|CONTACT_OPT_IN|CUSTOM_OPT_IN|ACCESS|ERASURE|RECTIFICATION|RESTRICTION|BUSINESS_PURPOSE|PLACE_ON_LEGAL_HOLD|REMOVE_FROM_LEGAL_HOLD) [--origins PRIVACY_CENTER|ADMIN_DASHBOARD|API|SHOPIFY] [--silentModeBefore value] [--createdAtBefore value] [--createdAtAfter value] [--transcendUrl value] [--concurrency value]
|
|
387
|
+
transcend request approve --help
|
|
388
|
+
|
|
389
|
+
Bulk approve a set of privacy requests from the DSR Automation -> Incoming Requests tab.
|
|
390
|
+
|
|
391
|
+
FLAGS
|
|
392
|
+
--auth The Transcend API key. Requires scopes: "Request Approval and Communication", "View Incoming Requests", "Manage Request Compilation"
|
|
393
|
+
--actions The request actions to approve [AUTOMATED_DECISION_MAKING_OPT_OUT|USE_OF_SENSITIVE_INFORMATION_OPT_OUT|CONTACT_OPT_OUT|SALE_OPT_OUT|TRACKING_OPT_OUT|CUSTOM_OPT_OUT|AUTOMATED_DECISION_MAKING_OPT_IN|USE_OF_SENSITIVE_INFORMATION_OPT_IN|SALE_OPT_IN|TRACKING_OPT_IN|CONTACT_OPT_IN|CUSTOM_OPT_IN|ACCESS|ERASURE|RECTIFICATION|RESTRICTION|BUSINESS_PURPOSE|PLACE_ON_LEGAL_HOLD|REMOVE_FROM_LEGAL_HOLD, separator = ,]
|
|
394
|
+
[--origins] The request origins to approve [PRIVACY_CENTER|ADMIN_DASHBOARD|API|SHOPIFY, separator = ,]
|
|
395
|
+
[--silentModeBefore] Any requests made before this date should be marked as silent mode
|
|
396
|
+
[--createdAtBefore] Approve requests that were submitted before this time
|
|
397
|
+
[--createdAtAfter] Approve requests that were submitted after this time
|
|
398
|
+
[--transcendUrl] URL of the Transcend backend. Use https://api.us.transcend.io for US hosting [default = https://api.transcend.io]
|
|
399
|
+
[--concurrency] The concurrency to use when uploading requests in parallel [default = 50]
|
|
400
|
+
-h --help Print help information and exit
|
|
401
|
+
```
|
|
402
|
+
## transcend request upload
|
|
403
|
+
|
|
404
|
+
```bash
|
|
405
|
+
USAGE
|
|
406
|
+
transcend request upload (--auth value) [--file value] [--transcendUrl value] [--cacheFilepath value] [--requestReceiptFolder value] [--sombraAuth value] [--concurrency value] [--attributes value] [--isTest] [--isSilent] [--skipSendingReceipt] [--emailIsVerified] [--skipFilterStep] [--dryRun] [--debug] [--defaultPhoneCountryCode value]
|
|
407
|
+
transcend request upload --help
|
|
408
|
+
|
|
409
|
+
If you need to upload a set of requests from a CSV, you can run this command.
|
|
410
|
+
This command uses inquirer to prompt the user to map the shape of the CSV to the shape of the Transcend API. There is no requirement for the shape of the incoming CSV, as the script will handle the mapping process.
|
|
411
|
+
|
|
412
|
+
The script will also produce a JSON cache file, that allows for the mappings to be preserved between runs.
|
|
413
|
+
|
|
414
|
+
FLAGS
|
|
415
|
+
--auth The Transcend API key. Requires scopes: "Submit New Data Subject Request", "View Identity Verification Settings", "View Global Attributes"
|
|
416
|
+
[--file] Path to the CSV file of requests to upload [default = ./requests.csv]
|
|
417
|
+
[--transcendUrl] URL of the Transcend backend. Use https://api.us.transcend.io for US hosting [default = https://api.transcend.io]
|
|
418
|
+
[--cacheFilepath] The path to the JSON file encoding the metadata used to map the CSV shape to Transcend API [default = ./transcend-privacy-requests-cache.json]
|
|
419
|
+
[--requestReceiptFolder] The path to the folder where receipts of each upload are stored [default = ./privacy-request-upload-receipts]
|
|
420
|
+
[--sombraAuth] The Sombra internal key, use for additional authentication when self-hosting Sombra
|
|
421
|
+
[--concurrency] The concurrency to use when uploading requests in parallel [default = 50]
|
|
422
|
+
[--attributes] Tag all of the requests with the following attributes. Format: key1:value1;value2,key2:value3;value4 [default = Tags:transcend-cli]
|
|
423
|
+
[--isTest] Flag whether the requests being uploaded are test requests or regular requests [default = false]
|
|
424
|
+
[--isSilent/--noIsSilent] Flag whether the requests being uploaded should be submitted in silent mode [default = true]
|
|
425
|
+
[--skipSendingReceipt] Flag whether to skip sending of the receipt email [default = false]
|
|
426
|
+
[--emailIsVerified/--noEmailIsVerified] Indicate whether the email address being uploaded is pre-verified. Set to false to send a verification email [default = true]
|
|
427
|
+
[--skipFilterStep] When true, skip the interactive step to filter down the CSV [default = false]
|
|
428
|
+
[--dryRun] When true, perform a dry run of the upload instead of calling the API to submit the requests [default = false]
|
|
429
|
+
[--debug] Debug logging [default = false]
|
|
430
|
+
[--defaultPhoneCountryCode] When uploading phone numbers, if the phone number is missing a country code, assume this country code [default = 1]
|
|
431
|
+
-h --help Print help information and exit
|
|
432
|
+
```
|
|
433
|
+
## transcend request download-files
|
|
434
|
+
|
|
435
|
+
```bash
|
|
436
|
+
USAGE
|
|
437
|
+
transcend request download-files (--auth value) [--sombraAuth value] [--concurrency value] [--requestIds value]... [--statuses REQUEST_MADE|FAILED_VERIFICATION|ENRICHING|ON_HOLD|WAITING|COMPILING|APPROVING|DELAYED|COMPLETED|DOWNLOADABLE|VIEW_CATEGORIES|CANCELED|SECONDARY|SECONDARY_COMPLETED|SECONDARY_APPROVING|REVOKED] [--folderPath value] [--createdAtBefore value] [--createdAtAfter value] [--approveAfterDownload] [--transcendUrl value]
|
|
438
|
+
transcend request download-files --help
|
|
439
|
+
|
|
440
|
+
Download the files associated with a Data Subject Access Request (DSAR) from DSR Automation -> Incoming Requests tab.
|
|
441
|
+
|
|
442
|
+
FLAGS
|
|
443
|
+
--auth The Transcend API key. Requires scopes: "View the Request Compilation", "View Incoming Requests", "Request Approval and Communication"
|
|
444
|
+
[--sombraAuth] The Sombra internal key, use for additional authentication when self-hosting Sombra
|
|
445
|
+
[--concurrency] The concurrency to use when downloading requests in parallel [default = 10]
|
|
446
|
+
[--requestIds]... Specify the specific request IDs to download [separator = ,]
|
|
447
|
+
[--statuses] The request statuses to download. Comma-separated list. Defaults to APPROVING,DOWNLOADABLE. [REQUEST_MADE|FAILED_VERIFICATION|ENRICHING|ON_HOLD|WAITING|COMPILING|APPROVING|DELAYED|COMPLETED|DOWNLOADABLE|VIEW_CATEGORIES|CANCELED|SECONDARY|SECONDARY_COMPLETED|SECONDARY_APPROVING|REVOKED, separator = ,]
|
|
448
|
+
[--folderPath] The folder to download files to [default = ./dsr-files]
|
|
449
|
+
[--createdAtBefore] Download requests that were submitted before this time
|
|
450
|
+
[--createdAtAfter] Download requests that were submitted after this time
|
|
451
|
+
[--approveAfterDownload] If the request is in status=APPROVING, approve the request after its downloaded [default = false]
|
|
452
|
+
[--transcendUrl] URL of the Transcend backend. Use https://api.us.transcend.io for US hosting [default = https://api.transcend.io]
|
|
453
|
+
-h --help Print help information and exit
|
|
454
|
+
```
|
|
455
|
+
## transcend request cancel
|
|
456
|
+
|
|
457
|
+
```bash
|
|
458
|
+
USAGE
|
|
459
|
+
transcend request cancel (--auth value) (--actions AUTOMATED_DECISION_MAKING_OPT_OUT|USE_OF_SENSITIVE_INFORMATION_OPT_OUT|CONTACT_OPT_OUT|SALE_OPT_OUT|TRACKING_OPT_OUT|CUSTOM_OPT_OUT|AUTOMATED_DECISION_MAKING_OPT_IN|USE_OF_SENSITIVE_INFORMATION_OPT_IN|SALE_OPT_IN|TRACKING_OPT_IN|CONTACT_OPT_IN|CUSTOM_OPT_IN|ACCESS|ERASURE|RECTIFICATION|RESTRICTION|BUSINESS_PURPOSE|PLACE_ON_LEGAL_HOLD|REMOVE_FROM_LEGAL_HOLD) [--statuses REQUEST_MADE|FAILED_VERIFICATION|ENRICHING|ON_HOLD|WAITING|COMPILING|APPROVING|DELAYED|COMPLETED|DOWNLOADABLE|VIEW_CATEGORIES|CANCELED|SECONDARY|SECONDARY_COMPLETED|SECONDARY_APPROVING|REVOKED] [--requestIds value]... [--silentModeBefore value] [--createdAtBefore value] [--createdAtAfter value] [--cancellationTitle value] [--transcendUrl value] [--concurrency value]
|
|
460
|
+
transcend request cancel --help
|
|
461
|
+
|
|
462
|
+
Bulk cancel a set of privacy requests from the DSR Automation -> Incoming Requests tab.
|
|
463
|
+
|
|
464
|
+
FLAGS
|
|
465
|
+
--auth The Transcend API key. Requires scopes: "View Incoming Requests", "Request Approval and Communication"
|
|
466
|
+
--actions The request actions to cancel [AUTOMATED_DECISION_MAKING_OPT_OUT|USE_OF_SENSITIVE_INFORMATION_OPT_OUT|CONTACT_OPT_OUT|SALE_OPT_OUT|TRACKING_OPT_OUT|CUSTOM_OPT_OUT|AUTOMATED_DECISION_MAKING_OPT_IN|USE_OF_SENSITIVE_INFORMATION_OPT_IN|SALE_OPT_IN|TRACKING_OPT_IN|CONTACT_OPT_IN|CUSTOM_OPT_IN|ACCESS|ERASURE|RECTIFICATION|RESTRICTION|BUSINESS_PURPOSE|PLACE_ON_LEGAL_HOLD|REMOVE_FROM_LEGAL_HOLD, separator = ,]
|
|
467
|
+
[--statuses] The request statuses to cancel. Comma-separated list. [REQUEST_MADE|FAILED_VERIFICATION|ENRICHING|ON_HOLD|WAITING|COMPILING|APPROVING|DELAYED|COMPLETED|DOWNLOADABLE|VIEW_CATEGORIES|CANCELED|SECONDARY|SECONDARY_COMPLETED|SECONDARY_APPROVING|REVOKED, separator = ,]
|
|
468
|
+
[--requestIds]... Specify the specific request IDs to cancel [separator = ,]
|
|
469
|
+
[--silentModeBefore] Any requests made before this date should be marked as silent mode for canceling to skip email sending
|
|
470
|
+
[--createdAtBefore] Cancel requests that were submitted before this time
|
|
471
|
+
[--createdAtAfter] Cancel requests that were submitted after this time
|
|
472
|
+
[--cancellationTitle] The title of the email template that should be sent to the requests upon cancelation [default = Request Canceled]
|
|
473
|
+
[--transcendUrl] URL of the Transcend backend. Use https://api.us.transcend.io for US hosting [default = https://api.transcend.io]
|
|
474
|
+
[--concurrency] The concurrency to use when uploading requests in parallel [default = 50]
|
|
475
|
+
-h --help Print help information and exit
|
|
476
|
+
```
|
|
477
|
+
## transcend request restart
|
|
478
|
+
|
|
479
|
+
```bash
|
|
480
|
+
USAGE
|
|
481
|
+
transcend request restart (--auth value) (--actions AUTOMATED_DECISION_MAKING_OPT_OUT|USE_OF_SENSITIVE_INFORMATION_OPT_OUT|CONTACT_OPT_OUT|SALE_OPT_OUT|TRACKING_OPT_OUT|CUSTOM_OPT_OUT|AUTOMATED_DECISION_MAKING_OPT_IN|USE_OF_SENSITIVE_INFORMATION_OPT_IN|SALE_OPT_IN|TRACKING_OPT_IN|CONTACT_OPT_IN|CUSTOM_OPT_IN|ACCESS|ERASURE|RECTIFICATION|RESTRICTION|BUSINESS_PURPOSE|PLACE_ON_LEGAL_HOLD|REMOVE_FROM_LEGAL_HOLD) (--statuses REQUEST_MADE|FAILED_VERIFICATION|ENRICHING|ON_HOLD|WAITING|COMPILING|APPROVING|DELAYED|COMPLETED|DOWNLOADABLE|VIEW_CATEGORIES|CANCELED|SECONDARY|SECONDARY_COMPLETED|SECONDARY_APPROVING|REVOKED) [--transcendUrl value] [--requestReceiptFolder value] [--sombraAuth value] [--concurrency value] [--requestIds value]... [--emailIsVerified] [--createdAt value] [--silentModeBefore value] [--createdAtBefore value] [--createdAtAfter value] [--sendEmailReceipt] [--copyIdentifiers] [--skipWaitingPeriod]
|
|
482
|
+
transcend request restart --help
|
|
483
|
+
|
|
484
|
+
Bulk update a set of privacy requests based on a set of request filters.
|
|
485
|
+
|
|
486
|
+
FLAGS
|
|
487
|
+
--auth The Transcend API key. Requires scopes: "Submit New Data Subject Request", "View the Request Compilation"
|
|
488
|
+
--actions The request actions to restart [AUTOMATED_DECISION_MAKING_OPT_OUT|USE_OF_SENSITIVE_INFORMATION_OPT_OUT|CONTACT_OPT_OUT|SALE_OPT_OUT|TRACKING_OPT_OUT|CUSTOM_OPT_OUT|AUTOMATED_DECISION_MAKING_OPT_IN|USE_OF_SENSITIVE_INFORMATION_OPT_IN|SALE_OPT_IN|TRACKING_OPT_IN|CONTACT_OPT_IN|CUSTOM_OPT_IN|ACCESS|ERASURE|RECTIFICATION|RESTRICTION|BUSINESS_PURPOSE|PLACE_ON_LEGAL_HOLD|REMOVE_FROM_LEGAL_HOLD, separator = ,]
|
|
489
|
+
--statuses The request statuses to restart [REQUEST_MADE|FAILED_VERIFICATION|ENRICHING|ON_HOLD|WAITING|COMPILING|APPROVING|DELAYED|COMPLETED|DOWNLOADABLE|VIEW_CATEGORIES|CANCELED|SECONDARY|SECONDARY_COMPLETED|SECONDARY_APPROVING|REVOKED, separator = ,]
|
|
490
|
+
[--transcendUrl] URL of the Transcend backend. Use https://api.us.transcend.io for US hosting [default = https://api.transcend.io]
|
|
491
|
+
[--requestReceiptFolder] The path to the folder where receipts of each upload are stored [default = ./privacy-request-upload-receipts]
|
|
492
|
+
[--sombraAuth] The Sombra internal key, use for additional authentication when self-hosting Sombra
|
|
493
|
+
[--concurrency] The concurrency to use when uploading requests in parallel [default = 15]
|
|
494
|
+
[--requestIds]... Specify the specific request IDs to restart [separator = ,]
|
|
495
|
+
[--emailIsVerified/--noEmailIsVerified] Indicate whether the primary email address is verified. Set to false to send a verification email [default = true]
|
|
496
|
+
[--createdAt] Restart requests that were submitted before a specific date
|
|
497
|
+
[--silentModeBefore] Requests older than this date should be marked as silent mode
|
|
498
|
+
[--createdAtBefore] Restart requests that were submitted before this time
|
|
499
|
+
[--createdAtAfter] Restart requests that were submitted after this time
|
|
500
|
+
[--sendEmailReceipt] Send email receipts to the restarted requests [default = false]
|
|
501
|
+
[--copyIdentifiers] Copy over all enriched identifiers from the initial request [default = false]
|
|
502
|
+
[--skipWaitingPeriod] Skip queued state of request and go straight to compiling [default = false]
|
|
503
|
+
-h --help Print help information and exit
|
|
504
|
+
```
|
|
505
|
+
## transcend request notify-additional-time
|
|
506
|
+
|
|
507
|
+
```bash
|
|
508
|
+
USAGE
|
|
509
|
+
transcend request notify-additional-time (--auth value) (--createdAtBefore value) [--createdAtAfter value] [--actions AUTOMATED_DECISION_MAKING_OPT_OUT|USE_OF_SENSITIVE_INFORMATION_OPT_OUT|CONTACT_OPT_OUT|SALE_OPT_OUT|TRACKING_OPT_OUT|CUSTOM_OPT_OUT|AUTOMATED_DECISION_MAKING_OPT_IN|USE_OF_SENSITIVE_INFORMATION_OPT_IN|SALE_OPT_IN|TRACKING_OPT_IN|CONTACT_OPT_IN|CUSTOM_OPT_IN|ACCESS|ERASURE|RECTIFICATION|RESTRICTION|BUSINESS_PURPOSE|PLACE_ON_LEGAL_HOLD|REMOVE_FROM_LEGAL_HOLD] [--daysLeft value] [--days value] [--requestIds value]... [--emailTemplate value] [--transcendUrl value] [--concurrency value]
|
|
510
|
+
transcend request notify-additional-time --help
|
|
511
|
+
|
|
512
|
+
Bulk notify a set of privacy requests from the DSR Automation -> Incoming Requests tab that more time is needed to complete the request. Note any request in silent mode will not be emailed.
|
|
513
|
+
|
|
514
|
+
FLAGS
|
|
515
|
+
--auth The Transcend API key. Requires scopes: "View Incoming Requests", "Request Approval and Communication"
|
|
516
|
+
--createdAtBefore Notify requests that are open but submitted before this time
|
|
517
|
+
[--createdAtAfter] Notify requests that are open but submitted after this time
|
|
518
|
+
[--actions] The request actions to notify [AUTOMATED_DECISION_MAKING_OPT_OUT|USE_OF_SENSITIVE_INFORMATION_OPT_OUT|CONTACT_OPT_OUT|SALE_OPT_OUT|TRACKING_OPT_OUT|CUSTOM_OPT_OUT|AUTOMATED_DECISION_MAKING_OPT_IN|USE_OF_SENSITIVE_INFORMATION_OPT_IN|SALE_OPT_IN|TRACKING_OPT_IN|CONTACT_OPT_IN|CUSTOM_OPT_IN|ACCESS|ERASURE|RECTIFICATION|RESTRICTION|BUSINESS_PURPOSE|PLACE_ON_LEGAL_HOLD|REMOVE_FROM_LEGAL_HOLD, separator = ,]
|
|
519
|
+
[--daysLeft] Only notify requests that have less than this number of days until they are considered expired [default = 10]
|
|
520
|
+
[--days] The number of days to adjust the expiration of the request to [default = 45]
|
|
521
|
+
[--requestIds]... Specify the specific request IDs to notify [separator = ,]
|
|
522
|
+
[--emailTemplate] The title of the email template that should be sent to the requests [default = Additional Time Needed]
|
|
523
|
+
[--transcendUrl] URL of the Transcend backend. Use https://api.us.transcend.io for US hosting [default = https://api.transcend.io]
|
|
524
|
+
[--concurrency] The concurrency to use when uploading requests in parallel [default = 50]
|
|
525
|
+
-h --help Print help information and exit
|
|
526
|
+
```
|
|
527
|
+
## transcend request mark-silent
|
|
528
|
+
|
|
529
|
+
```bash
|
|
530
|
+
USAGE
|
|
531
|
+
transcend request mark-silent (--auth value) (--actions AUTOMATED_DECISION_MAKING_OPT_OUT|USE_OF_SENSITIVE_INFORMATION_OPT_OUT|CONTACT_OPT_OUT|SALE_OPT_OUT|TRACKING_OPT_OUT|CUSTOM_OPT_OUT|AUTOMATED_DECISION_MAKING_OPT_IN|USE_OF_SENSITIVE_INFORMATION_OPT_IN|SALE_OPT_IN|TRACKING_OPT_IN|CONTACT_OPT_IN|CUSTOM_OPT_IN|ACCESS|ERASURE|RECTIFICATION|RESTRICTION|BUSINESS_PURPOSE|PLACE_ON_LEGAL_HOLD|REMOVE_FROM_LEGAL_HOLD) [--statuses REQUEST_MADE|FAILED_VERIFICATION|ENRICHING|ON_HOLD|WAITING|COMPILING|APPROVING|DELAYED|COMPLETED|DOWNLOADABLE|VIEW_CATEGORIES|CANCELED|SECONDARY|SECONDARY_COMPLETED|SECONDARY_APPROVING|REVOKED] [--requestIds value]... [--createdAtBefore value] [--createdAtAfter value] [--transcendUrl value] [--concurrency value]
|
|
532
|
+
transcend request mark-silent --help
|
|
533
|
+
|
|
534
|
+
Bulk update a set of privacy requests from the DSR Automation -> Incoming Requests tab to be in silent mode.
|
|
535
|
+
|
|
536
|
+
FLAGS
|
|
537
|
+
--auth The Transcend API key. Requires scopes: "Manage Request Compilation"
|
|
538
|
+
--actions The request actions to mark silent [AUTOMATED_DECISION_MAKING_OPT_OUT|USE_OF_SENSITIVE_INFORMATION_OPT_OUT|CONTACT_OPT_OUT|SALE_OPT_OUT|TRACKING_OPT_OUT|CUSTOM_OPT_OUT|AUTOMATED_DECISION_MAKING_OPT_IN|USE_OF_SENSITIVE_INFORMATION_OPT_IN|SALE_OPT_IN|TRACKING_OPT_IN|CONTACT_OPT_IN|CUSTOM_OPT_IN|ACCESS|ERASURE|RECTIFICATION|RESTRICTION|BUSINESS_PURPOSE|PLACE_ON_LEGAL_HOLD|REMOVE_FROM_LEGAL_HOLD, separator = ,]
|
|
539
|
+
[--statuses] The request statuses to mark silent. Comma-separated list. Defaults to REQUEST_MADE,WAITING,ENRICHING,COMPILING,DELAYED,APPROVING,SECONDARY,SECONDARY_APPROVING. [REQUEST_MADE|FAILED_VERIFICATION|ENRICHING|ON_HOLD|WAITING|COMPILING|APPROVING|DELAYED|COMPLETED|DOWNLOADABLE|VIEW_CATEGORIES|CANCELED|SECONDARY|SECONDARY_COMPLETED|SECONDARY_APPROVING|REVOKED, separator = ,]
|
|
540
|
+
[--requestIds]... Specify the specific request IDs to mark silent [separator = ,]
|
|
541
|
+
[--createdAtBefore] Mark silent requests that were submitted before this time
|
|
542
|
+
[--createdAtAfter] Mark silent requests that were submitted after this time
|
|
543
|
+
[--transcendUrl] URL of the Transcend backend. Use https://api.us.transcend.io for US hosting [default = https://api.transcend.io]
|
|
544
|
+
[--concurrency] The concurrency to use when uploading requests in parallel [default = 50]
|
|
545
|
+
-h --help Print help information and exit
|
|
546
|
+
```
|
|
547
|
+
## transcend request enricher-restart
|
|
548
|
+
|
|
549
|
+
```bash
|
|
550
|
+
USAGE
|
|
551
|
+
transcend request enricher-restart (--auth value) (--enricherId value) [--actions AUTOMATED_DECISION_MAKING_OPT_OUT|USE_OF_SENSITIVE_INFORMATION_OPT_OUT|CONTACT_OPT_OUT|SALE_OPT_OUT|TRACKING_OPT_OUT|CUSTOM_OPT_OUT|AUTOMATED_DECISION_MAKING_OPT_IN|USE_OF_SENSITIVE_INFORMATION_OPT_IN|SALE_OPT_IN|TRACKING_OPT_IN|CONTACT_OPT_IN|CUSTOM_OPT_IN|ACCESS|ERASURE|RECTIFICATION|RESTRICTION|BUSINESS_PURPOSE|PLACE_ON_LEGAL_HOLD|REMOVE_FROM_LEGAL_HOLD] [--requestEnricherStatuses QUEUED|WAITING|SKIPPED|ERROR|RESOLVED|ACTION_REQUIRED|REMOTE_PROCESSING|WAITING_ON_DEPENDENCIES|POLLING] [--transcendUrl value] [--concurrency value] [--requestIds value]... [--createdAtBefore value] [--createdAtAfter value]
|
|
552
|
+
transcend request enricher-restart --help
|
|
553
|
+
|
|
554
|
+
Bulk restart a particular enricher across a series of DSRs.
|
|
555
|
+
|
|
556
|
+
The API key needs the following scopes:
|
|
557
|
+
- Manage Request Compilation
|
|
558
|
+
|
|
559
|
+
FLAGS
|
|
560
|
+
--auth The Transcend API key. Requires scopes: "Manage Request Compilation"
|
|
561
|
+
--enricherId The ID of the enricher to restart
|
|
562
|
+
[--actions] The request action to restart [AUTOMATED_DECISION_MAKING_OPT_OUT|USE_OF_SENSITIVE_INFORMATION_OPT_OUT|CONTACT_OPT_OUT|SALE_OPT_OUT|TRACKING_OPT_OUT|CUSTOM_OPT_OUT|AUTOMATED_DECISION_MAKING_OPT_IN|USE_OF_SENSITIVE_INFORMATION_OPT_IN|SALE_OPT_IN|TRACKING_OPT_IN|CONTACT_OPT_IN|CUSTOM_OPT_IN|ACCESS|ERASURE|RECTIFICATION|RESTRICTION|BUSINESS_PURPOSE|PLACE_ON_LEGAL_HOLD|REMOVE_FROM_LEGAL_HOLD, separator = ,]
|
|
563
|
+
[--requestEnricherStatuses] The request enricher statuses to restart [QUEUED|WAITING|SKIPPED|ERROR|RESOLVED|ACTION_REQUIRED|REMOTE_PROCESSING|WAITING_ON_DEPENDENCIES|POLLING, separator = ,]
|
|
564
|
+
[--transcendUrl] URL of the Transcend backend. Use https://api.us.transcend.io for US hosting [default = https://api.transcend.io]
|
|
565
|
+
[--concurrency] The concurrency to use when uploading requests in parallel [default = 15]
|
|
566
|
+
[--requestIds]... Specify the specific request IDs to restart [separator = ,]
|
|
567
|
+
[--createdAtBefore] Restart requests that were submitted before this time
|
|
568
|
+
[--createdAtAfter] Restart requests that were submitted after this time
|
|
569
|
+
-h --help Print help information and exit
|
|
570
|
+
```
|
|
571
|
+
## transcend request reject-unverified-identifiers
|
|
572
|
+
|
|
573
|
+
```bash
|
|
574
|
+
USAGE
|
|
575
|
+
transcend request reject-unverified-identifiers (--auth value) (--identifierNames value)... [--actions AUTOMATED_DECISION_MAKING_OPT_OUT|USE_OF_SENSITIVE_INFORMATION_OPT_OUT|CONTACT_OPT_OUT|SALE_OPT_OUT|TRACKING_OPT_OUT|CUSTOM_OPT_OUT|AUTOMATED_DECISION_MAKING_OPT_IN|USE_OF_SENSITIVE_INFORMATION_OPT_IN|SALE_OPT_IN|TRACKING_OPT_IN|CONTACT_OPT_IN|CUSTOM_OPT_IN|ACCESS|ERASURE|RECTIFICATION|RESTRICTION|BUSINESS_PURPOSE|PLACE_ON_LEGAL_HOLD|REMOVE_FROM_LEGAL_HOLD] [--transcendUrl value]
|
|
576
|
+
transcend request reject-unverified-identifiers --help
|
|
577
|
+
|
|
578
|
+
Bulk clear out any request identifiers that are unverified.
|
|
579
|
+
|
|
580
|
+
FLAGS
|
|
581
|
+
--auth The Transcend API key. Requires scopes: "Manage Request Compilation"
|
|
582
|
+
--identifierNames... The names of identifiers to clear out [separator = ,]
|
|
583
|
+
[--actions] The request action to restart [AUTOMATED_DECISION_MAKING_OPT_OUT|USE_OF_SENSITIVE_INFORMATION_OPT_OUT|CONTACT_OPT_OUT|SALE_OPT_OUT|TRACKING_OPT_OUT|CUSTOM_OPT_OUT|AUTOMATED_DECISION_MAKING_OPT_IN|USE_OF_SENSITIVE_INFORMATION_OPT_IN|SALE_OPT_IN|TRACKING_OPT_IN|CONTACT_OPT_IN|CUSTOM_OPT_IN|ACCESS|ERASURE|RECTIFICATION|RESTRICTION|BUSINESS_PURPOSE|PLACE_ON_LEGAL_HOLD|REMOVE_FROM_LEGAL_HOLD, separator = ,]
|
|
584
|
+
[--transcendUrl] URL of the Transcend backend. Use https://api.us.transcend.io for US hosting [default = https://api.transcend.io]
|
|
585
|
+
-h --help Print help information and exit
|
|
586
|
+
```
|
|
587
|
+
## transcend request export
|
|
588
|
+
|
|
589
|
+
```bash
|
|
590
|
+
USAGE
|
|
591
|
+
transcend request export (--auth value) [--sombraAuth value] [--actions AUTOMATED_DECISION_MAKING_OPT_OUT|USE_OF_SENSITIVE_INFORMATION_OPT_OUT|CONTACT_OPT_OUT|SALE_OPT_OUT|TRACKING_OPT_OUT|CUSTOM_OPT_OUT|AUTOMATED_DECISION_MAKING_OPT_IN|USE_OF_SENSITIVE_INFORMATION_OPT_IN|SALE_OPT_IN|TRACKING_OPT_IN|CONTACT_OPT_IN|CUSTOM_OPT_IN|ACCESS|ERASURE|RECTIFICATION|RESTRICTION|BUSINESS_PURPOSE|PLACE_ON_LEGAL_HOLD|REMOVE_FROM_LEGAL_HOLD] [--statuses REQUEST_MADE|FAILED_VERIFICATION|ENRICHING|ON_HOLD|WAITING|COMPILING|APPROVING|DELAYED|COMPLETED|DOWNLOADABLE|VIEW_CATEGORIES|CANCELED|SECONDARY|SECONDARY_COMPLETED|SECONDARY_APPROVING|REVOKED] [--transcendUrl value] [--file value] [--concurrency value] [--createdAtBefore value] [--createdAtAfter value] [--showTests] [--pageLimit value]
|
|
592
|
+
transcend request export --help
|
|
593
|
+
|
|
594
|
+
Export privacy requests and request identifiers to a CSV file.
|
|
595
|
+
|
|
596
|
+
FLAGS
|
|
597
|
+
--auth The Transcend API key. Requires scopes: "View Incoming Requests", "View the Request Compilation"
|
|
598
|
+
[--sombraAuth] The Sombra internal key, use for additional authentication when self-hosting Sombra
|
|
599
|
+
[--actions] The request actions to export [AUTOMATED_DECISION_MAKING_OPT_OUT|USE_OF_SENSITIVE_INFORMATION_OPT_OUT|CONTACT_OPT_OUT|SALE_OPT_OUT|TRACKING_OPT_OUT|CUSTOM_OPT_OUT|AUTOMATED_DECISION_MAKING_OPT_IN|USE_OF_SENSITIVE_INFORMATION_OPT_IN|SALE_OPT_IN|TRACKING_OPT_IN|CONTACT_OPT_IN|CUSTOM_OPT_IN|ACCESS|ERASURE|RECTIFICATION|RESTRICTION|BUSINESS_PURPOSE|PLACE_ON_LEGAL_HOLD|REMOVE_FROM_LEGAL_HOLD, separator = ,]
|
|
600
|
+
[--statuses] The request statuses to export [REQUEST_MADE|FAILED_VERIFICATION|ENRICHING|ON_HOLD|WAITING|COMPILING|APPROVING|DELAYED|COMPLETED|DOWNLOADABLE|VIEW_CATEGORIES|CANCELED|SECONDARY|SECONDARY_COMPLETED|SECONDARY_APPROVING|REVOKED, separator = ,]
|
|
601
|
+
[--transcendUrl] URL of the Transcend backend. Use https://api.us.transcend.io for US hosting [default = https://api.transcend.io]
|
|
602
|
+
[--file] Path to the CSV file where identifiers will be written to [default = ./transcend-request-export.csv]
|
|
603
|
+
[--concurrency] The concurrency to use when uploading requests in parallel [default = 100]
|
|
604
|
+
[--createdAtBefore] Pull requests that were submitted before this time
|
|
605
|
+
[--createdAtAfter] Pull requests that were submitted after this time
|
|
606
|
+
[--showTests/--noShowTests] Filter for test requests or production requests - when not provided, pulls both
|
|
607
|
+
[--pageLimit] The page limit to use when pulling in pages of requests [default = 100]
|
|
608
|
+
-h --help Print help information and exit
|
|
609
|
+
```
|
|
610
|
+
## transcend request skip-preflight-jobs
|
|
611
|
+
|
|
612
|
+
```bash
|
|
613
|
+
USAGE
|
|
614
|
+
transcend request skip-preflight-jobs (--auth value) (--enricherIds value)... [--transcendUrl value]
|
|
615
|
+
transcend request skip-preflight-jobs --help
|
|
616
|
+
|
|
617
|
+
This command allows for bulk skipping preflight checks.
|
|
618
|
+
|
|
619
|
+
FLAGS
|
|
620
|
+
--auth The Transcend API key. Requires scopes: "Manage Request Compilation"
|
|
621
|
+
--enricherIds... The ID of the enrichers to skip privacy request jobs for [separator = ,]
|
|
622
|
+
[--transcendUrl] URL of the Transcend backend. Use https://api.us.transcend.io for US hosting [default = https://api.transcend.io]
|
|
623
|
+
-h --help Print help information and exit
|
|
624
|
+
```
|
|
625
|
+
## transcend request system mark-request-data-silos-completed
|
|
626
|
+
|
|
627
|
+
```bash
|
|
628
|
+
USAGE
|
|
629
|
+
transcend request system mark-request-data-silos-completed (--auth value) (--dataSiloId value) [--file value] [--transcendUrl value]
|
|
630
|
+
transcend request system mark-request-data-silos-completed --help
|
|
631
|
+
|
|
632
|
+
This command takes in a CSV of Request IDs as well as a Data Silo ID and marks all associated privacy request jobs as completed.
|
|
633
|
+
This command is useful with the "Bulk Response" UI. The CSV is expected to have 1 column named "Request Id".
|
|
634
|
+
|
|
635
|
+
FLAGS
|
|
636
|
+
--auth The Transcend API key. Requires scopes: "Manage Request Compilation"
|
|
637
|
+
--dataSiloId The ID of the data silo to pull in
|
|
638
|
+
[--file] Path to the CSV file where identifiers will be written to [default = ./request-identifiers.csv]
|
|
639
|
+
[--transcendUrl] URL of the Transcend backend. Use https://api.us.transcend.io for US hosting [default = https://api.transcend.io]
|
|
640
|
+
-h --help Print help information and exit
|
|
641
|
+
```
|
|
642
|
+
## transcend request system retry-request-data-silos
|
|
643
|
+
|
|
644
|
+
```bash
|
|
645
|
+
USAGE
|
|
646
|
+
transcend request system retry-request-data-silos (--auth value) (--dataSiloId value) (--actions AUTOMATED_DECISION_MAKING_OPT_OUT|USE_OF_SENSITIVE_INFORMATION_OPT_OUT|CONTACT_OPT_OUT|SALE_OPT_OUT|TRACKING_OPT_OUT|CUSTOM_OPT_OUT|AUTOMATED_DECISION_MAKING_OPT_IN|USE_OF_SENSITIVE_INFORMATION_OPT_IN|SALE_OPT_IN|TRACKING_OPT_IN|CONTACT_OPT_IN|CUSTOM_OPT_IN|ACCESS|ERASURE|RECTIFICATION|RESTRICTION|BUSINESS_PURPOSE|PLACE_ON_LEGAL_HOLD|REMOVE_FROM_LEGAL_HOLD) [--transcendUrl value]
|
|
647
|
+
transcend request system retry-request-data-silos --help
|
|
648
|
+
|
|
649
|
+
This command allows for bulk restarting a set of data silos jobs for open privacy requests. This is equivalent to clicking the "Wipe and Retry" button for a particular data silo across a set of privacy requests.
|
|
650
|
+
|
|
651
|
+
FLAGS
|
|
652
|
+
--auth The Transcend API key. Requires scopes: "Manage Request Compilation"
|
|
653
|
+
--dataSiloId The ID of the data silo to pull in
|
|
654
|
+
--actions The request actions to restart [AUTOMATED_DECISION_MAKING_OPT_OUT|USE_OF_SENSITIVE_INFORMATION_OPT_OUT|CONTACT_OPT_OUT|SALE_OPT_OUT|TRACKING_OPT_OUT|CUSTOM_OPT_OUT|AUTOMATED_DECISION_MAKING_OPT_IN|USE_OF_SENSITIVE_INFORMATION_OPT_IN|SALE_OPT_IN|TRACKING_OPT_IN|CONTACT_OPT_IN|CUSTOM_OPT_IN|ACCESS|ERASURE|RECTIFICATION|RESTRICTION|BUSINESS_PURPOSE|PLACE_ON_LEGAL_HOLD|REMOVE_FROM_LEGAL_HOLD, separator = ,]
|
|
655
|
+
[--transcendUrl] URL of the Transcend backend. Use https://api.us.transcend.io for US hosting [default = https://api.transcend.io]
|
|
656
|
+
-h --help Print help information and exit
|
|
657
|
+
```
|
|
658
|
+
## transcend request system skip-request-data-silos
|
|
659
|
+
|
|
660
|
+
```bash
|
|
661
|
+
USAGE
|
|
662
|
+
transcend request system skip-request-data-silos (--auth value) (--dataSiloId value) [--transcendUrl value] (--statuses REQUEST_MADE|FAILED_VERIFICATION|ENRICHING|ON_HOLD|WAITING|COMPILING|APPROVING|DELAYED|COMPLETED|DOWNLOADABLE|VIEW_CATEGORIES|CANCELED|SECONDARY|SECONDARY_COMPLETED|SECONDARY_APPROVING|REVOKED) [--status SKIPPED|RESOLVED]
|
|
663
|
+
transcend request system skip-request-data-silos --help
|
|
664
|
+
|
|
665
|
+
This command allows for bulk skipping all open privacy request jobs for a particular data silo. This command is useful if you want to disable a data silo and then clear out any active privacy requests that are still queued up for that data silo.
|
|
666
|
+
|
|
667
|
+
FLAGS
|
|
668
|
+
--auth The Transcend API key. Requires scopes: "Manage Request Compilation"
|
|
669
|
+
--dataSiloId The ID of the data silo to skip privacy request jobs for
|
|
670
|
+
[--transcendUrl] URL of the Transcend backend. Use https://api.us.transcend.io for US hosting [default = https://api.transcend.io]
|
|
671
|
+
--statuses The request statuses to skip [REQUEST_MADE|FAILED_VERIFICATION|ENRICHING|ON_HOLD|WAITING|COMPILING|APPROVING|DELAYED|COMPLETED|DOWNLOADABLE|VIEW_CATEGORIES|CANCELED|SECONDARY|SECONDARY_COMPLETED|SECONDARY_APPROVING|REVOKED, separator = ,]
|
|
672
|
+
[--status] The status to set the request data silo job to [SKIPPED|RESOLVED, default = SKIPPED]
|
|
673
|
+
-h --help Print help information and exit
|
|
674
|
+
```
|
|
675
|
+
## transcend request preflight pull-identifiers
|
|
676
|
+
|
|
677
|
+
```bash
|
|
678
|
+
USAGE
|
|
679
|
+
transcend request preflight pull-identifiers (--auth value) [--sombraAuth value] [--transcendUrl value] [--file value] [--actions AUTOMATED_DECISION_MAKING_OPT_OUT|USE_OF_SENSITIVE_INFORMATION_OPT_OUT|CONTACT_OPT_OUT|SALE_OPT_OUT|TRACKING_OPT_OUT|CUSTOM_OPT_OUT|AUTOMATED_DECISION_MAKING_OPT_IN|USE_OF_SENSITIVE_INFORMATION_OPT_IN|SALE_OPT_IN|TRACKING_OPT_IN|CONTACT_OPT_IN|CUSTOM_OPT_IN|ACCESS|ERASURE|RECTIFICATION|RESTRICTION|BUSINESS_PURPOSE|PLACE_ON_LEGAL_HOLD|REMOVE_FROM_LEGAL_HOLD] [--concurrency value]
|
|
680
|
+
transcend request preflight pull-identifiers --help
|
|
681
|
+
|
|
682
|
+
This command pulls down the set of privacy requests that are currently pending manual enrichment.
|
|
683
|
+
|
|
684
|
+
This is useful for the following workflow:
|
|
685
|
+
|
|
686
|
+
1. Pull identifiers to CSV:
|
|
687
|
+
transcend request preflight pull-identifiers --file=./enrichment-requests.csv
|
|
688
|
+
2. Fill out the CSV with additional identifiers
|
|
689
|
+
3. Push updated back to Transcend
|
|
690
|
+
transcend request preflight push-identifiers --file=./enrichment-requests.csv
|
|
691
|
+
|
|
692
|
+
FLAGS
|
|
693
|
+
--auth The Transcend API key. Requires scopes: "View Incoming Requests", "View the Request Compilation"
|
|
694
|
+
[--sombraAuth] The Sombra internal key, use for additional authentication when self-hosting Sombra
|
|
695
|
+
[--transcendUrl] URL of the Transcend backend. Use https://api.us.transcend.io for US hosting [default = https://api.transcend.io]
|
|
696
|
+
[--file] Path to the CSV file where requests will be written to [default = ./manual-enrichment-identifiers.csv]
|
|
697
|
+
[--actions] The request actions to pull for [AUTOMATED_DECISION_MAKING_OPT_OUT|USE_OF_SENSITIVE_INFORMATION_OPT_OUT|CONTACT_OPT_OUT|SALE_OPT_OUT|TRACKING_OPT_OUT|CUSTOM_OPT_OUT|AUTOMATED_DECISION_MAKING_OPT_IN|USE_OF_SENSITIVE_INFORMATION_OPT_IN|SALE_OPT_IN|TRACKING_OPT_IN|CONTACT_OPT_IN|CUSTOM_OPT_IN|ACCESS|ERASURE|RECTIFICATION|RESTRICTION|BUSINESS_PURPOSE|PLACE_ON_LEGAL_HOLD|REMOVE_FROM_LEGAL_HOLD, separator = ,]
|
|
698
|
+
[--concurrency] The concurrency to use when uploading requests in parallel [default = 100]
|
|
699
|
+
-h --help Print help information and exit
|
|
700
|
+
```
|
|
701
|
+
## transcend request preflight push-identifiers
|
|
702
|
+
|
|
703
|
+
```bash
|
|
704
|
+
USAGE
|
|
705
|
+
transcend request preflight push-identifiers (--auth value) (--enricherId value) [--sombraAuth value] [--transcendUrl value] [--file value] [--markSilent] [--concurrency value]
|
|
706
|
+
transcend request preflight push-identifiers --help
|
|
707
|
+
|
|
708
|
+
This command push up a set of identifiers for a set of requests pending manual enrichment.
|
|
709
|
+
|
|
710
|
+
This is useful for the following workflow:
|
|
711
|
+
|
|
712
|
+
1. Pull identifiers to CSV:
|
|
713
|
+
transcend request preflight pull-identifiers --file=./enrichment-requests.csv
|
|
714
|
+
2. Fill out the CSV with additional identifiers
|
|
715
|
+
3. Push updated back to Transcend
|
|
716
|
+
transcend request preflight push-identifiers --file=./enrichment-requests.csv
|
|
717
|
+
|
|
718
|
+
FLAGS
|
|
719
|
+
--auth The Transcend API key. Requires scopes: "Manage Request Identity Verification", "Manage Request Compilation"
|
|
720
|
+
--enricherId The ID of the Request Enricher to upload to
|
|
721
|
+
[--sombraAuth] The Sombra internal key, use for additional authentication when self-hosting Sombra
|
|
722
|
+
[--transcendUrl] URL of the Transcend backend. Use https://api.us.transcend.io for US hosting [default = https://api.transcend.io]
|
|
723
|
+
[--file] Path to the CSV file where requests will be written to [default = ./manual-enrichment-identifiers.csv]
|
|
724
|
+
[--markSilent] When true, set requests into silent mode before enriching [default = false]
|
|
725
|
+
[--concurrency] The concurrency to use when uploading requests in parallel [default = 100]
|
|
726
|
+
-h --help Print help information and exit
|
|
727
|
+
```
|
|
728
|
+
## transcend request cron pull-identifiers
|
|
729
|
+
|
|
730
|
+
```bash
|
|
731
|
+
USAGE
|
|
732
|
+
transcend request cron pull-identifiers (--auth value) (--dataSiloId value) (--actions AUTOMATED_DECISION_MAKING_OPT_OUT|USE_OF_SENSITIVE_INFORMATION_OPT_OUT|CONTACT_OPT_OUT|SALE_OPT_OUT|TRACKING_OPT_OUT|CUSTOM_OPT_OUT|AUTOMATED_DECISION_MAKING_OPT_IN|USE_OF_SENSITIVE_INFORMATION_OPT_IN|SALE_OPT_IN|TRACKING_OPT_IN|CONTACT_OPT_IN|CUSTOM_OPT_IN|ACCESS|ERASURE|RECTIFICATION|RESTRICTION|BUSINESS_PURPOSE|PLACE_ON_LEGAL_HOLD|REMOVE_FROM_LEGAL_HOLD) [--file value] [--transcendUrl value] [--sombraAuth value] [--pageLimit value] [--skipRequestCount] [--chunkSize value]
|
|
733
|
+
transcend request cron pull-identifiers --help
|
|
734
|
+
|
|
735
|
+
If you are using the cron job integration, you can run this command to pull the outstanding identifiers for the data silo to a CSV.
|
|
736
|
+
|
|
737
|
+
For large datasets, the output will be automatically split into multiple CSV files to avoid file system size limits. Use the --chunkSize parameter to control the maximum number of rows per file.
|
|
738
|
+
|
|
739
|
+
Read more at https://docs.transcend.io/docs/integrations/cron-job-integration.
|
|
740
|
+
|
|
741
|
+
FLAGS
|
|
742
|
+
--auth The Transcend API key. This key must be associated with the data silo(s) being operated on. No scopes are required for this command.
|
|
743
|
+
--dataSiloId The ID of the data silo to pull in
|
|
744
|
+
--actions The request actions to restart [AUTOMATED_DECISION_MAKING_OPT_OUT|USE_OF_SENSITIVE_INFORMATION_OPT_OUT|CONTACT_OPT_OUT|SALE_OPT_OUT|TRACKING_OPT_OUT|CUSTOM_OPT_OUT|AUTOMATED_DECISION_MAKING_OPT_IN|USE_OF_SENSITIVE_INFORMATION_OPT_IN|SALE_OPT_IN|TRACKING_OPT_IN|CONTACT_OPT_IN|CUSTOM_OPT_IN|ACCESS|ERASURE|RECTIFICATION|RESTRICTION|BUSINESS_PURPOSE|PLACE_ON_LEGAL_HOLD|REMOVE_FROM_LEGAL_HOLD, separator = ,]
|
|
745
|
+
[--file] Path to the CSV file where identifiers will be written to [default = ./cron-identifiers.csv]
|
|
746
|
+
[--transcendUrl] URL of the Transcend backend. Use https://api.us.transcend.io for US hosting [default = https://api.transcend.io]
|
|
747
|
+
[--sombraAuth] The Sombra internal key, use for additional authentication when self-hosting Sombra
|
|
748
|
+
[--pageLimit] The page limit to use when pulling in pages of identifiers [default = 100]
|
|
749
|
+
[--skipRequestCount] Whether to skip the count of all outstanding requests. This is required to render the progress bar, but can take a long time to run if you have a large number of outstanding requests to process. In that case, we recommend setting skipRequestCount=true so that you can still proceed with fetching the identifiers [default = false]
|
|
750
|
+
[--chunkSize] Maximum number of rows per CSV file. For large datasets, the output will be automatically split into multiple files to avoid file system size limits. Each file will contain at most this many rows [default = 100000]
|
|
751
|
+
-h --help Print help information and exit
|
|
752
|
+
```
|
|
753
|
+
## transcend request cron mark-identifiers-completed
|
|
754
|
+
|
|
755
|
+
```bash
|
|
756
|
+
USAGE
|
|
757
|
+
transcend request cron mark-identifiers-completed (--auth value) (--dataSiloId value) [--file value] [--transcendUrl value] [--sombraAuth value]
|
|
758
|
+
transcend request cron mark-identifiers-completed --help
|
|
759
|
+
|
|
760
|
+
This command takes the output of tr-cron-pull-identifiers and notifies Transcend that all of the requests in the CSV have been processed.
|
|
761
|
+
This is used in the workflow like:
|
|
762
|
+
|
|
763
|
+
1. Pull identifiers to CSV:
|
|
764
|
+
transcend request cron pull-identifiers --auth=$TRANSCEND_API_KEY --dataSiloId=70810f2e-cf90-43f6-9776-901a5950599f --actions=ERASURE --file=./outstanding-requests.csv
|
|
765
|
+
2. Run your process to operate on that CSV of requests.
|
|
766
|
+
3. Notify Transcend of completion
|
|
767
|
+
transcend request cron mark-identifiers-completed --auth=$TRANSCEND_API_KEY --dataSiloId=70810f2e-cf90-43f6-9776-901a5950599f --file=./outstanding-requests.csv
|
|
768
|
+
|
|
769
|
+
Read more at https://docs.transcend.io/docs/integrations/cron-job-integration.
|
|
770
|
+
|
|
771
|
+
FLAGS
|
|
772
|
+
--auth The Transcend API key. This key must be associated with the data silo(s) being operated on. No scopes are required for this command.
|
|
773
|
+
--dataSiloId The ID of the data silo to pull in
|
|
774
|
+
[--file] Path to the CSV file where identifiers will be written to [default = ./cron-identifiers.csv]
|
|
775
|
+
[--transcendUrl] URL of the Transcend backend. Use https://api.us.transcend.io for US hosting [default = https://api.transcend.io]
|
|
776
|
+
[--sombraAuth] The Sombra internal key, use for additional authentication when self-hosting Sombra
|
|
777
|
+
-h --help Print help information and exit
|
|
778
|
+
```
|
|
779
|
+
## transcend consent build-xdi-sync-endpoint
|
|
780
|
+
|
|
781
|
+
```bash
|
|
782
|
+
USAGE
|
|
783
|
+
transcend consent build-xdi-sync-endpoint (--auth value) (--xdiLocation value) [--file value] [--removeIpAddresses] [--domainBlockList value] [--xdiAllowedCommands value] [--transcendUrl value]
|
|
784
|
+
transcend consent build-xdi-sync-endpoint --help
|
|
785
|
+
|
|
786
|
+
This command allows for building of the XDI Sync Endpoint across a set of Transcend accounts.
|
|
787
|
+
|
|
788
|
+
FLAGS
|
|
789
|
+
--auth The Transcend API key. Requires scopes: "View Consent Manager"
|
|
790
|
+
--xdiLocation The location of the XDI that will be loaded by the generated sync endpoint
|
|
791
|
+
[--file] The HTML file path where the sync endpoint should be written [default = ./sync-endpoint.html]
|
|
792
|
+
[--removeIpAddresses/--noRemoveIpAddresses] When true, remove IP addresses from the domain list [default = true]
|
|
793
|
+
[--domainBlockList] The set of domains that should be excluded from the sync endpoint. Comma-separated list. [default = localhost]
|
|
794
|
+
[--xdiAllowedCommands] The allowed set of XDI commands [default = ConsentManager:Sync]
|
|
795
|
+
[--transcendUrl] URL of the Transcend backend. Use https://api.us.transcend.io for US hosting [default = https://api.transcend.io]
|
|
796
|
+
-h --help Print help information and exit
|
|
797
|
+
```
|
|
798
|
+
## transcend consent pull-consent-metrics
|
|
799
|
+
|
|
800
|
+
```bash
|
|
801
|
+
USAGE
|
|
802
|
+
transcend consent pull-consent-metrics (--auth value) (--start value) [--end value] [--folder value] [--bin value] [--transcendUrl value]
|
|
803
|
+
transcend consent pull-consent-metrics --help
|
|
804
|
+
|
|
805
|
+
This command allows for pulling consent manager metrics for a Transcend account, or a set of Transcend accounts.
|
|
806
|
+
|
|
807
|
+
FLAGS
|
|
808
|
+
--auth The Transcend API key. Requires scopes: "View Consent Manager"
|
|
809
|
+
--start The start date to pull metrics from
|
|
810
|
+
[--end] The end date to pull metrics until
|
|
811
|
+
[--folder] The folder to save metrics to [default = ./consent-metrics/]
|
|
812
|
+
[--bin] The bin metric when pulling data (1h or 1d) [default = 1d]
|
|
813
|
+
[--transcendUrl] URL of the Transcend backend. Use https://api.us.transcend.io for US hosting [default = https://api.transcend.io]
|
|
814
|
+
-h --help Print help information and exit
|
|
815
|
+
```
|
|
816
|
+
## transcend consent pull-consent-preferences
|
|
817
|
+
|
|
818
|
+
```bash
|
|
819
|
+
USAGE
|
|
820
|
+
transcend consent pull-consent-preferences (--auth value) (--partition value) [--sombraAuth value] [--file value] [--transcendUrl value] [--timestampBefore value] [--timestampAfter value] [--identifiers value]... [--concurrency value]
|
|
821
|
+
transcend consent pull-consent-preferences --help
|
|
822
|
+
|
|
823
|
+
This command allows for pull of consent preferences from the Managed Consent Database.
|
|
824
|
+
|
|
825
|
+
FLAGS
|
|
826
|
+
--auth The Transcend API key. Requires scopes: "View Managed Consent Database Admin API"
|
|
827
|
+
--partition The partition key to download consent preferences to
|
|
828
|
+
[--sombraAuth] The Sombra internal key, use for additional authentication when self-hosting Sombra
|
|
829
|
+
[--file] Path to the CSV file to save preferences to [default = ./preferences.csv]
|
|
830
|
+
[--transcendUrl] URL of the Transcend backend. Use https://api.us.transcend.io for US hosting [default = https://api.transcend.io]
|
|
831
|
+
[--timestampBefore] Filter for consents updated this time
|
|
832
|
+
[--timestampAfter] Filter for consents updated after this time
|
|
833
|
+
[--identifiers]... Filter for specific identifiers [separator = ,]
|
|
834
|
+
[--concurrency] The concurrency to use when downloading consents in parallel [default = 100]
|
|
835
|
+
-h --help Print help information and exit
|
|
836
|
+
```
|
|
837
|
+
## transcend consent update-consent-manager
|
|
838
|
+
|
|
839
|
+
```bash
|
|
840
|
+
USAGE
|
|
841
|
+
transcend consent update-consent-manager (--auth value) (--bundleTypes PRODUCTION|TEST) [--deploy] [--transcendUrl value]
|
|
842
|
+
transcend consent update-consent-manager --help
|
|
843
|
+
|
|
844
|
+
This command allows for updating Consent Manager to latest version. The consent manager bundle can also be deployed using this command.
|
|
845
|
+
|
|
846
|
+
FLAGS
|
|
847
|
+
--auth The Transcend API key. Requires scopes: "Manage Consent Manager Developer Settings"
|
|
848
|
+
--bundleTypes The bundle types to deploy. Defaults to PRODUCTION,TEST. [PRODUCTION|TEST, separator = ,]
|
|
849
|
+
[--deploy] When true, deploy the Consent Manager after updating the version [default = false]
|
|
850
|
+
[--transcendUrl] URL of the Transcend backend. Use https://api.us.transcend.io for US hosting [default = https://api.transcend.io]
|
|
851
|
+
-h --help Print help information and exit
|
|
852
|
+
```
|
|
853
|
+
## transcend consent upload-consent-preferences
|
|
854
|
+
|
|
855
|
+
```bash
|
|
856
|
+
USAGE
|
|
857
|
+
transcend consent upload-consent-preferences (--base64EncryptionKey value) (--base64SigningKey value) (--partition value) [--file value] [--consentUrl value] [--concurrency value]
|
|
858
|
+
transcend consent upload-consent-preferences --help
|
|
859
|
+
|
|
860
|
+
This command allows for updating of consent preferences to the Managed Consent Database.
|
|
861
|
+
|
|
862
|
+
FLAGS
|
|
863
|
+
--base64EncryptionKey The encryption key used to encrypt the userId
|
|
864
|
+
--base64SigningKey The signing key used to prove authentication of consent request
|
|
865
|
+
--partition The partition key to download consent preferences to
|
|
866
|
+
[--file] The file to pull consent preferences from [default = ./preferences.csv]
|
|
867
|
+
[--consentUrl] URL of the Transcend Consent backend. Use https://consent.us.transcend.io for US hosting [default = https://consent.transcend.io]
|
|
868
|
+
[--concurrency] The concurrency to use when uploading requests in parallel [default = 100]
|
|
869
|
+
-h --help Print help information and exit
|
|
870
|
+
```
|
|
871
|
+
## transcend consent upload-cookies-from-csv
|
|
872
|
+
|
|
873
|
+
```bash
|
|
874
|
+
USAGE
|
|
875
|
+
transcend consent upload-cookies-from-csv (--auth value) (--trackerStatus LIVE|NEEDS_REVIEW) [--file value] [--transcendUrl value]
|
|
876
|
+
transcend consent upload-cookies-from-csv --help
|
|
877
|
+
|
|
878
|
+
This command allows for uploading cookies from CSV.
|
|
879
|
+
|
|
880
|
+
FLAGS
|
|
881
|
+
--auth The Transcend API key. Requires scopes: "Manage Data Flows"
|
|
882
|
+
--trackerStatus The status of the cookies you will upload. [LIVE|NEEDS_REVIEW]
|
|
883
|
+
[--file] Path to the CSV file to upload [default = ./cookies.csv]
|
|
884
|
+
[--transcendUrl] URL of the Transcend backend. Use https://api.us.transcend.io for US hosting [default = https://api.transcend.io]
|
|
885
|
+
-h --help Print help information and exit
|
|
886
|
+
```
|
|
887
|
+
## transcend consent upload-data-flows-from-csv
|
|
888
|
+
|
|
889
|
+
```bash
|
|
890
|
+
USAGE
|
|
891
|
+
transcend consent upload-data-flows-from-csv (--auth value) (--trackerStatus LIVE|NEEDS_REVIEW) [--file value] [--classifyService] [--transcendUrl value]
|
|
892
|
+
transcend consent upload-data-flows-from-csv --help
|
|
893
|
+
|
|
894
|
+
This command allows for uploading of data flows from CSV.
|
|
895
|
+
|
|
896
|
+
FLAGS
|
|
897
|
+
--auth The Transcend API key. Requires scopes: "Manage Data Flows"
|
|
898
|
+
--trackerStatus The status of the data flows you will upload. [LIVE|NEEDS_REVIEW]
|
|
899
|
+
[--file] Path to the CSV file to upload [default = ./data-flows.csv]
|
|
900
|
+
[--classifyService] When true, automatically assign the service for a data flow based on the domain that is specified [default = false]
|
|
901
|
+
[--transcendUrl] URL of the Transcend backend. Use https://api.us.transcend.io for US hosting [default = https://api.transcend.io]
|
|
902
|
+
-h --help Print help information and exit
|
|
903
|
+
```
|
|
904
|
+
## transcend consent upload-preferences
|
|
905
|
+
|
|
906
|
+
```bash
|
|
907
|
+
USAGE
|
|
908
|
+
transcend consent upload-preferences (--auth value) (--partition value) [--sombraAuth value] [--consentUrl value] [--file value] [--directory value] [--dryRun] [--skipExistingRecordCheck] [--receiptFileDir value] [--skipWorkflowTriggers] [--forceTriggerWorkflows] [--skipConflictUpdates] [--isSilent] [--attributes value] [--receiptFilepath value] [--concurrency value]
|
|
909
|
+
transcend consent upload-preferences --help
|
|
910
|
+
|
|
911
|
+
This command allows for updating of preference management data to your Transcend Preference Store.
|
|
912
|
+
|
|
913
|
+
FLAGS
|
|
914
|
+
--auth The Transcend API key. Requires scopes: "Modify User Stored Preferences", "View Managed Consent Database Admin API", "View Preference Store Settings"
|
|
915
|
+
--partition The partition key to download consent preferences to
|
|
916
|
+
[--sombraAuth] The Sombra internal key, use for additional authentication when self-hosting Sombra
|
|
917
|
+
[--consentUrl] URL of the Transcend backend. Use https://consent.us.transcend.io for US hosting [default = https://consent.transcend.io]
|
|
918
|
+
[--file] Path to the CSV file to load preferences from
|
|
919
|
+
[--directory] Path to the directory of CSV files to load preferences from
|
|
920
|
+
[--dryRun] Whether to do a dry run only - will write results to receiptFilepath without updating Transcend [default = false]
|
|
921
|
+
[--skipExistingRecordCheck] Whether to skip the check for existing records. SHOULD ONLY BE USED FOR INITIAL UPLOAD [default = false]
|
|
922
|
+
[--receiptFileDir] Directory path where the response receipts should be saved [default = ./receipts]
|
|
923
|
+
[--skipWorkflowTriggers] Whether to skip workflow triggers when uploading to preference store [default = false]
|
|
924
|
+
[--forceTriggerWorkflows] Whether to force trigger workflows for existing consent records [default = false]
|
|
925
|
+
[--skipConflictUpdates] Whether to skip uploading of any records where the preference store and file have a hard conflict [default = false]
|
|
926
|
+
[--isSilent/--noIsSilent] Whether to skip sending emails in workflows [default = true]
|
|
927
|
+
[--attributes] Attributes to add to any DSR request if created. Comma-separated list of key:value pairs. [default = Tags:transcend-cli,Source:transcend-cli]
|
|
928
|
+
[--receiptFilepath] Store resulting, continuing where left off [default = ./preference-management-upload-receipts.json]
|
|
929
|
+
[--concurrency] The concurrency to use when uploading in parallel [default = 10]
|
|
930
|
+
-h --help Print help information and exit
|
|
931
|
+
```
|
|
932
|
+
## transcend consent consent-manager-service-json-to-yml
|
|
933
|
+
|
|
934
|
+
```bash
|
|
935
|
+
USAGE
|
|
936
|
+
transcend consent consent-manager-service-json-to-yml [--file value] [--output value]
|
|
937
|
+
transcend consent consent-manager-service-json-to-yml --help
|
|
938
|
+
|
|
939
|
+
Import the services from an airgap.js file into a Transcend instance.
|
|
940
|
+
|
|
941
|
+
FLAGS
|
|
942
|
+
[--file] Path to the services.json file, output of await airgap.getMetadata() [default = ./services.json]
|
|
943
|
+
[--output] Path to the output transcend.yml to write to [default = ./transcend.yml]
|
|
944
|
+
-h --help Print help information and exit
|
|
945
|
+
```
|
|
946
|
+
## transcend consent consent-managers-to-business-entities
|
|
947
|
+
|
|
948
|
+
```bash
|
|
949
|
+
USAGE
|
|
950
|
+
transcend consent consent-managers-to-business-entities (--consentManagerYmlFolder value) [--output value]
|
|
951
|
+
transcend consent consent-managers-to-business-entities --help
|
|
952
|
+
|
|
953
|
+
This command allows for converting a folder or Consent Manager transcend.yml files into a single transcend.yml file where each consent manager configuration is a Business Entity in the data inventory.
|
|
954
|
+
|
|
955
|
+
FLAGS
|
|
956
|
+
--consentManagerYmlFolder Path to the folder of Consent Manager transcend.yml files to combine
|
|
957
|
+
[--output] Path to the output transcend.yml with business entity configuration [default = ./combined-business-entities.yml]
|
|
958
|
+
-h --help Print help information and exit
|
|
959
|
+
```
|
|
960
|
+
## transcend inventory pull
|
|
961
|
+
|
|
962
|
+
```bash
|
|
963
|
+
USAGE
|
|
964
|
+
transcend inventory pull (--auth value) [--resources apiKeys|customFields|templates|dataSilos|enrichers|dataFlows|businessEntities|actions|dataSubjects|identifiers|cookies|consentManager|partitions|prompts|promptPartials|promptGroups|agents|agentFunctions|agentFiles|vendors|dataCategories|processingPurposes|actionItems|actionItemCollections|teams|privacyCenters|policies|messages|assessments|assessmentTemplates|purposes] [--file value] [--transcendUrl value] [--dataSiloIds value]... [--integrationNames value]... [--trackerStatuses LIVE|NEEDS_REVIEW] [--pageSize value] [--skipDatapoints] [--skipSubDatapoints] [--includeGuessedCategories] [--debug]
|
|
965
|
+
transcend inventory pull --help
|
|
966
|
+
|
|
967
|
+
Generate's a transcend.yml by pulling the configuration from your connected services view.
|
|
968
|
+
|
|
969
|
+
The API key needs various scopes depending on the resources being pulled.
|
|
970
|
+
|
|
971
|
+
FLAGS
|
|
972
|
+
--auth The Transcend API key. The scopes required will vary depending on the operation performed. If in doubt, the Full Admin scope will always work.
|
|
973
|
+
[--resources] The different resource types to pull in. Defaults to dataSilos,enrichers,templates,apiKeys. [apiKeys|customFields|templates|dataSilos|enrichers|dataFlows|businessEntities|actions|dataSubjects|identifiers|cookies|consentManager|partitions|prompts|promptPartials|promptGroups|agents|agentFunctions|agentFiles|vendors|dataCategories|processingPurposes|actionItems|actionItemCollections|teams|privacyCenters|policies|messages|assessments|assessmentTemplates|purposes, separator = ,]
|
|
974
|
+
[--file] Path to the YAML file to pull into [default = ./transcend.yml]
|
|
975
|
+
[--transcendUrl] URL of the Transcend backend. Use https://api.us.transcend.io for US hosting [default = https://api.transcend.io]
|
|
976
|
+
[--dataSiloIds]... The UUIDs of the data silos that should be pulled into the YAML file [separator = ,]
|
|
977
|
+
[--integrationNames]... The types of integrations to pull down [separator = ,]
|
|
978
|
+
[--trackerStatuses] The statuses of consent manager trackers to pull down. Defaults to all statuses. [LIVE|NEEDS_REVIEW, separator = ,]
|
|
979
|
+
[--pageSize] The page size to use when paginating over the API [default = 50]
|
|
980
|
+
[--skipDatapoints] When true, skip pulling in datapoints alongside data silo resource [default = false]
|
|
981
|
+
[--skipSubDatapoints] When true, skip pulling in subDatapoints alongside data silo resource [default = false]
|
|
982
|
+
[--includeGuessedCategories] When true, included guessed data categories that came from the content classifier [default = false]
|
|
983
|
+
[--debug] Set to true to include debug logs while pulling the configuration [default = false]
|
|
984
|
+
-h --help Print help information and exit
|
|
985
|
+
```
|
|
986
|
+
## transcend inventory push
|
|
987
|
+
|
|
988
|
+
```bash
|
|
989
|
+
USAGE
|
|
990
|
+
transcend inventory push (--auth value) [--file value] [--transcendUrl value] [--pageSize value] [--variables value] [--publishToPrivacyCenter] [--classifyService] [--deleteExtraAttributeValues]
|
|
991
|
+
transcend inventory push --help
|
|
992
|
+
|
|
993
|
+
Given a transcend.yml file, sync the contents up to your connected services view.
|
|
994
|
+
|
|
995
|
+
FLAGS
|
|
996
|
+
--auth The Transcend API key. The scopes required will vary depending on the operation performed. If in doubt, the Full Admin scope will always work.
|
|
997
|
+
[--file] Path to the YAML file to push from [default = ./transcend.yml]
|
|
998
|
+
[--transcendUrl] URL of the Transcend backend. Use https://api.us.transcend.io for US hosting [default = https://api.transcend.io]
|
|
999
|
+
[--pageSize] The page size to use when paginating over the API [default = 50]
|
|
1000
|
+
[--variables] The variables to template into the YAML file when pushing configuration. Comma-separated list of key:value pairs. [default = ""]
|
|
1001
|
+
[--publishToPrivacyCenter] When true, publish the configuration to the Privacy Center [default = false]
|
|
1002
|
+
[--classifyService] When true, automatically assign the service for a data flow based on the domain that is specified [default = false]
|
|
1003
|
+
[--deleteExtraAttributeValues] When true and syncing attributes, delete any extra attributes instead of just upserting [default = false]
|
|
1004
|
+
-h --help Print help information and exit
|
|
1005
|
+
```
|
|
1006
|
+
## transcend inventory scan-packages
|
|
1007
|
+
|
|
1008
|
+
```bash
|
|
1009
|
+
USAGE
|
|
1010
|
+
transcend inventory scan-packages (--auth value) [--scanPath value] [--ignoreDirs value]... [--repositoryName value] [--transcendUrl value]
|
|
1011
|
+
transcend inventory scan-packages --help
|
|
1012
|
+
|
|
1013
|
+
Transcend can scan your codebase to inventory your code packages and dependencies.
|
|
1014
|
+
|
|
1015
|
+
FLAGS
|
|
1016
|
+
--auth The Transcend API key. Requires scopes: "Manage Code Scanning"
|
|
1017
|
+
[--scanPath] File path in the project to scan [default = ./]
|
|
1018
|
+
[--ignoreDirs]... List of directories to ignore in scan [separator = ,]
|
|
1019
|
+
[--repositoryName] Name of the git repository that the package should be tied to
|
|
1020
|
+
[--transcendUrl] URL of the Transcend backend. Use https://api.us.transcend.io for US hosting [default = https://api.transcend.io]
|
|
1021
|
+
-h --help Print help information and exit
|
|
1022
|
+
```
|
|
1023
|
+
## transcend inventory discover-silos
|
|
1024
|
+
|
|
1025
|
+
```bash
|
|
1026
|
+
USAGE
|
|
1027
|
+
transcend inventory discover-silos (--scanPath value) (--dataSiloId value) (--auth value) [--fileGlobs value] [--ignoreDirs value] [--transcendUrl value]
|
|
1028
|
+
transcend inventory discover-silos --help
|
|
1029
|
+
|
|
1030
|
+
Transcend can help scan dependency management files to help detect new data silos where you may be storing user personal data.
|
|
1031
|
+
|
|
1032
|
+
FLAGS
|
|
1033
|
+
--scanPath File path in the project to scan
|
|
1034
|
+
--dataSiloId The UUID of the corresponding data silo
|
|
1035
|
+
--auth The Transcend API key. This key must be associated with the data silo(s) being operated on. Requires scopes: "Manage Assigned Data Inventory"
|
|
1036
|
+
[--fileGlobs] You can pass a glob syntax pattern(s) to specify additional file paths to scan. Comma-separated list of globs. [default = ""]
|
|
1037
|
+
[--ignoreDirs] Comma-separated list of directories to ignore. [default = ""]
|
|
1038
|
+
[--transcendUrl] URL of the Transcend backend. Use https://api.us.transcend.io for US hosting [default = https://api.transcend.io]
|
|
1039
|
+
-h --help Print help information and exit
|
|
1040
|
+
```
|
|
1041
|
+
## transcend inventory pull-datapoints
|
|
1042
|
+
|
|
1043
|
+
```bash
|
|
1044
|
+
USAGE
|
|
1045
|
+
transcend inventory pull-datapoints (--auth value) [--file value] [--transcendUrl value] [--dataSiloIds value]... [--includeAttributes] [--includeGuessedCategories] [--parentCategories FINANCIAL|HEALTH|CONTACT|LOCATION|DEMOGRAPHIC|ID|ONLINE_ACTIVITY|USER_PROFILE|SOCIAL_MEDIA|CONNECTION|TRACKING|DEVICE|SURVEY|OTHER|UNSPECIFIED|NOT_PERSONAL_DATA|INTEGRATION_IDENTIFIER] [--subCategories value]...
|
|
1046
|
+
transcend inventory pull-datapoints --help
|
|
1047
|
+
|
|
1048
|
+
This command allows for pulling your Data Inventory -> Datapoints into a CSV.
|
|
1049
|
+
|
|
1050
|
+
FLAGS
|
|
1051
|
+
--auth The Transcend API key. Requires scopes: "View Data Inventory"
|
|
1052
|
+
[--file] The file to save datapoints to [default = ./datapoints.csv]
|
|
1053
|
+
[--transcendUrl] URL of the Transcend backend. Use https://api.us.transcend.io for US hosting [default = https://api.transcend.io]
|
|
1054
|
+
[--dataSiloIds]... List of data silo IDs to filter by [separator = ,]
|
|
1055
|
+
[--includeAttributes] Whether to include attributes in the output [default = false]
|
|
1056
|
+
[--includeGuessedCategories] Whether to include guessed categories in the output [default = false]
|
|
1057
|
+
[--parentCategories] List of parent categories to filter by [FINANCIAL|HEALTH|CONTACT|LOCATION|DEMOGRAPHIC|ID|ONLINE_ACTIVITY|USER_PROFILE|SOCIAL_MEDIA|CONNECTION|TRACKING|DEVICE|SURVEY|OTHER|UNSPECIFIED|NOT_PERSONAL_DATA|INTEGRATION_IDENTIFIER, separator = ,]
|
|
1058
|
+
[--subCategories]... List of subcategories to filter by [separator = ,]
|
|
1059
|
+
-h --help Print help information and exit
|
|
1060
|
+
```
|
|
1061
|
+
## transcend inventory pull-unstructured-discovery-files
|
|
1062
|
+
|
|
1063
|
+
```bash
|
|
1064
|
+
USAGE
|
|
1065
|
+
transcend inventory pull-unstructured-discovery-files (--auth value) [--file value] [--transcendUrl value] [--dataSiloIds value]... [--subCategories value]... [--status MANUALLY_ADDED|CORRECTED|VALIDATED|CLASSIFIED|REJECTED] [--includeEncryptedSnippets]
|
|
1066
|
+
transcend inventory pull-unstructured-discovery-files --help
|
|
1067
|
+
|
|
1068
|
+
This command allows for pulling Unstructured Discovery into a CSV.
|
|
1069
|
+
|
|
1070
|
+
FLAGS
|
|
1071
|
+
--auth The Transcend API key. Requires scopes: "View Data Inventory"
|
|
1072
|
+
[--file] The file to save datapoints to [default = ./unstructured-discovery-files.csv]
|
|
1073
|
+
[--transcendUrl] URL of the Transcend backend. Use https://api.us.transcend.io for US hosting [default = https://api.transcend.io]
|
|
1074
|
+
[--dataSiloIds]... List of data silo IDs to filter by [separator = ,]
|
|
1075
|
+
[--subCategories]... List of data categories to filter by [separator = ,]
|
|
1076
|
+
[--status] List of classification statuses to filter by [MANUALLY_ADDED|CORRECTED|VALIDATED|CLASSIFIED|REJECTED, separator = ,]
|
|
1077
|
+
[--includeEncryptedSnippets] Whether to include encrypted snippets of the entries classified [default = false]
|
|
1078
|
+
-h --help Print help information and exit
|
|
1079
|
+
```
|
|
1080
|
+
## transcend inventory derive-data-silos-from-data-flows
|
|
1081
|
+
|
|
1082
|
+
```bash
|
|
1083
|
+
USAGE
|
|
1084
|
+
transcend inventory derive-data-silos-from-data-flows (--auth value) (--dataFlowsYmlFolder value) (--dataSilosYmlFolder value) [--ignoreYmls value]... [--transcendUrl value]
|
|
1085
|
+
transcend inventory derive-data-silos-from-data-flows --help
|
|
1086
|
+
|
|
1087
|
+
Given a folder of data flow transcend.yml configurations, convert those configurations to set of data silo transcend.yml configurations.
|
|
1088
|
+
|
|
1089
|
+
FLAGS
|
|
1090
|
+
--auth The Transcend API key. No scopes are required for this command.
|
|
1091
|
+
--dataFlowsYmlFolder The folder that contains data flow yml files
|
|
1092
|
+
--dataSilosYmlFolder The folder that contains data silo yml files
|
|
1093
|
+
[--ignoreYmls]... The set of yml files that should be skipped when uploading [separator = ,]
|
|
1094
|
+
[--transcendUrl] URL of the Transcend backend. Use https://api.us.transcend.io for US hosting [default = https://api.transcend.io]
|
|
1095
|
+
-h --help Print help information and exit
|
|
1096
|
+
```
|
|
1097
|
+
## transcend inventory derive-data-silos-from-data-flows-cross-instance
|
|
1098
|
+
|
|
1099
|
+
```bash
|
|
1100
|
+
USAGE
|
|
1101
|
+
transcend inventory derive-data-silos-from-data-flows-cross-instance (--auth value) (--dataFlowsYmlFolder value) [--output value] [--ignoreYmls value]... [--transcendUrl value]
|
|
1102
|
+
transcend inventory derive-data-silos-from-data-flows-cross-instance --help
|
|
1103
|
+
|
|
1104
|
+
Given a folder of data flow transcend.yml configurations, convert those configurations to a single transcend.yml configurations of all related data silos.
|
|
1105
|
+
|
|
1106
|
+
FLAGS
|
|
1107
|
+
--auth The Transcend API key. No scopes are required for this command.
|
|
1108
|
+
--dataFlowsYmlFolder The folder that contains data flow yml files
|
|
1109
|
+
[--output] The output transcend.yml file containing the data silo configurations [default = ./transcend.yml]
|
|
1110
|
+
[--ignoreYmls]... The set of yml files that should be skipped when uploading [separator = ,]
|
|
1111
|
+
[--transcendUrl] URL of the Transcend backend. Use https://api.us.transcend.io for US hosting [default = https://api.transcend.io]
|
|
1112
|
+
-h --help Print help information and exit
|
|
1113
|
+
```
|
|
1114
|
+
## transcend admin generate-api-keys
|
|
1115
|
+
|
|
1116
|
+
```bash
|
|
1117
|
+
USAGE
|
|
1118
|
+
transcend admin generate-api-keys (--email value) (--password value) (--apiKeyTitle value) (--file value) (--scopes value)... [--deleteExistingApiKey] [--createNewApiKey] [--parentOrganizationId value] [--transcendUrl value]
|
|
1119
|
+
transcend admin generate-api-keys --help
|
|
1120
|
+
|
|
1121
|
+
This command allows for creating API keys across multiple Transcend instances. This is useful for customers that are managing many Transcend instances and need to regularly create, cycle or delete API keys across all of their instances.
|
|
1122
|
+
|
|
1123
|
+
Unlike the other commands that rely on API key authentication, this command relies upon username/password authentication. This command will spit out the API keys into a JSON file, and that JSON file can be used in subsequent cli commands.
|
|
1124
|
+
|
|
1125
|
+
Authentication requires your email and password for the Transcend account. This command will only generate API keys for Transcend instances where you have the permission to "Manage API Keys".
|
|
1126
|
+
|
|
1127
|
+
FLAGS
|
|
1128
|
+
--email The email address that you use to log into Transcend
|
|
1129
|
+
--password The password for your account login
|
|
1130
|
+
--apiKeyTitle The title of the API key being generated or destroyed
|
|
1131
|
+
--file The file where API keys should be written to
|
|
1132
|
+
--scopes... The list of scopes that should be given to the API key [separator = ,]
|
|
1133
|
+
[--deleteExistingApiKey/--noDeleteExistingApiKey] When true, if an API key exists with the specified apiKeyTitle, the existing API key is deleted [default = true]
|
|
1134
|
+
[--createNewApiKey/--noCreateNewApiKey] When true, new API keys will be created. Set to false if you simply want to delete all API keys with a title [default = true]
|
|
1135
|
+
[--parentOrganizationId] Filter for only a specific organization by ID, returning all child accounts associated with that organization
|
|
1136
|
+
[--transcendUrl] URL of the Transcend backend. Use https://api.us.transcend.io for US hosting [default = https://api.transcend.io]
|
|
1137
|
+
-h --help Print help information and exit
|
|
1138
|
+
```
|
|
1139
|
+
## transcend migration sync-ot
|
|
1140
|
+
|
|
1141
|
+
```bash
|
|
1142
|
+
USAGE
|
|
1143
|
+
transcend migration sync-ot [--hostname value] [--oneTrustAuth value] [--source oneTrust|file] [--transcendAuth value] [--transcendUrl value] [--file value] [--resource assessments] [--dryRun] [--debug]
|
|
1144
|
+
transcend migration sync-ot --help
|
|
1145
|
+
|
|
1146
|
+
Pulls resources from a OneTrust and syncs them to a Transcend instance. For now, it only supports retrieving OneTrust Assessments.
|
|
1147
|
+
|
|
1148
|
+
This command can be helpful if you are looking to:
|
|
1149
|
+
- Pull resources from your OneTrust account.
|
|
1150
|
+
- Migrate your resources from your OneTrust account to Transcend.
|
|
1151
|
+
|
|
1152
|
+
OneTrust authentication requires an OAuth Token with scope for accessing the assessment endpoints.
|
|
1153
|
+
If syncing the resources to Transcend, you will also need to generate an API key on the Transcend Admin Dashboard.
|
|
1154
|
+
|
|
1155
|
+
FLAGS
|
|
1156
|
+
[--hostname] The domain of the OneTrust environment from which to pull the resource
|
|
1157
|
+
[--oneTrustAuth] The OAuth access token with the scopes necessary to access the OneTrust Public APIs
|
|
1158
|
+
[--source] Whether to read the assessments from OneTrust or from a file [oneTrust|file, default = oneTrust]
|
|
1159
|
+
[--transcendAuth] The Transcend API key. Requires scopes: "Manage Assessments"
|
|
1160
|
+
[--transcendUrl] URL of the Transcend backend. Use https://api.us.transcend.io for US hosting [default = https://api.transcend.io]
|
|
1161
|
+
[--file] Path to the file to pull the resource into. Must be a json file!
|
|
1162
|
+
[--resource] The resource to pull from OneTrust. For now, only assessments is supported [assessments, default = assessments]
|
|
1163
|
+
[--dryRun] Whether to export the resource to a file rather than sync to Transcend [default = false]
|
|
1164
|
+
[--debug] Whether to print detailed logs in case of error [default = false]
|
|
1165
|
+
-h --help Print help information and exit
|
|
1166
|
+
```
|
|
1167
|
+
<!-- COMMANDS_END -->
|
|
1168
|
+
|
|
381
1169
|
### tr-pull
|
|
382
1170
|
|
|
383
1171
|
Generate's a transcend.yml by pulling the configuration from your connected services view (https://app.transcend.io/privacy-requests/connected-services).
|