organizations¶
The organizations command allows you to create, modify and view
organization resources.
Usage: croud organizations [-h]
{create,get,list,edit,delete,auditlogs,users} ...
Note
The organizations auditlogs and organizations users subcommands
are only available to organization admins and superusers.
organizations create¶
Usage: croud organizations create [-h] --name NAME [--plan-type {1,2,3,4,5,6}]
[--region REGION]
[--output-fmt {table,wide,json,yaml}]
[--sudo]
Required Arguments¶
- --name
The organization name to use.
Optional Arguments¶
- --plan-type
Possible choices: 1, 2, 3, 4, 5, 6
The support plan to use for the organization. Argument is for superusers only.
- --region, -r
Temporarily use the specified region that command will be run in.
- --output-fmt, --format, -o
Possible choices: table, wide, json, yaml
Change the formatting of the output.
- --sudo
Run the given command as superuser.
Default: False
Example¶
sh$ croud organizations create --name my-org
+--------------------------------------+--------+------------+
| id | name | planType |
|--------------------------------------+--------+------------|
| f6c39580-5719-431d-a508-0cee4f9e8209 | my-org | 3 |
+--------------------------------------+--------+------------+
==> Success: Organization created.
organizations list¶
Usage: croud organizations list [-h] [--region REGION]
[--output-fmt {table,wide,json,yaml}] [--sudo]
Optional Arguments¶
- --region, -r
Temporarily use the specified region that command will be run in.
- --output-fmt, --format, -o
Possible choices: table, wide, json, yaml
Change the formatting of the output.
- --sudo
Run the given command as superuser.
Default: False
Example¶
sh$ croud organizations list
+--------------------------------------+--------+------------+
| id | name | planType |
|--------------------------------------+--------+------------|
| f6c39580-5719-431d-a508-0cee4f9e8209 | my-org | 3 |
+--------------------------------------+--------+------------+
organizations edit¶
Usage: croud organizations edit [-h] [--name NAME] [--plan-type {1,2,3,4,5,6}]
[--org-id ORG_ID] [--region REGION]
[--output-fmt {table,wide,json,yaml}] [--sudo]
Optional Arguments¶
- --name
The new organization name to use.
- --plan-type
Possible choices: 1, 2, 3, 4, 5, 6
The new support plan to use for the organization.
- --org-id
The organization ID to use.
- --region, -r
Temporarily use the specified region that command will be run in.
- --output-fmt, --format, -o
Possible choices: table, wide, json, yaml
Change the formatting of the output.
- --sudo
Run the given command as superuser.
Default: False
Example¶
sh$ croud organizations edit --name new-name
+--------------------------------------+-------------+-------------+
| id | name | plan_type |
|--------------------------------------+-------------+-------------|
| f6c39580-5719-431d-a508-0cee4f9e8209 | new-name | 3 |
+--------------------------------------+-------------+-------------+
==> Success: Organization edited.
organizations delete¶
Usage: croud organizations delete [-h] [-y] [--org-id ORG_ID]
[--region REGION]
[--output-fmt {table,wide,json,yaml}]
[--sudo]
Optional Arguments¶
- -y, --yes
Default: False
- --org-id
The organization ID to use.
- --region, -r
Temporarily use the specified region that command will be run in.
- --output-fmt, --format, -o
Possible choices: table, wide, json, yaml
Change the formatting of the output.
- --sudo
Run the given command as superuser.
Default: False
Example¶
sh$ croud organizations delete \
--org-id f6c39580-5719-431d-a508-0cee4f9e8209
Are you sure you want to delete the organization? [yN] y
==> Success: Organization deleted.
organizations auditlogs¶
Usage: croud organizations auditlogs [-h] {list} ...
organizations auditlogs list¶
Usage: croud organizations auditlogs list [-h] [--action ACTION] [--from FROM]
[--to TO] [--org-id ORG_ID]
[--region REGION]
[--output-fmt {table,wide,json,yaml}]
[--sudo]
Optional Arguments¶
- --action
The audit event action.
- --from
Only show events from this point in time.
- --to
Only show events older than this.
- --org-id
The organization ID to use.
- --region, -r
Temporarily use the specified region that command will be run in.
- --output-fmt, --format, -o
Possible choices: table, wide, json, yaml
Change the formatting of the output.
- --sudo
Run the given command as superuser.
Default: False
Example¶
sh$ croud organizations auditlogs list \
--org-id f6c39580-5719-431d-a508-0cee4f9e8209
+------------------------+--------------------------------------+----------------------------------+
| action | actor | created |
|------------------------+--------------------------------------+----------------------------------|
| product.create_cluster | e4c6e51f-bd56-4d92-bdf8-9947531c3225 | 2019-11-05T12:35:23.168000+00:00 |
| project.add_user | e4c6e51f-bd56-4d92-bdf8-9947531c3225 | 2019-11-05T12:22:31.796000+00:00 |
| project.create | e4c6e51f-bd56-4d92-bdf8-9947531c3225 | 2019-11-05T12:22:31.196000+00:00 |
| organization.add_user | e4c6e51f-bd56-4d92-bdf8-9947531c3225 | 2019-11-05T12:20:57.610000+00:00 |
| organization.create | e4c6e51f-bd56-4d92-bdf8-9947531c3225 | 2019-11-05T12:20:57.598000+00:00 |
+------------------------+--------------------------------------+----------------------------------+
Note
The full context for each auditlog event is available through the JSON output format:
sh$ croud organizations auditlogs list \
--org-id f6c39580-5719-431d-a508-0cee4f9e8209 \
--output-fmt json
organizations users¶
Usage: croud organizations users [-h] {add,list,remove} ...
organizations users add¶
Usage: croud organizations users add [-h] --user USER --role ROLE
[--org-id ORG_ID] [--region REGION]
[--output-fmt {table,wide,json,yaml}]
[--sudo]
Required Arguments¶
- --user
The user email address or ID to use.
- --role
The role FQN to use. Run croud users roles list for a list of available roles.
Optional Arguments¶
- --org-id
The organization ID to use.
- --region, -r
Temporarily use the specified region that command will be run in.
- --output-fmt, --format, -o
Possible choices: table, wide, json, yaml
Change the formatting of the output.
- --sudo
Run the given command as superuser.
Default: False
Example¶
sh$ croud organizations users add \
--org-id f6c39580-5719-431d-a508-0cee4f9e8209 \
--role org_member \
--user john.doe@example.com
+--------------------------------------+------------+--------------------------------------+
| organization_id | role_fqn | user_id |
|--------------------------------------+------------+--------------------------------------|
| f6c39580-5719-431d-a508-0cee4f9e8209 | org_member | e4c6e51f-bd56-4d92-bdf8-9947531c3225 |
+--------------------------------------+------------+--------------------------------------+
==> Success: User added to organization.
organizations users list¶
Usage: croud organizations users list [-h] [--org-id ORG_ID] [--region REGION]
[--output-fmt {table,wide,json,yaml}]
[--sudo]
Optional Arguments¶
- --org-id
The organization ID to use.
- --region, -r
Temporarily use the specified region that command will be run in.
- --output-fmt, --format, -o
Possible choices: table, wide, json, yaml
Change the formatting of the output.
- --sudo
Run the given command as superuser.
Default: False
Example¶
sh$ croud organizations users list \
--org-id f6c39580-5719-431d-a508-0cee4f9e8209
+----------------------+--------------------+----------+--------------------------------------+
| email | organization_roles | username | uid |
|----------------------+--------------------+----------+--------------------------------------|
| john.doe@example.com | org_admin | john.doe | e4c6e51f-bd56-4d92-bdf8-9947531c3225 |
+----------------------+--------------------+----------+--------------------------------------+
organizations users remove¶
Usage: croud organizations users remove [-h] --user USER [--org-id ORG_ID]
[--region REGION]
[--output-fmt {table,wide,json,yaml}]
[--sudo]
Required Arguments¶
- --user
The user email address or ID to use.
Optional Arguments¶
- --org-id
The organization ID to use.
- --region, -r
Temporarily use the specified region that command will be run in.
- --output-fmt, --format, -o
Possible choices: table, wide, json, yaml
Change the formatting of the output.
- --sudo
Run the given command as superuser.
Default: False
Example¶
sh$ croud organizations users remove \
--org-id f6c39580-5719-431d-a508-0cee4f9e8209 \
--user john.doe@example.io
==> Success: User removed from organization.