@affinidi/cli 2.3.0 → 2.5.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/README.md CHANGED
@@ -29,6 +29,12 @@ Update the Affinidi CLI
29
29
  npm update -g @affinidi/cli
30
30
  ```
31
31
 
32
+ View the installed version on your machine
33
+
34
+ ```bash
35
+ affinidi --version
36
+ ```
37
+
32
38
  ## What can I do with Affinidi CLI?
33
39
 
34
40
  Affinidi CLI is all you need to interact and consume Affinidi services. Optionally you can also use [Affinidi Portal](https://portal.affinidi.com) or call Affinidi APIs directly.
@@ -183,27 +189,8 @@ affinidi <topic> <command> [flags]
183
189
 
184
190
  ### Available commands
185
191
 
186
- In the [All Commands](#all-commands) section below you can find all of the CLI commands, with their help information, which includes usage, descriptions, flags and examples.
187
-
188
- #### Useful commands:
189
-
190
- [`affinidi start`](#affinidi-start) Log in to Affinidi
191
-
192
- [`affinidi stop`](#affinidi-stop) Log out of Affinidi
193
-
194
- [`affinidi whoami`](#affinidi-whoami) - Show the current signed in user identifiers
195
-
196
- [`affinidi help`](#affinidi-help-commands) - Print the help information of a topic or command
197
-
198
- [`affinidi search`](#affinidi-search) - Search and navigate through available commands
199
-
200
- [`affinidi commands`](#affinidi-commands) - List all available commands
201
-
202
- [`affinidi generate app`](#affinidi-generate-app) Clones and configures a reference application
192
+ In the [`Command Topics`](#command-topics) section below, you can find the topics with all their commands and help information, which includes usage, descriptions, flags and examples.
203
193
 
204
- [`affinidi autocomplete`](#affinidi-autocomplete-shell) - Print the instructions to set up command autocomplete
205
-
206
- `affinidi --version` - Show the current version of the Affinidi CLI installed on your machine
207
194
 
208
195
  ### Help
209
196
 
@@ -261,13 +248,31 @@ NOTE: If system keychain is not available, the CLI will create a folder with a c
261
248
 
262
249
  When you run `affinidi stop` your session information is deleted.
263
250
 
264
- ## Support & Feedback
251
+ <!-- commands -->
252
+ # Command Topics
253
+
254
+ * [`affinidi autocomplete`](docs/autocomplete.md) - display autocomplete installation instructions
255
+ * [`affinidi commands`](docs/commands.md) - list all the commands
256
+ * [`affinidi generate`](docs/generate.md) - Use these commands to generate code to get started or to scaffold your solution
257
+ * [`affinidi help`](docs/help.md) - Display help for affinidi.
258
+ * [`affinidi iam`](docs/iam.md) - Use these commands to manage policies for access configuration
259
+ * [`affinidi login`](docs/login.md) - Use these commands for user login configuration and group management
260
+ * [`affinidi project`](docs/project.md) - Use these commands to manage your projects
261
+ * [`affinidi search`](docs/search.md) - Search for a command.
262
+ * [`affinidi start`](docs/start.md) - Log in to Affinidi
263
+ * [`affinidi stop`](docs/stop.md) - Log out from Affinidi
264
+ * [`affinidi token`](docs/token.md) - Use these commands for Personal Access Token (PAT) management
265
+ * [`affinidi whoami`](docs/whoami.md) - Returns user's subject, projects, and token details from the current session.
266
+
267
+ <!-- commandsstop -->
268
+
269
+ # Support & Feedback
265
270
 
266
271
  If you face any issue or have some suggestion for us please don't hesitate to create a ticket [here](https://share.hsforms.com/1i-4HKZRXSsmENzXtPdIG4g8oa2v).
267
272
 
268
273
  If you have a technical issue with the CLI's codebase, you can also [create an issue](https://github.com/affinidi/affinidi-cli/issues) directly in GitHub.
269
274
 
270
- ## FAQ
275
+ # FAQ
271
276
 
272
277
  ### What can I develop?
273
278
 
@@ -309,1005 +314,3 @@ Affinidi collects usage data to improve our products and services. For informati
309
314
 
310
315
  _Disclaimer:
311
316
  Please note that this FAQ is provided for informational purposes only and is not to be considered a legal document. For the legal terms and conditions governing your use of the Affinidi CLI, please refer to our [Terms and Conditions](https://www.affinidi.com/terms-conditions)._
312
-
313
- ## All commands
314
-
315
- <!-- commands -->
316
- * [`affinidi autocomplete [SHELL]`](#affinidi-autocomplete-shell)
317
- * [`affinidi commands`](#affinidi-commands)
318
- * [`affinidi generate app`](#affinidi-generate-app)
319
- * [`affinidi help [COMMANDS]`](#affinidi-help-commands)
320
- * [`affinidi iam add-principal`](#affinidi-iam-add-principal)
321
- * [`affinidi iam get-policies`](#affinidi-iam-get-policies)
322
- * [`affinidi iam list-principals`](#affinidi-iam-list-principals)
323
- * [`affinidi iam remove-principal`](#affinidi-iam-remove-principal)
324
- * [`affinidi iam update-policies`](#affinidi-iam-update-policies)
325
- * [`affinidi login add-user-to-group`](#affinidi-login-add-user-to-group)
326
- * [`affinidi login create-config`](#affinidi-login-create-config)
327
- * [`affinidi login create-group`](#affinidi-login-create-group)
328
- * [`affinidi login delete-config`](#affinidi-login-delete-config)
329
- * [`affinidi login delete-group`](#affinidi-login-delete-group)
330
- * [`affinidi login export-configs`](#affinidi-login-export-configs)
331
- * [`affinidi login export-groups`](#affinidi-login-export-groups)
332
- * [`affinidi login get-config`](#affinidi-login-get-config)
333
- * [`affinidi login get-group`](#affinidi-login-get-group)
334
- * [`affinidi login import-configs`](#affinidi-login-import-configs)
335
- * [`affinidi login import-groups`](#affinidi-login-import-groups)
336
- * [`affinidi login list-configs`](#affinidi-login-list-configs)
337
- * [`affinidi login list-groups`](#affinidi-login-list-groups)
338
- * [`affinidi login list-users-in-group`](#affinidi-login-list-users-in-group)
339
- * [`affinidi login remove-user-from-group`](#affinidi-login-remove-user-from-group)
340
- * [`affinidi login update-config`](#affinidi-login-update-config)
341
- * [`affinidi project create-project`](#affinidi-project-create-project)
342
- * [`affinidi project get-active-project`](#affinidi-project-get-active-project)
343
- * [`affinidi project list-projects`](#affinidi-project-list-projects)
344
- * [`affinidi project select-project`](#affinidi-project-select-project)
345
- * [`affinidi project update-project`](#affinidi-project-update-project)
346
- * [`affinidi search`](#affinidi-search)
347
- * [`affinidi start`](#affinidi-start)
348
- * [`affinidi stop`](#affinidi-stop)
349
- * [`affinidi token create-token`](#affinidi-token-create-token)
350
- * [`affinidi token delete-token`](#affinidi-token-delete-token)
351
- * [`affinidi token get-token`](#affinidi-token-get-token)
352
- * [`affinidi token list-tokens`](#affinidi-token-list-tokens)
353
- * [`affinidi token update-token`](#affinidi-token-update-token)
354
- * [`affinidi whoami`](#affinidi-whoami)
355
-
356
- ## `affinidi autocomplete [SHELL]`
357
-
358
- display autocomplete installation instructions
359
-
360
- ```
361
- USAGE
362
- $ affinidi autocomplete [SHELL] [-r]
363
-
364
- ARGUMENTS
365
- SHELL (zsh|bash|powershell) Shell type
366
-
367
- FLAGS
368
- -r, --refresh-cache Refresh cache (ignores displaying instructions)
369
-
370
- DESCRIPTION
371
- display autocomplete installation instructions
372
-
373
- EXAMPLES
374
- $ affinidi autocomplete
375
-
376
- $ affinidi autocomplete bash
377
-
378
- $ affinidi autocomplete zsh
379
-
380
- $ affinidi autocomplete powershell
381
-
382
- $ affinidi autocomplete --refresh-cache
383
- ```
384
-
385
- _See code: [@oclif/plugin-autocomplete](https://github.com/oclif/plugin-autocomplete/blob/v2.3.6/src/commands/autocomplete/index.ts)_
386
-
387
- ## `affinidi commands`
388
-
389
- list all the commands
390
-
391
- ```
392
- USAGE
393
- $ affinidi commands [--json] [-h] [--hidden] [--tree] [--columns <value> | -x] [--sort <value>] [--filter
394
- <value>] [--output csv|json|yaml | | [--csv | --no-truncate]] [--no-header | ]
395
-
396
- FLAGS
397
- -h, --help Show CLI help.
398
- -x, --extended show extra columns
399
- --columns=<value> only show provided columns (comma-separated)
400
- --csv output is csv format [alias: --output=csv]
401
- --filter=<value> filter property by partial string matching, ex: name=foo
402
- --hidden show hidden commands
403
- --no-header hide table header from output
404
- --no-truncate do not truncate output to fit screen
405
- --output=<option> output in a more machine friendly format
406
- <options: csv|json|yaml>
407
- --sort=<value> property to sort by (prepend '-' for descending)
408
- --tree show tree of commands
409
-
410
- GLOBAL FLAGS
411
- --json Format output as json.
412
-
413
- DESCRIPTION
414
- list all the commands
415
- ```
416
-
417
- _See code: [@oclif/plugin-commands](https://github.com/oclif/plugin-commands/blob/v2.2.25/src/commands/commands.ts)_
418
-
419
- ## `affinidi generate app`
420
-
421
- Generates a reference application that integrates Affinidi Login. Requires git
422
-
423
- ```
424
- USAGE
425
- $ affinidi generate app [--json] [--no-color] [--no-input] [-a <value>] [-f <value>] [-l <value>] [-p <value>]
426
- [--force]
427
-
428
- FLAGS
429
- -a, --provider=<value> Authentication provider for the reference app
430
- -f, --framework=<value> Framework for the reference app
431
- -l, --library=<value> Library for the reference app
432
- -p, --path=<value> Relative or absolute path where reference application should be cloned into
433
- --force Override destination directory if exists
434
-
435
- GLOBAL FLAGS
436
- --json Format output as json.
437
- --no-color Disables color in the output. If you have trouble distinguishing colors, consider using this flag.
438
- --no-input Disables all the interactive prompts
439
-
440
- EXAMPLES
441
- $ affinidi generate app
442
-
443
- $ affinidi generate app -p "../my-app" -f django -a affinidi
444
-
445
- $ affinidi generate app --path "../my-app" --framework django --provider affinidi --force
446
- ```
447
-
448
- ## `affinidi help [COMMANDS]`
449
-
450
- Display help for affinidi.
451
-
452
- ```
453
- USAGE
454
- $ affinidi help [COMMANDS] [-n]
455
-
456
- ARGUMENTS
457
- COMMANDS Command to show help for.
458
-
459
- FLAGS
460
- -n, --nested-commands Include all nested commands in the output.
461
-
462
- DESCRIPTION
463
- Display help for affinidi.
464
- ```
465
-
466
- _See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v5.2.18/src/commands/help.ts)_
467
-
468
- ## `affinidi iam add-principal`
469
-
470
- Adds a principal (user or token) to the active project
471
-
472
- ```
473
- USAGE
474
- $ affinidi iam add-principal [--json] [--no-color] [--no-input] [-i <value>] [-t token|user]
475
-
476
- FLAGS
477
- -i, --principal-id=<value> ID of the principal
478
- -t, --principal-type=<option> Type of the principal
479
- <options: token|user>
480
-
481
- GLOBAL FLAGS
482
- --json Format output as json.
483
- --no-color Disables color in the output. If you have trouble distinguishing colors, consider using this flag.
484
- --no-input Disables all the interactive prompts
485
-
486
- DESCRIPTION
487
- Adds a principal (user or token) to the active project
488
-
489
- To change your active project, use command affinidi project select-project
490
-
491
- EXAMPLES
492
- $ affinidi iam add-principal -i <uuid>
493
-
494
- $ affinidi iam add-principal --principal-id <uuid> --principal-type token
495
-
496
- FLAG DESCRIPTIONS
497
- -i, --principal-id=<value> ID of the principal
498
-
499
- Get a list of possible IDs with command affinidi token list-tokens
500
- ```
501
-
502
- ## `affinidi iam get-policies`
503
-
504
- Gets the policies of a principal (user or token)
505
-
506
- ```
507
- USAGE
508
- $ affinidi iam get-policies [--json] [--no-color] [--no-input] [-i <value>] [-t token|user]
509
-
510
- FLAGS
511
- -i, --principal-id=<value> ID of the principal
512
- -t, --principal-type=<option> Type of the principal
513
- <options: token|user>
514
-
515
- GLOBAL FLAGS
516
- --json Format output as json.
517
- --no-color Disables color in the output. If you have trouble distinguishing colors, consider using this flag.
518
- --no-input Disables all the interactive prompts
519
-
520
- DESCRIPTION
521
- Gets the policies of a principal (user or token)
522
-
523
- Make sure the principal you are working with is part of the active project
524
- Use command affinidi project select-project to change your active project
525
-
526
- EXAMPLES
527
- $ affinidi iam get-policies -i <uuid>
528
-
529
- $ affinidi iam get-policies --principal-id <uuid> --principal-type token
530
-
531
- FLAG DESCRIPTIONS
532
- -i, --principal-id=<value> ID of the principal
533
-
534
- Get a list of possible IDs with command affinidi token list-tokens
535
- ```
536
-
537
- ## `affinidi iam list-principals`
538
-
539
- Lists the principals (users and tokens) in the active project
540
-
541
- ```
542
- USAGE
543
- $ affinidi iam list-principals [--json] [--no-color] [--no-input]
544
-
545
- GLOBAL FLAGS
546
- --json Format output as json.
547
- --no-color Disables color in the output. If you have trouble distinguishing colors, consider using this flag.
548
- --no-input Disables all the interactive prompts
549
-
550
- DESCRIPTION
551
- Lists the principals (users and tokens) in the active project
552
-
553
- To change your active project, use command affinidi project select-project
554
-
555
- EXAMPLES
556
- $ affinidi iam list-principals
557
- ```
558
-
559
- ## `affinidi iam remove-principal`
560
-
561
- Removes a principal (user or token) from the active project
562
-
563
- ```
564
- USAGE
565
- $ affinidi iam remove-principal [--json] [--no-color] [--no-input] [-i <value>] [-t token|user]
566
-
567
- FLAGS
568
- -i, --principal-id=<value> ID of the principal
569
- -t, --principal-type=<option> Type of the principal
570
- <options: token|user>
571
-
572
- GLOBAL FLAGS
573
- --json Format output as json.
574
- --no-color Disables color in the output. If you have trouble distinguishing colors, consider using this flag.
575
- --no-input Disables all the interactive prompts
576
-
577
- DESCRIPTION
578
- Removes a principal (user or token) from the active project
579
-
580
- To change your active project, use command affinidi project select-project
581
-
582
- EXAMPLES
583
- $ affinidi iam remove-principal -i <uuid>
584
-
585
- $ affinidi iam remove-principal --principal-id <uuid> --principal-type token
586
-
587
- FLAG DESCRIPTIONS
588
- -i, --principal-id=<value> ID of the principal
589
-
590
- Get a list of possible IDs with command affinidi token list-tokens
591
- ```
592
-
593
- ## `affinidi iam update-policies`
594
-
595
- Updates the policies of a principal (user or token) in the active project
596
-
597
- ```
598
- USAGE
599
- $ affinidi iam update-policies [--json] [--no-color] [--no-input] [-i <value>] [-t token|user] [-f <value>]
600
-
601
- FLAGS
602
- -f, --file=<value> Location of a json file containing principal policies
603
- -i, --principal-id=<value> ID of the principal
604
- -t, --principal-type=<option> Type of the principal
605
- <options: token|user>
606
-
607
- GLOBAL FLAGS
608
- --json Format output as json.
609
- --no-color Disables color in the output. If you have trouble distinguishing colors, consider using this flag.
610
- --no-input Disables all the interactive prompts
611
-
612
- DESCRIPTION
613
- Updates the policies of a principal (user or token) in the active project
614
-
615
- Make sure the principal you are working with is part of the active project
616
- Use command affinidi project select-project to change your active project
617
-
618
- EXAMPLES
619
- $ affinidi iam update-policies -i <uuid>
620
-
621
- $ affinidi iam update-policies --principal-id <uuid> --principal-type token --file policies.json
622
-
623
- FLAG DESCRIPTIONS
624
- -i, --principal-id=<value> ID of the principal
625
-
626
- Get a list of possible IDs with command affinidi token list-tokens
627
- ```
628
-
629
- ## `affinidi login add-user-to-group`
630
-
631
- Adds a user to a user group
632
-
633
- ```
634
- USAGE
635
- $ affinidi login add-user-to-group [--json] [--no-color] [--no-input] [--group-name <value>] [--user-id <value>]
636
-
637
- FLAGS
638
- --group-name=<value> Name of the user group
639
- --user-id=<value> Id of the user. Currently the user's DID is supported.
640
-
641
- GLOBAL FLAGS
642
- --json Format output as json.
643
- --no-color Disables color in the output. If you have trouble distinguishing colors, consider using this flag.
644
- --no-input Disables all the interactive prompts
645
-
646
- EXAMPLES
647
- $ affinidi login add-user-to-group --group-name my_group --user-id did:key:12345
648
- ```
649
-
650
- ## `affinidi login create-config`
651
-
652
- Creates a login configuration in your active project
653
-
654
- ```
655
- USAGE
656
- $ affinidi login create-config [--json] [--no-color] [--no-input] [-f <value> | -n <value> | -u <value> |
657
- --token-endpoint-auth-method client_secret_basic|client_secret_post|none | --claim-format array|map | --client-name
658
- <value> | --client-origin <value> | --client-logo <value>]
659
-
660
- FLAGS
661
- -f, --file=<value> Location of a json file containing login configuration data
662
- -n, --name=<value> Name of the login configuration
663
- -u, --redirect-uris=<value> OAuth 2.0 redirect URIs, separated by space
664
- --claim-format=<option> ID token claims output format. Defaults to array
665
- <options: array|map>
666
- --client-logo=<value> URL of a logo for the client, displayed in the consent page
667
- --client-name=<value> Name of the client, displayed in the consent page
668
- --client-origin=<value> Origin of the client, displayed in the consent page
669
- --token-endpoint-auth-method=<option> Client authentication method for the token endpoint. Defaults to
670
- client_secret_post
671
- <options: client_secret_basic|client_secret_post|none>
672
-
673
- GLOBAL FLAGS
674
- --json Format output as json.
675
- --no-color Disables color in the output. If you have trouble distinguishing colors, consider using this flag.
676
- --no-input Disables all the interactive prompts
677
-
678
- EXAMPLES
679
- $ affinidi login create-config
680
-
681
- $ affinidi login create-config -f loginConfig.json
682
-
683
- $ affinidi login create-config -n MyLoginConfig -u http://localhost:8080/callback
684
-
685
- $ affinidi login create-config --name "My Login Config" --redirect-uris "https://my-fancy-project.eu.auth0.com/login/callback http://localhost:8080/callback" --token-endpoint-auth-method client_secret_post --claim-format array --client-name "My App Name" --client-origin http://localhost:8080 --client-logo http://localhost:8080/logo
686
-
687
- FLAG DESCRIPTIONS
688
- --token-endpoint-auth-method=client_secret_basic|client_secret_post|none
689
-
690
- Client authentication method for the token endpoint. Defaults to client_secret_post
691
-
692
- The options are:
693
- client_secret_post: (default) Send client_id and client_secret as application/x-www-form-urlencoded in the HTTP body
694
- client_secret_basic: Send client_id and client_secret as application/x-www-form-urlencoded encoded in the HTTP
695
- Authorization header
696
- none: For public clients (native/mobile apps) which can not have a secret
697
- ```
698
-
699
- ## `affinidi login create-group`
700
-
701
- Create a user group in your active project
702
-
703
- ```
704
- USAGE
705
- $ affinidi login create-group [--json] [--no-color] [--no-input] [-n <value>]
706
-
707
- FLAGS
708
- -n, --name=<value> Name of the user group, that follows url-friendly pattern ^[a-z_]+$
709
-
710
- GLOBAL FLAGS
711
- --json Format output as json.
712
- --no-color Disables color in the output. If you have trouble distinguishing colors, consider using this flag.
713
- --no-input Disables all the interactive prompts
714
-
715
- EXAMPLES
716
- $ affinidi login create-group -n my_new_group
717
-
718
- $ affinidi login create-group --name my_new_group
719
- ```
720
-
721
- ## `affinidi login delete-config`
722
-
723
- Deletes a login configuration from your active project
724
-
725
- ```
726
- USAGE
727
- $ affinidi login delete-config [--json] [--no-color] [--no-input] [-i <value>]
728
-
729
- FLAGS
730
- -i, --id=<value> ID of the login configuration
731
-
732
- GLOBAL FLAGS
733
- --json Format output as json.
734
- --no-color Disables color in the output. If you have trouble distinguishing colors, consider using this flag.
735
- --no-input Disables all the interactive prompts
736
-
737
- EXAMPLES
738
- $ affinidi login delete-config -i <value>
739
-
740
- $ affinidi login delete-config --id <value>
741
- ```
742
-
743
- ## `affinidi login delete-group`
744
-
745
- Deletes a user group from your active project
746
-
747
- ```
748
- USAGE
749
- $ affinidi login delete-group [--json] [--no-color] [--no-input] [-n <value>]
750
-
751
- FLAGS
752
- -n, --name=<value> Name of the user group
753
-
754
- GLOBAL FLAGS
755
- --json Format output as json.
756
- --no-color Disables color in the output. If you have trouble distinguishing colors, consider using this flag.
757
- --no-input Disables all the interactive prompts
758
-
759
- EXAMPLES
760
- $ affinidi login delete-group -n my_group
761
-
762
- $ affinidi login delete-group --name my_group
763
- ```
764
-
765
- ## `affinidi login export-configs`
766
-
767
- Export selected login configurations of your active project
768
-
769
- ```
770
- USAGE
771
- $ affinidi login export-configs [--json] [--no-color] [--no-input] [-i <value>] [-p <value>]
772
-
773
- FLAGS
774
- -i, --ids=<value> IDs of the login configurations to export, separated by space
775
- -p, --path=<value> Relative or absolute path where configurations should be exported
776
-
777
- GLOBAL FLAGS
778
- --json Format output as json.
779
- --no-color Disables color in the output. If you have trouble distinguishing colors, consider using this flag.
780
- --no-input Disables all the interactive prompts
781
-
782
- EXAMPLES
783
- $ affinidi login export-configs
784
-
785
- $ affinidi login export-configs --ids "configurationId1 configurationId2" --path "../my-configs.json"
786
- ```
787
-
788
- ## `affinidi login export-groups`
789
-
790
- Export selected user groups with its users
791
-
792
- ```
793
- USAGE
794
- $ affinidi login export-groups [--json] [--no-color] [--no-input] [-n <value>] [-p <value>]
795
-
796
- FLAGS
797
- -n, --names=<value> Group names to export, separated by space
798
- -p, --path=<value> Relative or absolute path where user groups should be exported
799
-
800
- GLOBAL FLAGS
801
- --json Format output as json.
802
- --no-color Disables color in the output. If you have trouble distinguishing colors, consider using this flag.
803
- --no-input Disables all the interactive prompts
804
-
805
- EXAMPLES
806
- $ affinidi login export-groups
807
-
808
- $ affinidi login export-groups --names "groupName1 groupName2" --path "../my-user-groups.json"
809
- ```
810
-
811
- ## `affinidi login get-config`
812
-
813
- Gets the details of a login configuration in your active project
814
-
815
- ```
816
- USAGE
817
- $ affinidi login get-config [--json] [--no-color] [--no-input] [-i <value>]
818
-
819
- FLAGS
820
- -i, --id=<value> ID of the login configuration
821
-
822
- GLOBAL FLAGS
823
- --json Format output as json.
824
- --no-color Disables color in the output. If you have trouble distinguishing colors, consider using this flag.
825
- --no-input Disables all the interactive prompts
826
-
827
- EXAMPLES
828
- $ affinidi login get-config -i <value>
829
-
830
- $ affinidi login get-config --id <value>
831
- ```
832
-
833
- ## `affinidi login get-group`
834
-
835
- Gets the details of a user group
836
-
837
- ```
838
- USAGE
839
- $ affinidi login get-group [--json] [--no-color] [--no-input] [-n <value>]
840
-
841
- FLAGS
842
- -n, --name=<value> Name of the user group
843
-
844
- GLOBAL FLAGS
845
- --json Format output as json.
846
- --no-color Disables color in the output. If you have trouble distinguishing colors, consider using this flag.
847
- --no-input Disables all the interactive prompts
848
-
849
- EXAMPLES
850
- $ affinidi login get-group -n my_group
851
-
852
- $ affinidi login get-group --name my_group
853
- ```
854
-
855
- ## `affinidi login import-configs`
856
-
857
- Import login configurations in your active project
858
-
859
- ```
860
- USAGE
861
- $ affinidi login import-configs [--json] [--no-color] [--no-input] [-p <value>]
862
-
863
- FLAGS
864
- -p, --path=<value> Path to file with configurations that should be imported
865
-
866
- GLOBAL FLAGS
867
- --json Format output as json.
868
- --no-color Disables color in the output. If you have trouble distinguishing colors, consider using this flag.
869
- --no-input Disables all the interactive prompts
870
-
871
- EXAMPLES
872
- $ affinidi login import-configs
873
-
874
- $ affinidi login import-configs --path "../my-configs.json"
875
- ```
876
-
877
- ## `affinidi login import-groups`
878
-
879
- Import groups with its users
880
-
881
- ```
882
- USAGE
883
- $ affinidi login import-groups [--json] [--no-color] [--no-input] [-p <value>]
884
-
885
- FLAGS
886
- -p, --path=<value> Path to file with groups that should be imported
887
-
888
- GLOBAL FLAGS
889
- --json Format output as json.
890
- --no-color Disables color in the output. If you have trouble distinguishing colors, consider using this flag.
891
- --no-input Disables all the interactive prompts
892
-
893
- EXAMPLES
894
- $ affinidi login import-groups
895
-
896
- $ affinidi login import-groups --path "../my-groups.json"
897
- ```
898
-
899
- ## `affinidi login list-configs`
900
-
901
- Lists login configurations in your active project
902
-
903
- ```
904
- USAGE
905
- $ affinidi login list-configs [--json] [--no-color] [--no-input]
906
-
907
- GLOBAL FLAGS
908
- --json Format output as json.
909
- --no-color Disables color in the output. If you have trouble distinguishing colors, consider using this flag.
910
- --no-input Disables all the interactive prompts
911
-
912
- EXAMPLES
913
- $ affinidi login list-configs
914
- ```
915
-
916
- ## `affinidi login list-groups`
917
-
918
- Lists user groups in your active project
919
-
920
- ```
921
- USAGE
922
- $ affinidi login list-groups [--json] [--no-color] [--no-input]
923
-
924
- GLOBAL FLAGS
925
- --json Format output as json.
926
- --no-color Disables color in the output. If you have trouble distinguishing colors, consider using this flag.
927
- --no-input Disables all the interactive prompts
928
-
929
- EXAMPLES
930
- $ affinidi login list-groups
931
- ```
932
-
933
- ## `affinidi login list-users-in-group`
934
-
935
- Use this command to list users in the user group
936
-
937
- ```
938
- USAGE
939
- $ affinidi login list-users-in-group [--json] [--no-color] [--no-input] [--group-name <value>]
940
-
941
- FLAGS
942
- --group-name=<value> Name of the user group
943
-
944
- GLOBAL FLAGS
945
- --json Format output as json.
946
- --no-color Disables color in the output. If you have trouble distinguishing colors, consider using this flag.
947
- --no-input Disables all the interactive prompts
948
-
949
- EXAMPLES
950
- $ affinidi login list-users-in-group --group-name my_group
951
- ```
952
-
953
- ## `affinidi login remove-user-from-group`
954
-
955
- Removes a user from a user group
956
-
957
- ```
958
- USAGE
959
- $ affinidi login remove-user-from-group [--json] [--no-color] [--no-input] [--group-name <value>] [--user-id <value>]
960
-
961
- FLAGS
962
- --group-name=<value> Name of the user group
963
- --user-id=<value> ID of the user
964
-
965
- GLOBAL FLAGS
966
- --json Format output as json.
967
- --no-color Disables color in the output. If you have trouble distinguishing colors, consider using this flag.
968
- --no-input Disables all the interactive prompts
969
-
970
- EXAMPLES
971
- $ affinidi login remove-user-from-group --group-name my_group --user-id did:key:12345
972
- ```
973
-
974
- ## `affinidi login update-config`
975
-
976
- Updates a login configuration
977
-
978
- ```
979
- USAGE
980
- $ affinidi login update-config [--json] [--no-color] [--no-input] [-i <value>] [-f <value> | -n <value> | -u <value> |
981
- --token-endpoint-auth-method client_secret_basic|client_secret_post|none | --client-name <value> | --client-origin
982
- <value> | --client-logo <value>]
983
-
984
- FLAGS
985
- -f, --file=<value> Location of a json file containing login configuration data
986
- -i, --id=<value> ID of the login configuration
987
- -n, --name=<value> Name of the login configuration
988
- -u, --redirect-uris=<value> OAuth 2.0 redirect URIs, separated by space
989
- --client-logo=<value> URL of a logo for the client, displayed in the consent page
990
- --client-name=<value> Name of the client, displayed in the consent page
991
- --client-origin=<value> Origin of the client, displayed in the consent page
992
- --token-endpoint-auth-method=<option> Client authentication method for the token endpoint. Defaults to
993
- client_secret_post
994
- <options: client_secret_basic|client_secret_post|none>
995
-
996
- GLOBAL FLAGS
997
- --json Format output as json.
998
- --no-color Disables color in the output. If you have trouble distinguishing colors, consider using this flag.
999
- --no-input Disables all the interactive prompts
1000
-
1001
- EXAMPLES
1002
- $ affinidi login update-config --id <value> -f loginConfig.json
1003
-
1004
- $ affinidi login update-config --id <value> -u http://localhost:8080/callback
1005
-
1006
- $ affinidi login update-config --id <value> --name "My Login Config" --redirect-uris "https://my-fancy-project.eu.auth0.com/login/callback http://localhost:8080/callback" --token-endpoint-auth-method client_secret_post --client-name "My App Name" --client-origin http://localhost:8080 --client-logo http://localhost:8080/logo
1007
-
1008
- FLAG DESCRIPTIONS
1009
- --token-endpoint-auth-method=client_secret_basic|client_secret_post|none
1010
-
1011
- Client authentication method for the token endpoint. Defaults to client_secret_post
1012
-
1013
- The options are:
1014
- client_secret_post: (default) Send client_id and client_secret as application/x-www-form-urlencoded in the HTTP body
1015
- client_secret_basic: Send client_id and client_secret as application/x-www-form-urlencoded encoded in the HTTP
1016
- Authorization header
1017
- none: For public clients (native/mobile apps) which can not have a secret
1018
- ```
1019
-
1020
- ## `affinidi project create-project`
1021
-
1022
- Creates a project and sets it as the active project
1023
-
1024
- ```
1025
- USAGE
1026
- $ affinidi project create-project [--json] [--no-color] [--no-input] [-n <value>] [-d <value>]
1027
-
1028
- FLAGS
1029
- -d, --description=<value> Description of the project
1030
- -n, --name=<value> Name of the project
1031
-
1032
- GLOBAL FLAGS
1033
- --json Format output as json.
1034
- --no-color Disables color in the output. If you have trouble distinguishing colors, consider using this flag.
1035
- --no-input Disables all the interactive prompts
1036
-
1037
- EXAMPLES
1038
- $ affinidi project create-project -n MyProjectName
1039
-
1040
- $ affinidi project create-project --name "My project name"
1041
- ```
1042
-
1043
- ## `affinidi project get-active-project`
1044
-
1045
- Gets the current active project
1046
-
1047
- ```
1048
- USAGE
1049
- $ affinidi project get-active-project [--json] [--no-color] [--no-input]
1050
-
1051
- GLOBAL FLAGS
1052
- --json Format output as json.
1053
- --no-color Disables color in the output. If you have trouble distinguishing colors, consider using this flag.
1054
- --no-input Disables all the interactive prompts
1055
-
1056
- EXAMPLES
1057
- $ affinidi project get-active-project
1058
- ```
1059
-
1060
- ## `affinidi project list-projects`
1061
-
1062
- Lists your projects
1063
-
1064
- ```
1065
- USAGE
1066
- $ affinidi project list-projects [--json] [--no-color] [--no-input]
1067
-
1068
- GLOBAL FLAGS
1069
- --json Format output as json.
1070
- --no-color Disables color in the output. If you have trouble distinguishing colors, consider using this flag.
1071
- --no-input Disables all the interactive prompts
1072
-
1073
- EXAMPLES
1074
- $ affinidi project list-projects
1075
- ```
1076
-
1077
- ## `affinidi project select-project`
1078
-
1079
- Sets a project as the active project
1080
-
1081
- ```
1082
- USAGE
1083
- $ affinidi project select-project [--json] [--no-color] [--no-input] [-i <value>]
1084
-
1085
- FLAGS
1086
- -i, --project-id=<value> ID of the project
1087
-
1088
- GLOBAL FLAGS
1089
- --json Format output as json.
1090
- --no-color Disables color in the output. If you have trouble distinguishing colors, consider using this flag.
1091
- --no-input Disables all the interactive prompts
1092
-
1093
- EXAMPLES
1094
- $ affinidi project select-project
1095
-
1096
- $ affinidi project select-project -i <project-id>
1097
-
1098
- $ affinidi project select-project --project-id <project-id>
1099
- ```
1100
-
1101
- ## `affinidi project update-project`
1102
-
1103
- Updates project details
1104
-
1105
- ```
1106
- USAGE
1107
- $ affinidi project update-project [--json] [--no-color] [--no-input] [-i <value>] [-n <value>] [-d <value>]
1108
-
1109
- FLAGS
1110
- -d, --description=<value> Description of the project
1111
- -i, --id=<value> Project Id
1112
- -n, --name=<value> Name of the project
1113
-
1114
- GLOBAL FLAGS
1115
- --json Format output as json.
1116
- --no-color Disables color in the output. If you have trouble distinguishing colors, consider using this flag.
1117
- --no-input Disables all the interactive prompts
1118
-
1119
- EXAMPLES
1120
- $ affinidi project update-project -n MyUpdatedProjectName -d MyUpdatedProjectDescription
1121
-
1122
- $ affinidi project update-project --name="My project name" --description="My project description
1123
- ```
1124
-
1125
- ## `affinidi search`
1126
-
1127
- Search for a command.
1128
-
1129
- ```
1130
- USAGE
1131
- $ affinidi search
1132
-
1133
- DESCRIPTION
1134
- Search for a command.
1135
-
1136
- Once you select a command, hit enter and it will show the help for that command.
1137
- ```
1138
-
1139
- _See code: [@oclif/plugin-search](https://github.com/oclif/plugin-search/blob/v0.0.22/dist/commands/search.ts)_
1140
-
1141
- ## `affinidi start`
1142
-
1143
- Log in to Affinidi
1144
-
1145
- ```
1146
- USAGE
1147
- $ affinidi start [--json] [--no-color] [--no-input]
1148
-
1149
- GLOBAL FLAGS
1150
- --json Format output as json.
1151
- --no-color Disables color in the output. If you have trouble distinguishing colors, consider using this flag.
1152
- --no-input Disables all the interactive prompts
1153
-
1154
- EXAMPLES
1155
- $ affinidi start
1156
- ```
1157
-
1158
- _See code: [dist/commands/start.ts](https://github.com/affinidi/affinidi-cli/blob/v2.2.0/dist/commands/start.ts)_
1159
-
1160
- ## `affinidi stop`
1161
-
1162
- Log out from Affinidi
1163
-
1164
- ```
1165
- USAGE
1166
- $ affinidi stop [--json] [--no-color] [--no-input]
1167
-
1168
- GLOBAL FLAGS
1169
- --json Format output as json.
1170
- --no-color Disables color in the output. If you have trouble distinguishing colors, consider using this flag.
1171
- --no-input Disables all the interactive prompts
1172
-
1173
- EXAMPLES
1174
- $ affinidi stop
1175
- ```
1176
-
1177
- _See code: [dist/commands/stop.ts](https://github.com/affinidi/affinidi-cli/blob/v2.2.0/dist/commands/stop.ts)_
1178
-
1179
- ## `affinidi token create-token`
1180
-
1181
- Creates a Personal Access Token (PAT)
1182
-
1183
- ```
1184
- USAGE
1185
- $ affinidi token create-token [--json] [--no-color] [--no-input] [-n <value>] [-k <value>] [-f <value>] [--algorithm
1186
- RS256|RS512|ES256|ES512]
1187
-
1188
- FLAGS
1189
- -f, --public-key-file=<value> Location of the public key PEM file
1190
- -k, --key-id=<value> Identifier of the key (kid)
1191
- -n, --name=<value> Name of the Personal Access Token, at least 8 chars long
1192
- --algorithm=<option> [default: RS256] The specific cryptographic algorithm used with the key
1193
- <options: RS256|RS512|ES256|ES512>
1194
-
1195
- GLOBAL FLAGS
1196
- --json Format output as json.
1197
- --no-color Disables color in the output. If you have trouble distinguishing colors, consider using this flag.
1198
- --no-input Disables all the interactive prompts
1199
-
1200
- EXAMPLES
1201
- $ affinidi token create-token -n MyNewToken -k MyKeyID -f publicKey.pem
1202
-
1203
- $ affinidi token create-token --name "My new token" --key-id MyKeyID --public-key-file publicKey.pem --algorithm RS256
1204
- ```
1205
-
1206
- ## `affinidi token delete-token`
1207
-
1208
- Deletes a Personal Access Token (PAT)
1209
-
1210
- ```
1211
- USAGE
1212
- $ affinidi token delete-token [--json] [--no-color] [--no-input] [-i <value>]
1213
-
1214
- FLAGS
1215
- -i, --token-id=<value> ID of the Personal Access Token
1216
-
1217
- GLOBAL FLAGS
1218
- --json Format output as json.
1219
- --no-color Disables color in the output. If you have trouble distinguishing colors, consider using this flag.
1220
- --no-input Disables all the interactive prompts
1221
-
1222
- EXAMPLES
1223
- $ affinidi token delete-token -i <uuid>
1224
-
1225
- $ affinidi token delete-token --token-id <uuid>
1226
- ```
1227
-
1228
- ## `affinidi token get-token`
1229
-
1230
- Gets the details of a Personal Access Token (PAT)
1231
-
1232
- ```
1233
- USAGE
1234
- $ affinidi token get-token [--json] [--no-color] [--no-input] [-i <value>]
1235
-
1236
- FLAGS
1237
- -i, --token-id=<value> ID of the Personal Access Token
1238
-
1239
- GLOBAL FLAGS
1240
- --json Format output as json.
1241
- --no-color Disables color in the output. If you have trouble distinguishing colors, consider using this flag.
1242
- --no-input Disables all the interactive prompts
1243
-
1244
- EXAMPLES
1245
- $ affinidi token get-token -i <uuid>
1246
-
1247
- $ affinidi token get-token --token-id <uuid>
1248
- ```
1249
-
1250
- ## `affinidi token list-tokens`
1251
-
1252
- Lists your Personal Access Tokens (PATs)
1253
-
1254
- ```
1255
- USAGE
1256
- $ affinidi token list-tokens [--json] [--no-color] [--no-input]
1257
-
1258
- GLOBAL FLAGS
1259
- --json Format output as json.
1260
- --no-color Disables color in the output. If you have trouble distinguishing colors, consider using this flag.
1261
- --no-input Disables all the interactive prompts
1262
-
1263
- EXAMPLES
1264
- $ affinidi token list-tokens
1265
- ```
1266
-
1267
- ## `affinidi token update-token`
1268
-
1269
- Updates a Personal Access Token (PAT)
1270
-
1271
- ```
1272
- USAGE
1273
- $ affinidi token update-token [--json] [--no-color] [--no-input] [-i <value>] [-n <value>] [-k <value>] [-f <value>]
1274
- [--algorithm RS256|RS512|ES256|ES512]
1275
-
1276
- FLAGS
1277
- -f, --public-key-file=<value> Location of the public key PEM file
1278
- -i, --token-id=<value> ID of the Personal Access Token
1279
- -k, --key-id=<value> Identifier of the key (kid)
1280
- -n, --name=<value> Name of the Personal Access Token, at least 8 chars long
1281
- --algorithm=<option> [default: RS256] The specific cryptographic algorithm used with the key
1282
- <options: RS256|RS512|ES256|ES512>
1283
-
1284
- GLOBAL FLAGS
1285
- --json Format output as json.
1286
- --no-color Disables color in the output. If you have trouble distinguishing colors, consider using this flag.
1287
- --no-input Disables all the interactive prompts
1288
-
1289
- EXAMPLES
1290
- $ affinidi token update-token -i <uuid> -n MyNewToken -k MyKeyID -f publicKey.pem
1291
-
1292
- $ affinidi token update-token --token-id <uuid> --name "My new token" --key-id "My key ID" --public-key-file publicKey.pem --algorithm RS256
1293
- ```
1294
-
1295
- ## `affinidi whoami`
1296
-
1297
- Returns user's subject, projects, and token details from the current session.
1298
-
1299
- ```
1300
- USAGE
1301
- $ affinidi whoami [--json] [--no-color] [--no-input]
1302
-
1303
- GLOBAL FLAGS
1304
- --json Format output as json.
1305
- --no-color Disables color in the output. If you have trouble distinguishing colors, consider using this flag.
1306
- --no-input Disables all the interactive prompts
1307
-
1308
- EXAMPLES
1309
- $ affinidi whoami
1310
- ```
1311
-
1312
- _See code: [dist/commands/whoami.ts](https://github.com/affinidi/affinidi-cli/blob/v2.2.0/dist/commands/whoami.ts)_
1313
- <!-- commandsstop -->