uip or users

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

uip or users は、Orchestrator ユーザーをテナント レベルで管理します。Orchestrator のユーザーは ID サービス (IS) によってサポートされます。このツールではスタンドアロン ユーザーをゼロから作成することはできません。代わりに、 users import は 既存の IS ディレクトリ プリンシパル (ユーザー、グループ、ロボット アカウント、外部アプリケーション) を参照し、テナントにプロビジョニングします。その後、 users update は Orchestrator 側に存在するテナント側のプロパティ (ライセンス、セッション権限、Unattended 資格情報) を編集します。users deleteはありません。ユーザーの削除は、この CLI ではなく Identity Service または Orchestrator ポータルを使用して管理されます。フォルダー レベルのロール管理については、「 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	既存の Identity Service ディレクトリ プリンシパルをテナントにインポートします。
assign	ユーザーをフォルダーに割り当てます。任意でフォルダー レベルのロールを設定します。
unassign	フォルダーからユーザーを削除します。
update (エイリアス edit)	ユーザーのテナント側のプロパティを更新します (PATCH セマンティクス)。
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 またはユーザーのインポート

ディレクトリ プリンシパル (Identity Service のユーザー、グループ、ロボット アカウント、外部アプリケーション) をこのテナントにインポートします。これは、この CLI が新しいテナント ユーザーをプロビジョニングする唯一の方法です。スタンドアロンの「ユーザーを作成する」動詞はありません。Orchestrator ユーザーは常に IS プリンシパルによってサポートされるためです。

既存の IS プリンシパルを --username または --directory-idで参照し、そのプリンシパルがどの種類のプリンシパルであるかを宣言するための --type を使用します (CLI は推測しません)。任意で、 --folder-path/--folder-key と --role-keys を使用する同じ呼び出しでフォルダー ロールを割り当てます — フォルダーとロールの両方を一緒に指定するか、両方指定しない必要があります。--directory-id インポートはべき等です。インポート済みのプリンシパルをディレクトリ ID でインポートすると、失敗するのではなく、既存のテナント レコードが返されます。

ロボット アカウントと外部アプリケーションは、 --directory-id (IS UUID) を使用してインポートする必要があります。Orchestrator は、ディレクトリ ユーザーを解決する方法を <domain>\<name> しても解決できません。uip admin robot-accounts list --search <name> または uip admin external-apps listで ID を検索します。

引数と必須の識別子

名前	Required	目的
--username	--username/--directory-idのいずれか	ID サービスのユーザー名 (通常はメール アドレス)。
--directory-id	--username/--directory-idのいずれか	Identity Service のディレクトリ識別子 (OIDC サブジェクト/IS UUID)。DirectoryRobot および DirectoryExternalApplication の種類に必要です。

オプション

Short	長押し	値 (Value)	既定 (Default)	説明
—	--type	DirectoryUser | DirectoryGroup | DirectoryRobot | DirectoryExternalApplication	必須	ディレクトリ プリンシパルの種類。
—	--domain	text	—	Identity Service で設定されたディレクトリ ドメイン名です。Active Directory ドメインが設定されているオンプレミス環境でのみ必要です。
—	--folder-path	パス	—	インポートしたプリンシパルを割り当てるフォルダーです。--role-keysとともに使用します。
—	--folder-key	GUID	—	--folder-pathの代替フォルダーです。--role-keysとともに使用します。
—	--role-keys	GUID の CSV	—	付与するフォルダー ロールの GUID です。フォルダー オプションが必要です。 --role-keys のないフォルダー オプションも拒否されます。

例

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 は、 --directory-id がテナントにすでに存在するプリンシパルと一致した場合に追加されます。

uip or users assign

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

注:

注意 — 役割に破壊的です。--role-keysが渡されると、サーバーはターゲット フォルダー内のユーザーの既存のロールをすべて指定されたロールに置き換えます。ペイロードにないロールはサイレントに削除されます。既存のロールを保持するには、最初にロールを roles user-roles list <principal-name> --type <type> で読み取ってから、目的の完全な和集合を に渡 --role-keys。ロールに追加のテナント レベルのロール メンバーシップがある場合は、代わりに roles users set を使用します。

オプション

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

フォルダーからユーザーを削除するユーザーは削除されず、フォルダーの割り当てのみが削除されます。

オプション

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 またはユーザーの更新

ユーザーのテナント側のプロパティをキー (GUID) で更新する。現在の値を読み込み、指定したフィールドをマージして保存します。オプションを 1 つ以上指定します。

edit はこの動詞の登録済みエイリアスです。 uip or users edit と同じように機能します uip or users updateです。

確実に編集可能: ライセンス プロファイル、セッション フラグ、Unattended ロボットの資格情報。ID 属性 (--name、 --surname、 --email、 --type) は API で受け入れられますが、ディレクトリ プリンシパル (DirectoryUser/Group/Robot/ExternalApplication) の場合、これらのフィールドは通常 Identity Service から同期されます。ここで変更すると、Orchestrator 側でキャッシュされたコピーのみが編集され、次回の Is 同期で上書きされる可能性があります。永続的な ID 変更を行うには、IS プリンシパルを直接編集します。

このコマンドではロールの割り当ては公開 されません 。そのためには、 users assign (フォルダー ロール) または users assign-roles (テナント ロール) を使用します。現在のテナント ロールのリストは常に変更されずに再送信されるため、更新によってリストが変更されることはありません。

引数

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

オプション

ID (ディレクトリ プリンシパルに対してのみ Orchestrator 側のキャッシュ)

長押し	値 (Value)	説明
--name	text	新しい名。
--surname	text	新しい姓。
--email	text	新しいメール アドレス。
--type	text	新しいユーザーの種類 (例: User、 DirectoryUser)。

ライセンスとセッションの権限

長押し	値 (Value)	説明
--license-type	text	たとえば、 、 Unattended、 StudioProAttendedなどです。
--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 アカウントです (例: DOMAIN\user)。
--unattended-password	text	パスワード、または外部シークレットの参照名 (読み取り専用の資格情報ストアの場合は) です。
--credential-store-key	GUID	無人実行の資格情報ストア。credential-stores listを使用して検索します。
--credential-type	Default | SmartCard	資格情報の種類。
--limit-concurrent / --no-limit-concurrent	フラグ	複数のマシンでの同時実行を許可または禁止します。

既存の UnattendedRobot レコードがないユーザーに無人資格情報フラグを設定した場合、 --unattended-username と --unattended-password の両方が同時に必要になります。Orchestrator は不完全なレコードをサイレントに破棄するため、CLI は誤った成功を報告するのではなく、レコードの送信を拒否します。既存のレコードを編集すると、これらのフラグの任意のサブセットを受け入れます。

例

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

テナント レベルのロールをユーザーに割り当てる

注:

注意 — 破壊的です。サーバーは、ユーザーのテナント レベルのロール リスト 全体 を、 --role-keys を介して渡されたキーに置き換えます。ペイロードにないロールはサイレントに削除されます。既存のテナント ロールを保持するには、最初にテナント ロールを roles user-roles list <principal-name> --type <type> で読み取ってから、目的の完全な和集合を に渡します --role-keys。users assign (フォルダー レベルのロール) とは異なり、テナント全体に適用されるロールが設定されます。

引数

名前	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 — ロール、ロールとユーザーのメンバーシップ、およびプリンシパル権限の検査を管理します (roles user-roles list、roles user-permissions list)。
• uip or folders — users assign / unassignのフォルダーキーを検索します。
• uip or jobs - 特にjobs start --user-keys。

参照

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