uip or users

「uip or users」の構文とオプション - Orchestrator テナント ユーザーとそのフォルダーとロールの割り当てを管理します。

uip or users manages Orchestrator users at the tenant level. Orchestrator users are backed by Identity Service (IS) — this tool does not create standalone users from scratch. Instead, users import references an existing IS directory principal (a user, group, robot account, or external application) and provisions it into the tenant; users update then edits the tenant-side properties (license, session permissions, unattended credentials) that live on the Orchestrator side. There is no users delete — user removal is managed through Identity Service or the Orchestrator portal, not this CLI. For folder-level role management, see uip or roles.

概要

uip or users list [options]
uip or users list-in-folder [--folder-path <path> | --folder-key <key>] [options]
uip or users list-available [--folder-path <path> | --folder-key <key>] [options]
uip or users get <user-key>
uip or users import (--username <name> | --directory-id <id>) --type <type> [--folder-path <path> | --folder-key <key>] [--role-keys <keys>]
uip or users assign --user-key <key> [--folder-path <path> | --folder-key <key>] [--role-keys <keys>]
uip or users unassign --user-key <key> [--folder-path <path> | --folder-key <key>]
uip or users update <user-key> [options]
uip or users current
uip or users assign-roles <user-key> --role-keys <keys>

動詞

動詞	目的
list	任意のフィルターを使用してテナント ユーザーを表示します。
list-in-folder	フォルダーに割り当てられているユーザーを、フォルダー レベルのロールとともに一覧表示します。
list-available	フォルダーにまだ割り当てることができる (まだ割り当てられていない) ユーザーのリストを取得します。
get	キーで 1 人のユーザーを取得します。
import	Import an existing Identity Service directory principal into the tenant.
assign	ユーザーをフォルダーに割り当てます。任意でフォルダー レベルのロールを設定します。
unassign	フォルダーからユーザーを削除します。
update (alias edit)	Update a user's tenant-side properties (PATCH semantics).
current	現在認証されているユーザーの詳細を返します。
assign-roles	ユーザーのテナント レベルのロールの割り当てを置き換えます。

uip or users list

テナント内のユーザーのリストを取得します。ユーザー キー (GUID)、ユーザー名、フル ネーム、メール アドレス、種類、アクティブ ステータスを返します。

オプション

Short	長押し	値 (Value)	既定 (Default)	説明
—	--key	GUID	—	ユーザー キー (完全一致) でフィルター処理します。
—	--username	text	—	ユーザー名でフィルター (次の値を含む)
—	--email	text	—	メール アドレスでフィルター処理します (一致する文字列を含む)。
-l	--limit	Number	50	ページ サイズ
—	--offset	Number	0	カウントをスキップします。
—	--sort-by	フィールド	—	OData の並べ替え ( UserName ascなど)。
—	--all-fields	フラグ	無効	選定された概要ではなく、完全な API ペイロードを返します。

例

uip or users list --limit 10
uip or users list --username admin
uip or users list --output-filter 'Data[].{key:Key, name:UserName}'

データシェイプ(--output json)

{
  "Code": "UserList",
  "Data": [
    {
      "Key": "d4e5f6a7-0000-0000-0000-000000000001",
      "UserName": "[e-mail]",
      "FullName": "Admin User",
      "Email": "[e-mail]",
      "Type": "User",
      "IsActive": true
    }
  ],
  "Pagination": { "Returned": 1, "Limit": 50, "Offset": 0 }
}

uip or users list-in-folder

フォルダーに割り当てられているユーザーを、フォルダー レベルのロールとともに一覧表示します。--folder-path または --folder-keyが必要です。

オプション

Short	長押し	値 (Value)	既定 (Default)	説明
—	--folder-path	パス	—	ターゲット フォルダー。これまたは --folder-keyを指定します。
—	--folder-key	GUID	—	ターゲット フォルダー。これまたは --folder-pathを指定します。
—	--include-inherited	フラグ	無効	親フォルダーから継承されたユーザーも表示されます。
-l	--limit	Number	50	ページ サイズ
—	--offset	Number	0	カウントをスキップします。
—	--sort-by	フィールド	Id desc	OData の並べ替え。
—	--all-fields	フラグ	無効	選定された概要ではなく、完全な API ペイロードを返します。

例

