uip or roles

「uip or roles」の構文とオプション - Orchestrator RBAC ロール、権限、フォルダー レベルの割り当てを管理します。

uip or roles manages Orchestrator roles and permissions (RBAC). Roles bundle permissions and are assigned to users, groups, robots, machines, or external applications at either the tenant (globally) or folder (scoped) level. Verbs on this page cover roles and their permissions, role-user membership, principal-level role/permission inspection, and folder-level assignments. For tenant-level role assignment per user, see users assign-roles in uip or users.

概要

uip or roles permissions list [options]
uip or roles list [options]
uip or roles get <role-key>
uip or roles create --name <name> --type <Tenant|Folder>
uip or roles update <role-key> [--add-permissions <names>] [--remove-permissions <names>]
uip or roles delete <role-key> -y
uip or roles users list <role-key> [options]
uip or roles users set <role-key> [--add-user-keys <keys>] [--remove-user-keys <keys>]
uip or roles user-roles list <principal-name> [--type <type>] [options]
uip or roles user-permissions list <username> [--folder-path <path> | --folder-key <key>]
uip or roles assign --user-key <key> --role-keys <keys> [--folder-path <path> | --folder-key <key>]

動詞

動詞	目的
permissions list	付与可能な権限の名前を一覧表示します。
list	テナント内のロールを一覧表示します。
get	付与された権限を持つロールを 1 つ取得します。
create	TenantまたはFolderの範囲でロール (権限なし) を作成します。
update (alias edit)	ロールの権限を追加または削除します。
delete	ユーザーが作成したロールを削除します。
users list	ロールに割り当てられたユーザーのリストを取得します。
users set	ロールのユーザーを追加または削除します (一括)。
user-roles list	List a principal's (user, group, robot, machine, or external app) complete role assignments across tenant and every folder.
user-permissions list	List a user's effective permissions, tenant-wide or scoped to one folder.
assign	特定のフォルダー内のユーザーにフォルダー レベルのロールを割り当てます。

uip or roles permissions list

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

オプション

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

例

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

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

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

uip or roles list

List roles. Returns key (GUID), ID, name, display name, type, and whether the role is editable. Use the role key with roles get, roles update, or roles users set.

オプション

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

例

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

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

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

uip or roles get

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

引数

名前	Required	目的
<role-key>	○	Role key (GUID). Use roles list to find it.

オプション

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

例

uip or roles get a1b2c3d4-0000-0000-0000-000000000001
uip or roles get a1b2c3d4-0000-0000-0000-000000000001 \
    --output-filter 'Data.Permissions'
uip or roles get 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 or roles create

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

オプション

Short	長押し	値 (Value)	既定 (Default)	説明
—	--name	text	必須	ロール名。
—	--type	Tenant | Folder	必須	Tenant applies across the tenant; Folder applies within folders.

例

uip or roles create --name "Read Only" --type Tenant
uip or roles create --name "Folder Viewer" --type Folder
uip or roles create --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 or roles update

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

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

引数

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

オプション

Short	長押し	値 (Value)	既定 (Default)	説明
—	--add-permissions	名前の CSV	—	付与する権限。
—	--remove-permissions	名前の CSV	—	取り消す権限。

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

例

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

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

uip or roles update 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 or roles delete

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

引数

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

オプション

Short	長押し	値 (Value)	既定 (Default)	説明
-y	--yes	フラグ	—	Required. Confirms this irreversible operation — the CLI never prompts.

例

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

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

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

uip or roles users list

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

引数

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

オプション

Short	長押し	値 (Value)	既定 (Default)	説明
-l	--limit	Number	50	ページ サイズ
—	--offset	Number	0	カウントをスキップします。

例

uip or roles users list a1b2c3d4-0000-0000-0000-000000000001
uip or roles users list a1b2c3d4-0000-0000-0000-000000000001 --limit 200
uip or roles users list 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 or roles users set

Add or remove users on a role (bulk). Provide --add-user-keys, --remove-user-keys, or both. At least one is required. Additive/subtractive only — existing membership not named in either flag is left untouched (unlike users assign-roles, which replaces the full list).

引数

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

オプション

Short	長押し	値 (Value)	既定 (Default)	説明
—	--add-user-keys	GUID の CSV	—	追加するユーザー。
—	--remove-user-keys	GUID の CSV	—	削除するユーザー。

例

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

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

uip or roles users set 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 or roles user-roles list

List all role assignments for a principal — a user, directory group, directory robot, machine, or external application — across the tenant and every folder. Useful for auditing a principal's full access profile.

引数

名前	Required	目的
<principal-name>	○	Username, group name, robot name, machine name, or external-app name to look up.

オプション

Short	長押し	値 (Value)	既定 (Default)	説明
—	--type	User | Group | Robot | Machine | ExternalApplication	User	Principal type. The DirectoryUser/DirectoryGroup/DirectoryRobot/DirectoryExternalApplication spellings are also accepted as aliases.
-l	--limit	Number	50	ページ サイズ
—	--offset	Number	0	カウントをスキップします。

例

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

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

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

uip or roles user-permissions list

List a user's effective permissions. Without a folder option, shows tenant-level roles and permissions; with --folder-path/--folder-key, shows the roles and permissions granted in that specific folder instead. Returns the deduplicated union of permissions granted by all matching roles.

引数

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

オプション

Short	長押し	値 (Value)	既定 (Default)	説明
—	--folder-path	パス	—	Show folder-level permissions for this folder instead of tenant-level.
—	--folder-key	GUID	—	Folder alternative to --folder-path.

例

uip or roles user-permissions list [e-mail]

uip or roles user-permissions list [e-mail] --folder-path "Shared"

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

Tenant-level:

{
  "Code": "UserPermissionList",
  "Data": {
    "Roles": ["Administrator"],
    "Permissions": ["Jobs.View", "Assets.Create"]
  }
}

Folder-scoped:

{
  "Code": "UserPermissionList",
  "Data": {
    "FolderPath": "Shared",
    "Roles": ["Folder User"],
    "Permissions": ["Jobs.View", "Assets.View"]
  }
}

uip or roles assign

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

注:

CAUTION — destructive on roles. The server replaces the user's entire folder-level role list for the target folder with the keys passed via --role-keys. Roles not in the payload are silently removed. To preserve existing folder 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 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のフォルダー キーを見つけます。

参照

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