Product UpdatesStatus PageWorkato Academy
English
日本語
Get a trial

Workato Identity IAM ​

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

Workato Identity APIを使用すると、ユーザーID、グループメンバーシップ、アクセス制御をプログラムで管理できます。

短い動画ガイドを見る: Workato Identity IAMでGenieユーザーをオンボードする

レート制限 ​

Workato Identity IAMリソースには、次のレート制限があります:

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

クイックリファレンス ​

タイプリソース説明
GET/api/iam/usersワークスペース内のユーザーを一覧表示します。
GET/api/iam/users/:user-idIDで特定のユーザーの詳細を取得します。
POST/api/iam/users1人以上の新規ユーザーを作成します。
PUT/api/iam/users/:user-id既存のユーザーを更新します。
DELETE/api/iam/users/:user-idワークスペースからユーザーを削除します。
POST/api/iam/users/:user-id/add_to_group特定のグループにユーザーを追加します。
POST/api/iam/users/:user-id/remove_from_group特定のグループからユーザーを削除します。
GET/api/iam/user_groups現在のEnvironment内のユーザーグループを一覧表示します。
GET/api/iam/user_groups/:user-group-idIDで特定のユーザーグループの詳細を取得します。
POST/api/iam/user_groups新しいユーザーグループを作成します。
PUT/api/iam/user_groups/:user-group-id既存のユーザーグループを更新します。
DELETE/api/iam/user_groups/:user-group-idユーザーグループを削除します。
POST/api/iam/user_groups/:user-group-id/add_users複数のユーザーをグループに追加します。
DELETE/api/iam/user_groups/:user-group-id/remove_usersグループから複数のユーザーを削除します。
GET/api/iam/user_groups/:user-group-id/membersユーザーグループのすべてのメンバーを一覧表示します。
GET/api/iam/app_links現在のEnvironment内のアプリリンクを一覧表示します。
POST/api/iam/app_linksアプリリンクを作成します。
DELETE/api/iam/app_links/:idIDでアプリリンクを削除します。
DELETE/api/iam/app_linksIDでアプリリンクを削除します。

ユーザー ​

次のエンドポイントを使用して、Workato Identityユーザーを管理できます:

ユーザーの一覧表示 ​

ワークスペース内のすべてのユーザーを一覧表示します。

shell
GET /api/iam/users

クエリパラメーター ​

名前タイプ説明
querystring
任意		ユーザーをフィルターする検索クエリ。
emails[]array[string]
任意		メールアドレスでフィルターします。
user_ids[]array[string]
任意		ユーザーIDでフィルターします。
namestring
任意		ユーザー名でフィルターします。
user_group_ids[]array[string]
任意		ユーザーグループIDでフィルターします。
environment_idstring
任意		Environment IDでグループメンバーシップをフィルターします。
order_bystring
任意		name、email、またはstatusでソートします。
orderstring
任意		ソート方向: ascまたはdesc。
pageinteger
optional		ページ番号。 デフォルトは1です。
per_pageinteger
optional		ページサイズ。 最大値/デフォルトは100です。
サンプルリクエスト ​
shell
curl  -X GET 'https://www.workato.com/api/iam/users?page=1&per_page=100' \
      -H 'Authorization: Bearer <api_token>' \
      -H 'Content-Type: application/json'
レスポンス ​
json
{
  "data": [
    {
      "id": "user-id",
      "email": "[email protected]",
      "name": "Jade Anderson",
      "status": "active",
      "last_signed_in_at": "2025-01-15T10:30:00Z",
      "created_at": "2025-01-01T00:00:00Z",
      "environment_ids": ["env-id"],
      "user_groups": [
        {
          "id": "user-group-id",
          "environment_id": "env-id",
          "name": "Developers"
        }
      ]
    }
  ],
  "total": 1,
  "page": {
    "number": 1,
    "size": 100
  }
}

IDでユーザーを取得 ​

IDで特定のユーザーの詳細を取得します。

shell
GET /api/iam/users/:user-id

URLパラメーター ​

名前タイプ説明
user-idstring
必須		ユーザーID。
サンプルリクエスト ​
shell
curl  -X GET 'https://www.workato.com/api/iam/users/:user-id' \
      -H 'Authorization: Bearer <api_token>' \
      -H 'Content-Type: application/json'
レスポンス ​
json
{
  "data": {
    "id": "user-id",
    "email": "[email protected]",
    "name": "Jade Anderson",
    "status": "active",
    "last_signed_in_at": "2025-01-15T10:30:00Z",
    "created_at": "2025-01-01T00:00:00Z",
    "environment_ids": ["env-id"],
    "user_groups": [
      {
        "id": "user-group-id",
        "environment_id": "env-id",
        "name": "Developers"
      }
    ]
  }
}

ユーザーの作成 ​

ワークスペース内に1人以上の新規ユーザーを作成します。

shell
POST /api/iam/users

ペイロード ​

名前タイプ説明
users[]array
必須		作成するユーザーオブジェクトの配列。
users[].emailstring
任意		ユーザーのメールアドレス。
users[].namestring
任意		ユーザーの表示名。
users[].user_group_ids[]array[string]
任意		グループID。 グループIDを指定する場合は、environment_types[]を指定する必要があります。
users[].environment_types[]array[string]
任意		Environmentタイプ。 例: dev、test、またはprod。
users[].send_invitationboolean
optional		ユーザーに招待メールを送信するかどうか。 デフォルトはtrueです。
サンプルリクエスト ​
shell
curl  -X POST https://www.workato.com/api/iam/users \
      -H 'Authorization: Bearer <api_token>' \
      -H 'Content-Type: application/json' \
      -d '{
            "users": [
              {
                "email": "[email protected]",
                "name": "Jade Anderson",
                "user_group_ids": ["user-group-id"],
                "environment_types": ["dev"]
              }
            ]
          }'
レスポンス ​
json
{
  "data": {
    "id": "new-user-id"
  }
}

ユーザーの更新 ​

名前やグループメンバーシップなど、既存のユーザー情報を更新します。

shell
PUT /api/iam/users/:user-id

URLパラメーター ​

名前タイプ説明
user-idstring
必須		ユーザーID。

ペイロード ​

名前タイプ説明
namestring
任意		更新後のユーザー名。
user_group_ids[]array[string]
任意		更新後のグループIDのリスト。
environment_types[]array[string]
任意		Environmentタイプ（dev、test、prod）。
environment_user_groups[]array[object]
任意		idとenvironment_idを使用した明示的なEnvironmentグループの割り当て。
サンプルリクエスト ​
shell
curl  -X PUT https://www.workato.com/api/iam/users/:user-id \
      -H 'Authorization: Bearer <api_token>' \
      -H 'Content-Type: application/json' \
      -d '{
            "name": "Developer CI/CD",
            "environment_types": ["dev", "test"],
            "environment_user_groups": [
              {"id": "user-group-id", "environment_id": "env-id"}
            ]
          }'
レスポンス ​
json
{
  "data": {
    "id": "user-id",
    "email": "[email protected]",
    "name": "Developer CI/CD",
    "status": "active",
    "last_signed_in_at": "2025-01-15T10:30:00Z",
    "created_at": "2025-01-01T00:00:00Z",
    "environment_ids": ["env-id", "env-id-2"],
    "user_groups": [
      {
        "id": "user-group-id",
        "environment_id": "env-id",
        "name": "Developers"
      }
    ]
  }
}

ユーザーの削除 ​

ワークスペースからユーザーを削除します。

永続的なアクション

このアクションにより、ユーザーがワークスペースから完全に削除されます。 このアクションでは、システムからユーザーは削除されません。

shell
DELETE /api/iam/users/:user-id

URLパラメーター ​

名前タイプ説明
user-idstring
必須		ユーザーID。
サンプルリクエスト ​
shell
curl  -X DELETE 'https://www.workato.com/api/iam/users/:user-id' \
      -H 'Authorization: Bearer <api_token>'
レスポンス ​
json
{
  "data": null
}

ユーザーをグループに追加 ​

特定のユーザーグループにユーザーを追加します。

shell
POST /api/iam/users/:user-id/add_to_group

URLパラメーター ​

名前タイプ説明
user-idstring
必須		ユーザーID。

ペイロード ​

名前タイプ説明
user_group_idstring
必須		ユーザーグループID。
environment_idstring
任意		Environment ID。 デフォルトはDevelopment environmentです。
サンプルリクエスト ​
shell
curl  -X POST https://www.workato.com/api/iam/users/:user-id/add_to_group \
      -H 'Authorization: Bearer <api_token>' \
      -H 'Content-Type: application/json' \
      -d '{
            "user_group_id": "user_group_id"
          }'
レスポンス ​
json
{
  "data": {
    "id": "user-id",
    "email": "[email protected]",
    "name": "Jade Anderson",
    "status": "active",
    "last_signed_in_at": "2025-01-15T10:30:00Z",
    "created_at": "2025-01-01T00:00:00Z",
    "environment_ids": ["env-id"],
    "user_groups": [
      {
        "id": "user-group-id",
        "environment_id": "env-id",
        "name": "Developers"
      }
    ]
  }
}