uip or users list-in-folder --folder-path "Shared"
uip or users list-in-folder --folder-path "Shared" --include-inherited
uip or users list-in-folder --folder-path "Shared" \
    --output-filter 'Data[].{name:UserName, roles:Roles}'

データシェイプ(--output json)

{
  "Code": "UserList",
  "Data": [
    {
      "Key": "d4e5f6a7-0000-0000-0000-000000000001",
      "UserName": "[e-mail]",
      "FullName": "Admin User",
      "Type": "User",
      "IsInherited": false,
      "Roles": "Folder Administrator"
    }
  ]
}

uip or users list-available

フォルダーに割り当て可能なテナント ユーザーのリストを取得します。返されたキーを users assign または roles assignで使用します。

オプション

Short	長押し	値 (Value)	既定 (Default)	説明
—	--folder-path	パス	—	ターゲット フォルダー。これまたは --folder-keyを指定します。
—	--folder-key	GUID	—	ターゲット フォルダー。これまたは --folder-pathを指定します。
-s	--search	text	—	ユーザー名でフィルター (次の値を含む)
-l	--limit	Number	50	ページ サイズ
—	--offset	Number	0	カウントをスキップします。

例

uip or users list-available --folder-path "Shared"
uip or users list-available --folder-path "Shared" --search admin
uip or users list-available --folder-path "Shared" \
    --output-filter 'Data[].Key'

データシェイプ(--output json)

{
  "Code": "UserAvailableList",
  "Data": [
    {
      "Key": "d4e5f6a7-0000-0000-0000-000000000003",
      "UserName": "[e-mail]",
      "Roles": ""
    }
  ]
}

uip or users get

GUID キーでユーザーを取得します。

引数

名前	Required	目的
<user-key>	○	ユーザー キー (GUID)。

オプション

Short	長押し	値 (Value)	既定 (Default)	説明
—	--all-fields	フラグ	無効	選定された概要ではなく、完全な API ペイロードを返します。

例

uip or users get d4e5f6a7-0000-0000-0000-000000000001
uip or users get d4e5f6a7-0000-0000-0000-000000000001 --all-fields
uip or users get d4e5f6a7-0000-0000-0000-000000000001 --output-filter 'Data.Email'

データシェイプ(--output json)

{
  "Code": "User",
  "Data": {
    "Key": "d4e5f6a7-0000-0000-0000-000000000001",
    "UserName": "[e-mail]",
    "FullName": "Admin User",
    "Email": "[e-mail]",
    "Type": "User",
    "IsActive": true
  }
}

uip or users import

Import a directory principal — an Identity Service user, group, robot account, or external application — into this tenant. This is the only way this CLI provisions a new tenant user; there is no standalone "create a user" verb, because Orchestrator users are always backed by an IS principal.

References an existing IS principal by --username or --directory-id, plus --type to declare which kind of principal it is (the CLI does not guess). Optionally assigns folder roles in the same call with --folder-path/--folder-key and --role-keys — both a folder and roles must be provided together, or neither. --directory-id imports are idempotent: importing an already-imported principal by directory ID returns the existing tenant record instead of failing.

Robot accounts and external applications must be imported with --directory-id (the IS UUID) — Orchestrator can't resolve them by <domain>\<name> the way it resolves a directory user. Find the ID with uip admin robot-accounts list --search <name> or uip admin external-apps list.

Arguments and required identifiers

名前	Required	目的
--username	one of --username/--directory-id	Identity Service username (typically an email).
--directory-id	one of --username/--directory-id	Identity Service directory identifier (OIDC subject / IS UUID). Required for DirectoryRobot and DirectoryExternalApplication types.

オプション

Short	長押し	値 (Value)	既定 (Default)	説明
—	--type	DirectoryUser | DirectoryGroup | DirectoryRobot | DirectoryExternalApplication	必須	Directory principal type.
—	--domain	text	—	Directory domain name as configured in Identity Service. Only needed for on-premises environments with configured AD domains.
—	--folder-path	パス	—	Folder to assign the imported principal to. Use with --role-keys.
—	--folder-key	GUID	—	Folder alternative to --folder-path. Use with --role-keys.
—	--role-keys	GUID の CSV	—	Folder role GUIDs to grant. Requires a folder option; a folder option without --role-keys is also rejected.

例

uip or users import --username [e-mail]

uip or users import --username [e-mail] \
    --folder-path Shared --role-keys a1b2c3d4-0000-0000-0000-000000000001

# Robot account — directory ID required
uip or users import --directory-id 11111111-2222-3333-4444-555555555555 \
    --type DirectoryRobot

データシェイプ(--output json)

{
  "Code": "UserImported",
  "Data": {
    "UserName": "[e-mail]",
    "Type": "DirectoryUser",
    "AssignedFolderPath": "Shared",
    "AssignedRoleKeys": ["a1b2c3d4-0000-0000-0000-000000000001"]
  }
}

AlreadyImported: true is added when --directory-id matched a principal already present in the tenant.

uip or users assign

ユーザーをフォルダーに割り当てます。任意でフォルダー レベルのロールを設定します。

注:

CAUTION — destructive on roles. If --role-keys is passed, the server replaces all of the user's existing roles in the target folder with the ones supplied — roles not in the payload are removed silently. To preserve existing roles, read them first with roles user-roles list <principal-name> --type <type> and pass the full desired union to --role-keys. For additive tenant-level role membership on a role, use roles users set instead.

オプション

Short	長押し	値 (Value)	既定 (Default)	説明
—	--user-key	GUID	必須	ユーザー キー
—	--role-keys	GUID の CSV	—	フォルダー スコープのロール GUID。
—	--folder-path	パス	—	ターゲット フォルダー。これまたは --folder-keyを指定します。
—	--folder-key	GUID	—	ターゲット フォルダー。

例

uip or users assign --user-key d4e5f6a7-0000-0000-0000-000000000001 \
    --folder-path "Shared"

uip or users assign --user-key d4e5f6a7-0000-0000-0000-000000000001 \
    --folder-path "Shared" \
    --role-keys a1b2c3d4-0000-0000-0000-000000000002

uip or users assign --user-key d4e5f6a7-0000-0000-0000-000000000001 \
    --folder-path "Shared" --output-filter 'Data.Status'

データシェイプ(--output json)

{
  "Code": "UserAssigned",
  "Data": {
    "UserKey": "d4e5f6a7-0000-0000-0000-000000000001",
    "FolderPath": "Shared",
    "Status": "Assigned successfully"
  }
}

uip or users unassign

Remove a user from a folder. The user is not deleted — only their folder assignment is removed.

オプション

Short	長押し	値 (Value)	既定 (Default)	説明
—	--user-key	GUID	必須	ユーザー キー
—	--folder-path	パス	—	削除するフォルダーです。これまたは --folder-keyを指定します。
—	--folder-key	GUID	—	削除するフォルダーです。

例

uip or users unassign --user-key d4e5f6a7-0000-0000-0000-000000000001 \
    --folder-path "Shared"

uip or users unassign --user-key d4e5f6a7-0000-0000-0000-000000000001 \
    --folder-key b1c2d3e4-0000-0000-0000-000000000001

uip or users unassign --user-key d4e5f6a7-0000-0000-0000-000000000001 \
    --folder-path "Shared" --output-filter 'Data.Status'

データシェイプ(--output json)

{
  "Code": "UserUnassigned",
  "Data": {
    "UserKey": "d4e5f6a7-0000-0000-0000-000000000001",
    "FolderPath": "Shared",
    "Status": "Unassigned successfully"
  }
}

uip or users update

Update a user's tenant-side properties by key (GUID). Reads current values, merges the supplied fields, and saves. Provide at least one option.

edit is a registered alias for this verb — uip or users edit works identically to uip or users update.

Reliably editable: license profile, session flags, and unattended robot credentials. Identity attributes (--name, --surname, --email, --type) are accepted by the API, but for directory principals (DirectoryUser/Group/Robot/ExternalApplication) those fields are normally synced from Identity Service — changing them here only edits the Orchestrator-side cached copy and may be overwritten on the next IS sync. For a durable identity change, edit the IS principal directly.

This command does not expose role assignments — use users assign (folder roles) or users assign-roles (tenant roles) for that; the current tenant role list is always re-sent unchanged so an update never touches it.

引数

名前	Required	目的
<user-key>	○	ユーザー キー (GUID)。

オプション

Identity (Orchestrator-side cache only for directory principals)

長押し	値 (Value)	説明
--name	text	New first name.
--surname	text	New last name.
--email	text	New email address.
--type	text	New user type (for example User, DirectoryUser).

License and session permissions

長押し	値 (Value)	説明
--license-type	text	For example Attended, Unattended, StudioPro.
--allow-unattended / --deny-unattended	フラグ	無人ジョブの実行を許可または拒否します。
--allow-attended / --deny-attended	フラグ	有人セッションを許可または拒否します。
--allow-login / --deny-login	フラグ	Orchestrator のログインを許可または拒否します。
--allow-personal-workspace / --deny-personal-workspace	フラグ	個人用ワークスペースを許可または拒否します。
--active / --inactive	フラグ	ユーザーをアクティブ化または非アクティブ化します。

無人実行の資格情報

長押し	値 (Value)	説明
--unattended-username	text	Windows account for unattended execution (for example DOMAIN\user).
--unattended-password	text	Password, or — for a read-only credential store — the external secret reference name.
--credential-store-key	GUID	Credential store for unattended execution credentials. Use credential-stores list to find it.
--credential-type	Default | SmartCard	Credential type.
--limit-concurrent / --no-limit-concurrent	フラグ	複数のマシンでの同時実行を許可または禁止します。

If you set any unattended-credential flag on a user with no existing UnattendedRobot record, both --unattended-username and --unattended-password are required together — Orchestrator silently discards an incomplete record, so the CLI refuses to submit one rather than report a false success. Editing an existing record accepts any subset of these flags.

例

uip or users update d4e5f6a7-0000-0000-0000-000000000001 --email [e-mail]

uip or users update d4e5f6a7-0000-0000-0000-000000000001 \
    --allow-unattended --license-type Unattended \
    --unattended-username DOMAIN\\bot --unattended-password s3cret

uip or users update d4e5f6a7-0000-0000-0000-000000000001 --inactive \
    --output-filter 'Data.Status'

データシェイプ(--output json)

{
  "Code": "UserUpdated",
  "Data": { "Key": "d4e5f6a7-0000-0000-0000-000000000001", "Status": "Updated successfully" }
}

uip or users current

現在認証されているユーザーを返します。セッションを検証し、自身のユーザー キーを検出する場合に便利です。

オプション

Short	長押し	値 (Value)	既定 (Default)	説明

例

uip or users current
uip or users current --output-filter 'Data.Key'
uip or users current --output table

データシェイプ(--output json)

users getと同じUser形状。

uip or users assign-roles

Assign tenant-level roles to a user.

注:

CAUTION — destructive. The server replaces the user's entire tenant-level role list with the keys passed via --role-keys — roles not in the payload are removed silently. To preserve existing tenant roles, read them first with roles user-roles list <principal-name> --type <type> and pass the full desired union to --role-keys. Unlike users assign (folder-level roles), this sets roles that apply across the entire tenant.

引数

名前	Required	目的
<user-key>	○	ユーザー キー (GUID)。

オプション

Short	長押し	値 (Value)	既定 (Default)	説明
—	--role-keys	GUID の CSV	必須	テナントの範囲で割り当てるロール GUID。

例

uip or users assign-roles d4e5f6a7-0000-0000-0000-000000000001 \
    --role-keys a1b2c3d4-0000-0000-0000-000000000001

uip or users assign-roles d4e5f6a7-0000-0000-0000-000000000001 \
    --role-keys a1b2c3d4-0000-0000-0000-000000000001,a1b2c3d4-0000-0000-0000-000000000002

uip or users assign-roles d4e5f6a7-0000-0000-0000-000000000001 \
    --role-keys a1b2c3d4-0000-0000-0000-000000000001 \
    --output-filter 'Data.RolesAssigned'

データシェイプ(--output json)

{
  "Code": "UserRolesAssigned",
  "Data": {
    "UserKey": "d4e5f6a7-0000-0000-0000-000000000001",
    "RolesAssigned": 1,
    "Status": "Assigned successfully"
  }
}

終了コード

「終了コード」を参照してください。動詞固有の上書きはありません。

関連コマンド

• uip or roles — manage roles, role-user membership, and principal permission inspection (roles user-roles list, roles user-permissions list).
• uip or folders — users assign / unassignのフォルダーキーを検索します。
• uip or jobs - 特にjobs start --user-keys。

参照

• 認証。
• グローバル オプション。