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

Environmentロール ​

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

次のエンドポイントを使用して、Environmentロールを管理します。

Environmentロールには次の値を指定できます:

値定義
systemWorkatoが提供するデフォルトロール。
customワークスペース内で手動で作成されたロール。
inheritable子ワークスペースが継承できる、AHQ管理者またはEmbeddedパートナーワークスペースのカスタムロール。
inherited子ワークスペースがそのAHQまたはEmbedded親ワークスペースから継承したロール。

レガシーロールの互換性

次のエンドポイントは、role_typeがenvironmentである新しいロールとのみ互換性があります。

role_typeがprivilege_groupであるレガシーロールを管理するには、代わりに/api/rolesエンドポイントを使用します。

レート制限 ​

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

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

クイックリファレンス ​

タイプリソース説明
GET/api/environment_rolesEnvironmentロールを一覧表示します。
GET/api/environment_roles/:idEnvironmentロールの詳細を取得します。
POST/api/environment_rolesEnvironmentロールを作成します。
PUT/api/environment_roles/:idEnvironmentロールを更新します。
DELETE/api/environment_roles/:idEnvironmentロールを削除します。

Environmentロールの一覧表示 ​

ワークスペースからEnvironmentロールの一覧を取得します。

shell
GET /api/environment_roles

クエリパラメーター ​

名前タイプ説明
namestring
任意		Environmentロールを名前でフィルターします。
page[number]integer
optional		取得するページ番号。 デフォルト値は1です。
page[size]integer
optional		取得するページあたりの項目数。 デフォルト値および最大値は100です。

サンプルリクエスト ​

shell
curl -X GET 'https://www.workato.com/api/environment_roles?name=Developer&page[number]=1&page[size]=100' \
  -H 'Authorization: Bearer <api_token>'

レスポンス ​

json
{
  "data": [
    {
      "id": 1,
      "name" : "Developer",
      "members_count": 2,
      "type": "custom",
      "created_at": "2024-08-02T13:35:11.691-07:00",
      "updated_at": "2024-08-02T13:35:11.691-07:00"
    }
  ],
  "total": 1,
  "page": {
    "number": 1,
    "size": 100
  }
}

Environmentロールの詳細を取得 ​

IDでEnvironmentロールを取得します。

shell
GET /api/environment_roles/:id

パスパラメーター ​

名前タイプ説明
idstring
必須		取得するEnvironmentロールのID。

サンプルリクエスト ​

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

レスポンス ​

json
{
  "data": {
    "id": 1,
    "name" : "Developer",
    "config": { "team": { "privileges": "all" } },
    "members_count": 2,
    "type": "custom",
    "created_at": "2024-08-02T13:35:11.691-07:00",
    "updated_at": "2024-08-02T13:35:11.691-07:00"
  }
}

Environmentロールの作成 ​

新しいEnvironmentロールを作成します。

shell
POST /api/environment_roles

リクエスト本文 ​

名前タイプ説明
environment_roleobject
required		作成するEnvironmentロールを定義します。
environment_role[name]string
必須		作成するEnvironmentロールの名前。 最大長は200文字です。
environment_role[config]object
required		ロールに割り当てる権限を定義します。
environment_role[inheritable]boolean
optional		trueに設定すると、子ワークスペースがロールを継承します。 デフォルト値はfalseです。 この値をtrueに設定できるのは、Admin AHQまたはEmbeddedパートナーワークスペース内のみです。

サンプルリクエスト ​

shell
curl -X POST 'https://www.workato.com/api/environment_roles' \
  -H 'Authorization: Bearer <api_token>' \
  -H 'Content-Type: application/json' \
  -d '{
        "environment_role": {
          "name": "Developer",
          "config": { "team": { "privileges": "all" } },
          "inheritable": false
        }
      }'

レスポンス ​

json
{
  "data": {
    "id": 1,
    "name" : "Developer",
    "config": { "team": { "privileges": "all" } },
    "members_count": 0,
    "type": "custom",
    "created_at": "2024-08-02T13:35:11.691-07:00",
    "updated_at": "2024-08-02T13:35:11.691-07:00"
  }
}

Environmentロールの更新 ​

既存のEnvironmentロールをIDで更新します。

shell
PUT /api/environment_roles/:id

パスパラメーター ​

名前タイプ説明
idstring
必須		更新するEnvironmentロールのID。

リクエスト本文 ​

名前タイプ説明
environment_roleobject
required		更新されたEnvironmentロールを定義します。
environment_role[name]string
必須		Environmentロールの更新後の名前。 最大長は200文字です。
environment_role[config]object
required		Environmentロールに割り当てる権限を定義します。
environment_role[inheritable]boolean
optional		trueに設定すると、子ワークスペースがロールを継承します。 デフォルト値はfalseです。 この値をtrueに設定できるのは、Admin AHQまたはEmbeddedパートナーワークスペース内のみです。

サンプルリクエスト ​

shell
curl -X PUT 'https://www.workato.com/api/environment_roles/1' \
  -H 'Authorization: Bearer <api_token>' \
  -H 'Content-Type: application/json' \
  -d '{
        "environment_role": {
          "name": "Builder",
          "config": { "team": { "privileges": "all" } },
          "inheritable": false
        }
      }'

レスポンス ​

json
{
  "data": {
    "id": 1,
    "name" : "Builder",
    "config": { "team": { "privileges": "all" } },
    "members_count": 0,
    "type": "custom",
    "created_at": "2024-08-02T13:35:11.691-07:00",
    "updated_at": "2024-08-02T13:35:11.691-07:00"
  }
}

Environmentロールの削除 ​

IDでEnvironmentロールを削除します。

shell
DELETE /api/environment_roles/:id

パスパラメーター ​

名前タイプ説明
idstring
必須		削除するEnvironmentロールのID。

サンプルリクエスト ​

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

レスポンス ​

リクエストが成功すると、204 No Contentステータスコードが返されます。 APIはEnvironmentロールを削除し、空のレスポンス本文を返します。

400 BAD REQUEST

400 Bad Requestエラーは、クライアント側の問題によりサーバーがリクエストを処理できなかったことを示します。 一般的な原因には、不正な形式のリクエスト、無効なフィールド、サポートされていないデータ型などのフィールド制約違反が含まれます。

次の例では、ロールがまだ一部のコラボレーターに割り当てられているため、リクエストは失敗します:

json
{
  "errors": [
    {
      "code": "bad_request",
      "title": "You can’t delete a role when collaborators are assigned to the role."
    }
  ]
}

Last updated: