Tenant
doohickey tenant
allows you to interact with tenants in the Doohickey Cloud (DC) environment.
Arguments
doohickey tenant
accepts one argument - an alias
for the tenant
Create
doohickey tenant create
is used to create a new tenant within DC. These tenants can be used for separation of concern within the environment. The UUID for this tenant will be saved for Doohickey CLI to reference later, as well as for you to use within your templates. When this command is run, the created tenant is saved as the current session tenant.
IMPORTANT:
In order for tenant creation to work as expected, the environment ID you provide to the tenant command must have an admin
user. The tenant command looks for this user's authentication information to the OIH runtime. If the admin
user is missing, the tenant creation will not be successful.
flags | type | description |
---|---|---|
--name (-n) | string | Name of tenant in DC |
--environment (-e) | string | Target DC environment |
--file | string | Path to JSON file for Tenant body, instead of using prompts |
Delete
doohickey tenant delete
will remove a tenant from both your local integration environment and DC.
flags | type | description |
---|---|---|
--environment (-e) | string | Target DC environment |
Init
doohickey tenant init
will return a list of all tenants currently in the DC environment, allowing you to select one to alias. When this command is run, the aliased tenant is saved as the current session tenant.
flags | type | description |
---|---|---|
--id (-id) | string | Id of existing tenant |
--environment (-e) | string | Target DC environment |
Select
doohickey tenant select
will return a list of all aliased DC tenants and allow you to set your current session tenant. You can provide an alias with the select command to select that tenant.
flags | type | description |
---|---|---|
--environment (-e) | string | Target DC environment |
Update
doohickey tenant update
will retrieve an existing tenant and apply an update to it.
flags | type | description |
---|---|---|
--environment (-e) | string | Target DC environment |
--file | string | Path to JSON file for Tenant body, instead of using prompts |
View
doohickey tenant view
will allow you to view either a single aliased tenant or a list of all tenants currently in the DC environment. To view all, omit the alias. To view a single tenant, provide the alias.
flags | type | description |
---|---|---|
--environment (-e) | string | Target DC environment |