-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #70 from ggtakec/update_ghp
[gh-pages] Added tenant sub command document in k2hr3 cli
- Loading branch information
Showing
10 changed files
with
179 additions
and
10 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,77 @@ | ||
--- | ||
layout: contents | ||
language: en-us | ||
title: CLI tenant | ||
short_desc: K2Hdkc based Resource and Roles and policy Rules | ||
lang_opp_file: cli_tenantja.html | ||
lang_opp_word: To Japanese | ||
prev_url: cli_service.html | ||
prev_string: CLI service | ||
top_url: cli.html | ||
top_string: Command Line Interface | ||
next_url: cli_acr.html | ||
next_string: CLI acr | ||
--- | ||
|
||
# Tenant Subcommand | ||
Describes the **tenant** subcommand of the K2HR3 Command Line Interface(CLI). | ||
|
||
The **tenant** subcommand is a feature that provides the [TENANT API](api_tenant.html) as a Command Line Interface(CLI). | ||
For more information on the API, see [TENANT API](api_tenant.html). | ||
|
||
This command requires a K2HR3 Unscoped token. Specify the Unscoped token of K2HR3 in the option or configuration file, or specify the `--interactive(-i)` option. | ||
|
||
## Show | ||
Displays LOCAL TENANT information. | ||
|
||
### Format(1) | ||
``` | ||
k2hr3 tenant show [--expand] | ||
``` | ||
Displays lists the names(or all information including name) of LOCAL TENANT associated with the user. | ||
|
||
### Format(2) | ||
``` | ||
k2hr3 tenant show <tenant name> | ||
``` | ||
Displays information for the specified LOCAL TENANT. | ||
|
||
## Create | ||
Create a new LOCAL TENANT. | ||
|
||
### Format(1) | ||
``` | ||
k2hr3 tenant create <tenant name> [--display <display name>] [--description <description>] [--users '["user","user",...]'] | ||
``` | ||
Create a new LOCAL TENANT with accompanying information. | ||
Specify the `tenant name` with the `local@` prefix.(If this is omitted, it will be granted automatically.) | ||
|
||
## Update | ||
Update all information of LOCAL TENANT. | ||
|
||
### Format(1) | ||
``` | ||
k2hr3 tenant update <tenant name> --tenantid <tenant id> [--display <display name>] [--description <description>] [--users '["user","user",...]'] | ||
``` | ||
Update all information of LOCAL TENANT. | ||
Specify the `tenant name` with the `local@` prefix. | ||
The `tenant id` must be a valid value. | ||
|
||
## Delete | ||
Delete the LOCAL TENANT. | ||
|
||
### Format(1) | ||
``` | ||
k2hr3 tenant delete <tenant name> --tenantid <tenant id> | ||
``` | ||
Deletes the specified LOCAL TENANT. | ||
The `tenant id` must be a valid value. | ||
|
||
## Options | ||
You can specify the following options: | ||
- -\-help(-h) | ||
- -\-tenantid [tenant name] | ||
- -\-display [display name for tenant] | ||
- -\-description [description of tenant] | ||
- -\-users [user name array as JSON string] | ||
- -\-expand |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,78 @@ | ||
--- | ||
layout: contents | ||
language: ja | ||
title: CLI tenant | ||
short_desc: K2Hdkc based Resource and Roles and policy Rules | ||
lang_opp_file: cli_tenant.html | ||
lang_opp_word: To English | ||
prev_url: cli_serviceja.html | ||
prev_string: CLI service | ||
top_url: clija.html | ||
top_string: Command Line Interface | ||
next_url: cli_acrja.html | ||
next_string: CLI acr | ||
--- | ||
|
||
# Tenant Subcommand | ||
K2HR3 Command Line Interface(CLI) の**tenant** サブコマンドについて説明します。 | ||
|
||
**tenant** サブコマンドは、[TENANT API](api_tenantja.html)をCommand Line Interface(CLI)として提供した機能です。 | ||
APIの詳細は、[TENANT API](api_tenantja.html)を参照してください。 | ||
|
||
このコマンドには、K2HR3の Unscopedトークン が必要となります。K2HR3の Uncopedトークン は、オプションもしくはコンフィグレーションファイルで指定するか、`--interactive(-i)`オプションを指定してください。 | ||
|
||
## Show | ||
ローカルテナント(TENANT)の情報を表示します。 | ||
|
||
### 書式(1) | ||
``` | ||
k2hr3 tenant show [--expand] | ||
``` | ||
ユーザに紐づけられているローカルテナント(TENANT)の名前(もしくは名前を含む全情報)をリスト表示します。 | ||
|
||
### 書式(2) | ||
``` | ||
k2hr3 tenant show <tenant name> | ||
``` | ||
指定されたローカルテナント(TENANT)の情報を表示します。 | ||
|
||
## Create | ||
ローカルテナント(TENANT)を新規作成します。 | ||
|
||
### 書式(1) | ||
``` | ||
k2hr3 tenant create <tenant name> [--display <display name>] [--description <description>] [--users '["user","user",...]'] | ||
``` | ||
ローカルテナント(TENANT)を付随情報とともに作成します。 | ||
テナント名(`tenant name`)は、`local@`プレフィックスで指定してください。(これが省略された場合、自動的に付与されます。) | ||
|
||
## Update | ||
ローカルテナント(TENANT)の情報を更新します。 | ||
|
||
### 書式(1) | ||
``` | ||
k2hr3 tenant update <tenant name> --tenantid <tenant id> [--display <display name>] [--description <description>] [--users '["user","user",...]'] | ||
``` | ||
ローカルテナント(TENANT)の情報を更新します。 | ||
テナント名(`tenant name`)は、`local@`プレフィックスで指定してください。 | ||
テナントID(`tenant id`)は、正しい値を指定しなければなりません。 | ||
|
||
## Delete | ||
ローカルテナント(TENANT)を完全に削除します。 | ||
|
||
### 書式(1) | ||
``` | ||
k2hr3 tenant delete <tenant name> --tenantid <tenant id> | ||
``` | ||
指定されたローカルテナント(TENANT)を削除します。 | ||
テナントID(`tenant id`)は、正しい値を指定しなければなりません。 | ||
|
||
|
||
## オプション | ||
以下のオプションを指定することができます。 | ||
- -\-help(-h) | ||
- -\-tenantid [tenant name] | ||
- -\-display [display name for tenant] | ||
- -\-description [description of tenant] | ||
- -\-users [user name array as JSON string] | ||
- -\-expand |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters