UIP AH カテゴリ、タグ、共同作業者、ロール、ユーザー

Automation Hub カテゴリの構文とオプション タクソノミー、フリーテキスト タグ、オートメーションごとの共同作業者、割り当て可能なロール カタログ、ユーザー アカウント。

カテゴリは 、オートメーションが配置される階層的なタクソノミーです。 タグ はフリーテキスト ラベルです。共同作業者とは 、1 つのオートメーションに取り組むユーザーのことで、それぞれが 1 つ以上の ロールを担っています 。Automation Hub の割り当て可能なロール カタログは、 uip ah users create がテナント全体のアクセス権を付与する方法でもあります。すべての動詞に適用される共通の概念 (プロジェクション/--all-fields、ページ付きリストとページなしリスト) については、uip ahをご覧ください。

UIP AH カテゴリ

カテゴリ階層を読み取って、そこにオートメーションを配置します。

概要

uip ah categories get [--all-fields]
uip ah categories update --file <json-file> [-y, --yes]
uip ah categories set <automation-id> --category-id <id>

UIP AH カテゴリ 取得

カテゴリ階層を 1 つのツリーとして、そのレベル名とともに取得します。get、 listではない: エンドポイントは、ページ単位のコレクションではなく、入れ子になった 1 つのドキュメントを返します。 --limit/--offsetはありません。

オプション

長押し	説明
--all-fields	Levels/Categoriesではなく、生のペイロードを返します。

例

uip ah categories get

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

{
  "Code": "AhCategoriesGet",
  "Data": { "Levels": [{ "Id": 1, "Name": "Business Unit" }], "Categories": [{ "Id": 4, "Name": "Finance" }] }
}

UIP AH カテゴリの更新

ファイルからカテゴリ ツリー全体を置き換えます。Automation Hub ではカテゴリごとに作成/削除できません。ツリーは 1 つのドキュメントとして同期されます。

オプション

長押し	値 (Value)	Required	説明
--file <json-file>	パス	○	同期する完全なカテゴリ ツリーを含む JSON で、 categories get が返されます。
-y, --yes	フラグ	○	これにより、テナント カテゴリ ツリー全体が置換されることを確認します。必須 — CLI はプロンプトを表示しません。

空のファイルまたは明らかに不正な形式のファイルは、要求が送信される前にクライアント側で拒否されます。

例

uip ah categories update --file ./categories.json --yes

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

{ "Code": "AhCategoriesUpdate", "Data": { "Status": "Synced" } }

UIP AH カテゴリ セット

1 つのオートメーションを 1 つのカテゴリに割り当てます。

引数

名前	Required	目的
<automation-id>	○	オートメーション ID

オプション

長押し	値 (Value)	Required	説明
--category-id <id>	integer	○	割り当てるカテゴリ ID です。

例

uip ah categories set 20 --category-id 4

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

{ "Code": "AhCategoriesSet", "Data": { "AutomationId": 20, "CategoryId": 4 } }

uip ah タグ

オートメーションにタグを設定します。

UIP AH タグ セット

オートメーションのタグを指定したセットに置き換えます — これにより、タグ リスト全体が結合されず、置き換えられます ( uip config setのセマンティクスの置換に一致します)。

引数

名前	Required	目的
<automation-id>	○	オートメーション ID

オプション

長押し	値 (Value)	Required	説明
--tags <tag...>	繰り返し可能	○	このオートメーションに対して設定された完全なタグ。

例

uip ah tags set 20 --tags finance "quick win"

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

{ "Code": "AhTagsSet", "Data": { "AutomationId": 20, "Tags": ["finance", "quick win"] } }

UIP AH 共同作業者

オートメーションで共同作業するユーザーを管理するautomationsの動詞ではなく独自のリソース グループであるため、標準の CRUD 動詞は引き続き使用できます。

概要

uip ah collaborators list --automation-id <id> [--limit <n>] [--offset <n>] [--all-fields]
uip ah collaborators create <automation-id> --user-id <id...> --role-id <id...>
uip ah collaborators delete <automation-id> --user-id <id...> --role-id <id...> [-y, --yes]