グループからユーザーを削除 ​

特定のユーザーグループからユーザーを削除します。

shell
POST /api/iam/users/:user-id/remove_from_group

URLパラメーター ​

名前タイプ説明
user-idstring
必須		ユーザーID。

ペイロード ​

名前タイプ説明
user_group_idstring
必須		ユーザーグループID。
environment_idstring
任意		Environment ID。 デフォルトはDevelopment environmentです。
サンプルリクエスト ​
shell
curl  -X POST https://www.workato.com/api/iam/users/:user-id/remove_from_group \
      -H 'Authorization: Bearer <api_token>' \
      -H 'Content-Type: application/json' \
      -d '{
            "user_group_id": "user_group_id"
          }'
レスポンス ​
json
{
  "data": {
    "id": "user-id",
    "email": "[email protected]",
    "name": "Jade Anderson",
    "status": "active",
    "last_signed_in_at": "2025-01-15T10:30:00Z",
    "created_at": "2025-01-01T00:00:00Z",
    "environment_ids": ["env-id"],
    "user_groups": []
  }
}

ユーザーグループ ​

次のエンドポイントを使用して、Workato Identityグループを管理できます:

ユーザーグループの一覧表示 ​

現在のEnvironment内のすべてのユーザーグループを一覧表示します。

shell
GET /api/iam/user_groups

クエリパラメーター ​

名前タイプ説明
querystring
任意		ユーザーグループをフィルターする検索クエリ。
order_bystring
任意		結果の並べ替えに使用するフィールド。 許可される値: name。
orderstring
任意		ソート方向: ascまたはdesc。
pageinteger
optional		ページ番号。 デフォルトは1です。
per_pageinteger
optional		ページサイズ。 最大値/デフォルトは100です。
サンプルリクエスト ​
shell
curl  -X GET 'https://www.workato.com/api/iam/user_groups?page=1&per_page=100' \
      -H 'Authorization: Bearer <api_token>' \
      -H 'Content-Type: application/json'
レスポンス ​
json
{
  "data": [
    {
      "id": "user-group-id",
      "environment_id": "env-id",
      "name": "Developers",
      "users_count": 10,
      "created_at": "2025-01-01T00:00:00Z",
      "updated_at": "2025-01-10T00:00:00Z"
    }
  ],
  "total": 1,
  "page": {
    "number": 1,
    "size": 100
  }
}

IDでユーザーグループを取得 ​

IDで特定のユーザーグループの詳細を取得します。

shell
GET /api/iam/user_groups/:user-group-id

URLパラメーター ​

名前タイプ説明
user-group-idstring
必須		ユーザーグループID。
サンプルリクエスト ​
shell
curl  -X GET 'https://www.workato.com/api/iam/user_groups/:user-group-id' \
      -H 'Authorization: Bearer <api_token>' \
      -H 'Content-Type: application/json'
レスポンス ​
json
{
  "data": {
    "id": "user-group-id",
    "environment_id": "env-id",
    "name": "Developers",
    "users_count": 10,
    "created_at": "2025-01-01T00:00:00Z",
    "updated_at": "2025-01-10T00:00:00Z"
  }
}

ユーザーグループの作成 ​

ワークスペース内に新しいユーザーグループを作成します。

shell
POST /api/iam/user_groups

ペイロード ​

名前タイプ説明
user_group.namestring
必須		ユーザーグループの名前。
サンプルリクエスト ​
shell
curl  -X POST https://www.workato.com/api/iam/user_groups \
      -H 'Authorization: Bearer <api_token>' \
      -H 'Content-Type: application/json' \
      -d '{
            "user_group": {
              "name": "Sales Group"
            }
          }'
レスポンス ​
json
{
  "data": {
    "id": "user-group-id",
    "environment_id": "env-id",
    "name": "Sales Group",
    "users_count": 0,
    "created_at": "2025-01-20T00:00:00Z",
    "updated_at": "2025-01-20T00:00:00Z"
  }
}

ユーザーグループの更新 ​

既存のユーザーグループ名を更新します。

shell
PUT /api/iam/user_groups/:user-group-id

URLパラメーター ​

名前タイプ説明
user-group-idstring
必須		ユーザーグループID。

ペイロード ​

名前タイプ説明
user_group.namestring
必須		ユーザーグループの更新後の名前。
サンプルリクエスト ​
shell
curl  -X PUT https://www.workato.com/api/iam/user_groups/:user-group-id \
      -H 'Authorization: Bearer <api_token>' \
      -H 'Content-Type: application/json' \
      -d '{
            "user_group": {
              "name": "Sales training group"
            }
          }'
レスポンス ​
json
{
  "data": {
    "id": "user-group-id",
    "environment_id": "env-id",
    "name": "Sales training group",
    "users_count": 10,
    "created_at": "2025-01-01T00:00:00Z",
    "updated_at": "2025-01-20T00:00:00Z"
  }
}

ユーザーグループの削除 ​

ワークスペースからユーザーグループを削除します。

グループを削除してもユーザーは削除されません

このアクションにより、ユーザーグループが完全に削除されます。 グループに割り当てられているユーザーは削除されませんが、このグループから削除されます。

shell
DELETE /api/iam/user_groups/:user-group-id

URLパラメーター ​

名前タイプ説明
user-group-idstring
必須		ユーザーグループID。
サンプルリクエスト ​
shell
curl  -X DELETE 'https://www.workato.com/api/iam/user_groups/:user-group-id' \
      -H 'Authorization: Bearer <api_token>'
レスポンス ​
json
{
  "data": null
}

ユーザーをグループに追加 ​

1回の操作で複数のユーザーをユーザーグループに追加します。

shell
POST /api/iam/user_groups/:user-group-id/add_users

URLパラメーター ​

名前タイプ説明
user-group-idstring
必須		ユーザーグループID。

ペイロード ​

名前タイプ説明
user_ids[]array[string]
必須		グループに追加するユーザーIDの配列。
サンプルリクエスト ​
shell
curl  -X POST https://www.workato.com/api/iam/user_groups/:user-group-id/add_users \
      -H 'Authorization: Bearer <api_token>' \
      -H 'Content-Type: application/json' \
      -d '{
            "user_ids": ["user-id-1", "user-id-2"]
          }'
レスポンス ​
json
{
  "data": null
}

グループからユーザーを削除 ​

1回の操作でユーザーグループから複数のユーザーを削除します。

shell
DELETE /api/iam/user_groups/:user-group-id/remove_users

URLパラメーター ​

名前タイプ説明
user-group-idstring
必須		ユーザーグループID。

ペイロード ​

名前タイプ説明
user_ids[]array[string]
必須		グループから削除するユーザーIDの配列。
サンプルリクエスト ​
shell
curl  -X DELETE https://www.workato.com/api/iam/user_groups/:user-group-id/remove_users \
      -H 'Authorization: Bearer <api_token>' \
      -H 'Content-Type: application/json' \
      -d '{
            "user_ids": ["user-id-1", "user-id-2"]
          }'
レスポンス ​
json
{
  "data": null
}

グループメンバーの一覧表示 ​

特定のユーザーグループのすべてのメンバーを一覧表示します。

shell
GET /api/iam/user_groups/:user-group-id/members

URLパラメーター ​

名前タイプ説明
user-group-idstring
必須		ユーザーグループID。

クエリパラメーター ​

名前タイプ説明
pageinteger
optional		ページ番号。 デフォルトは1です。
per_pageinteger
optional		ページサイズ。 最大値/デフォルトは100です。
サンプルリクエスト ​
shell
curl  -X GET 'https://www.workato.com/api/iam/user_groups/:user-group-id/members?page=1&per_page=100' \
      -H 'Authorization: Bearer <api_token>' \
      -H 'Content-Type: application/json'
レスポンス ​
json
{
  "data": [
    {
      "id": "user-id",
      "email": "[email protected]",
      "name": "Jade Anderson",
      "status": "active",
      "last_signed_in_at": "2025-01-15T10:30:00Z",
      "created_at": "2025-01-01T00:00:00Z",
      "environment_ids": ["env-id"],
      "user_groups": [
        {
          "id": "user-group-id",
          "environment_id": "env-id",
          "name": "Developers"
        }
      ]
    }
  ],
  "total": 1,
  "page": {
    "number": 1,
    "size": 100
  }
}

アプリリンクは、ユーザーのWorkato Identityアカウントを、Slack、Microsoft Teams、Workato GOなどの特定のアプリ内の対応するアカウントにマッピングします。 たとえば、Workato Identityの[email protected]をSlackの@jadeに接続します。 ユーザーに最初のサインインを求めることなく、Workato Identityでアプリリンクを作成できます。 これにより、接続済みアプリを通じて、アプリイベント、通知、または自動化を組織全体に即座に送信できます。

次のエンドポイントを使用して、Workato Identityアプリリンクを管理できます:

現在のEnvironment内のすべてのアプリリンクを一覧表示します。

