uip またはユーザー

uip or users Orchestrator ユーザーをテナント レベルで管理します。ユーザーの一覧表示、作成、編集、削除に加え、フォルダーへのユーザーの割り当て、テナント レベルのロールの割り当ての管理を行います。フォルダー レベルのロール管理については、「 uip or roles」をご覧ください。

概要

uip or users <verb> [options]

動詞

動詞	目的
list	任意のフィルターを使用してテナント ユーザーを表示します。
list-in-folder	フォルダーに割り当てられているユーザーを、フォルダー レベルのロールとともに一覧表示します。
list-available	フォルダーにまだ割り当てることができる (まだ割り当てられていない) ユーザーのリストを取得します。
get	キーで 1 人のユーザーを取得します。
create	新しいユーザーを作成する必要に応じて、テナント ロールを割り当て、無人実行の資格情報を設定します。
delete	キーをキーで削除
assign	ユーザーをフォルダーに割り当てます。任意でフォルダー レベルのロールを設定します。
unassign	フォルダーからユーザーを削除します。
edit	ユーザー プロパティを編集します (PATCH セマンティクス)。
current	現在認証されているユーザーの詳細を返します。
assign-roles	ユーザーのテナント レベルのロールの割り当てを置き換えます。

uip またはユーザー リスト

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

オプション

Short	長押し	値 (Value)	既定 (Default)	説明
—	--key	GUID	—	ユーザー キー (完全一致) でフィルター処理します。
—	--username	text	—	ユーザー名でフィルター (次の値を含む)
—	--email	text	—	メール アドレスでフィルター処理します (一致する文字列を含む)。
-l	--limit	Number	50	ページ サイズ
—	--offset	Number	0	カウントをスキップします。
—	--order-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, "HasMore": false }
}

uip または users list-in-folder

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

オプション

Short	長押し	値 (Value)	既定 (Default)	説明
-t	--tenant	name	セッションの既定値	テナントを上書きします。
—	--folder-path	パス	—	ターゲット フォルダー。これまたは --folder-keyを指定します。
—	--folder-key	GUID	—	ターゲット フォルダー。これまたは --folder-pathを指定します。
—	--include-inherited	フラグ	無効	親フォルダーから継承されたユーザーも表示されます。
-l	--limit	Number	50	ページ サイズ
—	--offset	Number	0	カウントをスキップします。
—	--order-by	フィールド	Id desc	OData の並べ替え。

例

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またはユーザーリストが利用可能です

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

オプション

Short	長押し	値 (Value)	既定 (Default)	説明
-t	--tenant	name	セッションの既定値	テナントを上書きします。
—	--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またはユーザーは

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

引数

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

オプション

Short	長押し	値 (Value)	既定 (Default)	説明
-t	--tenant	name	セッションの既定値	テナントを上書きします。
—	--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 またはユーザーが作成します。

新しいテナント ユーザーを作成します。--usernameのみ必要です。API には rolesListが必要であるため、実際には --role-keys が効果的に必要です。テナント スコープのロール GUID と組み合わせて使用します。

オプション

Identity

Short	長押し	値 (Value)	既定 (Default)	説明
—	--username	text	必須	ログイン ユーザー名。
—	--name	text	—	ファーストネーム。
—	--surname	text	—	姓。
—	--email	text	—	を割り当てられました。
—	--type	ENUM	—	ユーザーの種類 (例: User、 DirectoryUserなど)。
-t	--tenant	name	セッションの既定値	テナントを上書きします。

ロールとライセンス

Short	長押し	値 (Value)	既定 (Default)	説明
—	--role-keys	GUID の CSV	—	テナント スコープのロール GUID (API ペイロードのロール名に解決される)。
—	--license-type	ENUM	—	たとえば、 Attended、 Unattended、 StudioProです。

セッションのアクセス許可 (フラグのペア)

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

無人実行の資格情報

Short	長押し	値 (Value)	既定 (Default)	説明
—	--unattended-username	text	—	Windows アカウント (例: DOMAIN\user)
—	--unattended-password	text	—	パスワード、または読み取り専用の資格情報ストアの場合は、外部シークレットの参照名。
—	--credential-store-key	GUID	—	資格情報ストア。credential-stores list を使用して検索します。
—	--credential-type	ENUM	—	Default または SmartCard。
—	--limit-concurrent / --no-limit-concurrent	フラグ	—	複数のマシンでの同時実行を許可または禁止します。

例

uip or users create --username [e-mail] --email [e-mail] \
    --role-keys a1b2c3d4-0000-0000-0000-000000000001

uip or users create --username [e-mail] --name Bot --surname Worker \
    --role-keys a1b2c3d4-0000-0000-0000-000000000002 \
    --unattended-username DOMAIN\\bot --unattended-password s3cret

uip or users create --username [e-mail] \
    --role-keys a1b2c3d4-0000-0000-0000-000000000001 \
    --output-filter 'Data.Key'

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

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

uip または users delete

テナントからユーザーを完全に削除する。

引数

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

オプション

Short	長押し	値 (Value)	既定 (Default)	説明
-t	--tenant	name	セッションの既定値	テナントを上書きします。

例

uip or users delete d4e5f6a7-0000-0000-0000-000000000010
uip or users delete d4e5f6a7-0000-0000-0000-000000000010 --output-filter 'Data.Status'
uip or users delete d4e5f6a7-0000-0000-0000-000000000010 --output plain

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

{
  "Code": "UserDeleted",
  "Data": { "Key": "d4e5f6a7-0000-0000-0000-000000000010", "Status": "Deleted successfully" }
}

uip またはユーザーが割り当てる

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

オプション

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

例

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 またはユーザーの割り当て解除

フォルダーからユーザーを削除します。ユーザーは削除されません。

オプション

Short	長押し	値 (Value)	既定 (Default)	説明
—	--user-key	GUID	必須	ユーザー キー
—	--folder-path	パス	—	削除するフォルダーです。これまたは --folder-keyを指定します。
—	--folder-key	GUID	—	削除するフォルダーです。
-t	--tenant	name	セッションの既定値	テナントを上書きします。

例

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 またはユーザーの編集

キーをキーで編集する。現在の値を読み取って、指定されたフィールドを結合して保存します。更新するオプションを少なくとも 1 つ指定します。

引数

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

オプション

users createと同じフラグですが、--username (変更不可) と --role-keys (代わりにusers assign-rolesを使用) を除きます。すべてのセッションと権限フラグのペア、ライセンスの種類、および無人資格情報のオプションが適用されます。

例

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

uip or users edit d4e5f6a7-0000-0000-0000-000000000001 \
    --allow-unattended --license-type Unattended

uip or users edit 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 または現在のユーザー

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

オプション

Short	長押し	値 (Value)	既定 (Default)	説明
-t	--tenant	name	セッションの既定値	テナントを上書きします。

例

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

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

users getと同じUser形状。

uip またはユーザーの assign-roles

テナント レベルのロールをユーザーに割り当てるこれにより、ユーザーの現在のテナント ロールが置き換えられます。ロール レベルでの付加的なメンバーシップには roles set-role-users を使用します。

引数

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

オプション

Short	長押し	値 (Value)	既定 (Default)	説明
—	--role-keys	GUID の CSV	必須	テナントの範囲で割り当てるロール GUID。
-t	--tenant	name	セッションの既定値	テナントを上書きします。

例

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 — ロールおよびロール ユーザー メンバーシップを管理します。
• uip or folders — users assign / unassignのフォルダーキーを検索します。
• uip or jobs - 特にjobs start --user-keys。

参照

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