ロール

コラボレーターグループ

コラボレーターグループを管理するには、次のエンドポイントを使用します。

レート制限

コラボレーターグループリソースには、次のレート制限があります:

タイプ	リソース	制限
すべて	すべてのコラボレーターグループエンドポイント	1分あたり60リクエスト

クイックリファレンス

タイプ	リソース	説明
GET	/api/user_groups	コラボレーターグループを一覧表示します。
GET	/api/user_groups/:id	コラボレーターグループの詳細を取得します。
POST	/api/user_groups	コラボレーターグループを作成します。
PUT	/api/user_groups/:id	コラボレーターグループを更新します。
DELETE	/api/user_groups/:id	コラボレーターグループを削除します。
GET	/api/user_groups/:id/members	コラボレーターグループのメンバーを一覧表示します。
POST	/api/user_groups/:id/members	コラボレーターグループにメンバーを追加します。
DELETE	/api/user_groups/:id/members	コラボレーターグループからメンバーを削除します。
GET	/api/user_groups/:id/project_grants	コラボレーターグループのプロジェクト権限付与を一覧表示します。

コラボレーターグループの一覧表示

ワークスペースからコラボレーターグループのリストを取得します。

shell

GET /api/user_groups

クエリパラメーター

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

サンプルリクエスト

shell

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

レスポンス

json

{
  "data": [
    {
      "id": "am-WxEKCibh-dTXBtz",
      "name" : "All collaborators",
      "description": null,
      "members_count": 5,
      "system": true,
      "created_at": "2024-08-01T13:35:11.691-07:00",
      "updated_at": "2024-08-01T13:35:11.691-07:00"
    },
    {
      "id": "pf-APHDLgAD-cTXBtz",
      "name" : "Developers",
      "description": "Group for developers",
      "members_count": 2,
      "system": false,
      "created_at": "2024-08-02T13:35:11.691-07:00",
      "updated_at": "2024-08-02T13:35:11.691-07:00"
    }
  ],
  "total": 2,
  "page": {
    "number": 1,
    "size": 100
  }
}

コラボレーターグループの詳細の取得

IDでコラボレーターグループを取得します。

shell

GET /api/user_groups/:id

すべてのコラボレーター

All collaboratorsグループは、すべてのコラボレーターに付与されるデフォルトのアクセス権を定義します。各データセンターはAll collaboratorsに一意のIDを割り当てます。 All collaboratorsグループIDを取得するには、コラボレーターグループの一覧表示エンドポイントを使用します。

パスパラメーター

名前	タイプ	説明
id	string 必須	取得するコラボレーターグループのID。

サンプルリクエスト

shell

curl  -X GET 'https://www.workato.com/api/user_groups/am-WxEKCibh-dTXBtz' \
      -H 'Authorization: Bearer <api_token>'

レスポンス

json

{
  "data": {
    "id": "am-WxEKCibh-dTXBtz",
    "name" : "Developers",
    "description": "Group for developers",
    "members_count": 2,
    "system": false,
    "created_at": "2024-08-02T13:35:11.691-07:00",
    "updated_at": "2024-08-02T13:35:11.691-07:00"
  }
}

コラボレーターグループの作成

新しいコラボレーターグループを作成します。

shell

POST /api/user_groups

リクエスト本文

名前	タイプ	説明
user_group	object required	作成するコラボレーターグループを定義します。
user_group[name]	string 必須	コラボレーターグループ名。最大長は`200`文字です。
user_group[description]	string 任意	コラボレーターグループの説明。最大長は`300`文字です。

サンプルリクエスト

shell

curl -X POST 'https://www.workato.com/api/user_groups' \
  -H 'Authorization: Bearer <api_token>' \
  -H 'Content-Type: application/json' \
  -d '{
        "user_group": {
          "name": "Developers",
          "description": "Group for developers"
        }
      }'

レスポンス

json

{
  "data": {
    "id": "am-WxEKCibh-dTXBtz",
    "name" : "Developers",
    "description": "Group for developers",
    "members_count": 1,
    "system": false,
    "created_at": "2024-08-02T13:35:11.691-07:00",
    "updated_at": "2024-08-02T13:35:11.691-07:00"
  }
}

400 BAD REQUEST

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

次の例では、必須のnameパラメーターが空白であるため、リクエストが失敗します:

json

{
  "errors": [
    {
      "code": "bad_request",
      "title": "Name can't be blank"
    }
  ]
}

コラボレーターグループの更新

IDでコラボレーターグループを更新します。

shell

PUT /api/user_groups/:id

パスパラメーター

名前	タイプ	説明
id	string 必須	更新するコラボレーターグループのID。

リクエスト本文

名前	タイプ	説明
user_group	object required	更新後のコラボレーターグループを定義します。
user_group[name]	string 必須	コラボレーターグループの更新後の名前。最大長は`200`文字です。
user_group[description]	string 任意	コラボレーターグループの更新後の説明。最大長は`300`文字です。

サンプルリクエスト

shell

curl -X PUT 'https://www.workato.com/api/user_groups/am-WxEKCibh-dTXBtz' \
  -H 'Authorization: Bearer <api_token>' \
  -H 'Content-Type: application/json' \
  -d '{
        "user_group": {
          "name": "Developers Team",
          "description": "Team"
        }
      }'

レスポンス

json

{
  "data": {
    "id": "am-WxEKCibh-dTXBtz",
    "name" : "Developers Team",
    "description": "Team",
    "members_count": 2,
    "system": false,
    "created_at": "2024-08-02T13:35:11.691-07:00",
    "updated_at": "2024-08-02T13:35:11.691-07:00"
  }
}

400 BAD REQUEST

次の例では、必須のnameパラメーターが空白であるため、リクエストが失敗します:

json

{
  "errors": [
    {
      "code": "bad_request",
      "title": "Name can't be blank"
    }
  ]
}

コラボレーターグループの削除

IDでコラボレーターグループを削除します。コラボレーターグループを削除すると、メンバーは別のソースから追加のアクセス権を持っていない限り、プロジェクトへのアクセス権を失います。

すべてのコラボレーター

All collaboratorsグループは、すべてのコラボレーターに付与されるデフォルトのアクセス権を定義します。このグループは削除できません。

shell

DELETE /api/user_groups/:id

パスパラメーター

名前	タイプ	説明
id	string 必須	削除するコラボレーターグループのID。

サンプルリクエスト

shell

curl  -X DELETE 'https://www.workato.com/api/user_groups/am-WxEKCibh-dTXBtz' \
      -H 'Authorization: Bearer <api_token>'

レスポンス

リクエストが成功すると、204 No Contentステータスコードが返されます。コラボレーターグループが削除され、レスポンス本文は空になります。

コラボレーターグループメンバーの一覧表示

コラボレーターグループのメンバーを取得します。

shell

GET /api/user_groups/:id/members

パスパラメーター

名前	タイプ	説明
id	string 必須	メンバーを取得するコラボレーターグループのID。

クエリパラメーター

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

サンプルリクエスト

shell

curl -X GET 'https://www.workato.com/api/user_groups/am-WxEKCibh-dTXBtz/members?page[number]=1&page[size]=100' \
  -H 'Authorization: Bearer <api_token>'

レスポンス

json

{
  "data": [
    {
      "user_id": 1,
      "member_invitation_id": null,
      "name" : "Dani",
      "email": "[email protected]",
      "type": "User",
      "avatar_url": "url"
    },
    {
      "user_id": null,
      "member_invitation_id": 1,
      "name" : "Alex",
      "email": "[email protected]",
      "type": "MemberInvitation",
      "avatar_url": null
    }
  ],
  "total": 2,
  "page": {
    "number": 1,
    "size": 100
  }
}

コラボレーターグループへのメンバーの追加

IDで既存のコラボレーターグループにコラボレーターを追加します。

shell

POST /api/user_groups/:id/members

パスパラメーター

名前	タイプ	説明
id	string 必須	メンバーを追加するコラボレーターグループのID。

リクエスト本文

名前	タイプ	説明
user_ids	整数の配列必須	グループに追加するメンバーのユーザーID。

サンプルリクエスト

shell

curl -X POST 'https://www.workato.com/api/user_groups/am-WxEKCibh-dTXBtz/members' \
  -H 'Authorization: Bearer <api_token>' \
  -H 'Content-Type: application/json' \
  -d '{
        "user_ids": [1, 2]
      }'

レスポンス

成功したリクエストは{ "data": null }を返します。このレスポンスは、操作が成功したものの、追加のデータは返されないことを示します。

コラボレーターグループからのメンバーの削除

IDでコラボレーターグループからコラボレーターを削除します。

shell

DELETE /api/user_groups/:id/members

パスパラメーター

名前	タイプ	説明
id	string 必須	メンバーを取得するコラボレーターグループのID。

リクエスト本文

名前	タイプ	説明
user_ids	整数の配列条件付き必須	グループから削除するメンバーのユーザーID。
member_invitation_ids	整数の配列条件付き必須	コラボレーターグループ招待のIDのリスト。招待によって追加されたメンバーはグループから削除されます。

条件付き要件

リクエストには、グループから削除するコラボレーターを指定するために、user_idsまたはmember_invitation_idsのいずれかを含める必要があります。複数の条件に基づいてコラボレーターを削除するために、両方を含めることもできます。

サンプルリクエスト

shell

curl -X DELETE 'https://www.workato.com/api/user_groups/am-WxEKCibh-dTXBtz/members?user_ids[]=1&user_ids[]=2&member_invitation_ids[]=1&member_invitation_ids[]=2' \
  -H 'Authorization: Bearer <api_token>'

レスポンス

リクエストが成功すると、204 No Contentステータスコードが返されます。 APIはメンバーをコラボレーターグループから削除し、レスポンス本文にコンテンツを返しません。

コラボレーターグループのプロジェクト権限付与の一覧表示

コラボレーターグループに割り当てられているプロジェクトロールを取得します。

プロジェクト付与

プロジェクト付与は、コラボレーターまたはグループにプロジェクトロールを割り当てます。 Developer APIを使用してプロジェクト付与を管理するにはプロジェクト付与を、UIでプロジェクトロールを管理するにはプロジェクトアクセスとロールを管理するを参照してください。

shell

GET /api/user_groups/:id/project_grants

パスパラメーター

名前	タイプ	説明
id	string 必須	取得するプロジェクト権限付与を持つコラボレーターグループのID。

クエリパラメーター

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

サンプルリクエスト

shell

curl -X GET 'https://www.workato.com/api/user_groups/pg-AQAEnmMX-b4rPeT/project_grants?page[number]=1&page[size]=100' \
  -H 'Authorization: Bearer <api_token>'

レスポンス

json

{
  "data": [
    {
      "id": "pg-AQAEnmMX-b4rPeT",
      "project": {
        "id": 178229,
        "name": "Development",
        "environment": {
          "id": 148425,
          "type": "dev"
        }
      },
      "project_role": {
        "id": "pr-AQAEnmK3-EQpeYM",
        "name": "Developers"
      }
    },
    {
      "id": "pg-AQAEnmKE-xpCFwT",
      "project": {
        "id": 178230,
        "name": "Development",
        "environment": {
          "id": 148426,
          "type": "prod"
        },
      },
      "project_role": {
        "id": "pr-AQAEnmK3-EQpeYM",
        "name": "Developers"
      }
    }
  ],
  "total": 2,
  "page": {
    "number": 1,
    "size": 100
  }
}

Last updated:

コラボレーターグループ ​

レート制限 ​

クイックリファレンス ​

コラボレーターグループの一覧表示 ​

クエリパラメーター ​

サンプルリクエスト ​

レスポンス ​

コラボレーターグループの詳細の取得 ​

パスパラメーター ​

サンプルリクエスト ​

レスポンス ​

コラボレーターグループの作成 ​

リクエスト本文 ​

サンプルリクエスト ​

レスポンス ​

コラボレーターグループの更新 ​

パスパラメーター ​

リクエスト本文 ​

サンプルリクエスト ​

レスポンス ​

コラボレーターグループの削除 ​

パスパラメーター ​

サンプルリクエスト ​

レスポンス ​

コラボレーターグループメンバーの一覧表示 ​

パスパラメーター ​

クエリパラメーター ​

サンプルリクエスト ​

レスポンス ​

コラボレーターグループへのメンバーの追加 ​

パスパラメーター ​

リクエスト本文 ​

サンプルリクエスト ​

レスポンス ​

コラボレーターグループからのメンバーの削除 ​

パスパラメーター ​

リクエスト本文 ​

サンプルリクエスト ​

レスポンス ​

コラボレーターグループのプロジェクト権限付与の一覧表示 ​

パスパラメーター ​

クエリパラメーター ​

サンプルリクエスト ​

レスポンス ​

コラボレーターグループ

レート制限

クイックリファレンス

コラボレーターグループの一覧表示

クエリパラメーター

サンプルリクエスト

レスポンス

コラボレーターグループの詳細の取得

パスパラメーター

サンプルリクエスト

レスポンス

コラボレーターグループの作成

リクエスト本文

サンプルリクエスト

レスポンス

コラボレーターグループの更新

パスパラメーター

リクエスト本文

サンプルリクエスト

レスポンス

コラボレーターグループの削除

パスパラメーター

サンプルリクエスト

レスポンス

コラボレーターグループメンバーの一覧表示

パスパラメーター

クエリパラメーター

サンプルリクエスト

レスポンス

コラボレーターグループへのメンバーの追加

パスパラメーター

リクエスト本文

サンプルリクエスト

レスポンス

コラボレーターグループからのメンバーの削除

パスパラメーター

リクエスト本文

サンプルリクエスト

レスポンス

コラボレーターグループのプロジェクト権限付与の一覧表示

パスパラメーター

クエリパラメーター

サンプルリクエスト

レスポンス