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.read
  • crm.lists.write
  • crm.objects.companies.read
  • crm.objects.companies.write
  • crm.objects.contacts.write
  • crm.objects.deals.read
  • crm.objects.deals.write
  • crm.objects.owners.read
  • crm.schemas.companies.read
  • crm.schemas.companies.write
  • crm.schemas.contacts.read
  • crm.schemas.contacts.write
  • crm.schemas.deals.read
  • crm.schemas.deals.write

Principle of least privilege

The principle of least privilege approach is suitable if you're an admin and can configure a HubSpot Custom OAuth app in accordance with security best practices. This approach isn't suitable for Embedded partners who plan for their customers to connect to HubSpot using the profile.

Admins work with users to identify the relevant triggers and actions in the connector. Admins use this input to select and mark the appropriate scopes as optional in the HubSpot OAuth app. Users configure their HubSpot connection in Workato using the same scopes after the app is updated. This setup ensures access stays limited to only the required data and prevents users from viewing HubSpot information outside their roles.

All scopes

Admins must configure all available scopes as optional when using the all scopes approach. This eliminates potential connection errors when users configure additional scopes during the connection setup. Refer to the following list of optional scopes:

Full list of scopes

The following list of scopes are available for users to choose when configuring a HubSpot connection in Workato:

  • accounting
  • account-info.security.read
  • actions
  • analytics.behavioral_events.send
  • automation
  • automation.sequences.enrollments.write
  • automation.sequences.read
  • behavioral_events.event_definitions.read_write
  • business_units_view.read
  • business-intelligence
  • cms.domains.read
  • cms.domains.write
  • cms.functions.read
  • cms.functions.write
  • cms.knowledge_base.articles.publish
  • cms.knowledge_base.articles.read
  • cms.knowledge_base.articles.write
  • cms.knowledge_base.settings.read
  • cms.knowledge_base.settings.write
  • cms.membership.access_groups.read
  • cms.membership.access_groups.write
  • cms.performance.read
  • collector.graphql_query.execute
  • collector.graphql_schema.read
  • communication_preferences.read
  • communication_preferences.read_write
  • communication_preferences.statuses.batch.read
  • communication_preferences.statuses.batch.write
  • communication_preferences.write
  • content
  • conversations.custom_channels.read
  • conversations.custom_channels.write
  • conversations.read conversations.write
  • conversations.visitor_identification.tokens.create
  • crm.dealsplits.read_write
  • crm.export
  • crm.import
  • crm.lists.read
  • crm.lists.write
  • crm.objects.appointments.read
  • crm.objects.appointments.write
  • crm.objects.carts.read
  • crm.objects.carts.write
  • crm.objects.commercepayments.read
  • crm.objects.companies.read
  • crm.objects.companies.write
  • crm.objects.contacts.write
  • crm.objects.courses.read
  • crm.objects.courses.write
  • crm.objects.custom.read
  • crm.objects.custom.write
  • crm.objects.deals.read
  • crm.objects.deals.write
  • crm.objects.feedback_submissions.read
  • crm.objects.goals.read
  • crm.objects.goals.write
  • crm.objects.invoices.read
  • crm.objects.invoices.write
  • crm.objects.leads.read
  • crm.objects.leads.write
  • crm.objects.line_items.read
  • crm.objects.line_items.write
  • crm.objects.listings.read
  • crm.objects.listings.write
  • crm.objects.marketing_events.read
  • crm.objects.marketing_events.write
  • crm.objects.orders.read
  • crm.objects.orders.write
  • crm.objects.owners.read
  • crm.objects.partner-clients.read
  • crm.objects.partner-clients.write
  • crm.objects.products.read
  • crm.objects.products.write
  • crm.objects.quotes.read
  • crm.objects.quotes.write
  • crm.objects.services.read
  • crm.objects.services.write
  • crm.objects.subscriptions.read
  • crm.objects.subscriptions.write
  • crm.objects.users.read
  • crm.objects.users.write
  • crm.pipelines.orders.read
  • crm.pipelines.orders.write
  • crm.schemas.appointments.read
  • crm.schemas.appointments.write
  • crm.schemas.carts.read
  • crm.schemas.carts.write
  • crm.schemas.commercepayments.read
  • crm.schemas.companies.read
  • crm.schemas.companies.write
  • crm.schemas.contacts.read
  • crm.schemas.contacts.write
  • crm.schemas.courses.read
  • crm.schemas.courses.write
  • crm.schemas.custom.read
  • crm.schemas.custom.write*
  • crm.schemas.deals.read
  • crm.schemas.deals.write
  • crm.schemas.invoices.read
  • crm.schemas.invoices.write
  • crm.schemas.line_items.read
  • crm.schemas.listings.read
  • crm.schemas.listings.write
  • crm.schemas.orders.read
  • crm.schemas.orders.write
  • crm.schemas.quotes.read
  • crm.schemas.services.read
  • crm.schemas.services.write
  • crm.schemas.subscriptions.read
  • crm.schemas.subscriptions.write
  • ctas.read
  • e-commerce
  • external_integrations.forms.access
  • files
  • files.ui_hidden.read
  • forms
  • forms-uploaded-files
  • hubdb
  • integration-sync
  • marketing-email
  • marketing.campaigns.read
  • marketing.campaigns.revenue.read
  • marketing.campaigns.write
  • media_bridge.read
  • media_bridge.write
  • sales-email-read
  • scheduler.meetings.meeting-link.read
  • settings.billing.write
  • settings.currencies.read
  • settings.currencies.write
  • settings.security.security_health.read
  • settings.users.read
  • settings.users.teams.read
  • settings.users.teams.write
  • settings.users.write
  • social
  • tax_rates.read
  • tickets
  • timeline
  • transactional-email

AVAILABLE SCOPES

* The crm.schemas.custom.write scope is not available by default. If you require this scope for your integration, you can request access to HubSpot's Custom Objects Schema pilot program.

最終更新日: