カスタムOAuthプロファイル

以下のエンドポイントを使用して、顧客アカウントに割り当てられたカスタムOAuthプロファイルを管理します。

クイックリファレンス

タイプリソース説明
POST/api/managed_users/:managed_user_id/
custom_oauth_profiles/:id/assign
カスタムOAuthプロファイルを顧客ワークスペースに割り当てます
DELETE/api/managed_users/:managed_user_id/
custom_oauth_profiles/:id/unassign
カスタムOAuthプロファイルを顧客ワークスペースから削除します

カスタムOAuthプロファイルの割り当て

カスタムOAuthプロファイルを顧客ワークスペースに割り当てます。

POST /api/managed_users/:managed_user_id/custom_oauth_profiles/:id/assign

URLパラメータ

名前タイプ説明
managed_user_idstring
必須
Workato組み込み顧客アカウントのID/外部ID。
外部IDはEで接頭辞を付ける必要があり、結果のIDはURLエンコードする必要があります(例:EA2300)。
idinteger
必須
割り当てる予定の組み込みパートナーワークスペース内のカスタムOAuthプロファイルのID。

サンプルリクエスト

shell
curl  -X POST 'https://www.workato.com/api/managed_users/123/custom_oauth_profiles/322/assign' \
      -H 'Authorization: Bearer <api_token>' \
      -H 'Content-Type: application/json' \

レスポンス

json
{
  "result": { 
    "success": true
  }
}

カスタムOAuthプロファイルの削除

カスタムOAuthプロファイルを顧客ワークスペースから削除します。

DELETE /api/managed_users/:managed_user_id/custom_oauth_profiles/:id/unassign

URLパラメータ

名前タイプ説明
managed_user_idstring
必須
Workato組み込み顧客アカウントのID/外部ID。
外部IDはEで接頭辞を付ける必要があり、結果のIDはURLエンコードする必要があります(例:EA2300)。
idinteger
必須
顧客ワークスペースに割り当てるための組み込みパートナーワークスペース内のカスタムOAuthプロファイルのID。

クエリパラメータ

名前タイプ説明
forcebooleantrueの場合、顧客アカウントで使用されている場合でもカスタムOAuthプロファイルを削除します。デフォルトはfalseです。

サンプルリクエスト

shell
curl  -X DELETE 'https://www.workato.com/api/managed_users/123/custom_oauth_profiles/322/unassign' \
      -H 'Authorization: Bearer <api_token>' \
      -H 'Content-Type: application/json' \

レスポンス

json
{
  "result": { 
    "success": true
  }
}

Last updated: