Custom OAuth profilesのスコープ
Workatoで定義するスコープは、管理者がHubSpotアプリで設定するスコープと一致するか、そのサブセットである必要があります。これにより、Custom OAuth profilesを使用してWorkatoとHubSpotの間でコネクションを正常に確立できます。スコープの不一致により、HubSpotコネクションの設定エラーが発生する場合があります。この追加のセキュリティ対策は、2024年10月21日以降HubSpotで必須です。
Workatoユーザーは、コネクションのセットアップ中にAdvanced settings(詳細設定)でスコープを選択できます。これらのスコープは、HubSpotコネクションの確立時に要求されます。
管理者は、HubSpotアプリのapp-hsmeta.jsonファイルのauthオブジェクトでスコープを設定します。公開アプリで使用できるスコープタイプの詳細については、HubSpotのスコープドキュメントを参照してください。
設定アプローチ
管理者は、次のいずれかのアプローチを使用してHubSpotでスコープを設定できます。選択するアプローチは、内部ユーザー用にスコープを設定するのか、顧客にサービスを提供するWorkato Embeddedパートナーであるのかによって異なります。
必須スコープ
次のスコープは、設定アプローチに関係なく、すべてのコネクションに必須です。このスコープをHubSpotアプリのrequiredScopes配列に追加する必要があります:
crm.objects.contacts.read
HubSpotでは、OAuthを使用するアプリにoauthスコープも必要です。 crm.objects.contacts.readとともにrequiredScopes配列に追加します。他のすべてのスコープをoptionalScopes配列に追加します。
デフォルトのスコープを使用し、オンデマンドで追加
デフォルトのスコープを使用し、必要に応じて追加のスコープを割り当てることができます。このアプローチは、WorkatoからHubSpotに接続する際にAdvanced settings(詳細設定)でスコープを調整しないユーザーと連携する管理者によく使用されます。
チーム内の誰もスコープを調整しない限り、エラーなしでコネクションを確立できます。コネクションの設定中に誰かがスコープを調整すると、コネクションはエラーで失敗します。この場合、HubSpot Custom OAuthアプリの所有者に新しいスコープの追加を依頼できるHubSpot管理者に連絡する必要があります。または、Workatoサポートに連絡することもできます。スコープが同期されるまで、HubSpotへのコネクションを確立できません。
管理者は、次のスコープをHubSpotで任意として追加する必要があります。これらはWorkatoのコネクションによってデフォルトで要求されるためです:
Workatoデフォルトスコープ
crm.lists.readcrm.lists.writecrm.objects.companies.readcrm.objects.companies.writecrm.objects.contacts.writecrm.objects.deals.readcrm.objects.deals.writecrm.objects.owners.readcrm.schemas.companies.readcrm.schemas.companies.writecrm.schemas.contacts.readcrm.schemas.contacts.writecrm.schemas.deals.readcrm.schemas.deals.write
最小権限の原則
管理者であり、セキュリティのベストプラクティスに従ってHubSpotカスタムOAuthアプリを設定できる場合は、最小権限の原則アプローチが適しています。このアプローチは、顧客がそのプロファイルを使用してHubSpotに接続することを想定しているEmbeddedパートナーには適していません。
管理者はユーザーと協力して、コネクター内の関連するトリガーとアクションを特定します。管理者はこの入力を使用して、HubSpot OAuthアプリで適切なスコープを選択し、任意としてマークします。アプリが更新された後、ユーザーは同じスコープを使用してWorkatoでHubSpotコネクションを設定します。この設定により、アクセスは必要なデータのみに制限され、ユーザーが自分のロール外のHubSpot情報を表示できないようになります。
すべてのスコープ
すべてのスコープアプローチを使用する場合、管理者は利用可能なすべてのスコープを任意として設定する必要があります。これにより、ユーザーがコネクション設定中に追加のスコープを設定する際に発生する可能性のあるコネクションエラーを排除できます。任意のスコープの次のリストを参照してください。
スコープの完全なリスト
ユーザーがWorkatoでHubSpotコネクションを設定するときに選択できるスコープは次のとおりです。
accountingaccount-info.security.readactionsanalytics.behavioral_events.sendautomationautomation.sequences.enrollments.writeautomation.sequences.readbehavioral_events.event_definitions.read_writebusiness_units_view.readbusiness-intelligencecms.domains.readcms.domains.writecms.functions.readcms.functions.writecms.knowledge_base.articles.publishcms.knowledge_base.articles.readcms.knowledge_base.articles.writecms.knowledge_base.settings.readcms.knowledge_base.settings.writecms.membership.access_groups.readcms.membership.access_groups.writecms.performance.readcollector.graphql_query.executecollector.graphql_schema.readcommunication_preferences.readcommunication_preferences.read_writecommunication_preferences.statuses.batch.readcommunication_preferences.statuses.batch.writecommunication_preferences.writecontentconversations.custom_channels.readconversations.custom_channels.writeconversations.read conversations.writeconversations.visitor_identification.tokens.createcrm.dealsplits.read_writecrm.exportcrm.importcrm.lists.readcrm.lists.writecrm.objects.appointments.readcrm.objects.appointments.writecrm.objects.carts.readcrm.objects.carts.writecrm.objects.commercepayments.readcrm.objects.companies.readcrm.objects.companies.writecrm.objects.contacts.writecrm.objects.courses.readcrm.objects.courses.writecrm.objects.custom.readcrm.objects.custom.writecrm.objects.deals.readcrm.objects.deals.writecrm.objects.feedback_submissions.readcrm.objects.goals.readcrm.objects.goals.writecrm.objects.invoices.readcrm.objects.invoices.writecrm.objects.leads.readcrm.objects.leads.writecrm.objects.line_items.readcrm.objects.line_items.writecrm.objects.listings.readcrm.objects.listings.writecrm.objects.marketing_events.readcrm.objects.marketing_events.writecrm.objects.orders.readcrm.objects.orders.writecrm.objects.owners.readcrm.objects.partner-clients.readcrm.objects.partner-clients.writecrm.objects.products.readcrm.objects.products.writecrm.objects.quotes.readcrm.objects.quotes.writecrm.objects.services.readcrm.objects.services.writecrm.objects.subscriptions.readcrm.objects.subscriptions.writecrm.objects.users.readcrm.objects.users.writecrm.pipelines.orders.readcrm.pipelines.orders.writecrm.schemas.appointments.readcrm.schemas.appointments.writecrm.schemas.carts.readcrm.schemas.carts.writecrm.schemas.commercepayments.readcrm.schemas.companies.readcrm.schemas.companies.writecrm.schemas.contacts.readcrm.schemas.contacts.writecrm.schemas.courses.readcrm.schemas.courses.writecrm.schemas.custom.readcrm.schemas.custom.write*crm.schemas.deals.readcrm.schemas.deals.writecrm.schemas.invoices.readcrm.schemas.invoices.writecrm.schemas.line_items.readcrm.schemas.listings.readcrm.schemas.listings.writecrm.schemas.orders.readcrm.schemas.orders.writecrm.schemas.quotes.readcrm.schemas.services.readcrm.schemas.services.writecrm.schemas.subscriptions.readcrm.schemas.subscriptions.writectas.reade-commerceexternal_integrations.forms.accessfilesfiles.ui_hidden.readformsforms-uploaded-fileshubdbintegration-syncmarketing-emailmarketing.campaigns.readmarketing.campaigns.revenue.readmarketing.campaigns.writemedia_bridge.readmedia_bridge.writesales-email-readscheduler.meetings.meeting-link.readsettings.billing.writesettings.currencies.readsettings.currencies.writesettings.security.security_health.readsettings.users.readsettings.users.teams.readsettings.users.teams.writesettings.users.writesocialtax_rates.readticketstimelinetransactional-email
利用可能なスコープ
* crm.schemas.custom.writeスコープはデフォルトでは利用できません。インテグレーションにこのスコープが必要な場合は、HubSpotのCustom Objects Schemaパイロットプログラムへのアクセスをリクエストできます。
最終更新日: