エンタープライズユーザーコマンド

エンタープライズユーザーの管理

操作

• ユーザーの追加、編集、参照、削除などの操作

• ロック、アンロック、延長、期限切れなどのアクション

• ユーザーエイリアスとノードの設定

使い方

enterprise-user --command [--options] OR eu command [--options]

エイリアス: eu

コマンド一覧

コマンド	説明
view	エンタープライズユーザーを参照する
add	エンタープライズユーザーを作成する
edit	エンタープライズユーザーを編集する
delete	エンタープライズユーザーを削除する
action	エンタープライズユーザーに対するアクション
alias	ユーザーエイリアスを管理する

エンタープライズユーザーの参照

エンタープライズユーザーの詳細を参照できます。

DotNet CLI

コマンド: enterprise-user view

パラメーター: --team メールアドレスまたはUID

エイリアス: eu vie

例:

My Vault> eu view [email protected]

 User Email:  [email protected]
  User Name:  John Doe
    User ID:  894448414228492
     Status:  Active
      Teams:  Engineering Team
              DevOps Team
       Node:  Engineering

My Vault> enterprise-user view 894448414228492

 User Email:  [email protected]
  User Name:  John Doe
    User ID:  894448414228492
     Status:  Active
      Teams:  Engineering Team
              DevOps Team
       Node:  Engineering 

DotNet SDK

メソッド:

EnterpriseData.GetTeamsForUser

EnterpriseData.TryGetTeam

EnterpriseData.TryGetTeam

次の関数を組み合わせると、エンタープライズ上のユーザーに関するデータを取得できます。

PowerCommander

コマンド: Get-KeeperEnterpriseUser

構文:

Get-KeeperEnterpriseUser [[-Email] <string>] [[-Filter] <string>] [<CommonParameters>]

エイリアス: keu

パラメーター:

• -Email - ユーザーのメールアドレス

• -Filter - 検索フィルター

例:

PS> Get-KeeperEnterpriseUser
OR
# すべてのユーザーを一覧
PS> keu
# 特定のユーザーを取得
PS>Get-KeeperEnterpriseUser -Email "[email protected]"

# ユーザーを検索
PS> Get-KeeperEnterpriseUser -Filter "admin"

Python CLI

コマンド: enterprise-user --view

パラメーター:

email - ユーザーのメールアドレス。繰り返し指定可。(必須)

フラグ:

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

• -h, --help - このヘルプを表示して終了

• --format - 出力形式: {table,json}

• --output - 出力先ファイルのパス (形式が "table" のときは無視)

例:

My vault> enterprise-user --view <User email or UID> --output <file-path> --format json

Python SDK

関数:

username = '[email protected]'
enterprise_data = enterprise_types.IEnterpriseData
user = [user for user in enterprise_data.users.get_all_entities() if user.username.lower() == user_name.lower()]

エンタープライズユーザーの追加

エンタープライズユーザーを作成します。

DotNet CLI

コマンド: enterprise-user invite

エイリアス: eu invite

パラメーター:

パラメーター	説明
email	追加するユーザーのメールアドレス

例:

My Vault> enterprise-user invite <email>
User [email protected] invited.

My Vault> eu invite <email>
User [email protected] invited.

DotNet SDK

メソッド: InviteUser(string email, [InviteUserOptions options = null])

Task<KeeperSecurity.Enterprise.EnterpriseUser> EnterpriseData.InviteUser(string email, [InviteUserOptions options = null])

引数:

引数	型	必須	説明
email	string	はい	招待するユーザーのメールアドレス
options	InviteUserOptions	いいえ	招待オプション (既定: null)

戻り値:

Task<EnterpriseUser> - 作成された EnterpriseUser を返すタスク

InviteUserOptions のプロパティ:

プロパティ	型	説明
FullName	string	ユーザーの氏名
NodeId	long	ユーザーを割り当てるノードID
TeamIds	IEnumerable	ユーザーを追加するチームIDの一覧

例:

var newUser = await context.EnterpriseData.InviteUser("[email protected]");
Console.WriteLine($"Invited user: {newUser.Email}");

PowerCommander

コマンド: Add-KeeperEnterpriseUser

パラメーター:

パラメーター	説明
Email	招待するメールアドレス

フラグ:

フラグ	説明
-Name	ユーザーの氏名
-Node	ユーザーを割り当てるノード名またはID
-NodeId	ノードID (long)。-Node の代わりに指定
-Emails	追加で招待するメールアドレス (一括招待用)

例:

PS> Add-KeeperEnterpriseUser -Node "Test node" -Email "[email protected]"
User invited: [email protected]

Python CLI

コマンド: enterprise-user --add

パラメーター:

email - ユーザーのメールアドレス。繰り返し指定可。(必須)

フラグ:

• -h, --help - このヘルプを表示して終了

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

• --name - ユーザーの氏名を設定

• --job-title - 役職を設定

例:

My Vault> enterprise-user --add <User email> --name <FULL_NAME> --job-title <JOB_TITLE> --add-role <ADD_ROLE>
User Add: User ID = 1234567

Python SDK

関数:

from keepersdk.enterprise import batch_management, enterprise_management

batch = batch_management.BatchManagement(loader=enterprise_loader, logger=enterprise_management_logger)
users_to_add = [enterprise_management.UserEdit(
            enterprise_user_id=enterprise_loader.get_enterprise_id(), node_id=user_node_id, username=email,
            full_name=full_name, job_title=job_title)
            for email in unique_emails]
batch.modify_users(to_add=users_to_add)
batch.apply()

エンタープライズユーザーの編集

ロールやチームの追加・削除など、エンタープライズユーザーの詳細を編集します。

DotNet CLI

DotNet CLI はチームへの追加 (team-add) とチームからの削除 (team-remove) に対応しています。

チームへの追加:

コマンド: enterprise-user team-add

エイリアス: eu team-add

パラメーター:

パラメーター	説明
email	チームに追加するユーザーのメールアドレス
--team	チーム名またはUID

フラグ:

フラグ	説明
--teamname	チーム名の代替フラグ
--help	ヘルプ画面を表示
--version	バージョン情報を表示

例:

My Vault> enterprise-user team-add [email protected] --team "Developers"
User [email protected] added to team: Developers
# OR using alias
My Vault> eu team-add [email protected] --team "Developers"
User [email protected] added to team: Developers

チームからの削除:

コマンド: enterprise-user team-remove

エイリアス: eu team-remove

パラメーター:

パラメーター	説明
email	チームから削除するユーザーのメールアドレス
--team	チーム名またはUID

フラグ:

フラグ	説明
--teamname	チーム名の代替フラグ
--help	ヘルプ画面を表示
--version	バージョン情報を表示

例:

My Vault> enterprise-user team-remove [email protected] --team "Developers"
User [email protected] removed from team: Developers

# OR

My Vault> eu team-remove [email protected] --team "Developers"
User [email protected] removed from team: Developers

DotNet SDK

AddUsersToTeams

.NET SDK を用いて、アクティブなユーザーを1人以上、1つ以上のチームに追加します。ステータスが「アクティブ」のユーザーのみ対象です。招待済みやロック中など非アクティブなユーザーには QueueUserToTeam を使います。

メソッド:

Task AddUsersToTeams(string[] emails, string[] teamUids, Action<string> warnings = null);

引数:

引数	型	必須	説明
emails	string[]	はい	チームに追加するユーザーのメールアドレスの配列
teamUids	string[]	はい	ユーザーを追加する先のチームUIDの配列
warnings	Action	いいえ	警告メッセージを受け取るコールバック (省略時は null)

戻り値:

Task - すべてのユーザーがすべてのチームに追加されたときに完了するタスク

例:

var emails = new[] { "[email protected]" };
var teamUids = new[] { "ABC123XYZ456" };

await context.EnterpriseData.AddUsersToTeams(emails, teamUids);
Console.WriteLine("User added to team successfully");

QueueUserToTeam

非アクティブなユーザー (招待済みまたはロック中) をチーム追加キューに入れます。アカウントがアクティブになると自動的にチームに追加されます。招待未承諾やロック中のユーザー向けです。

メソッド:

Task QueueUserToTeam(long enterpriseUserId, string teamUid);

引数:

引数	型	必須	説明
enterpriseUserId	long	はい	非アクティブなユーザーのエンタープライズユーザーID
teamUid	string	はい	ユーザーをキューする先のチームのUID

戻り値:

Task - ユーザーがチーム用キューに入ったときに完了するタスク

例:

var user = context.EnterpriseData.Users
    .FirstOrDefault(u => u.Email == "[email protected]");

if (user != null && user.Status != "Active")
{
    await context.EnterpriseData.QueueUserToTeam(user.Id, "TEAM_UID_123");
    Console.WriteLine($"User queued for team (Status: {user.Status})");
}

RemoveUsersFromTeams

.NET SDK を用いて、1人以上のユーザーを1つ以上のチームから削除します。チーム所属のみを外し、ユーザーアカウントの削除や他チームへの所属には影響しません。

メソッド:

Task RemoveUsersFromTeams(string[] emails, string[] teamUids, Action<string> warnings = null);

引数:

引数	型	必須	説明
emails	string[]	はい	チームから削除するユーザーのメールアドレスの配列
teamUids	string[]	はい	ユーザーを削除する元のチームUIDの配列
warnings	Action	いいえ	警告メッセージを受け取るコールバック (省略時は null)

戻り値:

Task - すべてのユーザーがすべてのチームから削除されたときに完了するタスク

例:

var emails = new[] { "[email protected]" };
var teamUids = new[] { "ABC123XYZ456" };

await context.EnterpriseData.RemoveUsersFromTeams(emails, teamUids);
Console.WriteLine("User removed from team successfully");

PowerCommander

コマンド: 近日対応

Python CLI

コマンド: enterprise-user --edit

パラメーター:

email - ユーザーのメールアドレスまたはUID。繰り返し指定可。(必須)

フラグ:

• -h, --help - このヘルプを表示して終了

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

• --name - ユーザーの氏名を設定

• --job-title - 役職を設定

• --add-role - ロール名またはロールID

• --remove-role - ロール名またはロールID

• --add-team - チーム名またはチームUID

• --remove-team - チーム名またはチームUID

• -hsf, --hide-shared-folders - 共有フォルダを表示しない。--add-team

  • のみ: {on,off}

例:

My Vault> enterprise-user --edit <User email> --name <FULL_NAME> --job-title <JOB_TITLE> --add-role <ADD_ROLE> -hsf on

Python SDK

関数:

from keepersdk.enterprise import batch_management, enterprise_management

batch = batch_management.BatchManagement(loader=context.enterprise_loader, logger=self)

user = enterprise_data.users.get_entity('user_name')
users = [user]
users_to_update = [enterprise_management.UserEdit(
                enterprise_user_id=user.enterprise_user_id, node_id=parent_node_id, full_name=full_name, job_title=job_title)
                for user in users]
batch.modify_users(to_update=users_to_update)
batch.apply()

エンタープライズユーザーの削除

エンタープライズからユーザーを削除します。

DotNet CLI

コマンド: enterprise-user delete <email>

エイリアス: eu delete <email>

パラメーター:

email メールアドレス (必須)

オプション:

• --yes - 削除時の確認プロンプトを省略する

例:

My Vault> enterprise-user delete [email protected]
# 確認を省略
eu delete [email protected] --yes 

DotNet SDK

メソッド: DeleteUser

Task DeleteUser(EnterpriseUser user);

PowerCommander

コマンド: Remove-KeeperEnterpriseUser または delete-user

パラメーター:

• -User - ユーザーのメールアドレス (必須)

• -Force - 確認を省略する

例:

PS> Remove-KeeperEnterpriseUser -User<user email> 
OR
delete-user "[email protected]" -Force

Python CLI

コマンド: enterprise-user --delete

パラメーター:

email - ユーザーのメールアドレスまたはUID。繰り返し指定可。(必須)

フラグ:

• -h, --help - このヘルプを表示して終了

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

例:

My Vault>enterprise-user --delete <User_Email OR UID> -f

Python SDK

関数:

from keepersdk.enterprise import batch_management, enterprise_management

user = enterprise_data.users.get_entity('user_name')
users = [user]
batch = batch_management.BatchManagement(loader=enterprise_loader, logger=enterprise_management_logger)
users_to_delete = [enterprise_management.UserEdit(enterprise_user_id=user.enterprise_user_id) for user in users]
batch.modify_users(to_remove=users_to_delete)
batch.apply()

エンタープライズユーザーのアクション

ロックやアンロックなど、エンタープライズユーザーに対するアクションを実行できます。

DotNet CLI

コマンド: enterprise-user <action> user_email

例:

ユーザーのロック:

My Vault> enterprise-user lock [email protected] OR eu lock [email protected]

ユーザーのアンロック:

My Vault> enterprise-user unlock [email protected] OR eu enterprise-user unlock [email protected]

DotNet SDK

メソッド: SetUserLocked

Task<EnterpriseUser> SetUserLocked(EnterpriseUser user, bool locked);

locked が true ならユーザーをロックし、false ならアンロックします。

例:

var user = await context.EnterpriseData.SetUserLocked(singleUser, arguments.Command == "lock");

PowerCommander

コマンド: Lock-KeeperEnterpriseUser または Unlock-KeeperEnterpriseUser

エイリアス: lock-user, unlock-user

パラメーター: -User - ユーザーのメールアドレス

PS> Unlock-KeeperEnterpriseUser -User [email protected]
unlock-user "[email protected]"

Lock-KeeperEnterpriseUser -User "[email protected]"
lock-user "[email protected]"

コマンド: Move-KeeperEnterpriseUser

ユーザーを別のノードへ移動する

エイリアス: transfer-user

構文:

Move-KeeperEnterpriseUser [-Email] <string> [-NodeId] <long> [<CommonParameters>]

パラメーター:

• -Email - ユーザーのメールアドレス (必須)

• -NodeId - 移動先のノードID (必須)

例:

Move-KeeperEnterpriseUser -Email "[email protected]" -NodeId 12345
transfer-user "[email protected]" 12345

Python CLI

コマンド: enterprise-user --action

パラメーター:

email - ユーザーのメールアドレスまたはID。(必須)

フラグ:

• -h, --help - このヘルプを表示して終了

• --expire - マスターパスワードを期限切れにする

• --extend - ボルト転送の同意を7日延長する。擬似ユーザー @all に対応

• --lock - ユーザーをロックする

• --unlock - ユーザーをアンロックする

• --disable-2fa - ユーザーの2要素認証を無効にする

例:

My Vault> enterprise-user --action <User_Email OR UID> --expire

Python SDK

関数:

from keepersdk.enterprise import batch_management, enterprise_management

user = enterprise_data.users.get_entity('user_name')
users = [user]
batch = batch_management.BatchManagement(loader=enterprise_loader, logger=enterprise_management_logger)
if expire_password:
    batch.user_actions(to_expire_password=[user.enterprise_user_id for user in users])
elif extend_transfer:
    batch.user_actions(to_extend_transfer=[user.enterprise_user_id for user in users])
elif lock_user:
    batch.user_actions(to_lock=[user.enterprise_user_id for user in users])
elif unlock_user:
    batch.user_actions(to_unlock=[user.enterprise_user_id for user in users])
elif disable_2fa:
    batch.user_actions(to_disable_tfa=[user.enterprise_user_id for user in users])
else:
    return

batch.apply()

エンタープライズユーザーのエイリアス

エイリアスの追加または削除により、ユーザーエイリアスを管理します。

DotNet CLI

コマンド: enterprise-user <action> username --alias="<alias>" または eu <action> username --alias="<alias>"

パラメーター:

email - ユーザーのメールアドレスまたはID。

例:

エイリアスの追加:

My Vault> eu alias-add [email protected] --alias "[email protected]"

エイリアスの削除:

My Vault> eu alias-remove [email protected] --alias "[email protected]"

DotNet SDK

メソッド: 近日対応

PowerCommander

コマンド: 近日対応

Python CLI

コマンド: enterprise-user alias

パラメーター:

email - ユーザーのメールアドレスまたはID (必須)

フラグ:

• --add-alias - ユーザーエイリアスを追加する

• --remove-alias - ユーザーエイリアスを削除する

Python SDK

関数:

from keepersdk.enterprise import batch_management, enterprise_management

user = enterprise_data.users.get_entity('user_name')
aliases = enterprise_data.user_aliases.get_links_by_subject(user.enterprise_user_id)
add_user = 'email_to_add_as_alias'
if user.username == add_user:
    logging.error(f'User "%s" alias already exists', add_user)
has_alias = any((True for alias in aliases if alias.username == add_user))
if has_alias:
    alias_rq = APIRequest_pb2.EnterpriseUserAliasRequest()
    alias_rq.enterpriseUserId = user.enterprise_user_id
    alias_rq.alias = add_user
    KeeperAuth.execute_auth_rest('enterprise/enterprise_user_set_primary_alias', alias_rq)
else:
    alias_request = APIRequest_pb2.EnterpriseUserAddAliasRequest()
    alias_request.enterpriseUserId = user.enterprise_user_id
    alias_request.alias = add_user
    alias_request.primary = True
    add_rs = KeeperAuth.execute_auth_rest(
        'enterprise/enterprise_user_add_alias', alias_request, response_type=APIRequest_pb2.EnterpriseUserAddAliasResponse)

エンタープライズユーザーの招待の再送

非アクティブなユーザーに招待を再送するコマンド/関数です。

DotNet CLI

コマンド: enterprise-user <action> username または eu <action> username

パラメーター:

email - ユーザーのメールアドレスまたはID。

例:

My Vault> eu resend-invite "[email protected]"

参照:

Commanderリファレンス

DotNet SDK

招待の再送:

メソッド: ResendEnterpriseInvite

使い方:

 public async Task ResendEnterpriseInvite(EnterpriseUser enterpriseUser)

パラメーター:

パラメーター	説明
enterpriseUser	ユーザーを表す EnterpriseUser オブジェクト

例:

await EnterpriseManagementExamples.EnterpriseUserExamples.UserExamples.ResendEnterpriseInviteExample("[email protected]");

参照:

Commanderリファレンス

PowerCommander

コマンド: Resend-KeeperEnterpriseInvite

フラグ:

パラメーター	説明
User	再度招待を送る対象のユーザー

例:

PS> Resend-KeeperEnterpriseInvite -User "[email protected]"      
Invite for [email protected] resent.


PS> Resend-KeeperEnterpriseInvite -User [email protected]                        
Resend-KeeperEnterpriseInvite: User has already accepted invitation. Only inactive users can have invitations resent.

参照:

Commanderリファレンス

Python CLI

近日対応

参照:

Commanderリファレンス

Python SDK

近日対応

参照:

Commanderリファレンス

エンタープライズユーザーのマスターパスワード期限の設定

マスターパスワードの期限を設定し、ユーザーに新しいパスワードの設定を求めるコマンド/関数です。

DotNet CLI

コマンド: enterprise-user <action> username または eu <action> username

パラメーター:

email - ユーザーのメールアドレスまたはID。

例:

My Vault> eu set-master-password-expire "[email protected]"

参照:

Commanderリファレンス

DotNet SDK

マスターパスワード期限の設定:

メソッド: SetMasterPasswordExpire

使い方:

 public async Task SetMasterPasswordExpire(string email)

パラメーター:

パラメーター	説明
email	対象ユーザーのメールアドレス

例:

await EnterpriseManagementExamples.EnterpriseUserExamples.UserExamples.SetMasterPasswordExpireExample("[email protected]");

参照:

Commanderリファレンス

PowerCommander

コマンド: Set-KeeperEnterpriseUserMasterPasswordExpire

フラグ:

パラメーター	説明
User	マスターパスワードを期限切れにするユーザー

例:

PS> Set-KeeperEnterpriseUserMasterPasswordExpire -User [email protected]                                  
Master password expiration set for [email protected]

参照:

Commanderリファレンス

Python CLI

近日対応

参照:

Commanderリファレンス

Python SDK

近日対応

参照:

Commanderリファレンス

エンタープライズチームのユーザー種別の更新

チーム内のユーザーの種別を更新するコマンド/関数です。

DotNet CLI

コマンド: enterprise-user <action> username --team=<team_name> --user-type=<user_type>

パラメーター:

email - ユーザーのメールアドレスまたはID。

team - チーム名またはID

user-type - 0=ユーザー、1=管理者、2=admin_only (共有フォルダは表示されないがチームへのユーザー追加は可能)

例:

My Vault> eu team-user-update "[email protected]" --team="T2" --user-type=0

参照:

Commanderリファレンス

DotNet SDK

チーム内ユーザーの更新:

メソッド: TeamEnterpriseUserUpdate

使い方:

 public async Task TeamEnterpriseUserUpdate(EnterpriseTeam enterpriseTeam, EnterpriseUser enterpriseUser, int userType)

パラメーター:

パラメーター	説明
enterpriseTeam	チームを表す EnterpriseTeam オブジェクト
enterpriseUser	ユーザーを表す EnterpriseUser オブジェクト
userType	0=ユーザー、1=管理者、2=admin_only (共有フォルダは表示されないがチームへのユーザー追加は可能)

例:

await EnterpriseManagementExamples.EnterpriseUserExamples.UserExamples.TeamEnterpriseUserUpdateExample("jTiPyIP4NmPiyAVv2oKFpw", "[email protected]", 0);

参照:

Commanderリファレンス

PowerCommander

コマンド: Update-KeeperEnterpriseTeamUser

フラグ:

パラメーター	説明
User	更新対象のエンタープライズユーザー
Team	チーム名またはUID
UserType	ユーザー種別: 0、1、または 2 0 - ユーザー (一般) 1 - 管理者 2 - 管理者のみ

例:

PS > Update-KeeperEnterpriseTeamUser -Team PCTTeam -User [email protected] -UserType 1                     
Team user [email protected] updated

参照:

Commanderリファレンス

Python CLI

近日対応

参照:

Commanderリファレンス

Python SDK

近日対応

参照:

Commanderリファレンス

エンタープライズユーザーの情報更新

表示名や役職など、ユーザー情報を更新するコマンド/関数です。

DotNet CLI

コマンド: enterprise-user <action> username --node=<node_name> --name=<display_name> --job-title=<title> --invitee-locale=<location_name>

パラメーター:

email - ユーザーのメールアドレスまたはID。

node - 新しいノード名またはID。

name - 新しいユーザー表示名。

job-title - 新しい役職。

invitee-locale - 新しいロケール。

例:

My Vault> eu user-update "[email protected]" --node="Test" --name="T122" --job-title="T-Engineer" --invitee-locale="en-US" 

参照:

Commanderリファレンス

DotNet SDK

ユーザー情報の更新:

メソッド: EnterpriseUserUpdate

使い方:

public async Task<EnterpriseUser> EnterpriseUserUpdate(EnterpriseUser enterpriseUser, long? nodeId = null, string fullName = null, string jobTitle = null, string inviteeLocale = null)

パラメーター:

パラメーター	説明
enterpriseUser	ユーザーを表す EnterpriseUser オブジェクト
nodeId	ノードIDまたは名前
fullName	表示名
jobTitle	役職名
inviteeLocale	サポートする21ロケールのいずれか。既定は en_US

例:

await EnterpriseManagementExamples.EnterpriseUserExamples.UserExamples.EnterpriseUserUpdateExample("[email protected]", 70411693850884, "TestUser1", "Test Engineer", "en-US");

参照:

Commanderリファレンス

PowerCommander

コマンド: Update-KeeperEnterpriseUser

フラグ:

パラメーター	必須	説明
User	はい	更新対象のエンタープライズユーザー
Node	いいえ	ノード名またはID
FullName	いいえ	ユーザーの氏名
JobTitle	いいえ	ユーザーの役職
InviteeLocale	いいえ	招待に用いるロケール

例:

PS> Update-KeeperEnterpriseUser -User [email protected] -Node PCTNode -FullName "some new name" -JobTitle "ÄBC" -InviteeLocale US
User [email protected] updated

Id             DisplayName   Email                   UserStatus NodeName TransferStatus 2FA
--             -----------   -----                   ---------- -------- -------------- ---
70411693853031 some new name [email protected] Active     PCTNode       Yes       No

参照:

Commanderリファレンス

Python CLI

近日対応

参照:

Commanderリファレンス

Python SDK

近日対応

参照:

Commanderリファレンス