Product UpdatesStatus PageWorkato Academy
English
日本語
Get a trial
Developer API
リソース
ロール

レガシーロール ​

このページは機械翻訳により提供されています。翻訳内容と英語版に相違がある場合は、英語版が優先されます。

次のエンドポイントを使用して、レガシーロールをプログラムで管理します。

従来のロール

このページでは、レガシー権限モデルについて説明します。 Workatoは、Environmentロールとプロジェクトロールを使用する新しい権限モデルでレガシーロールを置き換えています。 ロール移行APIまたはアプリ内移行ウィザードを使用して、レガシーロールを移行できます。 詳細については、新しい権限モデルドキュメントを参照してください。

レート制限 ​

レガシーロールリソースには、次のレート制限があります:

タイプリソース制限
すべてすべてのレガシーロールエンドポイント1分あたり60リクエスト

クイックリファレンス ​

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

カスタムロールの一覧表示 ​

すべてのカスタムロールを一覧表示します。

shell
GET /api/roles

クエリパラメーター ​

名前タイプ説明
per_pageinteger
optional		取得するカスタムロールの数。
pageinteger
optional		ページ番号。 カスタムロールの総数がページ制限を超える場合は、次のページを呼び出すことで後続のレコードを取得できます。

サンプルリクエスト ​

shell
curl  -X GET https://www.workato.com/api/roles \
      -H 'Authorization: Bearer <api_token>'

レスポンス ​

json
[
    {
        "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は、GETフォルダAPIエンドポイントで取得できます。

shell
PUT /api/roles/:id

パスパラメーター ​

名前タイプ説明
idinteger
required		カスタムロールのID。

リクエスト本文 ​

名前タイプ説明
all_foldersstring
必須		"true"または"false"。 "folder_ids"を指定する場合は"false"にする必要があります。
folder_idsarray
プロジェクトIDの配列。

サンプルリクエスト ​

shell
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]
          }'

レスポンス ​

json
{
    "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は、GETフォルダAPIエンドポイントで取得できます。

shell
POST /api/roles/:id/copy

パスパラメータ ​

名前タイプ説明
idinteger
required		カスタムロールのID。

リクエスト本文 ​

名前タイプ説明
namestring
必須		カスタムロールの名前。
folder_idsarray
プロジェクトIDの配列。

サンプルリクエスト ​

shell
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"]
          }'

レスポンス ​

json
{
    "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"
}

Last updated: