UIP またはロール

uip or roles は Orchestrator のロールと権限 (RBAC) を管理します。ロールには権限がバンドルされており、テナント (グローバル) レベルまたはフォルダー (対象) レベルでユーザーに割り当てられます。このページの動詞では、ロールとその権限、ロールとユーザーのメンバーシップ、フォルダー レベルの割り当てについて説明します。ユーザーごとのテナント レベルのロールの割り当てについては、uip or usersusers assign-rolesをご覧ください。

概要

uip or roles <verb> [options]

動詞

動詞	目的
list-permissions	付与可能な権限の名前を一覧表示します。
list-roles	テナント内のロールを一覧表示します。
get-role	付与された権限を持つロールを 1 つ取得します。
create-role	TenantまたはFolderの範囲でロール (権限なし) を作成します。
edit-role	ロールの権限を追加または削除します。
delete-role	ユーザーが作成したロールを削除します。
list-role-users	ロールに割り当てられたユーザーのリストを取得します。
set-role-users	ロールのユーザーを追加または削除します (一括)。
list-user-roles	テナントとすべてのフォルダーにおけるユーザーのロールの完全な割り当てを表示します。
assign	特定のフォルダー内のユーザーにフォルダー レベルのロールを割り当てます。

uip または roles list-permissions

付与可能なすべての権限名を一覧表示します。これらの名前は 、 roles edit-role --add-permissionsと一緒に使用してください 。

オプション

Short	長押し	値 (Value)	既定 (Default)	説明
-t	--tenant	name	セッションの既定値	テナントを上書きします。
-l	--limit	Number	50	ページ サイズ
—	--offset	Number	0	カウントをスキップします。
—	--order-by	フィールド	Name asc	OData の並べ替え。

例

uip or roles list-permissions --limit 200
uip or roles list-permissions --output-filter 'Data[].Name'
uip or roles list-permissions --output table

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

{
  "Code": "PermissionList",
  "Data": [{ "Name": "Assets.Create" }, { "Name": "Assets.Delete" }]
}

uip または roles list-roles

ロールを一覧表示します。キー (GUID)、ID、名前、表示名、種類、およびロールが編集可能かどうかを返します。

オプション

Short	長押し	値 (Value)	既定 (Default)	説明
-t	--tenant	name	セッションの既定値	テナントを上書きします。
-l	--limit	Number	50	ページ サイズ
—	--offset	Number	0	カウントをスキップします。
—	--order-by	フィールド	Id desc	OData の並べ替え。

例

uip or roles list-roles --limit 50
uip or roles list-roles --output-filter "Data[?Type=='Tenant'].Name"
uip or roles list-roles --output table

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

{
  "Code": "RoleList",
  "Data": [
    {
      "Key": "a1b2c3d4-0000-0000-0000-000000000001",
      "ID": 1,
      "Name": "Administrator",
      "DisplayName": "Administrator",
      "Type": "Tenant",
      "IsEditable": false
    }
  ]
}

uip または roles get-role

付与された権限を持つロールを取得します。

引数

名前	Required	目的
<role-key>	○	ロール キー (GUID)。

オプション

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

例

uip or roles get-role a1b2c3d4-0000-0000-0000-000000000001
uip or roles get-role a1b2c3d4-0000-0000-0000-000000000001 \
    --output-filter 'Data.Permissions'
uip or roles get-role a1b2c3d4-0000-0000-0000-000000000001 --output table

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

{
  "Code": "Role",
  "Data": {
    "Key": "a1b2c3d4-0000-0000-0000-000000000001",
    "ID": 1,
    "Name": "Administrator",
    "DisplayName": "Administrator",
    "Type": "Tenant",
    "IsStatic": true,
    "IsEditable": false,
    "Permissions": "Assets.View, Assets.Create, Jobs.View"
  }
}

uip または roles create-role

権限のないロールを作成します。作成後、 roles edit-role --add-permissionsで権限を付与します。

オプション

Short	長押し	値 (Value)	既定 (Default)	説明
—	--name	text	必須	ロール名。
—	--type	ENUM	必須	Tenant (テナント全体に適用) または Folder (フォルダー内で適用) を選択します。
-t	--tenant	name	セッションの既定値	テナントを上書きします。

例

uip or roles create-role --name "Read Only" --type Tenant
uip or roles create-role --name "Folder Viewer" --type Folder
uip or roles create-role --name "Read Only" --type Tenant \
    --output-filter 'Data.Key'

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

{
  "Code": "RoleCreated",
  "Data": {
    "Key": "a1b2c3d4-0000-0000-0000-000000000010",
    "ID": 10,
    "Name": "Read Only",
    "Type": "Tenant",
    "Status": "Created successfully"
  }
}

uip または roles edit-role

ロールの権限を追加または削除します。現在の権限を読み取り、--add-permissions/--remove-permissions内の名前のisGranted切り替えて保存します。新しい名前 (まだロールに含まれていない名前) は、テナントの完全な権限カタログで検索されて追加されます。

引数

名前	Required	目的
<role-key>	○	ロール キー (GUID)。

オプション

Short	長押し	値 (Value)	既定 (Default)	説明
—	--add-permissions	名前の CSV	—	付与する権限。
—	--remove-permissions	名前の CSV	—	取り消す権限。
-t	--tenant	name	セッションの既定値	テナントを上書きします。

--add-permissionsまたは--remove-permissionsのうち少なくとも 1 つが必要です。

例

uip or roles edit-role a1b2c3d4-0000-0000-0000-000000000010 \
    --add-permissions Assets.View,Jobs.View

uip or roles edit-role a1b2c3d4-0000-0000-0000-000000000010 \
    --remove-permissions Jobs.Edit

uip or roles edit-role a1b2c3d4-0000-0000-0000-000000000010 \
    --add-permissions Assets.View --output-filter 'Data.Status'

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

{
  "Code": "RoleUpdated",
  "Data": { "Key": "a1b2c3d4-0000-0000-0000-000000000010", "Status": "Updated successfully" }
}

uip または roles delete-role

ユーザーが作成したロールを削除します。組み込みロール ( IsStatic=true) は削除できません。

引数

名前	Required	目的
<role-key>	○	ロール キー (GUID)。

オプション

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

例

uip or roles delete-role a1b2c3d4-0000-0000-0000-000000000010
uip or roles delete-role a1b2c3d4-0000-0000-0000-000000000010 \
    --output-filter 'Data.Status'
uip or roles delete-role a1b2c3d4-0000-0000-0000-000000000010 --output plain

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

{
  "Code": "RoleDeleted",
  "Data": { "Key": "a1b2c3d4-0000-0000-0000-000000000010", "Status": "Deleted successfully" }
}

uip または roles list-role-users

ロールに割り当てられたユーザーのリストを取得します。

引数

名前	Required	目的
<role-key>	○	ロール キー (GUID)。

オプション

Short	長押し	値 (Value)	既定 (Default)	説明
-t	--tenant	name	セッションの既定値	テナントを上書きします。
-l	--limit	Number	50	ページ サイズ
—	--offset	Number	0	カウントをスキップします。

例

uip or roles list-role-users a1b2c3d4-0000-0000-0000-000000000001
uip or roles list-role-users a1b2c3d4-0000-0000-0000-000000000001 --limit 200
uip or roles list-role-users a1b2c3d4-0000-0000-0000-000000000001 \
    --output-filter 'Data[].UserName'

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

{
  "Code": "RoleUserList",
  "Data": [
    {
      "Key": "d4e5f6a7-0000-0000-0000-000000000001",
      "ID": 101,
      "UserName": "[e-mail]",
      "FullName": "Admin User",
      "Type": "User"
    }
  ]
}

uip または roles set-role-users

ロールのユーザーを追加または削除します (一括)。--add-user-keys、--remove-user-keys、またはその両方を指定します。少なくとも 1 つ必要です。

引数

名前	Required	目的
<role-key>	○	ロール キー (GUID)。

オプション

Short	長押し	値 (Value)	既定 (Default)	説明
—	--add-user-keys	GUID の CSV	—	追加するユーザー。
—	--remove-user-keys	GUID の CSV	—	削除するユーザー。
-t	--tenant	name	セッションの既定値	テナントを上書きします。

例

uip or roles set-role-users a1b2c3d4-0000-0000-0000-000000000010 \
    --add-user-keys d4e5f6a7-0000-0000-0000-000000000001

uip or roles set-role-users a1b2c3d4-0000-0000-0000-000000000010 \
    --add-user-keys d4e5f6a7-…-001,d4e5f6a7-…-002 \
    --remove-user-keys d4e5f6a7-…-099

uip or roles set-role-users a1b2c3d4-0000-0000-0000-000000000010 \
    --add-user-keys d4e5f6a7-…-001 --output-filter 'Data.Added'

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

{
  "Code": "RoleUsersUpdated",
  "Data": {
    "RoleKey": "a1b2c3d4-0000-0000-0000-000000000010",
    "Added": 1,
    "Removed": 0,
    "Status": "Updated successfully"
  }
}

uip または roles list-user-roles

テナントおよびすべてのフォルダーにおけるユーザーのすべてのロールの割り当てのリストを取得します。ユーザーのフル アクセス プロファイルを監査する場合に便利です。

引数

名前	Required	目的
<username>	○	検索するユーザー名です。

オプション

Short	長押し	値 (Value)	既定 (Default)	説明
-t	--tenant	name	セッションの既定値	テナントを上書きします。
-l	--limit	Number	50	ページ サイズ
—	--offset	Number	0	カウントをスキップします。

例

uip or roles list-user-roles [e-mail]
uip or roles list-user-roles [e-mail] \
    --output-filter "Data[?Scope=='Folder']"
uip or roles list-user-roles [e-mail] --output table

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

{
  "Code": "UserRoleList",
  "Data": [
    { "Scope": "Tenant", "FolderPath": "", "Role": "Administrator" },
    { "Scope": "Folder", "FolderPath": "Shared", "Role": "Folder Administrator" }
  ]
}

UIP またはロールの割り当て

フォルダー レベルのロールをユーザーに割り当てる。フォルダーの種類のロールのみを使用します。--folder-path または --folder-keyが必要です。

オプション

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

例

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

uip or roles assign --user-key d4e5f6a7-0000-0000-0000-000000000001 \
    --role-keys a1b2c3d4-…-002,a1b2c3d4-…-003 \
    --folder-key b1c2d3e4-0000-0000-0000-000000000001

uip or roles assign --user-key d4e5f6a7-0000-0000-0000-000000000001 \
    --role-keys a1b2c3d4-0000-0000-0000-000000000002 \
    --folder-path "Shared" --output-filter 'Data.Status'

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

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

終了コード

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

関連コマンド

• uip or users — ユーザーキーの検索テナント レベルのロールの割り当ての場合はusers assign-roles。
• uip or folders — roles assignのフォルダー キーを見つけます。

参照

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