UIP AH 共同作業者のリスト

オプション

長押し	値 (Value)	Required	説明
--automation-id <id>	integer	○	読み取るオートメーションです (指定位置ではなく、このエンドポイントのクエリ パラメーター)。
--limit <n> / --offset <n>	integer	×	ページング、クライアント側 (ページなしエンドポイント) で適用されます。
--all-fields	フラグ	×	未加工のペイロードを返します。

例

uip ah collaborators list --automation-id 20

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

{
  "Code": "AhCollaboratorsList",
  "Data": [
    { "Id": 1, "Email": "[e-mail]", "FirstName": "Jane", "LastName": "Doe", "JobTitle": "Analyst", "Department": "Finance", "BusinessUnit": "EMEA", "IsActive": 1 }
  ]
}

UIP AH 共同作業者が作成

オートメーションに共同作業者を追加する

引数

名前	Required	目的
<automation-id>	○	オートメーション ID

オプション

長押し	値 (Value)	Required	説明
--user-id <id...>	繰り返し可能	○	追加するユーザー ID です。
--role-id <id...>	繰り返し可能	○	追加したすべてのユーザーに付与するロール ID です (すべてのユーザーに適用されます。ユーザーごとのロール分割では、ユーザーごとに 1 回の呼び出しが必要です)。種類が process のアクティブなロールのみが受け入れられます。その他の種類は拒否されます。

少なくとも 1 つの --role-id が必要です。つまり、エンドポイントはロールのない共同作業者のエントリを拒否します。

例

uip ah collaborators create 20 --user-id 3 --role-id 3

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

{ "Code": "AhCollaboratorsCreate", "Data": { "AutomationId": 20, "UserIds": [3] } }

UIP AH 共同作業者 削除

オートメーションのユーザーから共同作業者ロールを削除するエンドポイントは共同作業者レコードではなくロールの割り当てを削除することから、 --role-id が必要です。つまり、ユーザーが保持しているすべてのロールを削除し、共同作業者ではなくなります。

引数

名前	Required	目的
<automation-id>	○	オートメーション ID

オプション

長押し	値 (Value)	Required	説明
--user-id <id...>	繰り返し可能	○	ロールを削除するユーザー ID です。
--role-id <id...>	繰り返し可能	○	各ユーザーから削除するロール ID。
-y, --yes	フラグ	○	この元に戻せない操作を確認します。必須 — CLI はプロンプトを表示しません。

例

uip ah collaborators delete 20 --user-id 3 --role-id 3 --yes

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

{ "Code": "AhCollaboratorsDelete", "Data": { "AutomationId": 20, "UserIds": [3], "RoleIds": [3] } }

UIP AH ロール

割り当てることができる Automation Hub ロールを見つけます。読み取り専用です。

UIP AH ロール リスト

オプション

長押し	説明
--limit <n> / --offset <n>	ページング、クライアント側 (ページなしエンドポイント) で適用されます。
--all-fields	未加工のペイロードを返します。

例

uip ah roles list

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

{
  "Code": "AhRolesList",
  "Data": [
    { "Id": 2, "Name": "System Admin", "Slug": "ah-system-admin", "Type": "service", "Description": "...", "IsActive": 1, "IsDefault": 0 }
  ]
}

Slug は、 uip ah users create --role 取る値です。 Id/Type は、 collaborators create --role-id フィルター処理対象です ( Type: "process" ロールのみが受け入れられます)。

UIP AH ユーザー

Automation Hub ユーザーとそのロールを管理する

概要

uip ah users list [--search <text>] [--sort-by <field>] [--sort-order asc|desc] [--department <name>] [--business-unit <name>] [--location <name>] [--job-title <title>] [--invite-status <status>] [--role <slug>] [--limit <n>] [--offset <n>] [--all-fields]
uip ah users create --email <email> [write options...] --role-id <id...>
uip ah users update --email <email> [write options...]

UIP AH ユーザーのリスト

オプション

長押し	値 (Value)	説明
--search <text>	string	フリーテキスト検索。
--sort-by <field>	string	並べ替えの基準にするフィールド (例:user_emailです。
--sort-order <direction>	asc|desc	並べ替え方向です。
--department <name> / --business-unit <name> / --location <name> / --job-title <title>	string	スコープ フィルター
--invite-status <status>	string	この招待ステータスのみ。
--role <slug>	string	このロールを持つユーザーのみ スラッグ
--limit <n> / --offset <n>	integer	ページング。既定 --limit 20です。
--all-fields	フラグ	未加工のペイロードを返します。

例

uip ah users list --department Finance --limit 20

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

{
  "Code": "AhUsersList",
  "Data": [
    { "Id": 3, "Email": "[e-mail]", "FirstName": "Jane", "LastName": "Doe", "JobTitle": "Analyst", "Department": "Finance", "BusinessUnit": "EMEA", "Location": "Boston", "IsAdmin": 0, "IsActive": 1, "InviteStatus": 2, "AutomationCount": 3 }
  ],
  "Pagination": { "Returned": 1, "Limit": 20, "Offset": 0 }
}

UIP AH ユーザーが作成する

既存の Automation Cloud ユーザーを Automation Hub に追加します。これにより、すでに組織に存在するユーザーがインポートされます。新しいユーザーを招待することはできず、アドレスが Automation Cloud で認識されていない場合は明示的な指示エラーが発生して失敗します。

オプション

長押し	値 (Value)	Required	説明
--email <email>	メール アドレス	○	ユーザーのメール アドレス。
--first-name <name> / --last-name <name>	string	条件付き	書き込み時にサービスで必要です (以下を参照)。
--job-title <title> / --department <name> / --business-unit <name> / --location <name>	string	条件付き	書き込み時にサービスで必要です。
--invite-status <status>	integer	×	数値の Automation Hub 招待ステータス コード。既定の 2 は作成時です。
--active	フラグ	×	ユーザーをアクティブにマークします。既定値は作成時です。--inactiveと競合します。
--inactive	フラグ	×	ユーザーを非アクティブとしてマークします。--activeと競合します。
--role-id <id...>	繰り返し可能	×	割り当てるロール ID です (ID の場合はuip ah roles list )。

Automation Hub では、書き込みごとに 9 つのフィールドに値を保持する必要があります (email、 first-name、 last-name、 business-unit、 department、 location、 job-title、 invite-status、 active/inactive) — createでは、どのフィールドもフォールバックが保存されていないため、フィールドを省略すると、クライアント側で渡すフラグに正確に名前を付けることができません。

例

uip ah users create --email [e-mail] --first-name Jane --last-name Doe \
  --job-title Analyst --department Finance --business-unit EMEA --location Boston --role-id 3

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

{ "Code": "AhUsersCreate", "Data": { "Email": "[e-mail]", "Status": "Created" } }

UIP AH ユーザーの更新

によって見つかったユーザーを更新 --email。Automation Hub は書き込み時にユーザー レコード全体を置き換えるため、渡さなかったフィールドは保存されたレコードから引き継がれます。ただし、フラグと保存されているレコードの両方で 9 つの必須フィールドのいずれかが空である場合、サービスは引き続き書き込みを拒否します。

オプション

createと同じフラグですが、必要なのは --email だけです。残りは既存のレコードのギャップを埋めます。

例

uip ah users update --email [e-mail] --job-title 'Senior Analyst'

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

{ "Code": "AhUsersUpdate", "Data": { "Email": "[e-mail]", "Status": "Updated" } }

関連

• uip ah — 概要、概念、audit-logs、auth-info
• 自動化、アイデア フロー、ビジネス ケース、フェーズ、アンケート、パイプライン
• アプリケーション、コンポーネント、ドキュメント、メディア、ストア リスト、ストア レビュー

参照

• ツール (プラグイン)
• グローバル オプション
• 終了コード