ロール

Environmentロール

Embedded顧客ワークスペース内のEnvironmentロールを管理するには、次のエンドポイントを使用します。

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

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

レガシーロールの互換性

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

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

レート制限

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

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

クイックリファレンス

タイプ	リソース	説明
GET	/api/managed_users/:managed_user_id/environment_roles	顧客ワークスペース内のEnvironmentロールを一覧表示します。
GET	/api/managed_users/:managed_user_id/environment_roles/:id	顧客ワークスペースからEnvironmentロールを取得します。
POST	/api/managed_users/:managed_user_id/environment_roles	顧客ワークスペース内にEnvironmentロールを作成します。
PUT	/api/managed_users/:managed_user_id/environment_roles/:id	顧客ワークスペース内のEnvironmentロールを更新します。
DELETE	/api/managed_users/:managed_user_id/environment_roles/:id	顧客ワークスペース内のEnvironmentロールを削除します。

顧客ワークスペース内のEnvironmentロールの一覧表示

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

shell

GET /api/managed_users/:managed_user_id/environment_roles

パスパラメーター

名前	タイプ	説明
managed_user_id	string 必須	Embedded顧客IDまたは外部ID。外部IDはURLエンコードし、`E`のプレフィックスを付ける必要があります。例: `EA2300`。

クエリパラメーター

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

サンプルリクエスト

shell

curl -X GET 'https://www.workato.com/api/managed_users/19029/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ロールを取得

Embedded顧客ワークスペースからEnvironmentロールを取得します。

shell

GET /api/managed_users/:managed_user_id/environment_roles/:id

パスパラメータ

名前	タイプ	説明
managed_user_id	string 必須	Embedded顧客IDまたは外部ID。外部IDはURLエンコードし、`E`のプレフィックスを付ける必要があります。例: `EA2300`。
id	string 必須	取得するEnvironmentロールのID。

サンプルリクエスト

shell

curl -X GET 'https://www.workato.com/api/managed_users/19029/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ロールを作成

Embedded顧客ワークスペース内に新しいEnvironmentロールを作成します。

shell

POST /api/managed_users/:managed_user_id/environment_roles

パスパラメータ

名前	タイプ	説明
managed_user_id	string 必須	Embedded顧客IDまたは外部ID。外部IDはURLエンコードし、`E`のプレフィックスを付ける必要があります。例: `EA2300`。

リクエスト本文

名前	タイプ	説明
environment_role	object 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/managed_users/19029/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ロールを更新

Embedded顧客ワークスペース内の既存のEnvironmentロールを更新します。

shell

PUT /api/managed_users/:managed_user_id/environment_roles/:id

パスパラメーター

名前	タイプ	説明
managed_user_id	string 必須	Embedded顧客IDまたは外部ID。外部IDはURLエンコードし、`E`のプレフィックスを付ける必要があります。例: `EA2300`。
id	string 必須	更新するEnvironmentロールのID。

リクエスト本文

名前	タイプ	説明
environment_role	object 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 PUT 'https://www.workato.com/api/managed_users/19029/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ロールを削除

Embedded顧客ワークスペース内のEnvironmentロールを削除します。

shell

DELETE /api/managed_users/:managed_user_id/environment_roles/:id

パスパラメーター

名前	タイプ	説明
managed_user_id	string 必須	Embedded顧客IDまたは外部ID。外部IDはURLエンコードし、`E`のプレフィックスを付ける必要があります。例: `EA2300`。
id	string 必須	削除するEnvironmentロールのID。

サンプルリクエスト

shell

curl -X DELETE 'https://www.workato.com/api/managed_users/19029/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:

Environmentロール ​

レート制限 ​

クイックリファレンス ​

顧客ワークスペース内のEnvironmentロールの一覧表示 ​

パスパラメーター ​

クエリパラメーター ​

サンプルリクエスト ​

レスポンス ​

顧客ワークスペースからEnvironmentロールを取得 ​

パスパラメータ ​

サンプルリクエスト ​

レスポンス ​

顧客ワークスペース内にEnvironmentロールを作成 ​

パスパラメータ ​

リクエスト本文 ​

サンプルリクエスト ​

レスポンス ​

顧客ワークスペース内のEnvironmentロールを更新 ​

パスパラメーター ​

リクエスト本文 ​

サンプルリクエスト ​

レスポンス ​

顧客ワークスペース内のEnvironmentロールを削除 ​

パスパラメーター ​

サンプルリクエスト ​

レスポンス ​

Environmentロール

レート制限

クイックリファレンス

顧客ワークスペース内のEnvironmentロールの一覧表示

パスパラメーター

クエリパラメーター

サンプルリクエスト

レスポンス

顧客ワークスペースからEnvironmentロールを取得

パスパラメータ

サンプルリクエスト

レスポンス

顧客ワークスペース内にEnvironmentロールを作成

パスパラメータ

リクエスト本文

サンプルリクエスト

レスポンス

顧客ワークスペース内のEnvironmentロールを更新

パスパラメーター

リクエスト本文

サンプルリクエスト

レスポンス

顧客ワークスペース内のEnvironmentロールを削除

パスパラメーター

サンプルリクエスト

レスポンス