レガシーロール
Embedded顧客ワークスペースでレガシーロールを管理するには、次のエンドポイントを使用します。
管理者チームでレガシーロールを管理するには、Developer APIのレガシーロールドキュメントを参照してください。
従来のロール
このページでは、レガシーロールについて説明します。 Workatoは、Environmentロールとプロジェクトロールを使用する新しい権限モデルでレガシーロールを置き換えています。 ロール移行APIまたはアプリ内移行ウィザードを使用して、レガシーロールを移行できます。 詳細については、新しい権限モデルドキュメントを参照してください。
レート制限
rolesリソースには、次のレート制限があります:
| タイプ | リソース | 制限 |
|---|---|---|
| すべて | すべてのレガシーロールエンドポイント | 1分あたり60リクエスト |
クイックリファレンス
| タイプ | リソース | 説明 |
|---|---|---|
| GET | /api/managed_users/:id/roles | 顧客ワークスペース内のカスタムロールを一覧表示します。 |
| POST | /api/managed_users/:id/roles/:role_id/copy | 顧客ワークスペース内のカスタムロールのコピーを作成します。 |
カスタムロールの一覧表示
顧客ワークスペース内のすべてのカスタムロールを一覧表示します。
継承可能ロールの制限
このエンドポイントは、指定された顧客ワークスペース内で直接作成されたカスタムロールのみを返します。 Embed管理ワークスペースで作成された継承可能ロールは含まれません。
顧客ワークスペースに関連付けられたrole_nameのリストを取得するには、GET customer workspace member APIを使用します。
shell
GET /api/managed_users/:id/rolesパスパラメーター
| 名前 | タイプ | 説明 |
|---|---|---|
| id | integer required | 管理対象顧客ID。 |
クエリパラメーター
| 名前 | タイプ | 説明 |
|---|---|---|
| per_page | integer optional | 取得するカスタムロールの数。 |
| page | integer optional | ページ番号。 カスタムロールの総数がページ制限を超える場合は、次のページを呼び出すことで後続のレコードを取得できます。 |
| role_name | string 任意 | カスタムロールの名前。 role_nameで結果をフィルタリングします。 |
サンプルリクエスト
リクエスト1: カスタムロールの一覧表示
shell
curl -X GET https://www.workato.com/api/managed_users/123/roles \
-H 'Authorization: Bearer <api_token>'レスポンス1: カスタムロールの一覧表示
json
[
{
"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": [
"read",
"create"
],
"Folders": [
"read"
],
"Workbot": [
"read",
"create",
"update",
"delete"
]
},
{
"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",
"privileges": {
"Recipes": [
"read",
],
"Folders": [
"read"
],
"Workbot": [
"read",
"create",
"update"
]
}
}
]リクエスト2: ロール名で結果をフィルタリング
shell
curl -X GET https://www.workato.com/api/managed_users/123/roles?role_name=dev \
-H 'Authorization: Bearer <api_token>'レスポンス2: ロール名で結果をフィルタリング
json
[
{
"id": 1128,
"name": "dev",
"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": {
"Projects": [
"read",
"create",
"update",
"delete"
],
"Folders": [
"read",
"create",
"update",
"delete"
],
"Connections": [
"read",
"create",
"update",
"delete"
],
"Recipes": [
"read",
"create",
"update",
"delete",
"run",
"read_run_history"
],
"Connection Folders": [
"all"
]
}
}
]カスタムロールのコピー
顧客ワークスペース内のカスタムロールのコピーを作成し、そのロールがアクセスできるフォルダを変更できるようにします。 フォルダIDは、GET folders APIエンドポイントで取得できます。
shell
POST /api/managed_users/:id/roles/:role_id/copyパスパラメータ
| 名前 | タイプ | 説明 |
|---|---|---|
| id | integer required | 管理対象顧客ID。 |
| role_id | integer required | 顧客ワークスペース内のロールのID。 |
リクエスト本文
| 名前 | タイプ | 説明 |
|---|---|---|
| name | string 必須 | カスタムロールの名前。 |
| folder_ids | array | フォルダIDの配列。 |
サンプルリクエスト
shell
curl -X POST https://www.workato.com/api/managed_users/123/roles/490/copy \
-H 'Authorization: Bearer <api_token>' \
-H 'Content-Type: application/json' \
-d '{
"name": "Customer developer",
"folder_ids": ["1232", "1224"]
}'レスポンス
json
{
"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"
}Last updated: