コンテンツにスキップ

SCIM APIオブジェクトと付録

この記事では、さまざまなSCIM APIオブジェクトと付録について説明します。

きめ細かな権限への移行

既存のSCIM統合およびレガシーSCIM APIオブジェクトは、きめ細かな権限への移行後も引き続き動作しますが、Brazeは2026年12月にレガシーSCIM API値の受け入れを停止します。

すぐに対応する必要はありません。ただし、きめ細かな権限に移行する権限について統合を確認してください。たとえば、現在APIでbasic_accessを送信している場合は、きめ細かな権限への移行後に特定の権限を含めるよう統合を更新してください(例:"appGroupPermissions":["view_campaigns","edit_campaigns"])。Brazeは、既存の統合が壊れないよう、きめ細かな権限への移行後もbasic_accessなどのレガシー文字列を引き続き受け入れます。

権限オブジェクト

権限オブジェクトは、SCIM ID権限を通じてユーザーリソースとやり取りする際の一部のリクエストおよびレスポンスに含まれるフィールドです。

{
  "permissions": {
    "companyPermissions": (required, array),
    "appGroup": (required, array)
  }
}

有効な権限オブジェクトは、以下のキーと値のペアを持つJSONオブジェクトです。

キー 必須 データ型 説明
companyPermissions 任意 配列 会社レベルの権限文字列の配列。文字列が存在する場合、ユーザーが対応する権限を持つことを意味します。
roles 任意 配列 ロールオブジェクトの配列。
appGroup 必須 配列 ワークスペース権限オブジェクトの配列。

ワークスペース権限オブジェクト

有効なワークスペース権限オブジェクトは、以下のキーと値のペアを持つJSONオブジェクトです。

キー 必須 データ型 説明
appGroupName 任意 文字列 ワークスペースの名前。このオブジェクトに含まれる権限がどのワークスペースに対するものかを指定するために使用されます。
appGroupId appGroupNameがない場合は必須 文字列 ワークスペースのAPI識別子(UUID)。ワークスペースを指定する代替手段として使用されます。
appGroupPermissionSets 任意 配列 1つ以上のワークスペース権限セットオブジェクトの配列。ユーザーは、このワークスペースについてリストされた権限セットに含まれるすべての権限を取得します。配列を空にすることはできません。ワークスペースエントリごとにappGroupPermissionsまたはappGroupPermissionSetsのいずれか一方を指定してください(両方は指定しないでください)。
appGroupPermissions 条件付きで必須 配列 ワークスペース権限文字列テーブルのワークスペースレベルの権限文字列の配列。appGroupPermissionSetsが指定されていない場合に必須です。
team 任意 配列 チーム権限オブジェクトの配列。

ワークスペース権限セットオブジェクト

有効なワークスペース権限セットオブジェクトは、以下のキーと値のペアを持つJSONオブジェクトです。

キー 必須 データ型 説明
appGroupPermissionSetName 任意 文字列 このワークスペースに対してユーザーに割り当てられるワークスペース権限セットの名前。
appGroupPermissionSetId appGroupPermissionSetNameがない場合は必須 文字列 権限セットのAPI識別子(UUID)。このワークスペースに対してユーザーに割り当てられるワークスペース権限セットを指定する代替手段として使用されます。

チーム権限オブジェクト

有効なチーム権限オブジェクトは、以下のキーと値のペアを持つJSONオブジェクトです。

キー 必須 データ型 説明
teamName 任意 文字列 チームの名前。このオブジェクト内の権限がどのチームに対するものかを指定するために使用できます。
teamId teamNameがない場合は必須 文字列 チームのAPI識別子(UUID)。チームを指定する代替手段として使用されます。
teamPermissions 必須 配列 チーム権限文字列テーブルのチームレベルの権限文字列の配列。文字列が存在する場合、ユーザーが指定されたチームに対して対応する権限を持つことを意味します。

ロールオブジェクト

有効なロールオブジェクトは、以下のキーと値のペアを持つJSONオブジェクトです。

キー 必須 データ型 説明
roleName 任意 文字列 ユーザーに割り当てられるロールの名前。
roleId roleNameがない場合は必須 文字列 ロールのAPI識別子(UUID)。ロールを指定する代替手段として使用されます。

付録

会社権限文字列

UIでの表示 SCIM API文字列
管理者 admin
会社設定を管理 manage_company_settings
ワークスペースを作成および削除 add_remove_app_groups
ドメイン設定を表示 view_domain_settings
ドメイン設定を編集 edit_domain_settings
ダッシュボードユーザーを削除 delete_dashboard_users

ワークスペース権限文字列

権限名 SCIM API文字列
キャンペーンを表示 view_campaigns
キャンペーンを編集 edit_campaigns
キャンペーンをアーカイブ archive_campaigns
キャンバスを表示 view_canvases
キャンバスを編集 edit_canvases
キャンバスをアーカイブ archive_canvases
フリークエンシーキャップルールを表示 view_frequency_caps
フリークエンシーキャップルールを編集 edit_frequency_caps
メッセージ優先順位設定を表示 view_message_prioritization
メッセージ優先順位設定を編集 edit_message_prioritization
メッセージ優先順位設定を削除 delete_message_prioritization
Content Blocksを表示 view_content_blocks
Content Blocksを編集 edit_content_blocks
Content Blocksをアーカイブ archive_content_blocks
フィーチャーフラグを表示 view_feature_flags
フィーチャーフラグを編集 edit_feature_flags
フィーチャーフラグをアーカイブ archive_feature_flags
セグメントを表示 view_segments
オーディエンス数を表示 view_audience_population
セグメントを編集 edit_segments
セグメントをアーカイブ archive_segments
グローバルコントロールグループを表示 view_global_control_group
グローバルコントロールグループを編集 edit_global_control_group
アプリ内メッセージテンプレートを表示 view_iam_templates
アプリ内メッセージテンプレートを編集 edit_iam_templates
アプリ内メッセージテンプレートをアーカイブ archive_iam_templates
メールテンプレートを表示 view_email_templates
メールテンプレートを編集 edit_email_templates
メールテンプレートをアーカイブ archive_email_templates
Webhookテンプレートを表示 view_webhook_templates
Webhookテンプレートを編集 edit_webhook_templates
Webhookテンプレートをアーカイブ archive_webhook_templates
メールリンクテンプレートを表示 view_link_templates
メールリンクテンプレートを編集 edit_link_templates
メディアライブラリーアセットを表示 view_media_library_assets
位置情報を表示 view_locations
位置情報を編集 edit_locations
位置情報をアーカイブ archive_locations
プロモーションコードを表示 view_promotion_codes
プロモーションコードを編集 edit_promotion_codes
プロモーションコードをエクスポート export_promotion_codes
ユーザー設定センターを表示 view_preference_centers
ユーザー設定センターを編集 edit_preference_centers
レポートを編集 edit_reports
プレースメントを表示 view_placements
プレースメントを編集 edit_placements
プレースメントをアーカイブ archive_placements
バナーテンプレートを表示 view_banner_templates
多言語設定を表示 view_multi_language_settings
BrazeAI OperatorTMを使用 use_operator
Decisioning Studioエージェントを表示 view_decisioning_studio_agents
Decisioning Studioオーディエンスを表示 view_decisioning_studio_audience
Decisioning Studioコンバージョンイベントを表示 view_decisioning_studio_conversion_event
Decisioning Studioガードレールを表示 view_decisioning_studio_guardrails
キャンペーンを開始 launch_campaigns
キャンバスを開始 launch_canvases
キャンペーンを承認 approve_deny_campaigns
キャンバスを承認 approve_deny_canvases
キャンペーン、キャンバスを送信 send_campaigns_canvases
カードを公開 publish_cards
ユーザーデータをエクスポート export_user_data
PIIを表示 view_pii
ユーザープロファイルを表示(PII秘匿) view_user_profile
ダッシュボードユーザーを編集 edit_dashboard_users
メディアライブラリーアセットを編集 edit_media_library_assets
メディアライブラリーアセットを削除 delete_media_library_assets
ユーザーインポートを表示 view_import_users
ユーザーをインポート import_users
ユーザーデータを編集 edit_user_data
ユーザーマージ記録を表示 view_user_merge_records
重複ユーザーをマージ merge_duplicate_users
API キーを表示 view_api_keys
API キーを編集 edit_api_keys
内部グループを表示 view_internal_user_groups
内部グループを編集 edit_internal_user_groups
内部グループを削除 delete_internal_user_groups
メッセージアクティビティログを表示 view_message_activity_log
イベントユーザーログを表示 view_event_user_log
API識別子を表示 view_api_identifiers
API使用状況ダッシュボードを表示 view_api_usage_dashboard
API制限を表示 view_api_limits
API使用状況アラートを表示 view_api_usage_alerts
API使用状況アラートを編集 edit_api_usage_alerts
SDKデバッガーを表示 view_sdk_debugger
SDKデバッガーを編集 edit_sdk_debugger
Content Blocksを開始 launch_content_blocks
クラウドデータ取り込みを編集 edit_cloud_data_ingestion
アプリ設定を表示 view_app_settings
アプリ設定を編集 edit_app_settings
プッシュ設定を表示 view_push_settings
プッシュ設定を編集 edit_push_settings
チームを表示 view_teams
チームを編集 edit_teams
チームをアーカイブ archive_teams
カスタム属性を表示 view_custom_attributes
カスタム属性を編集 edit_custom_attributes
カスタム属性をブロックリストに追加 blocklist_custom_attributes
カスタム属性を削除 delete_custom_attributes
カスタム属性をエクスポート export_custom_attributes
カスタムイベントを表示 view_custom_events
カスタムイベントを編集 edit_custom_events
カスタムイベントをブロックリストに追加 blocklist_custom_events
カスタムイベントを削除 delete_custom_events
カスタムイベントをエクスポート export_custom_events
カスタムイベントプロパティのセグメンテーションを編集 edit_custom_event_property_segmentation
製品を表示 view_products
製品を編集 edit_products
製品をブロックリストに追加 blocklist_products
購入プロパティのセグメンテーションを編集 edit_purchase_property_segmentation
タグを表示 view_tags
タグを編集 edit_tags
タグを削除 delete_tags
メール設定を表示 view_email_settings
メール設定を編集 edit_email_settings
カタログを表示 view_catalogs
カタログを編集 edit_catalogs
カタログをエクスポート export_catalogs
カタログを削除 delete_catalogs
WhatsApp設定を表示 view_whatsapp_settings
テクノロジーパートナーを編集 edit_technology_partners

チーム権限文字列

権限名 SCIM API文字列
キャンペーンを表示 view_campaigns
キャンペーンを編集 edit_campaigns
キャンペーンをアーカイブ archive_campaigns
キャンペーンを開始 launch_campaigns
キャンペーンを承認 approve_deny_campaigns
キャンバスを表示 view_canvases
キャンバスを編集 edit_canvases
キャンバスをアーカイブ archive_canvases
キャンバスを開始 launch_canvases
キャンバスを承認 approve_deny_canvases
キャンバステンプレートを表示 view_canvas_templates
キャンバステンプレートを編集 create_and_edit_canvas_templates
キャンバステンプレートをアーカイブ archive_canvas_templates
Content Blocksを表示 view_content_blocks
Content Blocksを編集 edit_content_blocks
Content Blocksをアーカイブ archive_content_blocks
Content Blocksを開始 launch_content_blocks
セグメントを表示 view_segments
オーディエンス数を表示 view_audience_population
セグメントを編集 edit_segments
セグメントをアーカイブ archive_segments
アプリ内メッセージテンプレートを表示 view_iam_templates
アプリ内メッセージテンプレートを編集 edit_iam_templates
アプリ内メッセージテンプレートをアーカイブ archive_iam_templates
メールテンプレートを表示 view_email_templates
メールテンプレートを編集 edit_email_templates
メールテンプレートをアーカイブ archive_email_templates
Webhookテンプレートを表示 view_webhook_templates
Webhookテンプレートを編集 edit_webhook_templates
Webhookテンプレートをアーカイブ archive_webhook_templates
メールリンクテンプレートを表示 view_link_templates
メールリンクテンプレートを編集 edit_link_templates
バナーテンプレートを表示 view_banner_templates
バナーテンプレートを編集 edit_banner_templates
バナーテンプレートをアーカイブ archive_banner_templates
ランディングページテンプレートを表示 view_landing_page_templates
ランディングページテンプレートを編集 edit_landing_page_templates
ランディングページテンプレートをアーカイブ archive_landing_page_templates
メディアライブラリーアセットを表示 view_media_library_assets
メディアライブラリーアセットを編集 edit_media_library_assets
メディアライブラリーアセットを削除 delete_media_library_assets
メディアライブラリーアセットを置換 replace_media_library_assets
ダッシュボードレポートを表示 view_reporting
ダッシュボードレポートを編集 edit_reporting
ダッシュボードレポートを削除 delete_reporting
ユーザーデータをエクスポート export_user_data
ユーザープロファイルを表示(PII秘匿) view_user_profile
ダッシュボードユーザーを編集 edit_dashboard_users
管理者 admin

