1
1
= Manage your Astra organization with the {product}
2
2
:navtitle: Astra administration
3
3
4
- Use the {product} to manage your Astra organization's users, roles, and tokens .
4
+ Use the {product} to manage your Astra organization.
5
5
6
6
== Get organization details
7
7
@@ -28,6 +28,9 @@ astra org
28
28
29
29
=== `org` options
30
30
31
+ .Expand to see all `org` options
32
+ [%collapsible]
33
+ ====
31
34
[source,console]
32
35
----
33
36
NAME
@@ -42,6 +45,7 @@ SYNOPSIS
42
45
Where * indicates the default command(s)
43
46
See 'astra help org <command>' for more information on a specific command.
44
47
----
48
+ ====
45
49
46
50
== List users
47
51
@@ -69,6 +73,9 @@ astra user list
69
73
70
74
=== `user list` options
71
75
76
+ .Expand to see all `user list` options
77
+ [%collapsible]
78
+ ====
72
79
[source,console]
73
80
----
74
81
NAME
@@ -102,6 +109,7 @@ OPTIONS
102
109
-v, --verbose
103
110
Verbose mode with log in console
104
111
----
112
+ ====
105
113
106
114
== Add a user
107
115
@@ -128,6 +136,9 @@ If you don't specify a role when inviting a user, the user is automatically assi
128
136
129
137
=== `user invite` options
130
138
139
+ .Expand to see all `user invite` options
140
+ [%collapsible]
141
+ ====
131
142
[source,console]
132
143
----
133
144
NAME
@@ -173,6 +184,7 @@ OPTIONS
173
184
<EMAIL>
174
185
User Email
175
186
----
187
+ ====
176
188
177
189
Use the `-r`/`--role` option to specify a role when inviting a user:
178
190
@@ -240,6 +252,9 @@ Replace `**USER**` with the email address or ID of the user you want to get info
240
252
241
253
=== `user get` options
242
254
255
+ .Expand to see all `user get` options
256
+ [%collapsible]
257
+ ====
243
258
[source,console]
244
259
----
245
260
NAME
@@ -281,9 +296,13 @@ OPTIONS
281
296
<EMAIL>
282
297
User Email
283
298
----
299
+ ====
284
300
285
301
=== `user describe` options
286
302
303
+ .Expand to see all `user describe` options
304
+ [%collapsible]
305
+ ====
287
306
[source,console]
288
307
----
289
308
NAME
@@ -325,6 +344,7 @@ OPTIONS
325
344
<EMAIL>
326
345
User Email
327
346
----
347
+ ====
328
348
329
349
== Remove a user
330
350
@@ -358,6 +378,9 @@ Replace `**USER**` with the email address or ID of the user you want to delete.
358
378
359
379
=== `user delete` options
360
380
381
+ .Expand to see all `user delete` options
382
+ [%collapsible]
383
+ ====
361
384
[source,console]
362
385
----
363
386
NAME
@@ -399,6 +422,7 @@ OPTIONS
399
422
<EMAIL>
400
423
User email or identifier
401
424
----
425
+ ====
402
426
403
427
[#list-roles]
404
428
== List roles
@@ -441,6 +465,9 @@ astra role list
441
465
442
466
=== `role list` options
443
467
468
+ .Expand to see all `role list` options
469
+ [%collapsible]
470
+ ====
444
471
[source,console]
445
472
----
446
473
NAME
@@ -474,6 +501,7 @@ OPTIONS
474
501
-v, --verbose
475
502
Verbose mode with log in console
476
503
----
504
+ ====
477
505
478
506
== Get role details
479
507
@@ -555,6 +583,9 @@ Replace `**ROLE**` with the name or ID of the role you want to get information a
555
583
556
584
=== `role get` options
557
585
586
+ .Expand to see all `role get` options
587
+ [%collapsible]
588
+ ====
558
589
[source,console]
559
590
----
560
591
NAME
@@ -596,9 +627,13 @@ OPTIONS
596
627
<ROLE>
597
628
Role name or identifier
598
629
----
630
+ ====
599
631
600
632
=== `role describe` options
601
633
634
+ .Expand to see all `role describe` options
635
+ [%collapsible]
636
+ ====
602
637
[source,console]
603
638
----
604
639
NAME
@@ -640,6 +675,7 @@ OPTIONS
640
675
<ROLE>
641
676
Role name or identifier
642
677
----
678
+ ====
643
679
644
680
[#list-tokens]
645
681
== Get a list of tokens
@@ -665,6 +701,9 @@ astra token list
665
701
666
702
=== `token list` options
667
703
704
+ .Expand to see all `token list` options
705
+ [%collapsible]
706
+ ====
668
707
[source,console]
669
708
----
670
709
NAME
@@ -698,6 +737,7 @@ OPTIONS
698
737
-v, --verbose
699
738
Verbose mode with log in console
700
739
----
740
+ ====
701
741
702
742
== Create an application token
703
743
@@ -728,6 +768,9 @@ Replace `**ROLE**` with the name or ID of the role you want to assign to the tok
728
768
729
769
=== `token create` options
730
770
771
+ .Expand to see all `token create` options
772
+ [%collapsible]
773
+ ====
731
774
[source,console]
732
775
----
733
776
NAME
@@ -765,6 +808,7 @@ OPTIONS
765
808
-v, --verbose
766
809
Verbose mode with log in console
767
810
----
811
+ ====
768
812
769
813
== Show the current token
770
814
@@ -786,6 +830,9 @@ AstraCS:FZmCtRdyzJkYidnmlzwcwJWc:f51d3ee8fce90b28a7681a1e1bc3fa0d69cb770b0219aa9
786
830
787
831
=== `token get` options
788
832
833
+ .Expand to see all `token get` options
834
+ [%collapsible]
835
+ ====
789
836
[source,console]
790
837
----
791
838
NAME
@@ -819,6 +866,7 @@ OPTIONS
819
866
-v, --verbose
820
867
Verbose mode with log in console
821
868
----
869
+ ====
822
870
823
871
== Delete an application token
824
872
@@ -853,6 +901,9 @@ To get a token's client ID, see <<list-tokens>>.
853
901
854
902
=== `token delete` options
855
903
904
+ .Expand to see all `token delete` options
905
+ [%collapsible]
906
+ ====
856
907
[source,console]
857
908
----
858
909
NAME
@@ -894,9 +945,13 @@ OPTIONS
894
945
<TOKEN>
895
946
token identifier
896
947
----
948
+ ====
897
949
898
950
=== `token revoke` options
899
951
952
+ .Expand to see all `token revoke` options
953
+ [%collapsible]
954
+ ====
900
955
[source,console]
901
956
----
902
957
NAME
@@ -938,3 +993,4 @@ OPTIONS
938
993
<TOKEN>
939
994
token identifier
940
995
----
996
+ ====
0 commit comments