shell
GET /api/iam/app_links
名前タイプ説明
app_typestring
任意		アプリタイプ: slack、teams、またはmatrix。
app_user_idstring
任意		アプリユーザーID。
app_user_ids[]array[string]
任意		アプリユーザーID。
user_idstring
任意		WorkatoユーザーID。
user_ids[]array[string]
任意		WorkatoユーザーID。
statestring
任意		状態: initialまたはlinked。
order_bystring
任意		app_type、state、linked_at、またはcreated_atでソートします。
orderstring
任意		ソート方向: ascまたはdesc。
pageinteger
optional		ページ番号。 デフォルトは1です。
per_pageinteger
optional		ページサイズ。 デフォルトの最大値100に設定します。
shell
curl  -X GET 'https://www.workato.com/api/iam/app_links?page=1&per_page=100' \
      -H 'Authorization: Bearer <api_token>' \
      -H 'Content-Type: application/json'
json
{
  "data": [
    {
      "id": "7H9UjixTng97i7dTSXMYpo",
      "app_type": "slack",
      "app_user_id": "/slack/teams/T083UTJ97C1/users/U083G78PZV0",
      "user_id": "user-id",
      "state": "linked",
      "linked_at": "2025-01-15T10:30:00Z",
      "created_at": "2025-01-01T00:00:00Z",
      "updated_at": "2025-01-10T00:00:00Z",
      "auth_link": null
    },
    {
      "id": "4YYoEcATHdUVHceXUHymKY",
      "app_type": "teams",
      "app_user_id": "/teams/teams/1a30ead4-ab61-473e-8c8a-a83eb2948145/users/cb3bbf8f-579e-41c6-89ad-5927346f8944",
      "user_id": "user-id",
      "state": "linked",
      "linked_at": "2025-01-15T10:30:00Z",
      "created_at": "2025-01-01T00:00:00Z",
      "updated_at": "2025-01-10T00:00:00Z",
      "auth_link": null
    },
    {
      "id": "yDQe8Ua4PKQWT7hDMAPgi",
      "app_type": "matrix",
      "app_user_id": "[email protected]",
      "user_id": "user-id",
      "state": "linked",
      "linked_at": "2025-01-15T10:30:00Z",
      "created_at": "2025-01-01T00:00:00Z",
      "updated_at": "2025-01-10T00:00:00Z",
      "auth_link": null
    }
  ],
  "total": 3,
  "page": {
    "number": 1,
    "size": 100
  }
}

ワークスペース内に新しいアプリリンクを作成します。

shell
POST /api/iam/app_links
名前タイプ説明
app_typestring
必須		アプリタイプ: slack、teams、またはmatrix。
app_user_idstring
必須		アプリ内のユーザーID。 形式はアプリタイプによって異なります:
• Slack: /slack/teams/{team_id}/users/{user_id}
• Teams: /teams/teams/{team_uuid}/users/{user_uuid}
• Matrix（GO）: ユーザーのメールアドレス
user_idstring
任意		WorkatoユーザーID。 省略した場合、リンクはinitial状態で作成されます。
shell
curl  -X POST https://www.workato.com/api/iam/app_links \
      -H 'Authorization: Bearer <api_token>' \
      -H 'Content-Type: application/json' \
      -d '{
            "app_type": "slack",
            "app_user_id": "/slack/teams/T083UTJ97C1/users/U083G78PZV0",
            "user_id": "user-id"
          }'
json
{
  "data": {
    "id": "app-link-id",
    "app_type": "slack",
    "app_user_id": "/slack/teams/T083UTJ97C1/users/U083G78PZV0",
    "user_id": "user-id",
    "state": "linked",
    "linked_at": "2025-01-15T10:30:00Z",
    "created_at": "2025-01-01T00:00:00Z",
    "updated_at": "2025-01-10T00:00:00Z",
    "auth_link": "http://id.workato.com/portal/workspaces/<ID>/environments/<ENV ID>/sign-in?app_link_unique_id=<APP LINK ID>"
  }
}

ワークスペースからアプリリンクを削除します。

shell
DELETE /api/iam/app_links/:id
名前タイプ説明
idstring
必須		アプリリンクID。
shell
curl  -X DELETE 'https://www.workato.com/api/iam/app_links/:id' \
      -H 'Authorization: Bearer <api_token>'
json
{
  "data": null
}

1回の操作でワークスペースから複数のアプリリンクを削除します。

shell
DELETE /api/iam/app_links
名前タイプ説明
ids[]array[string]
任意		削除するアプリリンクID。
shell
curl  -X DELETE 'https://www.workato.com/api/iam/app_links' \
      -H 'Authorization: Bearer <api_token>' \
      -H 'Content-Type: application/json' \
      -d '{
            "ids": ["app-link-id-1", "app-link-id-2"]
          }'
json
{
  "data": null
}

Last updated: