@rockcarver/frodo-cli 4.0.1 → 4.0.2-0

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/CHANGELOG.md CHANGED
@@ -7,6 +7,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
7
7
 
8
8
  ## [Unreleased]
9
9
 
10
+ ## [4.0.1] - 2026-07-17
11
+
10
12
  ### Changed
11
13
 
12
14
  - Updated journey commands to work correctly with frodo-lib 4.0.1 export format changes (PR #629).
@@ -376,18 +378,23 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
376
378
  ### Added
377
379
 
378
380
  - Improve support for custom platform deployments (non-forgeops or customized forgeops)
381
+
379
382
  - \#429: Added options to support custom oauth2 clients used to obtain the access token for IDM API calls:
383
+
380
384
  - `--login-client-id <client-id>` Specify a custom OAuth2 client id to use a your own oauth2 client for IDM API calls in deployments of type "cloud" or "forgeops". Your custom client must be configured as a public client and allow the authorization code grant using the "openid fr:idm:\*" scope. Use the "--redirect-uri" parameter if you have configured a custom redirect uri (default: "<host>/platform/appAuthHelperRedirect.html").
381
385
  - `--login-redirect-uri <redirect-uri>` Specify a custom redirect URI to use with your custom OAuth2 client (efault: "<host>/platform/appAuthHelperRedirect.html").
382
386
 
383
387
  The above options can also be supplied through environment variables:
388
+
384
389
  - `FRODO_LOGIN_CLIENT_ID` OAuth2 client id for IDM API calls. Overridden by '--login-client-id' option.
385
390
  - `FRODO_LOGIN_REDIRECT_URI` Redirect Uri for custom OAuth2 client id. Overridden by '--login-redirect-uri' option.
386
391
 
387
392
  - \#359: Added an option to support custom IDM host URLs for all IDM API calls (e.g. platform deployments hosting AM and IDM on/in different DNS hosts/domains):
393
+
388
394
  - `--idm-host <idm-host>` IDM base URL, e.g.: <https://cdk.idm.example.com/myidm>. Use only if your IDM installation resides in a different domain and/or if the base path differs from the default "/openidm".
389
395
 
390
396
  The above option can also be supplied through an environment variable:
397
+
391
398
  - `FRODO_IDM_HOST` IDM base URL. Overridden by '--idm-host' option.
392
399
 
393
400
  **_Note:_** All the above options are also persisted in connection profiles so they only have to specified once and after that they come out of the connection profile.
@@ -729,12 +736,15 @@ Frodo CLI 2.x automatically refreshes session and access tokens before they expi
729
736
  - `frodo esv secret import`
730
737
 
731
738
  - Frodo now supports exporting (and importing) of ESV secret values. To leave stuartship of secret values with the cloud environment where they belong, frodo will always encrypt values using either encryption keys from the source environment (default) or the target environment (export option). Frodo will never export secrets in the clear. However, frodo supports importing clear values (as well as importing encrypted values). Use these new commands and parameters to export/import variables and secrets including secret values:
739
+
732
740
  - New parameters for existing `frodo esv secret export` and `frodo config export` commands:
741
+
733
742
  - `--include-active-values` Include the currently active (and loaded) secret value in the export. By default, secret values are encrypted server-side in the environment they are exported from. Use `--target <host url>` to have another environment perform the encryption.
734
743
 
735
744
  - `--target <host url>` Host URL of the environment to perform secret value encryption. The URL must resolve to an existing connection profile. Use this option to generate an export that can be imported into the target environment without requiring admin access to the source environment.
736
745
 
737
746
  - New `frodo esv secret import` and updated existing `frodo config import` command and note-worthy parameters:
747
+
738
748
  - `--include-active-values` Import any secret values contained in the import file. By default, secret values are encrypted server-side in the environment they are exported from. Use `--source <host url>` to import a file exported from another environment than the one you are importing to.
739
749
 
740
750
  - `--source <host url>` Host URL of the environment which performed secret value encryption. The URL must resolve to an existing connection profile. Use this option to import a file that was exported from a different source environment than the one you are importing to.
@@ -912,12 +922,14 @@ Frodo CLI 2.x automatically refreshes session and access tokens before they expi
912
922
  ### Added
913
923
 
914
924
  - \#283: Support for authentication settings:
925
+
915
926
  - `frodo authn` Manage authentication setting.
916
927
  - `describe` List authentication settings.
917
928
  - `export` Export authentication settings.
918
929
  - `import` Import authentication settings.
919
930
 
920
931
  Examples:
932
+
921
933
  - Describe authentication settings:<br>
922
934
  `frodo authn describe <myTenant> <realm>`
923
935
 
@@ -1020,12 +1032,14 @@ Frodo CLI 2.x automatically refreshes session and access tokens before they expi
1020
1032
  ### Added
1021
1033
 
1022
1034
  - \#251: Support for Identity Cloud admin federation configuration:
1035
+
1023
1036
  - `frodo admin federation` Manage admin federation configuration.
1024
1037
  - `export` Export admin federation providers.
1025
1038
  - `import` Import admin federation providers.
1026
1039
  - `list` List admin federation providers.
1027
1040
 
1028
1041
  Examples:
1042
+
1029
1043
  - List all configured admin federation providers:<br>
1030
1044
  `frodo admin federation list <myTenant>`
1031
1045
 
@@ -1063,12 +1077,14 @@ Frodo CLI 2.x automatically refreshes session and access tokens before they expi
1063
1077
 
1064
1078
  - MacOS binaries are now signed and notarized and run without security exceptions.
1065
1079
  - \#251: Support for Identity Cloud admin federation configuration:
1080
+
1066
1081
  - `frodo admin federation` Manage admin federation configuration.
1067
1082
  - `export` Export admin federation providers.
1068
1083
  - `import` Import admin federation providers.
1069
1084
  - `list` List admin federation providers.
1070
1085
 
1071
1086
  Examples:
1087
+
1072
1088
  - List all configured admin federation providers:<br>
1073
1089
  `frodo admin federation list <myTenant>`
1074
1090
 
@@ -1101,12 +1117,14 @@ Frodo CLI 2.x automatically refreshes session and access tokens before they expi
1101
1117
  ### Added
1102
1118
 
1103
1119
  - \#251: Support for Identity Cloud admin federation configuration:
1120
+
1104
1121
  - `frodo admin federation` Manage admin federation configuration.
1105
1122
  - `export` Export admin federation providers.
1106
1123
  - `import` Import admin federation providers.
1107
1124
  - `list` List admin federation providers.
1108
1125
 
1109
1126
  Examples:
1127
+
1110
1128
  - List all configured admin federation providers:<br>
1111
1129
  `frodo admin federation list <myTenant>`
1112
1130
 
@@ -1159,6 +1177,7 @@ Frodo CLI 2.x automatically refreshes session and access tokens before they expi
1159
1177
  ### Added
1160
1178
 
1161
1179
  - Support for authorization policies, policy sets, and resource types through new `authz` commands:
1180
+
1162
1181
  - `frodo authz type` Manage authorization resource types.
1163
1182
  - `delete` Delete authorization resource types.
1164
1183
  - `describe` Describe authorization resource types.
@@ -1179,6 +1198,7 @@ Frodo CLI 2.x automatically refreshes session and access tokens before they expi
1179
1198
  - `list` List authorization policies.
1180
1199
 
1181
1200
  Examples:
1201
+
1182
1202
  - Export a whole policy set including policies and resource types:<br>
1183
1203
  `frodo authz set export -i <myPolicySet> <myTenant>`
1184
1204
  - Import a whole policy set including dependencies exported using the previous example:<br>
@@ -1192,6 +1212,7 @@ Frodo CLI 2.x automatically refreshes session and access tokens before they expi
1192
1212
  **_Note_**: Policy IDs/names have to be unique within the realm. Therefore you cannot export all policies from one policy set and import them into another policy set in the same realm without deleting the original policy set first.
1193
1213
 
1194
1214
  Notes:
1215
+
1195
1216
  - Use the new `--prereqs` option with the `authz set/policy import/export` commands to include structural prerequisites like resource types and policy sets.
1196
1217
  - Use the new `--json` option with all `describe` sub-commands:<br>
1197
1218
  `frodo authz type describe --json -n URL <myTenant>`<br>
@@ -1332,9 +1353,11 @@ Frodo CLI 2.x automatically refreshes session and access tokens before they expi
1332
1353
  ### Added
1333
1354
 
1334
1355
  - \#52: Added new developer options for `script export` and `script import` commands:
1356
+
1335
1357
  - `frodo script export`:
1336
1358
  - `-x`, `--extract`: Extract the script from the exported file, and save it to a separate file. Ignored with `-n` or `-a`.
1337
1359
  - `frodo script import`:
1360
+
1338
1361
  - `-w`, `--watch`: Watch for changes to the script files and import the scripts automatically when the file changes. Can only be used with `-A`. (default: false)
1339
1362
 
1340
1363
  **_Note:_** This new option only applies if the export was generated with the new `--extract` option!
@@ -1375,50 +1398,53 @@ Frodo CLI 2.x automatically refreshes session and access tokens before they expi
1375
1398
  ### Added
1376
1399
 
1377
1400
  - Full support for Identity Cloud Service Accounts across all commands. Three options to leverage service accounts:
1378
- 1. Connection profiles for daily CLI usage:
1379
1401
 
1380
- For daily admin and development tasks, using the new `frodo conn save` command (see details under next bullet) is the easiest way to get going with service accounts. To migrate an existing connection profile to service accounts and automatically create a service account for your tenant admin, simply issue the following command:
1402
+ 1. Connection profiles for daily CLI usage:
1403
+
1404
+ For daily admin and development tasks, using the new `frodo conn save` command (see details under next bullet) is the easiest way to get going with service accounts. To migrate an existing connection profile to service accounts and automatically create a service account for your tenant admin, simply issue the following command:
1405
+
1406
+ % frodo conn save service-accounts
1407
+ Connected to https://openam-service-accounts.forgeblocks.com/am [alpha] as user volker.scheuber@forgerock.com
1408
+ Created and added service account Frodo-SA-1673586189578 with id 99c04bba-7213-463b-9a27-ceafa8a95734 to profile.
1409
+ Saved connection profile https://openam-service-accounts.forgeblocks.com/am
1410
+ %
1381
1411
 
1382
- % frodo conn save service-accounts
1383
- Connected to https://openam-service-accounts.forgeblocks.com/am [alpha] as user volker.scheuber@forgerock.com
1384
- Created and added service account Frodo-SA-1673586189578 with id 99c04bba-7213-463b-9a27-ceafa8a95734 to profile.
1385
- Saved connection profile https://openam-service-accounts.forgeblocks.com/am
1386
- %
1412
+ Then validate your connection profile is using the new service account:
1387
1413
 
1388
- Then validate your connection profile is using the new service account:
1414
+ % frodo info service-accounts
1415
+ Connected to https://openam-service-accounts.forgeblocks.com/am [alpha] as service account Frodo-SA-1673586189578 [99c04bba-7213-463b-9a27-ceafa8a95734]
1389
1416
 
1390
- % frodo info service-accounts
1391
- Connected to https://openam-service-accounts.forgeblocks.com/am [alpha] as service account Frodo-SA-1673586189578 [99c04bba-7213-463b-9a27-ceafa8a95734]
1417
+ Host URL │https://openam-service-accounts.forgeblocks.com/am
1418
+ AM Version │7.3.0-2022-10-SNAPSHOT Build 9a1793c301ef579705e59b66ce57587f553e915f (2022-December-13 10:05)
1419
+ Subject (Type) │Frodo-SA-1673586189578 [99c04bba-7213-463b-9a27-ceafa8a95734] (Service Account)
1420
+ Deployment Type│cloud
1421
+ Cookie Name │e8b2bd07d5440d3
1422
+ Immutable │false
1423
+ Locked │false
1424
+ Region │us-west1
1425
+ Tier │other
1392
1426
 
1393
- Host URL │https://openam-service-accounts.forgeblocks.com/am
1394
- AM Version │7.3.0-2022-10-SNAPSHOT Build 9a1793c301ef579705e59b66ce57587f553e915f (2022-December-13 10:05)
1395
- Subject (Type) │Frodo-SA-1673586189578 [99c04bba-7213-463b-9a27-ceafa8a95734] (Service Account)
1396
- Deployment Type│cloud
1397
- Cookie Name │e8b2bd07d5440d3
1398
- Immutable │false
1399
- Locked │false
1400
- Region │us-west1
1401
- Tier │other
1427
+ Bearer token:
1428
+ eyJ0eXAiOiJKV1QiLCJlbmMiOiJBMTI4Q0JDLUhTMjU2IiwiYWxnIjoiZGlyIn0..JD1iu64iGZZoGNwEr-iF2w.af-0-UDDOdusAETjw9YE3YnjOPr6TrdQrBLcl1lxf5RpNThfRhD08xvu1WtJbUZgvjbWdajECEFJfnEinnrUdpe9l0tHU6gAxDrRmu9hAjt0AB3PFSk9BE5SlwvaGoW5vrF4oH0IYtuv4899hFF8KGNYUtou143xmSrsLH37862YiAeiRKtjaQsVUrdbDPAFnKgGRxJIiXp-UE0ZCQQGSqm-Gj0AqVvo-Piib9THrEbbJCzdc00RPaCU2Ra1DH9PDid7ix-zfuind5IgEXxA8XwBM7kSEkiDLUWZ8EaFhn6YXwIHjXetacgYvvDaUav2Fq5baIitnG_LIrCm32XzcDkVnph4mVklBwfbQbWE6BGXEVLK-QLdDupaQw-bic-yVs2d7PBk2y70gbChHCQOm6-MepkYznP4wKoRR1gkqCdl51QIp-tsFB5K2plrKXiwsfHlHKfFKmsbdQUmH7xJFZQRhAtR_pKm-vHPOrPfBh0VbAdLRSkSeOZUABFH56X3gwXIpG_zuH42bQQkM9AlkB-lZrLf4jN0zFq-2ZN-zDgRR9h6qiiD3p9BDmFfaorUDTfFSrfaKas7OIp5ooW8Kqpv28RRtRtvfex0vT_kRbWl5R08MPWZDKZbx4IMyuun-2pYJ-F2-dvfA4A-jRvWIvC6jTUTu-RZZ0Yw1F2lgwFOVbmpMmG2uGHp5GceWePsZ34FVtJuaTd5D-uq_FoAb3HQ7FGEgUMJN_q82hCCX3URv_ocbFMjYwctdUqV_Ed-__A_9lbHHr8D2Uw_Qo0mwku7qwNBTS0-OcrwDvBOJohzRbpbfim-Sq2UzV9SBzzXNK7sMft1pNfu2-saOwPfy6SE0u42-HDqxE9t4MkklSroPY0oDUxO58ET8LXnewGhC9Tt0XTk6WA2rNLcNirhFqdmtKgfrSMQ_t22_DQEDwXpXqtHGmDoltJe7x_6Ofh0W5l7_A71MoHeFpVa_AHpHybnaF4fvUbD284wOV8i22SqrUKuHoJ3o6_g5JlhvMCvb4OZQ-ltxSf98aPsB9nCSthYg5-GkiR_r5mK1w9gZkBTXfYs0qC8-zYEQb4WNiI9.2JGMj9iW6YD-RE_dGkL7_w
1429
+ %
1402
1430
 
1403
- Bearer token:
1404
- eyJ0eXAiOiJKV1QiLCJlbmMiOiJBMTI4Q0JDLUhTMjU2IiwiYWxnIjoiZGlyIn0..JD1iu64iGZZoGNwEr-iF2w.af-0-UDDOdusAETjw9YE3YnjOPr6TrdQrBLcl1lxf5RpNThfRhD08xvu1WtJbUZgvjbWdajECEFJfnEinnrUdpe9l0tHU6gAxDrRmu9hAjt0AB3PFSk9BE5SlwvaGoW5vrF4oH0IYtuv4899hFF8KGNYUtou143xmSrsLH37862YiAeiRKtjaQsVUrdbDPAFnKgGRxJIiXp-UE0ZCQQGSqm-Gj0AqVvo-Piib9THrEbbJCzdc00RPaCU2Ra1DH9PDid7ix-zfuind5IgEXxA8XwBM7kSEkiDLUWZ8EaFhn6YXwIHjXetacgYvvDaUav2Fq5baIitnG_LIrCm32XzcDkVnph4mVklBwfbQbWE6BGXEVLK-QLdDupaQw-bic-yVs2d7PBk2y70gbChHCQOm6-MepkYznP4wKoRR1gkqCdl51QIp-tsFB5K2plrKXiwsfHlHKfFKmsbdQUmH7xJFZQRhAtR_pKm-vHPOrPfBh0VbAdLRSkSeOZUABFH56X3gwXIpG_zuH42bQQkM9AlkB-lZrLf4jN0zFq-2ZN-zDgRR9h6qiiD3p9BDmFfaorUDTfFSrfaKas7OIp5ooW8Kqpv28RRtRtvfex0vT_kRbWl5R08MPWZDKZbx4IMyuun-2pYJ-F2-dvfA4A-jRvWIvC6jTUTu-RZZ0Yw1F2lgwFOVbmpMmG2uGHp5GceWePsZ34FVtJuaTd5D-uq_FoAb3HQ7FGEgUMJN_q82hCCX3URv_ocbFMjYwctdUqV_Ed-__A_9lbHHr8D2Uw_Qo0mwku7qwNBTS0-OcrwDvBOJohzRbpbfim-Sq2UzV9SBzzXNK7sMft1pNfu2-saOwPfy6SE0u42-HDqxE9t4MkklSroPY0oDUxO58ET8LXnewGhC9Tt0XTk6WA2rNLcNirhFqdmtKgfrSMQ_t22_DQEDwXpXqtHGmDoltJe7x_6Ofh0W5l7_A71MoHeFpVa_AHpHybnaF4fvUbD284wOV8i22SqrUKuHoJ3o6_g5JlhvMCvb4OZQ-ltxSf98aPsB9nCSthYg5-GkiR_r5mK1w9gZkBTXfYs0qC8-zYEQb4WNiI9.2JGMj9iW6YD-RE_dGkL7_w
1405
- %
1431
+ Once you have verified that your service account works, go ahead and enable MFA for your tenant admin account!
1406
1432
 
1407
- Once you have verified that your service account works, go ahead and enable MFA for your tenant admin account!
1433
+ 2. CLI parameters:
1408
1434
 
1409
- 2. CLI parameters:
1435
+ All commands support the following new options to use service accounts:
1410
1436
 
1411
- All commands support the following new options to use service accounts:
1412
- - `--sa-id <uuid>` Service account's uuid. If specified, must also include `--sa-jwk-file`.
1413
- - `--sa-jwk-file <file>` File containing the service account's java web key (jwk). Jwk must contain private key! If specified, must also include `--sa-id`.
1437
+ - `--sa-id <uuid>` Service account's uuid. If specified, must also include `--sa-jwk-file`.
1438
+ - `--sa-jwk-file <file>` File containing the service account's java web key (jwk). Jwk must contain private key! If specified, must also include `--sa-id`.
1414
1439
 
1415
- This is a great way to leverage the nice UI to create and manage service accounts and then use one of the accounts with Frodo.
1440
+ This is a great way to leverage the nice UI to create and manage service accounts and then use one of the accounts with Frodo.
1416
1441
 
1417
- 3. Environment variables for CI/CD
1442
+ 3. Environment variables for CI/CD
1418
1443
 
1419
- For CI/CD pipelines, environment variables are preferable over command line parameters, because they are not visible in system logs:
1420
- - `FRODO_SA_ID`: Service account's uuid. If set, must also set `FRODO_SA_JWK`.
1421
- - `FRODO_SA_JWK`: Service account's java web key (jwk) as single-line string. Jwk must contain private key! If set, must also set `FRODO_SA_ID`.
1444
+ For CI/CD pipelines, environment variables are preferable over command line parameters, because they are not visible in system logs:
1445
+
1446
+ - `FRODO_SA_ID`: Service account's uuid. If set, must also set `FRODO_SA_JWK`.
1447
+ - `FRODO_SA_JWK`: Service account's java web key (jwk) as single-line string. Jwk must contain private key! If set, must also set `FRODO_SA_ID`.
1422
1448
 
1423
1449
  - \#143: Support Identity Cloud Service Accounts in `frodo conn save|add` command
1424
1450
  1. The `frodo conn add` command is renamed to `frodo conn save` and `add` is added as an alias for backwards compatibility.
@@ -1433,6 +1459,7 @@ Frodo CLI 2.x automatically refreshes session and access tokens before they expi
1433
1459
  5. The `frodo conn save` command validates service account configuration unless the `--no-validate` options is supplied.
1434
1460
 
1435
1461
  - Add support for additional environment variables:
1462
+
1436
1463
  - `FRODO_SA_ID`: Service account's uuid. If set, must also set `FRODO_SA_JWK`.
1437
1464
  - `FRODO_SA_JWK`: Service account's java web key (jwk) as single-line string. Jwk must contain private key! If set, must also set `FRODO_SA_ID`.
1438
1465
  - `FRODO_AUTHENTICATION_SERVICE=journey`: Specify a login journey for frodo to use.
@@ -1440,6 +1467,7 @@ Frodo CLI 2.x automatically refreshes session and access tokens before they expi
1440
1467
  - `FRODO_POLLY_LOG_LEVEL=info`: Frodo mock engine log level (`trace`, `debug`, `info`, `warn`, `error`, `silent`). This is helpful for troubleshooting the mock capability, only.
1441
1468
 
1442
1469
  Environment variables added in 0.19.0:
1470
+
1443
1471
  - `FRODO_HOST`
1444
1472
  - `FRODO_REALM`
1445
1473
  - `FRODO_USERNAME`
@@ -2312,7 +2340,8 @@ Frodo CLI 2.x automatically refreshes session and access tokens before they expi
2312
2340
  - Fixed problem with adding connection profiles
2313
2341
  - Miscellaneous bug fixes
2314
2342
 
2315
- [unreleased]: https://github.com/rockcarver/frodo-cli/compare/v4.0.1-1...HEAD
2343
+ [unreleased]: https://github.com/rockcarver/frodo-cli/compare/v4.0.1...HEAD
2344
+ [4.0.1]: https://github.com/rockcarver/frodo-cli/compare/v4.0.1-1...v4.0.1
2316
2345
  [4.0.1-1]: https://github.com/rockcarver/frodo-cli/compare/v4.0.1-0...v4.0.1-1
2317
2346
  [4.0.1-0]: https://github.com/rockcarver/frodo-cli/compare/v4.0.0...v4.0.1-0
2318
2347
  [4.0.0]: https://github.com/rockcarver/frodo-cli/compare/v4.0.0-54...v4.0.0