Product UpdatesStatus PageAutomation Institute
日本語
Workato Embedded API
リソース

# Workato API - カスタマーアカウントの管理

これらのエンドポイントを使用できるユーザー

このガイド内のエンドポイントは、Embedded ベンダー API であり、oem_vendor 権限が必要です。使用中のアカウントでこの権限を有効にするには、Workato の担当者までお問い合わせください。

管理対象ユーザー リソースを使用すると、カスタマーアカウントをプログラムによって管理できるようにします。

# クイックリファレンス

非推奨のエンドポイント

非推奨のエンドポイントは引き続き動作しますが、廃止後は更新されなくなります。

管理対象ユーザーリソースには、以下のエンドポイントが含まれます。

タイプ リソース 説明
POST /api/managed_users カスタマーアカウントを作成します。
PUT /api/managed_users/:id カスタマーアカウントを更新します。
DELETE /api/managed_users/:id カスタマーアカウントを削除します。
GET /api/managed_users/:id カスタマーアカウントを取得します。
GET /api/managed_users/ すべてのカスタマーアカウントのリストを表示します。
GET /api/managed_users/:id/members カスタマーアカウント内のメンバーのリストを表示します。
GET /api/managed_users/:id/members/:member_id カスタマーアカウント内のメンバーを取得します。
POST /api/managed_users/:id/members カスタマーアカウントにメンバーを追加します。
PUT /api/managed_users/:id/members/:member_id カスタマーアカウント内のメンバーを更新します。
DELETE /api/managed_users/:id/members/:member_id カスタマーアカウントからメンバーを削除します。
GET /api/managed_users/:id/connections カスタマーアカウント内のコネクションのリストを表示します。
GET /api/managed_users/usage すべてのカスタマーアカウントの月ごとのタスク使用量を取得します。
PUT /api/managed_users/:id/upgrade 非推奨。 カスタマーアカウントをアップグレードします。
PUT /api/managed_users/:id/downgrade 非推奨。 カスタマーアカウントをダウングレードします。
POST /api/managed_users/:id/member 非推奨。 カスタマーアカウントにメンバーを追加します。
DELETE /api/managed_users/:id/member 非推奨。 カスタマーアカウントからメンバーを削除します。

# カスタマーアカウントの作成

新しい Embedded カスタマーアカウントを作成します。

POST /api/managed_users

# ペイロード

名前 型 説明
name string
必須		 ユーザーのフルネーム。
notification_email string
必須		 エラー通知と管理通知のメール。
plan_id string
任意		 プラン ID。指定されなかった場合は、デフォルトのプラン ID が使用されます。
external_id string
任意		 Embedded カスタマーの外部 ID。
origin_url string
任意		 埋め込まれた Embedded アカウントカスタマーに適用されます。埋め込まれた IFrame がデフォルト以外のオリジンページでホストされている場合に、値を指定します。たとえば、カスタマー固有のカスタムドメインなどです。デフォルトでは、アカウントレベルで設定されたオリジンに設定されます。
frame_ancestors string
任意		 1つ以上のカンマ区切りの上位フレームを指定します。これらの URL は、Workato IFrame のレンダリングを許可するために Content-Security-Policy HTTP ヘッダーで使用されます。
whitelisted_apps array
任意		 カスタマーアカウントがアクセスを許可されたアプリに関連するコネクション provider 値のリスト。この機能の詳細については、OEM 管理コンソール - アプリアクセスガイドを参照してください。
time_zone string
任意		 タイムゾーン名。タイムゾーンのリストについては、このドキュメントを参照してください。指定されなかった場合は、デフォルトで PST に設定されます。
auth_settings object
任意		 カスタマーアカウントに対する認証設定。使用可能な types は workato_auth と saml_sso です。saml_sso を設定した場合は、使用可能な providers は "okta"、"onelogin"、"others" です。例については、以下のサンプルリクエストを参照してください。

# サンプルリクエスト

# Workato 認証を使用したリクエスト

curl  -X POST https://www.workato.com/api/managed_users \
      -H 'x-user-email: <email>' \
      -H 'x-user-token: <token>' \
      -H 'Content-Type: application/json' \
      -d '{
            "name": "Kevin Leary",
            "notification_email": "kevinl@acme.com",
            "external_id": "UU0239093498",
            "whitelisted_apps": ["salesforce", "netsuite"],
            "time_zone": "Central Time (US & Canada)",
            "auth_settings": {
                "type": "workato_auth"
              }
          }'

# SAML SSO とメタデータ URL を使用したリクエスト

curl  -X POST https://www.workato.com/api/managed_users \
      -H 'x-user-email: <email>' \
      -H 'x-user-token: <token>' \
      -H 'Content-Type: application/json' \
      -d '{
            "name": "Kevin Leary",
            "notification_email": "kevinl@acme.com",
            "external_id": "UU0239093498",
            "whitelisted_apps": ["salesforce", "netsuite"],
            "time_zone": "Central Time (US & Canada)",
            "auth_settings": {
              "type": "saml_sso",
              "provider": "okta",
              "metadata_url": "https://workato.okta.com/app/exk3ar7z0drZQFDpK696/sso/saml/metadata"
            }
          }'

# SAML SSO と X509 証明書を使用したリクエスト

curl  -X POST https://www.workato.com/api/managed_users \
      -H 'x-user-email: <email>' \
      -H 'x-user-token: <token>' \
      -H 'Content-Type: application/json' \
      -d '{
            "name": "Kevin Leary",
            "notification_email": "kevinl@acme.com",
            "external_id": "UU0239093498",
            "whitelisted_apps": ["salesforce", "netsuite"],
            "time_zone": "Central Time (US & Canada)",
            "auth_settings": {
              "type": "saml_sso",
              "provider": "okta",
              "sso_url": "https://dev-workato.okta.com/app/dev-w_workato_1/exk21ojjvq6212R6e5d7/sso/saml",
              "saml_issuer": "http://www.okta.com/exk21ojjvq6212R6e5d7",
              "x509_cert": "sfas"
              }
          }'

# レスポンス

{
    "id": 14242,
    "external_id": "128490",
    "name": "B-max",
    "notification_email": "admin@bmax.com",
    "plan_id": "business_yearly",
    "origin_url": null,
    "frame_ancestors": null,    
    "trial": false,
    "in_trial": false,
    "whitelisted_apps": [
        "netsuite",
        "salesforce"
    ],
    "created_at": "2021-11-29T23:52:07.025-08:00",
    "updated_at": "2021-11-29T23:52:07.025-08:00",
    "time_zone": "Alaska",
    "auth_settings": {
        "type": "workato_auth"
    }
}

# カスタマーアカウントの更新

PUT /api/managed_users/:id

既存の Embedded カスタマーアカウントに関する以下をはじめとする情報を更新します。

  • 名前
  • 外部 ID
  • エラー通知メールアドレス
  • プラン
  • トライアル状態
  • 認証設定

補足事項 :

  • タスクベースのプランを利用しているカスタマーの場合は、このエンドポイントを使用して、タスク数の制限の上書きを更新し、1回限りの調整を行えます。
  • Embedded を使用しているパートナーの場合は、このエンドポイントを使用して、特定のカスタマーのカスタムのオリジン URL を更新できます。

# URL パラメータ

名前 型 説明
id string
必須		 Embedded カスタマーアカウント ID または外部 ID。
外部 ID は、E を先頭に付ける必要があります (例 : Ea2300)。結果として返される ID は URL エンコードされます。

# ペイロード

注 : プロパティは、ペイロードにプロパティが含まれている場合にのみ更新されます。プロパティの値をクリアするには、ペイロードでプロパティを null に設定します。

