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

顧客ワークスペースのコラボレーター ​

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

このAPIを使用すると、顧客ワークスペースでコラボレーターを管理できます。 管理ワークスペースでコラボレーターを操作するには、ワークスペースのコラボレーターのDeveloper APIドキュメントを参照してください。

レート制限 ​

顧客ワークスペースのコラボレーターリソースには、次のレート制限があります：

タイプリソース制限
すべてすべての顧客ワークスペースのコラボレーターエンドポイント1分あたり60リクエスト。さらに、管理対象顧客ワークスペースにコラボレーターを招待エンドポイントに、ユーザーおよびワークスペースIDごとに20分に1回リクエストを送信できます。

クイックリファレンス ​

タイプリソース説明
POST/api/managed_users/:id/member_invitationsコラボレーターを顧客ワークスペースに招待します。

コラボレーターを顧客ワークスペースに招待する ​

Embedded顧客ワークスペースにコラボレーターを招待します。 指定したメールアドレスが既存のユーザーに属していない場合、APIはメール招待を送信します。 コラボレーターは、Workatoアカウントを作成した後でワークスペースに参加できます。 特定のメールアドレスとワークスペースの組み合わせは、20分に1回招待できます。 または、コラボレーターを追加エンドポイントを使用して、コラボレーターを直接追加できます。

shell
POST /api/managed_users/:id/member_invitations

パスパラメーター ​

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

リクエスト本文 ​

名前タイプ説明
namestring
必須		コラボレーターの名前。
emailstring
必須		コラボレーターのメールアドレス。
env_rolesobject
conditional		コラボレーターのEnvironmentロールを設定します。 role_nameが指定されていない場合は必須です。
env_roles[environment_type]string
conditional		コラボレーターを招待する予定のワークスペース内のEnvironmentのタイプ。 role_nameが指定されていない場合は必須です。 単一Environmentのワークスペースにはdevを使用します。
env_roles[name]string
conditional		特定のEnvironmentに対してコラボレーターに割り当てるロール。 role_nameが指定されていない場合は必須です。
env_roles[role_type]string
任意		コラボレーターに割り当てるロールのタイプ。 使用可能な値には、privilege_groupとenvironmentがあります。 デフォルト値はprivilege_groupです。
role_namestring
conditional		コラボレーターに割り当てるロール。 env_rolesが指定されていない場合は必須です。
user_group_idsarray of strings
optional		割り当てるコラボレーターグループのID。

異なるEnvironmentのロールを指定

ペイロードにはrole_nameまたはenv_rolesのいずれかを指定する必要があります：

-role_nameはdevEnvironmentでのみロールを割り当てます。 -env_rolesを使用すると、異なるEnvironmentにロールを指定できます。

同じリクエストでrole_nameとenv_rolesを組み合わせることはできません。 両方が含まれている場合、Workatoはenv_roles内のロールのみを割り当て、role_nameを無視します。

サンプルリクエスト ​

このリクエスト例では、コラボレーターにAdminロールを割り当てるdevEnvironmentの招待を作成します。

shell
curl -X POST 'https://www.workato.com/api/managed_users/19029/member_invitations' \
  -H 'Authorization: Bearer <api_token>' \
  -H 'Content-Type: application/json' \
  -d '{
        "name": "Josh",
        "email": "[email protected]",
        "user_group_ids": [
          "am-WxEKCibh-dTXBtz",
          "am-APNHJbmM-hfhTD8"
        ],
        "env_roles": [
          {
            "environment_type": "dev",
            "name": "Admin",
            "role_type": "privilege_group"
          }
        ]
      }'

レスポンス ​

json
{
    "result": "ok"
}

Last updated: