diff --git a/cli.md b/cli.md index 79c12f0..9b4f7f3 100644 --- a/cli.md +++ b/cli.md @@ -120,6 +120,10 @@ This is a subcommand that operates the RESOURCE of K2HR3. This is a subcommand corresponding to [SERVICE API](api_service.html). This is a subcommand that operates the SERVICE of K2HR3. +#### [tenant](cli_tenant.html) +This is a subcommand corresponding to [TENANT API](api_service.html). +This is a subcommand that operates the LOCAL TENANT of K2HR3. + #### [acr](cli_acr.html) This is a subcommand corresponding to [ACR (ACCESS CROSS ROLE) API](api_acr.html). This is a subcommand to operate ACR(ACCESS CROSS ROLE) used by the +SERVICE function of K2HR3. diff --git a/cli_acr.md b/cli_acr.md index 16d984d..b4c9d58 100644 --- a/cli_acr.md +++ b/cli_acr.md @@ -5,8 +5,8 @@ title: CLI acr short_desc: K2Hdkc based Resource and Roles and policy Rules lang_opp_file: cli_acrja.html lang_opp_word: To Japanese -prev_url: cli_service.html -prev_string: CLI service +prev_url: cli_tenant.html +prev_string: CLI tenant top_url: cli.html top_string: Command Line Interface next_url: cli_userdata.html diff --git a/cli_acrja.md b/cli_acrja.md index 8d2c69c..cc3f7d3 100644 --- a/cli_acrja.md +++ b/cli_acrja.md @@ -5,8 +5,8 @@ title: CLI acr short_desc: K2Hdkc based Resource and Roles and policy Rules lang_opp_file: cli_acr.html lang_opp_word: To English -prev_url: cli_serviceja.html -prev_string: CLI service +prev_url: cli_tenantja.html +prev_string: CLI tenant top_url: clija.html top_string: Command Line Interface next_url: cli_userdataja.html diff --git a/cli_service.md b/cli_service.md index 5653965..bcf4723 100644 --- a/cli_service.md +++ b/cli_service.md @@ -9,8 +9,8 @@ prev_url: cli_resource.html prev_string: CLI resource top_url: cli.html top_string: Command Line Interface -next_url: cli_acr.html -next_string: CLI acr +next_url: cli_tenant.html +next_string: CLI tenant --- # Service Subcommand diff --git a/cli_serviceja.md b/cli_serviceja.md index 7a60d4b..8a3b6ff 100644 --- a/cli_serviceja.md +++ b/cli_serviceja.md @@ -9,8 +9,8 @@ prev_url: cli_resourceja.html prev_string: CLI resource top_url: clija.html top_string: Command Line Interface -next_url: cli_acrja.html -next_string: CLI acr +next_url: cli_tenantja.html +next_string: CLI tenant --- # Service Subcommand diff --git a/cli_tenant.md b/cli_tenant.md new file mode 100644 index 0000000..dcd722a --- /dev/null +++ b/cli_tenant.md @@ -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 +``` +Displays information for the specified LOCAL TENANT. + +## Create +Create a new LOCAL TENANT. + +### Format(1) +``` +k2hr3 tenant create [--display ] [--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 --tenantid [--display ] [--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 --tenantid +``` +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 diff --git a/cli_tenantja.md b/cli_tenantja.md new file mode 100644 index 0000000..1996ea8 --- /dev/null +++ b/cli_tenantja.md @@ -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）の情報を表示します。 + +## Create +ローカルテナント（TENANT）を新規作成します。 + +### 書式(1) +``` +k2hr3 tenant create [--display ] [--description ] [--users '["user","user",...]'] +``` +ローカルテナント（TENANT）を付随情報とともに作成します。 +テナント名（`tenant name`）は、`local@`プレフィックスで指定してください。（これが省略された場合、自動的に付与されます。） + +## Update +ローカルテナント（TENANT）の情報を更新します。 + +### 書式(1) +``` +k2hr3 tenant update --tenantid [--display ] [--description ] [--users '["user","user",...]'] +``` +ローカルテナント（TENANT）の情報を更新します。 +テナント名（`tenant name`）は、`local@`プレフィックスで指定してください。 +テナントID（`tenant id`）は、正しい値を指定しなければなりません。 + +## Delete +ローカルテナント（TENANT）を完全に削除します。 + +### 書式(1) +``` +k2hr3 tenant delete --tenantid +``` +指定されたローカルテナント（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 diff --git a/clija.md b/clija.md index 956607c..134265f 100644 --- a/clija.md +++ b/clija.md @@ -129,6 +129,10 @@ K2HR3のリソース（RESOURCE）を操作するサブコマンドです。 [SERVICE API](api_serviceja.html)に対応したサブコマンドです。 K2HR3のサービス（SERVICE）を操作するサブコマンドです。 +#### [tenant](cli_tenantja.html) +[TENANT API](api_tenantja.html)に対応したサブコマンドです。 +K2HR3のローカルテナント（TENANT）を操作するサブコマンドです。 + #### [acr](cli_acrja.html) [ACR(ACCESS CROSS ROLE) API](api_acrja.html)に対応したサブコマンドです。 K2HR3の+サービス（+SERVICE）機能で利用するACR(ACCESS CROSS ROLE)を操作するサブコマンドです。 diff --git a/whatnew.md b/whatnew.md index 1665ea5..8b539cc 100644 --- a/whatnew.md +++ b/whatnew.md @@ -15,7 +15,10 @@ next_string: Detail # What's new ## [26 Jul 2023] K2HR3 API updated -The source code of K2HR3 APP (Version 1.0.21) has been released on Github.com. +The source code of K2HR3 CLI (Version 1.0.9) has been released on Github.com. + +## [26 Jul 2023] K2HR3 API updated +The source code of K2HR3 APP (Version 1.0.22) has been released on Github.com. ## [25 Jul 2023] K2HR3 API updated The source code of K2HR3 API (Version 1.0.27) has been released on Github.com. diff --git a/whatnewja.md b/whatnewja.md index c2d1021..d4e81cd 100644 --- a/whatnewja.md +++ b/whatnewja.md @@ -14,8 +14,11 @@ next_string: Detail --- # What's new +## 2023年7月27日 +K2HR3 CLI (Version 1.0.9) をリリースし、Github.comで公開しました。 + ## 2023年7月26日 -K2HR3 APP (Version 1.0.21) をリリースし、Github.comで公開しました。 +K2HR3 APP (Version 1.0.22) をリリースし、Github.comで公開しました。 ## 2023年7月25日 K2HR3 API (Version 1.0.27) をリリースし、Github.comで公開しました。