UIP 管理者ユーザー

「uip admin users」および「uip admin groups」の構文とオプション - Identity Server のディレクトリ ユーザー、グループ、グループ メンバーシップを管理します。

組織のパーティション内のローカル Identity Server ユーザーとグループをuip admin usersおよびuip admin groups管理します。これは、Orchestrator レベルのロールの割り当てではなく、ログインの背後にあるディレクトリ レベルの ID。ここには、 users (ディレクトリ ユーザーの作成/読み取り/更新/削除/招待) と groups (グループの作成/読み取り/更新/削除、およびメンバーシップ管理) の 2 つの独立したコマンド グループが存在します。

--organization は両方のグループのほとんどの動詞で受け入れられますが、 非推奨となり無視されます 。組織は常に現在のログイン コンテキストから派生されます。渡すと警告 (--organization is deprecated and ignored; organization is derived from login context) が出力されますが、効果はありません。

概要

uip admin users list [--search <term>] [--sort-by <field>] [--sort-order asc|desc] [--limit <n>] [--offset <n>]
uip admin users get <user-id>
uip admin users create <username> --email <email> [--name <name>] [--surname <surname>]
uip admin users update <user-id> [--email <email>] [--name <name>] [--surname <surname>]
uip admin users delete <user-id>
uip admin users invite --email <emails> [--name <name>] [--surname <surname>]

uip admin groups list
uip admin groups get <group-id>
uip admin groups create <name>
uip admin groups update <group-id> --name <name>
uip admin groups delete <group-id>
uip admin groups members list <group-id> [--limit <n>] [--offset <n>]
uip admin groups members add <group-id> --user-ids <ids>
uip admin groups members revoke <group-id> --user-ids <ids>

動詞

グループ	動詞	目的
users	list	パーティション内のユーザーのリストを表示します (検索可能、並べ替え可能、ページ分割)。
users	get	ID でユーザーの完全な詳細を取得します。
users	create	新しいローカル ユーザーを作成します。
users	update	ユーザーのメール アドレス、名、または姓を更新します。
users	delete	ID でユーザーを削除します。
users	invite	メールで 1 人以上のユーザーを招待する
groups	list	パーティション内のすべてのグループを一覧表示します。
groups	get	グループの詳細を ID で取得します。
groups	create	新しいローカル グループを作成する
groups	update	グループの名前を変更します。
groups	delete	グループを ID で削除する
groups members	list	グループのメンバーのリストを表示します。
groups members	add	グループに 1 人以上のユーザーを追加します。
groups members	revoke	グループから 1 人以上のユーザーを削除します。

UIP 管理者リスト

パーティション内のユーザーのリストを表示します。ユーザー ID、ユーザー名、メール アドレス、名前、作成時刻を返します。

オプション

長押し	Short	値 (Value)	既定 (Default)	説明
--search <term>	-s	string	—	名前またはメール アドレスでユーザーを検索します。
--sort-by <field>		string	—	フィールドを並べ替え (例:UserName、 Emailです。
--sort-order <direction>		asc|desc	asc	並べ替え方向です。
--limit <number>	-l	integer	50 (DEFAULT_PAGE_SIZE)	返すアイテムの数です。
--offset <number>		integer	0	スキップするアイテムの数です。
--login-validity <minutes>		integer	—	この呼び出しのトークンの有効性を上書きします。

例

uip admin users list --limit 5

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

{
  "Code": "UserList",
  "Data": [
    {
      "id": "a1b2c3d4-0000-0000-0000-000000000001",
      "userName": "[e-mail]",
      "email": "[e-mail]",
      "name": "Admin",
      "surname": "User",
      "displayName": "Admin User",
      "creationTime": "2026-01-15T10:00:00.000Z"
    }
  ]
}

UIP 管理者ユーザーは

ユーザーの詳細を ID で取得します。

引数

名前	Required	目的
<user-id>	○	ユーザー ID (UUID)。users listで検索する

例

uip admin users get a1b2c3d4-0000-0000-0000-000000000001

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

{
  "Code": "UserDetails",
  "Data": {
    "id": "a1b2c3d4-0000-0000-0000-000000000001",
    "userName": "[e-mail]",
    "email": "[e-mail]",
    "name": "Admin",
    "surname": "User",
    "displayName": "Admin User",
    "creationTime": "2026-01-15T10:00:00.000Z"
  }
}

UIP 管理者ユーザーが作成

新しいローカル ユーザーを作成します。

引数

名前	Required	目的
<username>	○	新しいユーザーのユーザー名です。

オプション

長押し	Short	値 (Value)	Required	説明
--email <email>	-e	メール アドレス	○	を割り当てられました。
--name <name>	-n	string	×	ファーストネーム。
--surname <surname>		string	×	姓。

例

uip admin users create newuser --email "[e-mail]" --name "John" --surname "Doe"

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

{ "Code": "UserCreated", "Data": { "Succeeded": true } }

UIP 管理者ユーザーの更新

既存のユーザーのメール アドレス、名、または姓を更新します。少なくとも 1 つのフィールドが必要です。「なし」での呼び出しは、ネットワーク呼び出しの前にクライアント側 ("No fields to update") で失敗します。

引数

名前	Required	目的
<user-id>	○	ユーザー ID (UUID)。

オプション

長押し	Short	値 (Value)	説明
--email <email>	-e	メール アドレス	新しいメール アドレス。
--name <name>	-n	string	新しい名。
--surname <surname>		string	新しい姓。

例

uip admin users update a1b2c3d4-0000-0000-0000-000000000001 --name "Jane" --surname "Doe" --email "[e-mail]"

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

{ "Code": "UserUpdated" }

UIP 管理者ユーザー 削除

ID でユーザーを削除します。

引数

名前	Required	目的
<user-id>	○	ユーザー ID (UUID)。

例

uip admin users delete a1b2c3d4-0000-0000-0000-000000000001

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

{ "Code": "UserDeleted", "Data": { "Id": "a1b2c3d4-0000-0000-0000-000000000001", "Status": "Deleted successfully" } }

UIP 管理者ユーザーの招待

メールで 1 人以上のユーザーを招待する組織への参加を促す招待を送信します。

オプション

長押し	Short	値 (Value)	Required	説明
--email <emails>	-e	コンマ区切り	○	招待する 1 つ以上のメール アドレス
--name <name>	-n	string	×	招待されたすべてのユーザーに適用される名。
--surname <surname>		string	×	招待されたすべてのユーザーに適用された姓。

例

uip admin users invite --email "[e-mail]"

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

{ "Code": "UsersInvited", "Data": { "succeeded": true } }

UIP 管理者グループのリスト

パーティション内のすべてのグループを一覧表示します。グループ ID、名前、種類、作成時刻を返します。フィルター処理/ページネーションのオプションなし — すべてを 1 回の呼び出しで返します。

例

uip admin groups list

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

{
  "Code": "GroupList",
  "Data": [
    { "id": "a1b2c3d4-0000-0000-0000-000000000001", "name": "Administrators", "displayName": "Administrators", "type": "BuiltIn", "creationTime": "2026-01-15T10:00:00.000Z" }
  ]
}

UIP 管理グループは、

グループの詳細を ID で取得します。

引数

名前	Required	目的
<group-id>	○	グループ ID (UUID)。groups listで検索する

例

uip admin groups get a1b2c3d4-0000-0000-0000-000000000001

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

{ "Code": "GroupDetails", "Data": { "id": "a1b2c3d4-0000-0000-0000-000000000001", "name": "Administrators", "displayName": "Administrators", "type": "BuiltIn", "creationTime": "2026-01-15T10:00:00.000Z" } }

UIP 管理グループの作成

新しいローカル グループを作成する

引数

名前	Required	目的
<name>	○	グループ名。

例

uip admin groups create "DevOps Team"

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

{ "Code": "GroupCreated", "Data": { "id": "a1b2c3d4-0000-0000-0000-000000000002", "name": "DevOps Team", "displayName": "DevOps Team", "type": "Custom" } }

コマンドは、API を呼び出す前に、グループの id に対してクライアント側の UUID を生成します。ID が指定されていない場合、サーバーは 409 でグループの作成を拒否します。

UIP 管理者グループの更新

グループの名前を変更します。--name は更新可能な唯一のフィールドであり、必須です。省略するとクライアント側では失敗します ("No fields to update")。

引数

名前	Required	目的
<group-id>	○	グループ ID (UUID)。

オプション

長押し	Short	値 (Value)	Required	説明
--name <name>	-n	string	○	新しいグループ名。

例

uip admin groups update a1b2c3d4-0000-0000-0000-000000000001 --name "Renamed Group"

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

{ "Code": "GroupUpdated" }

UIP 管理グループ 削除

グループを ID で削除する

引数

名前	Required	目的
<group-id>	○	グループ ID (UUID)。

例

uip admin groups delete a1b2c3d4-0000-0000-0000-000000000002

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

{ "Code": "GroupDeleted", "Data": { "Id": "a1b2c3d4-0000-0000-0000-000000000002", "Status": "Deleted successfully" } }

UIP 管理者グループのメンバーのリスト

グループのメンバーのリストを表示します。

引数

名前	Required	目的
<group-id>	○	グループ ID (UUID)。

オプション

長押し	Short	値 (Value)	既定 (Default)	説明
--limit <number>	-l	integer	50	返すアイテムの数です。
--offset <number>		integer	0	スキップするアイテムの数です。

例

uip admin groups members list a1b2c3d4-0000-0000-0000-000000000001

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

{ "Code": "GroupMembers", "Data": [] }

UIP 管理グループ メンバーは、以下を追加します。

グループに 1 人以上のユーザーを追加します。

注:

読み取り/変更/書き込みとして実装されます。このコマンドは、グループの現在の名前を取得し、 で group-update API を呼び出します。これは directoryUserIDsToAddgroups updateと同じ基になる操作で、ペイロード フィールドが異なるだけです。専用の「メンバーを追加」API 呼び出しはありません。

引数

名前	Required	目的
<group-id>	○	グループ ID (UUID)。

オプション

長押し	値 (Value)	Required	説明
--user-ids <ids>	コンマ区切り	○	追加するユーザー ID です。users listでそれらを見つけます。

例

uip admin groups members add a1b2c3d4-0000-0000-0000-000000000001 --user-ids "user-id-1,user-id-2"

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

{ "Code": "GroupMembersAdded" }

UIP 管理者グループ メンバーが取り消す

グループから 1 人以上のユーザーを削除します。members addと同じ読み取り、変更、書き込みメカニズム directoryUserIDsToRemoveを使用します。

引数

名前	Required	目的
<group-id>	○	グループ ID (UUID)。

オプション

長押し	値 (Value)	Required	説明
--user-ids <ids>	コンマ区切り	○	削除するユーザー ID です。現在のメンバーである必要があります。

例

uip admin groups members revoke a1b2c3d4-0000-0000-0000-000000000001 --user-ids "user-id-1"

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

{ "Code": "GroupMembersRevoked" }

関連

• uip admin robot-accounts — 人間以外の ID、個人用アクセス トークン、OAuth スコープの参照。
• uip admin external-apps — OAuth2 クライアント登録とフェデレーション資格情報です。
• uip admin smtp — 組織のメールの設定です。
• uip platform users — ライセンスの割り当て (ライセンスに焦点を当てた別のユーザー画面)。

参照

• グローバル オプション
• 終了コード