ロール

ロール API を使用して、チームのカスタムロールをプログラムで管理することができます。

クイックリファレンス

タイプ	リソース	説明
GET	/api/roles	カスタムロールを列挙します。
PUT	/api/roles/:role_id	カスタムロールのプロジェクト権限を更新します。
POST	/api/roles/:role_id/copy	カスタムロールのコピーを作成します。

カスタムロールの列挙

すべてのカスタムロールを列挙します。

GET /api/roles

クエリーパラメータ

名前	型	説明
per_page	integer 任意	取得するカスタムロールの数。
page	integer 任意	ページ番号。カスタムロールの合計数がページ制限を超える場合は、次のページを呼び出すことで後続のレコードを取得できます。

サンプルリクエスト

curl  -X GET https://www.workato.com/api/roles \
      -H 'x-user-email: <email>' \
      -H 'x-user-token: <token>'

レスポンス

[
    {
        "id": 478,
        "name": "Developer role",
        "inheritable": false,
        "folder_ids": [],
        "created_at": "2020-05-20T11:54:31.706-07:00",
        "updated_at": "2020-05-20T11:54:31.706-07:00",
        "privileges": {
            "Recipes": [ ... ],
            "Folders": [ ... ],
            ...
        }
    },
    {
        "id": 446,
        "name": "Non-developer role",
        "inheritable": false,
        "folder_ids": [],
        "created_at": "2020-04-12T08:40:11.240-07:00",
        "updated_at": "2020-04-12T08:40:11.240-07:00",
        "privileges": {
            "Recipes": [ ... ],
            "Folders": [ ... ],
            ...
        }
    }
]

カスタムロールの更新

カスタムのコラボレータのロールからアクセス可能なプロジェクトを更新します。すべてのプロジェクトに対する権限、またはフォルダー ID を指定することで特定のプロジェクトに対する権限を設定できます。フォルダー ID は、フォルダーの取得 API エンドポイントを使用して取得できます。

PUT /api/roles/:id

ペイロード

名前	型	説明
all_folders	string 必須	"true" または "false" を指定します。"folder_ids" を指定した場合は、"false" にする必要があります。
folder_ids	array	プロジェクト ID の配列。

サンプルリクエスト

curl  -X PUT https://www.workato.com/api/roles/490 \
      -H 'Authorization: Bearer <api_token>'
      -H 'Content-Type: application/json' \
      -d  '{
            "all_folders": "false",
            "folder_ids": [1232, 1224]
          }'

レスポンス

{
    "id": 45899,
    "name": "Marketing Recipe Operator",
    "inheritable": false,
    "folder_ids": [
        1232,
        1224
    ],
    "created_at": "2022-12-26T02:26:04.582-08:00",
    "updated_at": "2022-12-26T02:37:04.124-08:00",
    "privileges": {
        "Recipes": [
            "read",
            "create",
            "update",
            "run",
            "read_run_history"
        ]
    }
}

カスタムロールのコピー

カスタムのコラボレータのロールのコピーを作成します。このロールからアクセス可能なフォルダーを変更することもできます。フォルダー ID は、フォルダーの取得 API エンドポイントを使用して取得できます。

POST /api/roles/:id/copy

ペイロード

名前	型	説明
name	string 必須	カスタムロールの名前。
folder_ids	array	プロジェクト ID の配列。

サンプルリクエスト

curl  -X POST https://www.workato.com/api/roles/490/copy \
      -H 'Authorization: Bearer <api_token>'
      -H 'Content-Type: application/json' \
      -d  '{
            "name": "Finance team developer",
            "folder_ids": ["1232", "1224"]
          }'

レスポンス

{
    "id": 546,
    "name": "Finance team developer",
    "inheritable": false,
    "folder_ids": ["1232", "1224"],
    "created_at": "2020-08-14T07:23:19.599-07:00",
    "updated_at": "2020-08-14T07:23:19.599-07:00"
}