名前 型 説明
name string
任意		 ユーザーのフルネーム。
notification_email string
任意		 エラー通知と管理通知に関するメール。
error_notification_emails string
任意		 エラー通知に関するメール。このプロパティは、通知メールプロパティへの入力を上書きします。
admin_notification_emails string
任意		 管理通知に関するメール。このプロパティは、通知メールプロパティへの入力を上書きします。
external_id string
任意		 Embedded カスタマーの外部 ID。
origin_url string
任意		 埋め込まれた Embedded アカウントのカスタマーに適用されます。埋め込まれた IFrame がデフォルト以外のオリジンページ (たとえば、カスタマー固有のカスタムドメインなど) でホストされている場合に、値を指定します。デフォルトでは、アカウントレベルで設定されたオリジンに設定されます。
frame_ancestors string
任意		 1つ以上のカンマ区切りの上位フレームを指定します。これらの URL は、Workato IFrame のレンダリングを許可するために Content-Security-Policy HTTP ヘッダーで使用されます。
plan_id string
任意		 プランの ID。
in_trial boolean
任意		 ユーザーを無料プランまたはサブスクリプションプランにダウングレードまたはアップグレードします。
task_limit_adjustment string
任意		 現在 の会計期間中のタスク数の制限の調整。タスクベースのプランに対してのみ有効です。この調整は、それ以降の期間には適用されません。"-" を追加することによってマイナスの調整を行えます ("-5000" など)。
custom_task_limit string
任意		 現在のプラン制限を上書きします。
whitelisted_apps array
任意		 カスタマーアカウントがアクセスを許可されたアプリに関連するコネクション provider 値のリスト。この機能の詳細については、OEM 管理コンソール - アプリアクセスガイドを参照してください。
time_zone string
任意		 タイムゾーン名。タイムゾーンのリストについては、このドキュメントを参照してください。指定されなかった場合は、デフォルトで PST に設定されます。
auth_settings object
任意		 カスタマーアカウントに対する認証設定。使用可能な types は workato_auth と saml_sso です。saml_sso を設定した場合は、使用可能な providers は "okta"、"onelogin"、"others" です。例については、以下のサンプルリクエストを参照してください。
current_billing_period_start string
任意		 現在の請求開始日を設定します。日付と時刻は ISO 8601形式で指定する必要があります。

# サンプルリクエスト

curl  -X PUT https://www.workato.com/api/managed_users/3498583 \
      -H 'x-user-email: <email>' \
      -H 'x-user-token: <token>' \
      -H 'Content-Type: application/json' \
      -d '{,
            "notification_email": "kevinl+workatodevops@acme.com",
            "admin_notification_emails": "kim@acme.com, jin@acem.com",
            "error_notification_emails": "kim@acme.com, john@acem.com",
            "whitelisted_apps": ["salesforce", "netsuite"],
            "auth_settings": {
              "type": "saml_sso",
              "provider": "okta",
              "metadata_url": "https://workato.okta.com/app/exk3ar7z0drZQFDpK696/sso/saml/metadata"
            }
          }'

# レスポンス

{
    "id": 3498583,
    "external_id": "",
    "name": "Kevin K Leary",
    "notification_email": "kim@acme.com, jin@acem.com, john@acem.com",
    "error_notification_emails": "kim@acme.com, jin@acem.com",
    "admin_notification_emails": "kim@acme.com, john@acem.com",
    "plan_id": "task_plan_1",
    "origin_url": null,
    "frame_ancestors": null,
    "trial": false,
    "in_trial": false,
    "created_at": "2019-05-16T21:21:48.320-07:00",
    "updated_at": "2020-10-02T02:49:42.644-07:00",
    "current_billing_period_start": "2020-09-22T19:15:11.372-07:00",
    "current_billing_period_end": "2020-10-22T19:15:11.372-07:00",
    "task_limit_adjustment": null,
    "task_limit": 20000,
    "task_count": 0,
    "active_connection_limit": 0,
    "active_connection_count": 8,
    "active_recipe_count": 0,
    "whitelisted_apps": [
        "salesforce",
        "netsuite"
    ],
    "auth_settings": {
        "type": "saml_sso",
        "provider": "okta",
        "metadata_url": "https://workato.okta.com/app/exk3ar7z0drZQFDpK696/sso/saml/metadata"
    },
    "time_zone": "Alaska"
}

# カスタマーアカウントの削除

使用時の注意

削除したカスタマーアカウントは、完全には復元できません。このエンドポイントは慎重に使用してください。

Embedded カスタマーアカウントを削除します。

DELETE /api/managed_users/:id

# URL パラメータ

名前 型 説明
id string
必須		 Embedded カスタマーアカウント ID または外部 ID。
外部 ID は、E を先頭に付ける必要があります (例 : Ea2300)。結果として返される ID は URL エンコードされます。

# サンプルリクエスト

curl  -X DELETE https://www.workato.com/api/managed_users/28942 \
      -H 'x-user-email: <email>' \
      -H 'x-user-token: <token>' \
      -H 'Content-Type: application/json' \

# レスポンス

{
    "success": true
}

# カスタマーアカウントの取得

Embedded カスタマーのアカウントに関する詳細を取得します。

GET /api/managed_users/:id

# URL パラメータ

名前 型 説明
id string
必須		 Embedded カスタマーアカウント ID または外部 ID。
外部 ID は、E を先頭に付ける必要があります (例 : Ea2300)。結果として返される ID は URL エンコードされます。

# サンプルリクエスト

curl  -X GET https://www.workato.com/api/managed_users/27819 \
      -H 'x-user-email: <email>' \
      -H 'x-user-token: <token>'

# レスポンス

{
    "id": 4243,
    "external_id": "",
    "name": "Abstergo Industries",
    "notification_email": "kim@acme.com, jin@acem.com, john@acem.com",
    "error_notification_emails": "kim@acme.com, jin@acem.com",
    "admin_notification_emails": "kim@acme.com, john@acem.com",
    "plan_id": "tbp_wrike_monthly_1",
    "whitelisted_apps": ["salesforce", "netsuite"],
    "origin_url": null,
    "frame_ancestors": null,
    "trial": false,
    "in_trial": false,
    "created_at": "2019-05-16T21:21:48.320-07:00",
    "updated_at": "2020-09-23T04:01:26.844-07:00"
}

# カスタマーアカウントのリストの取得

すべてのカスタマーアカウントのリストを取得します。このエンドポイントは、管理コンソールのカスタマー表内のデータを返します。

GET /api/managed_users/

# URL パラメータ

名前 型 説明
page integer ページ番号。デフォルトで1に設定されます。
per_page integer ページサイズ。デフォルトで100に設定されます (最大値は100です)。

# サンプルリクエスト

curl  -X GET https://www.workato.com/api/managed_users/ \
      -H 'x-user-email: <email>' \
      -H 'x-user-token: <token>'

# レスポンス

TIP

このエンドポイントから返されるタスク数は、カスタマーの請求期間に行われたタスク数を意味します。

{
    "result": [
        {
            "id": 4243,
            "external_id": "",
            "name": "Abstergo",
            "notification_email": "kim@abstergo.com, jin@abstergo.com, john@abstergo.com",
            "error_notification_emails": "kim@abstergo.com, jin@abstergo.com",
            "admin_notification_emails": "kim@abstergo.com, john@abstergo.com",
            "whitelisted_apps": ["salesforce", "netsuite"],
            "plan_id": "plan_tier1",
            "origin_url": null,
            "frame_ancestors": null,
            "trial": false,
            "in_trial": false,
            "created_at": "2019-05-16T21:21:48.320-07:00",
            "updated_at": "2020-10-01T02:59:32.845-07:00",
            "current_billing_period_start": "2020-09-18T05:34:50.215-07:00",
            "current_billing_period_end": "2020-10-18T05:34:50.215-07:00",
            "task_limit_adjustment": null,
            "task_limit": 20000,
            "task_count": 16777,
            "active_connection_limit": 0,
            "active_connection_count": 8,
            "active_recipe_count": 0
        },
        {
            "id": 4772,
            "external_id": "101",
            "name": "Carly's Company",
            "notification_email": "carly.frederick@w.com, jack@w.com",
            "error_notification_emails": "carly.frederick@w.com",
            "admin_notification_emails": "jack@w.com",
            "whitelisted_apps": ["salesforce", "netsuite"],
            "plan_id": "business_yearly",
            "origin_url": null,
            "frame_ancestors": null,
            "trial": false,
            "in_trial": false,
            "created_at": "2019-07-30T12:39:59.895-07:00",
            "updated_at": "2020-07-20T15:30:07.168-07:00",
            "time_zone": "Pacific Time (US & Canada)",
            "current_billing_period_start": "2020-09-30T12:39:59.936-07:00",
            "current_billing_period_end": "2020-10-30T12:39:59.936-07:00",
            "task_count": 0,
            "active_connection_limit": 0,
            "active_connection_count": 0,
            "active_recipe_count": 0
        }
      ]
}

# カスタマーアカウントメンバーのリストの取得

カスタマーアカウント内のチームメンバーのリストを取得します。アカウントメンバーの id、grant_type (チームメンバーとカスタマーマネージャーのどちらか)、name、email、external_id、role_name、time_zone を返します。

GET /api/managed_users/:id/members

# URL パラメータ

名前 型 説明
id string
必須		 Embedded カスタマーアカウント ID または外部 ID。
外部 ID は、E を先頭に付ける必要があります (例 : Ea2300)。結果として返される ID は URL エンコードされます。

# サンプルリクエスト

curl  -X GET https://www.workato.com/api/managed_users/124125/members \
      -H 'x-user-email: <email>' \
      -H 'x-user-token: <token>'

# レスポンス

[
    {
        "id": 1680,
        "grant_type": "team",
        "role_name": "Admin",
        "external_id": null,
        "name": "James Bourne",
        "email": "jason_bourne@workato.com",
        "time_zone": "Pacific Time (US & Canada)"
    },
    {
        "id": 2641,
        "grant_type": "customer_manager",
        "role_name": "Admin",
        "external_id": null,
        "name": "Jason Bond",
        "email": "jason_bond@workato.com",
        "time_zone": "Eastern Time (US & Canada)"
    }
]

# カスタマーアカウントメンバーの取得

カスタマーアカウント内の特定のチームメンバーに関する情報を取得します。指定されたメンバーの id、grant_type (チームメンバーまたはカスタマーマネージャーのどちらか)、name、email、external_id、role_name、time_zone を返します。

GET /api/managed_users/:id/members/:member_id

# URL パラメータ

名前 型 説明
id string
必須		 Embedded カスタマーアカウント ID または外部 ID。
外部 ID は、E を先頭に付ける必要があります (例 : Ea2300)。結果として返される ID は URL エンコードされます。
member_id string
必須		 メンバーの ID。

# サンプルリクエスト

curl  -X GET https://www.workato.com/api/managed_users/124/members/1680 \
      -H 'x-user-email: <email>' \
      -H 'x-user-token: <token>'

# レスポンス

{
    "id": 1680,
    "grant_type": "team",
    "role_name": "Admin",
    "external_id": null,
    "name": "James Bourne",
    "email": "jason_bourne@workato.com",
    "time_zone": "Pacific Time (US & Canada)"
}

# カスタマーアカウントへのメンバーの追加

指定された Embedded カスタマーアカウントにメンバーを追加します。

POST /api/managed_users/:id/members

# URL パラメータ

名前 型 説明
id string
必須		 Embedded カスタマーアカウント ID または外部 ID。
外部 ID は、E を先頭に付ける必要があります (例 : Ea2300)。結果として返される ID は URL エンコードされます。

# ペイロード

名前 型 説明
name string
必須		 ユーザーのフルネーム。
oauth_id string
任意		 OAuth に使用される ID。
role_name string
任意		 ロール名。
external_id string
任意		 メンバーの外部 ID。
time_zone string
任意		 タイムゾーン名。タイムゾーンのリストについては、このドキュメントを参照してください。指定されなかった場合は、デフォルトで PST に設定されます。

# サンプルリクエスト

curl  -X POST https://www.workato.com/api/managed_users/27819/members \
      -H 'x-user-email: <email>' \
      -H 'x-user-token: <token>' \
      -H 'Content-Type: application/json' \
      -d '{
            "name": "Jack Smith",
            "role_name": "Admin",
            "external_id": "UU0239093499"
          }'

# レスポンス

{
  "id": 3498583,
  "plan_id": "oem_plan",
  "trial": false,
  "time_zone": "Pacific Time (US & Canada)"
}

# カスタマーアカウントのメンバーの更新

既存の Embedded カスタマーアカウント内のメンバーを更新します。 注 : このエンドポイントを使用して更新できるのは、API を介して追加されたメンバーのみです。

PUT /api/managed_users/:id/members/:member_id

# URL パラメータ

名前 型 説明
id string
必須		 Embedded カスタマーアカウント ID または外部 ID。
外部 ID は、E を先頭に付ける必要があります (例 : Ea2300)。結果として返される ID は URL エンコードされます。
member_id string
必須		 メンバーの ID。

# ペイロード

名前 型 説明
oauth_id string
任意		 OAuth に使用される ID。
role_name string
任意		 ロール名。
external_id string
任意		 メンバーの外部 ID。
time_zone string
任意		 タイムゾーン名。タイムゾーンのリストについては、このドキュメントを参照してください。指定されなかった場合は、デフォルトで PST に設定されます。

# サンプルリクエスト

curl  -X PUT 'https://www.workato.com/api/managed_users/27819/members/12341' \
      -H 'x-user-email: <email>' \
      -H 'x-user-token: <token>' \
      -H 'Content-Type: application/json' \
      -d '{
            "role_name": "Operator",
            "external_id": "UU0239093499"
          }'

# レスポンス

{
  "id": 3498583,
  "plan_id": "oem_plan",
  "trial": false,
  "time_zone": "Pacific Time (US & Canada)"
}

# カスタマーアカウントからのメンバーの削除

Embedded カスタマーのアカウントからメンバーを削除します。 注 : このエンドポイントは、チームからメンバーを削除するだけです。これらのメンバーの Workato アカウントは削除されません。

DELETE /api/managed_users/:id/members/:member_id

# URL パラメータ

名前 型 説明
id string
必須		 Embedded カスタマーアカウント ID または外部 ID。
外部 ID は、E を先頭に付ける必要があります (例 : Ea2300)。結果として返される ID は URL エンコードされます。
member_id string
必須		 メンバーの ID。

# サンプルリクエスト

curl  -X DELETE 'https://www.workato.com/api/managed_users/27819/members/12314' \
      -H 'x-user-email: <email>' \
      -H 'x-user-token: <token>' \
      -H 'Content-Type: application/json' \

# レスポンス

{
  "id": 3485434779
}

# カスタマーコネクションのリストの表示

Embedded カスタマーアカウント内のコネクションのリストを取得します。

GET /api/managed_users/:id/connections

# URL パラメータ

名前 型 説明
id string
必須		 Embedded カスタマーアカウント ID または外部 ID。
外部 ID は、E を先頭に付ける必要があります (例 : Ea2300)。結果として返される ID は URL エンコードされます。

# サンプルリクエスト

curl  -X GET https://www.workato.com/api/managed_users/27819/connections \
      -H 'x-user-email: <email>' \
      -H 'x-user-token: <token>'

# レスポンス

{
  "result": [
    {
      "id": 6132,
      "name": "My Box account",
      "provider": "box",
      "authorization_status": "success",
      "authorized_at": "2019-09-10T18:20:08.854-07:00",
      "created_at": "2019-09-10T18:19:57.437-07:00",
      "updated_at": "2019-09-10T18:20:08.859-07:00"
    },
    {
      "id": 6131,
      "name": "My Salesforce account",
      "provider": "salesforce",
      "authorization_status": "success",
      "authorized_at": "2019-09-10T18:19:43.018-07:00",
      "created_at": "2019-09-10T18:19:12.902-07:00",
      "updated_at": "2019-09-10T18:19:43.021-07:00"
    }
  ]
}

# 月ごとの使用量の取得

過去12か月間のすべての Embedded カスタマーの月ごとの使用量のリストを取得します。タスクデータは、現在使用可能な唯一のデータです。

GET /api/managed_users/usage

TIP

このエンドポイントから返されるカスタマー別のタスク数は、関連する カレンダー月 に行われたすべてのタスクの合計です。カスタマーのプランが変更された場合や請求日または使用量がリセットされた場合でも、このエンドポイントを使用して合計使用量を取得できます。

# サンプルリクエスト

curl  -X GET https://www.workato.com/api/managed_users/usage \
      -H 'x-user-email: <email>' \
      -H 'x-user-token: <token>'

# レスポンス

注 : 以下のレスポンスは、12か月のうち3か月以降は切り捨てられています。

{
   "result":{
      "data":[
         {
            "user_id": 7443,
            "intervals":[
               {
                  "start_datetime": "2019-10-01T00:00:00.000-07:00",
                  "task_count": null
               },
               {
                  "start_datetime": "2019-11-01T00:00:00.000-07:00",
                  "task_count": null
               },
               {
                  "start_datetime": "2020-10-01T00:00:00.000-07:00",
                  "task_count": 0
               }
            ]
         }
      ],
      "generated_at":"2020-10-02T05:41:29.232-07:00"
   }
}
← 行の削除
ピックリスト →


Last updated: 2024/3/18 4:26:31

On this page