エンタープライズノードコマンド

エンタープライズノードの管理

概要

ノードは、ユーザー、ロール、チーム、およびプロビジョニング/認証方式を整理するための組織単位です。

使い方

enterprise-node command [--options] OR en command [--options]

別名: en

コマンド

エンタープライズノードコマンドで利用できるコマンドは次のとおりです。

コマンド	説明
view	エンタープライズノードを表示します。
add	エンタープライズノードを作成します。
edit	エンタープライズノードを編集します。
delete	エンタープライズノードを削除します。
set-logo	ノードのロゴを設定します。
invite-email	招待メールを設定します。
wipe-out	ノードの内容をワイプアウトします。

エンタープライズノード表示コマンド

エンタープライズノードを表示します。

DotNet CLI

コマンド: enterprise-node <node name> --command=tree OR en tree -v

例:

My Vault> enterprise-node DEVOPS --command=tree

DotNet SDK

関数: EnterpriseData.Nodes

var nodes = enterpriseData.Nodes
                            .Where(x => string.Equals(x.DisplayName, arguments.Node, StringComparison.InvariantCultureIgnoreCase))
                            .ToArray();

PowerCommander

コマンド: Get-KeeperEnterpriseNode

別名: ken

パラメータ:

• NodeId - ノードID (任意。省略時はすべて一覧)

例:

# すべてのノードを一覧
PS> Get-KeeperEnterpriseNode
----------------------------------------
# 特定のノードを取得
PS> Get-KeeperEnterpriseNode -NodeId 12345 - 未実装

Python CLI

コマンド: enterprise-node view

パラメータ:

node - ノード名またはUID (必須)

フラグ:

• -v, --verbose - 詳細情報を出力する

• --format - 出力形式: json

• --output - 出力ファイル名

Python SDK

関数:

node = enterprise_data.nodes.get_entity(node_id) if isintance(node_id, int)
node = [node for node in enterprise_data.nodes.get_all_entities() if node.name.lower() == node_id]  if isintance(node_id, str)

エンタープライズノード追加コマンド (add)

エンタープライズノードを作成します。

DotNet CLI

コマンド: enterprise-node --command=add <name> --parent "<main node>"

別名: en --command=add <name>

オプション:

• --parent <node> - 親ノード名またはID

• --name <name> - 新しいノード表示名 (追加/更新時)

• -v, --verbose - ノードIDなどの追加情報を表示

• --toggle-isolated - ノード分離の切り替え (可視性を制限)

例:

My Vault> enterprise-node --command=add "Engineering"
OR
My Vault> en --command=add "Isolated Team" --toggle-isolated

DotNet SDK

関数: CreateNode

public static async Task<EnterpriseNode> CreateNode(this EnterpriseData enterpriseData, string nodeName, EnterpriseNode parentNode = null)

例:

var node = await enterpriseData.CreateNode(arguments.Node, parentNode);

PowerCommander

コマンド: New-KeeperEnterpriseNode

別名: kena

構文:

New-KeeperEnterpriseNode [-NodeName] <string> [[-ParentNodeId] <long>] [<CommonParameters>]

パラメータ:

• -NodeName - ノード名

• -ParentNodeId - 親ノードID

例:

PS> New-KeeperEnterpriseNode -ParentName "parent" -NodeName "MyNode"
OR 
kena "DevOps" -ParentNodeId 12345

Python CLI

コマンド: enterprise-node add

パラメータ:

node - ノード名。繰り返し指定可。(必須)

フラグ:

• --parent - 親ノード名またはID

• --name, --displayname - ノード表示名を設定

• --set-isolated - ノード分離を設定: on または off

• -f, --force - 確認プロンプトを表示しない

Python SDK

関数:

from keepersdk.enterprise import batch_management,  enterprise_management

node_names = list['names of nodes to be created']
nodes_to_add = [enterprise_management.NodeEdit(
    node_id=enterprise_loader.get_enterprise_id(), name=node_name, parent_id=parent_node_id,
    restrict_visibility=is_isolated)
    for node_name in node_names]
batch = batch_management.BatchManagement(loader=enterprise_loader, logger=enterprise_manager_logger)
batch.modify_nodes(to_add=nodes_to_add)
batch.apply()

エンタープライズノード編集コマンド (edit)

エンタープライズノードを編集します。

DotNet CLI

コマンド: enterprise-node --command=update [--options]

別名: en --command=update [--options]

オプション:

• --parent <node> - 親ノード名またはID

• --name <name> - 新しいノード表示名 (追加/更新時)

• -v, --verbose - ノードIDなどの追加情報を表示

• --toggle-isolated - ノード分離の切り替え (可視性を制限)

例:

# Update node
enterprise-node --command=update "Engineering" --name "Engineering Dept"
enterprise-node update 12345 --parent "IT"
en update "Sales" --toggle-isolated  

DotNet SDK

関数: UpdateNode

public static async Task UpdateNode(this EnterpriseData enterpriseData, EnterpriseNode node, EnterpriseNode newParentNode = null)

例:

await enterpriseData.UpdateNode(node, parentNode);

PowerCommander

コマンド: Edit-KeeperEnterpriseNode

別名: kenu

使い方:

Edit-KeeperEnterpriseNode [-Node] <string> 
                          [-NewNodeName <string>] 
                          [-ParentNode <string>] 
                          [-RestrictVisibility] 
                          [<CommonParameters>]

パラメータ:

パラメータ	説明
-Node	更新するノード名またはIDです。位置指定パラメータ (位置 0) です。

オプション:

オプション	説明
-NewNodeName	ノードの新しい名前です。既存ノードの名前変更に使用します。
-ParentNode	新しい親ノード名またはIDです。階層内の別の場所へノードを移動するために使用します。
-RestrictVisibility	ノードの分離を有効にします。有効にすると、ノード外のユーザーからの可視性を制限します。

例:

PS> Get-KeeperEnterpriseNode                                                                         

Id              DisplayName        ParentNodeName  RestrictVisibility Provisioning
--              -----------        --------------  ------------------ ------------
894448414228482 MS.                                False              
894448414228541 Test node                          False              

PS> Edit-KeeperEnterpriseNode -Node "Test node" -NodeName "test_node_updated2" -ParentNode "MS" -RestrictVisibility        
Node "test_node_updated2" updated.
Node Isolation: ON
PS> Get-KeeperEnterpriseNode                                                                                       
        
Id              DisplayName        ParentNodeName  RestrictVisibility Provisioning
--              -----------        --------------  ------------------ ------------
894448414228482 MS                                 False              
894448414228541 test_node_updated2 MS              True               

Python CLI

コマンド: enterprise-node edit

パラメータ:

node - ノード名またはID。繰り返し指定可。(必須)

フラグ:

• --parent - 親ノード名またはID

• --name, --displayname - ノード表示名を設定

• --set-isolated - ノード分離を設定: on または off

Python SDK

関数:

from keepersdk.enterprise import batch_management,  enterprise_management

node = enterprise_data.nodes.get_entity(node_id)
node_list = [node]
nodes_to_update = [enterprise_management.NodeEdit(
    node_id=node.node_id, name=display_name, parent_id=node.parent_id, restrict_visibility=is_isolated)
    for node in node_list]
batch = batch_management.BatchManagement(loader=enterprise_loader, logger=enterprise_manager_logger)
batch.modify_nodes(to_update=nodes_to_update)
batch.apply()

エンタープライズノード削除コマンド (delete)

エンタープライズノードを削除します。

DotNet CLI

コマンド: enterprise-node --command=delete <node name>

別名: en --command=delete <node name>

オプション:

• -f, --force - エンタープライズデータを強制再読み込み

例:

# Delete node
My Vault> en --command=delete "Old Department" 
OR
enterprise-node --command=delete "Old Department"
enterprise-node --command=delete 12345

DotNet SDK

関数: DeleteNode

await enterpriseData.DeleteNode(node.Id);
public static async Task DeleteNode(this EnterpriseData enterpriseData, long nodeId)

PowerCommander

コマンド: Remove-KeeperEnterpriseNode

別名: kend

パラメータ:

パラメータ	説明
Node	削除対象のノード名またはIDです。表示名または数値のノードIDを指定します。
Force	確認プロンプトをスキップします。指定した場合、確認なしでノードを削除します。

使い方:

PS > Remove-KeeperEnterpriseNode -Node "Old Department"
PS > kend "Old Department"

例:

PS> Remove-KeeperEnterpriseNode -Node "test_node_1"                 

Confirm
Are you sure you want to perform this action?
Performing the operation "Delete Enterprise Node" on target "test_node_1".
[Y] Yes  [A] Yes to All  [N] No  [L] No to All  [S] Suspend  [?] Help (default is "Y"): a
Node "test_node_1" deleted successfully.

Python CLI

コマンド: enterprise-node delete

パラメータ:

node - ノード名またはID (必須)

フラグ:

• --logo-file - ローカル画像ファイルで会社ロゴを設定 (最大サイズ: 500 kB、最小寸法: 10x10、最大寸法: 320x320)

Python SDK

関数:

from keepersdk.enterprise import batch_management,  enterprise_management

node = enterprise_data.nodes.get_entity(node_id)
node_list = [node]
batch = batch_management.BatchManagement(loader=enterprise_loader, logger=enterprise_manager_logger)
batch.modify_nodes(to_remove=(enterprise_management.NodeEdit(node_id=node.node_id) for node in node_list))
batch.apply()

エンタープライズノードロゴ設定コマンド (set-logo)

エンタープライズノードのロゴを設定します。

DotNet CLI

コマンド: enterprise-node --command=<action> <node_name> --logo-type=<logo_type> --logo-path=<upload_logo_path> OR en --command=<action> <node_name> --logo-type=<logo_type> --logo-path=<upload_logo_path>

パラメータ:

	説明
nodeId	ノードを表す EnterpriseNode IDです。
logo-type	ロゴの種類です (例: vault または email)。
logo-path	アップロードするファイルのパスです。

例:

My Vault> en --command="upload-custom-logo" "Test" --logo-type="vault" --logo-path="<logo_path>" 

参考:

コマンダーリファレンス

DotNet SDK

ノードへのカスタム招待の設定:

関数: UploadEnterpriseCustomLogo

使い方:

public static async Task<CheckEnterpriseCustomLogoUploadResponse> UploadEnterpriseCustomLogo(this EnterpriseData enterpriseData, long nodeId, string logoType, string filePath)

パラメータ:

	説明
nodeId	ノードを表す EnterpriseNode IDです。
logoType	ロゴの種類です (例: vault または email)。
filePath	アップロードするファイルのパスです。

例:

await EnterpriseManagementExamples.EnterpriseNodeExamples.SetEnterpriseCustomLogoExample.SetEnterpriseCustomLogoExample(70411693850884, "vault", "<file_path>");

参考:

コマンダーリファレンス

PowerCommander

コマンド: Set-KeeperEnterpriseNodeCustomLogo

フラグ:

フラグ	説明
Node	ノード名またはIDです。
LogoType	ロゴの種類です (例: vault、email)。
LogoPath	ロゴファイルのパスです。

例:

PS > Set-KeeperEnterpriseNodeCustomLogo -Node PCTNode -LogoType vault -LogoPath /Users/satish/Desktop/dotnet-reference/keeper-sdk-dotnet/download1.jpg
Custom logo uploaded for node "PCTNode"

LogoPath   : /vault/logo/nycE_9wCsOg
Status     : active
IsSuccess  : True
result     : success
resultCode : 
message    : 
command    : check_vault_logo_upload

Python CLI

コマンド: enterprise-node set-logo

パラメータ:

• node : ノード名またはID

• --logo-file : ローカル画像ファイルで会社ロゴを設定 (最大サイズ: 500 kB、最小寸法: 10x10、最大寸法: 320x320)

例:

My Vault> enterprise-node set-logo <node_uid> --logo-file="logo.jpg"

Python SDK

関数:

from keepersdk.vault import attachment

upload_task = attachment.FileUploadTask(logo_filepath)
upload_task.prepare()
# Check file MIME-type and size
if upload_task.mime_type not in {'image/jpeg', 'image/png', 'image/gif'}:
    raise Exception('File must be a JPEG, PNG, or GIF image')
if upload_task.size > 500000:
    raise Exception('Filesize must be less than 500 kB')
rq_logo = {
    'command': f'request_{logo_type}_logo_upload',
    'node_id': node_id,
}
rs_logo = KeeperAuth_obj.execute_auth_command(rq_logo)
# Construct POST request for upload
upload_id = rs_logo.get('upload_id')
upload_url = rs_logo.get('url')
assert isinstance(upload_url, str)
success_status_code = rs_logo.get('success_status_code')
file_param: Optional[str] = rs_logo.get('file_parameter')
assert file_param is not None
form_data = rs_logo.get('parameters')
assert isinstance(form_data, dict)
form_data['Content-Type'] = upload_task.mime_type
with upload_task.open() as task_stream:
    files = {file_param: (None, task_stream, upload_task.mime_type)}
    upload_rs = requests.post(upload_url, files=files, data=form_data)
    if upload_rs.status_code == success_status_code:
        # Verify file upload
        check_rq = {
            'command': f'check_{logo_type}_logo_upload',
            'node_id': node_id,
            'upload_id': upload_id
        }
        while True:
            check_rs = KeeperAuth_obj.execute_auth_command(check_rq)
            check_status = check_rs.get('status')
            if check_status == 'pending':
                time.sleep(2)
            else:
                if check_status != 'active':
                    if check_status == 'invalid_dimensions':
                        raise Exception('Image dimensions must be between 10x10 and 320x320')
                    else:
                        raise Exception(f'Upload status = {check_status}')
                else:
                    get_logger().info('File "%s" set as %s logo.', logo_fp, logo_type)
                    break
    else:
        raise Exception(f'HTTP status code: {upload_rs.status_code}, expected {success_status_code}')

エンタープライズノードカスタム招待メール設定コマンド (invite-email)

招待メールを設定します。

DotNet CLI

コマンド: enterprise-node --command=<action> <node_name> --json-file-path="<file_path>" OR en --command=<action> <node_name> --json-file-path="<file_path>"

パラメータ:

	説明
nodeId	ノードを表す EnterpriseNode IDです。
jsonFilePath	subject、header、body、buttonLabel を含むJSONファイルを作成し、そのパスを指定します。

例:

My Vault> enterprise-node --command="set-custom-invitation" "Test" --json-file-path="<file_path>"

参考:

コマンダーリファレンス

DotNet SDK

ノードへのカスタム招待の設定:

関数: SetEnterpriseCustomInvitation

使い方:

public static async Task SetEnterpriseCustomInvitation(this EnterpriseData enterpriseData, long nodeId, string jsonFilePath)

パラメータ:

	説明
nodeId	ノードを表す EnterpriseNode IDです。
jsonFilePath	subject、header、body、buttonLabel を含むJSONファイルを作成し、そのパスを指定します。

例:

await EnterpriseManagementExamples.EnterpriseNodeExamples.SetEnterpriseCustomInvitationExample.SetEnterpriseCustomInvitationExample(70411693850884, "<Path_to_jsonFile>");

参考:

コマンダーリファレンス

PowerCommander

コマンド: Set-KeeperEnterpriseNodeCustomInvitation

フラグ:

Node	ノード名またはIDです。
JsonFilePath	招待テンプレート (subject、header、body、buttonLabel) を含むJSONファイルのパスです。

例:

PS> Set-KeeperEnterpriseNodeCustomInvitation -Node PCTNode -JsonFilePath "/Users/xxaaeafd/Desktop/dotnet-reference/keeper-sdk-dotnet/testfile.json"
Custom invitation set for node "PCTNode"

Python CLI

コマンド: enterprise-node invite-email

パラメータ:

node - ノード名またはID (必須)

フラグ:

• -f, --force - 確認プロンプトを表示しない

• --invite-email - ファイルから招待メールテンプレートを設定する。ファイルが存在しない場合は現在のテンプレートを保存する。標準出力にはダッシュ (-) を指定する

Python SDK

関数: 非対応

エンタープライズノードワイプアウトコマンド (wipe-out)

ワイプアウト は、指定したエンタープライズノード配下のコンテンツをすべて削除します。

削除対象	説明
ロール–ユーザーリンク	当該ノードまたはその子孫に属するすべてのロールから、すべてのユーザーが外されます。
ロール–管理ノードリンク	それらのロールに紐づく管理ノードの関連がすべて削除されます。
ロール	親ノードが対象ノードまたはその子孫であるロールがすべて削除されます。
ユーザー	親ノードが対象ノードまたはその子孫であるユーザーがすべて削除されます。
チーム	ノード配下のすべてのチーム (および .NET CLI ではキュー済みチーム) が削除されます。
子ノード	対象ノード直下のすべての子ノードが削除されます。

対象ノード自体は削除されず、空の状態で残ります。ルートノードはワイプアウトできません。

DotNet CLI

コマンド: enterprise-node --command=wipe-out <node>

引数	説明
--command=wipe-out	ワイプアウト操作を選択するサブコマンドです。
<node>	ワイプアウトするノード名またはノードIDです。wipe-out では必須です。

例:

enterprise-node --command=wipe-out "Sales"
# or using alias
en --command=wipe-out "Sales"

DotNet SDK

近日公開

PowerCommander

コマンド: Invoke-KeeperEnterpriseNodeWipeOut

別名: kenwipe

パラメータ:

パラメータ	必須	説明
Node	はい	ワイプアウトするノード名またはノードIDです。
Force	いいえ	確認プロンプトをスキップします。注意して使用してください。

例:

PowerCommander> Invoke-KeeperEnterpriseNodeWipeOut -Node Test1

Confirm
Are you sure you want to perform this action?
Performing the operation "Wipe out" on target "Node "Test1" and all its content".
[Y] Yes  [A] Yes to All  [N] No  [L] No to All  [S] Suspend  [?] Help (default is "Y"): a
WARNING: This action cannot be undone.
Node "Test1" and its content have been wiped out.

Python CLI

コマンド: enterprise-node wipe-out

パラメータ:

• node - ノード名またはID (必須)

警告: この操作は取り消せず、すべてのユーザー、ロール、チーム、子ノードを削除します。

Python SDK

関数:

from keepersdk.enterprise import batch_management,  enterprise_management

node = enterprise_data.nodes.get_entity(node_id)
if node.node_id == enterprise_data.root_node.node_id:
    raise ValueError('Cannot wipe out root node')

subnode_lookup: Dict[int, List[int]] = {}
for n in enterprise_data.nodes.get_all_entities():
    parent_id = n.parent_id or 0
    if parent_id not in subnode_lookup:
        subnode_lookup[parent_id] = []
    subnode_lookup[parent_id].append(n.node_id)

sub_nodes = [node.node_id]
pos = 0
while pos < len(sub_nodes):
    if sub_nodes[pos] in subnode_lookup:
        sub_nodes.extend(subnode_lookup[sub_nodes[pos]])
    pos += 1
nodes = set(sub_nodes)

batch = batch_management.BatchManagement(loader=enterprise_loader, logger=enterprise_manager_logger)

roles = {x.role_id for x in enterprise_data.roles.get_all_entities() if x.node_id in nodes}
users = {x.enterprise_user_id for x in enterprise_data.users.get_all_entities() if x.node_id in nodes}

role_users = [enterprise_management.RoleUserEdit(role_id=x.role_id, enterprise_user_id=x.enterprise_user_id)
                for x in enterprise_data.role_users.get_all_links() if
                x.role_id in roles or x.enterprise_user_id in users]
if len(role_users) > 0:
    batch.modify_role_users(to_remove=role_users)

managed_nodes = [enterprise_management.ManagedNodeEdit(role_id=x.role_id, managed_node_id=x.managed_node_id)
                    for x in enterprise_data.managed_nodes.get_all_links() if
                    x.managed_node_id in nodes or x.role_id in roles]
if len(managed_nodes) > 0:
    batch.modify_managed_nodes(to_remove=managed_nodes)

roles_to_remove = [enterprise_management.RoleEdit(role_id=x) for x in roles]
if len(roles) > 0:
    batch.modify_roles(to_remove=roles_to_remove)

users_to_remove = [enterprise_management.UserEdit(enterprise_user_id=x) for x in users]
if len(users_to_remove) > 0:
    batch.modify_users(to_remove=users_to_remove)

queued_teams = [enterprise_management.TeamEdit(team_uid=x.team_uid)
                for x in enterprise_data.queued_teams.get_all_entities() if x.node_id in nodes]
if len(queued_teams) > 0:
    batch.modify_teams(to_remove=queued_teams)

teams = [enterprise_management.TeamEdit(team_uid=x.team_uid)
            for x in enterprise_data.teams.get_all_entities() if x.node_id in nodes]
if len(teams) > 0:
    batch.modify_teams(to_remove=teams)

sub_nodes.pop(0)
sub_nodes.reverse()
nodes_to_remove = [enterprise_management.NodeEdit(node_id=x) for x in sub_nodes]
if len(nodes_to_remove) > 0:
    batch.modify_nodes(to_remove=nodes_to_remove)

batch.apply()

エンタープライズノードカスタム招待メールデータ取得コマンド (get-custom-invitation)

ノードのカスタム招待テンプレートを取得するコマンド/関数です。

DotNet CLI

コマンド: enterprise-node --command=<action> <node_name> OR en --command=<action> <node_name>

パラメータ:

	説明
nodeId	ノードを表す EnterpriseNode IDです。

例:

My Vault> enterprise-node --command="get-custom-invitation" "Test"   

参考:

コマンダーリファレンス

DotNet SDK

カスタム招待テンプレートの取得:

関数: GetEnterpriseCustomInvitation

使い方:

public static async Task<GetEnterpriseCustomInvitationResponse> GetEnterpriseCustomInvitation(this EnterpriseData enterpriseData, long nodeId)

パラメータ:

	説明
nodeId	ノードを表す EnterpriseNode IDです。

例:

await EnterpriseManagementExamples.EnterpriseNodeExamples.GetEnterpriseCustomInvitationExample.GetEnterpriseCustomInvitationExample(70411693850884);

参考:

コマンダーリファレンス

PowerCommander

コマンド: Get-KeeperEnterpriseNodeCustomInvitation

フラグ:

Node	ノード名またはIDです。
JsonFilePath	招待テンプレート (subject、header、body、buttonLabel) を含むJSONファイルのパスです。

例:

PS> Get-KeeperEnterpriseNodeCustomInvitation -Node PCTNode                                                                                       
Custom invitation for node "PCTNode":
Subject: You're Invited to Join
Header: Welcome to Our Portal
Body: Click the button below to create your Keeper account and start protecting your passwords.
Button Label: Create Account

Subject     : You're Invited to Join
Header      : Welcome to Our Portal
Body        : Click the button below to create your Keeper account and start protecting your passwords.
ButtonLabel : Create Account
LogoPath    : 
IsSuccess   : True
result      : success
resultCode  : 
message     : 
command     : get_enterprise_custom_invitation

参考:

コマンダーリファレンス

Python CLI

近日公開

参考:

コマンダーリファレンス

Python SDK

近日公開

参考:

コマンダーリファレンス