部門文字列

UIでの表示 SCIM API文字列
代理店 / サードパーティ agency
BI / 分析 bi
経営幹部 c_suite
開発 engineering
財務 finance
マーケティング / 編集 marketing
プロダクトマネジメント pm

権限オブジェクト

権限オブジェクトは、SCIM ID権限を通じてユーザーリソースとやり取りする際の一部のリクエストおよびレスポンスに含まれるフィールドです。

{
  "permissions": {
    "companyPermissions": (required, array),
    "appGroup": (required, array)
  }
}

有効な権限オブジェクトは、以下のキーと値のペアを持つJSONオブジェクトです。

キー 必須 データ型 説明
companyPermissions 任意 配列 会社権限文字列テーブルの会社レベルの権限文字列の配列。文字列が存在する場合、ユーザーが対応する権限を持つことを意味します。
roles 任意 配列 ロールオブジェクトの配列。
appGroup 必須 配列 ワークスペース権限オブジェクトの配列。

ワークスペース権限オブジェクト

有効なワークスペース権限オブジェクトは、以下のキーと値のペアを持つJSONオブジェクトです。

キー 必須 データ型 説明
appGroupName 任意 文字列 ワークスペースの名前。このオブジェクトに含まれる権限がどのワークスペースに対するものかを指定するために使用されます。
appGroupId appGroupNameがない場合は必須 文字列 ワークスペースのAPI識別子(UUID)。ワークスペースを指定する代替手段として使用されます。
appGroupPermissionSets 任意 配列 1つ以上のワークスペース権限セットオブジェクトの配列。ユーザーは、このワークスペースについてリストされた権限セットに含まれるすべての権限を取得します。配列を空にすることはできません。ワークスペースエントリごとにappGroupPermissionsまたはappGroupPermissionSetsのいずれか一方を指定してください(両方は指定しないでください)。
appGroupPermissions 条件付きで必須 配列 ワークスペース権限文字列テーブルのワークスペースレベルの権限文字列の配列。appGroupPermissionSetsが指定されていない場合に必須です。
team 任意 配列 チーム権限オブジェクトの配列。

ワークスペース権限セットオブジェクト

有効なワークスペース権限セットオブジェクトは、以下のキーと値のペアを持つJSONオブジェクトです。

キー 必須 データ型 説明
appGroupPermissionSetName 任意 文字列 このワークスペースに対してユーザーに割り当てられるワークスペース権限セットの名前。
appGroupPermissionSetId appGroupPermissionSetNameがない場合は必須 文字列 権限セットのAPI識別子(UUID)。このワークスペースに対してユーザーに割り当てられるワークスペース権限セットを指定する代替手段として使用されます。

チーム権限オブジェクト

有効なチーム権限オブジェクトは、以下のキーと値のペアを持つJSONオブジェクトです。

キー 必須 データ型 説明
teamName 任意 文字列 チームの名前。このオブジェクト内の権限がどのチームに対するものかを指定するために使用できます。
teamId teamNameがない場合は必須 文字列 チームのAPI識別子(UUID)。チームを指定する代替手段として使用されます。
teamPermissions 必須 配列 チーム権限文字列テーブルのチームレベルの権限文字列の配列。文字列が存在する場合、ユーザーが指定されたチームに対して対応する権限を持つことを意味します。

ロールオブジェクト

有効なロールオブジェクトは、以下のキーと値のペアを持つJSONオブジェクトです。

キー 必須 データ型 説明
roleName 任意 文字列 ユーザーに割り当てられるロールの名前。
roleId roleNameがない場合は必須 文字列 ロールのAPI識別子(UUID)。ロールを指定する代替手段として使用されます。

付録

会社権限文字列

UIでの表示 SCIM API文字列
管理者 admin
会社設定を管理可能 manage_company_settings
ワークスペースを追加/削除可能 add_remove_app_groups

ワークスペース権限文字列

権限名 SCIM API文字列
管理者 admin
キャンペーン、キャンバス、カード、セグメント、メディアライブラリーにアクセス basic_access
キャンペーンを承認 approve_deny_campaigns
キャンバスを承認 approve_deny_canvases
キャンペーン、キャンバスを送信 send_campaigns_canvases
カードを公開 publish_cards
セグメントを編集 edit_segments
ユーザーデータをエクスポート export_user_data
PIIを表示 view_pii
ユーザープロファイルを表示(PII秘匿) view_user_profile
ダッシュボードユーザーを管理 manage_dashboard_users
メディアライブラリーアセットを管理 manage_media_library
使用状況データを表示 view_usage_data
ユーザーデータをインポートおよび更新 import_update_user_data
請求の詳細を表示 view_billing_details
開発者コンソールにアクセス dev_console
Content Blocksを開始 launch_content_blocks
外部連携を管理 manage_external_integrations
アプリを管理 manage_apps
チームを管理 manage_teams
イベント、属性、購入を管理 manage_events_attributes_purchases
タグを管理 manage_tags
メール設定を管理 manage_email_settings
購読グループを管理 manage_subscription_groups
承認設定を管理 manage_approval_settings
カタログダッシュボード権限を管理 manage_catalogs_dashboard_permission

チーム権限文字列

権限名 SCIM API文字列
管理者 admin
キャンペーン、キャンバス、カード、セグメント、メディアライブラリーにアクセス basic_access
キャンペーンを承認 approve_deny_campaigns
キャンバスを承認 approve_deny_canvases
キャンペーン、キャンバスを送信 send_campaigns_canvases
カードを公開 publish_cards
セグメントを編集 edit_segments
ユーザーデータをエクスポート export_user_data
ユーザープロファイルを表示(PII秘匿) view_user_profile
ダッシュボードユーザーを管理 manage_dashboard_users
メディアライブラリーアセットを管理 manage_media_library

部門文字列

UIでの表示 SCIM API文字列
代理店 / サードパーティ agency
BI / 分析 bi
経営幹部 c_suite
開発 engineering
財務 finance
マーケティング / 編集 marketing
プロダクトマネジメント pm
New Stuff!