ロール

この API を使用すれば、カスタマーアカウントのカスタムロールをプログラムで管理することができます。管理者チームでカスタムロールを管理するには、カスタムロールのプラットフォーム API についての記事を参照してください。

クイックリファレンス

タイプ	リソース	説明
GET	/api/managed_users/:id/roles	カスタマーアカウント内のカスタムロールのリストを表示します。
POST	/api/managed_users/:id/roles/:role_id/copy	カスタムロールのコピーを作成します。

ベースパス

上記すべての API で、ベースパスは /api/managed_users/:id です。ここで、URL パラメータとしてカスタマーアカウント ID が必要になります。

名前	型	説明
id	string 必須	Embedded カスタマーアカウント ID または外部 ID。 外部 ID は、E を先頭に付ける必要があります (例 : Ea2300)。結果として返される ID は URL エンコードされます。

カスタムロールのリストの表示

カスタマーアカウント内のすべてカスタムロールのリストを表示します。

GET /api/managed_users/:id/roles

URL パラメータ

名前	型	説明
id	integer 必須	管理対象のカスタマー ID。

クエリパラメータ

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

サンプルリクエスト

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

レスポンス

[
    {
        "id": 1128,
        "name": "Workbot builder",
        "inheritable": false,
        "folder_ids": [],
        "created_at": "2022-08-31T23:37:04.777-07:00",
        "updated_at": "2022-08-31T23:37:04.777-07:00",
        "privileges": {
            "Recipes": [ ... ],
            "Folders": [ ... ],
            "Workbot": [
                "read",
                "create",
                "update",
                "delete"
            ],
            ...
        }
    }
]

カスタムロールのコピー

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

POST /api/recipes

ペイロード

名前	型	説明
name	string 必須	カスタムロールの名前。
folder_ids	array	フォルダー ID の配列。

サンプルリクエスト

curl  -X POST https://www.workato.com/api/managed_users/roles/490/copy \
      -H 'x-user-email: <email>' \
      -H 'x-user-token: <token>' \
      -H 'Content-Type: application/json' \
      -d  '{
            "name": "Customer developer",
            "folder_ids": ["1232", "1224"]
          }'

レスポンス

{
    "id": 546,
    "name": "Customer 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"
}