Skip to content

SCIM API オブジェクトと付録

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

権限オブジェクト

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

1
2
3
4
5
6
{
  "permissions": {
    "companyPermissions": (required, array),
    "appGroup": (required, array)
  }
}

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

キー 必須 データタイプ 説明
companyPermissions オプション 配列 会社権限文字列テーブルからの会社レベルの権限文字列の配列。文字列が存在する場合、そのユーザーが対応する権限を持っていることを示します。
roles オプション 配列 ロールオブジェクトの配列。
appGroup 必須 配列 ワークスペース権限オブジェクトの配列。

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

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

キー 必須 データタイプ 説明
appGroupName オプション 文字列 ワークスペースの名前。このオブジェクトに含まれる権限がどのワークスペースに対するものかを指定するために使用します。
appGroupId appGroupNameがない場合は必須 文字列 ワークスペースのID。ワークスペースを指定する代替方法として機能します。
appGroupPermissionSets オプション 配列 単一のワークスペース権限セットオブジェクトを持つ配列。
appGroupPermissions 必須 配列 ワークスペース権限文字列テーブルからのワークスペースレベルの権限文字列の配列。文字列が存在する場合、そのユーザーが指定されたワークスペースに対する対応する権限を持っていることを示します。
team オプション 配列 チーム権限オブジェクトの配列。

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

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

キー 必須 データタイプ 説明
appGroupPermissionSetName オプション 文字列 このワークスペースでユーザーに割り当てられるワークスペース権限セットの名前。
appGroupPermissionSetID appGroupPermissionSetNameがない場合は必須 文字列 ワークスペースのID。このワークスペースでユーザーに割り当てられたワークスペース権限セットを指定する代替方法として機能します。

チーム権限オブジェクト

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

キー 必須 データタイプ 説明
teamName オプション 文字列 チームの名前。このオブジェクト内の権限がどのチームに対するものかを指定するために使用できます。
teamId teamNameがない場合は必須 文字列 チームのID。チームを指定する代替方法として機能します。
teamPermissions 必須 配列 チーム権限文字列テーブルからのチームレベルの権限文字列の配列。文字列が存在する場合、そのユーザーが指定されたチームに対する対応する権限を持っていることを示します。

ロールオブジェクト

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

キー 必須 データタイプ 説明
roleName オプション 文字列 ユーザーに割り当てられるロールの名前。
roleId roleNameがない場合は必須 文字列 ロールのID。ロールを指定する代替方法として機能します。

付録

会社権限文字列

UIでの表示 SCIM API文字列
Administrator admin
Can Manage Company Settings manage_company_settings
Can Add/Remove Workspaces add_remove_app_groups

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

権限名 SCIM API文字列
Admin admin
Access Campaigns, Canvases, Cards, Segments, Media Library basic_access
Approve and Deny Canvases approve_deny_campaigns
Send Campaigns, Canvases send_campaigns_canvases
Publish Cards publish_cards
Edit Segments edit_segments
Export User Data export_user_data
View PII view_pii
View User Profiles PII Compliant view_user_profile
Manage Dashboard Users manage_dashboard_users
Manage Media Library Assets manage_media_library
View Usage Data view_usage_data
Import and Update User Data import_update_user_data
View Billing Details view_billing_details
Access Dev Console dev_console
Launch Content Blocks launch_content_blocks
Manage External Integrations manage_external_integrations
Manage Apps manage_apps
Manage Teams manage_teams
Manage Events, Attributes, Purchases manage_events_attributes_purchases
Manage Tags manage_tags
Manage Email Settings manage_email_settings
Manage Subscription Groups manage_subscription_groups
Manage Approval Settings manage_approval_settings
Manage Catalogs Dashboard Permission manage_catalogs_dashboard_permission

チーム権限文字列

権限名 SCIM API文字列
Admin admin
Access Campaigns, Canvases, Cards, Segments, Media Library basic_access
Approve and Deny Canvases approve_deny_campaigns
Send Campaigns, Canvases send_campaigns_canvases
Publish Cards publish_cards
Edit Segments edit_segments
Export User Data export_user_data
View User Profile view_user_profile
Manage Dashboard Users manage_dashboard_users
Manage Media Library Assets manage_media_library

部門文字列

UIでの表示 SCIM API文字列
Agency / Third Party agency
BI / Analytics bi
C-Suite c_suite
Engineering engineering
Finance finance
Marketing / Editorial marketing
Product Management pm

細粒度権限の移行

既存のSCIM統合とレガシーSCIM APIオブジェクトは、4月下旬の細粒度権限移行後も引き続き動作します。

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

権限オブジェクト

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

1
2
3
4
5
6
{
  "permissions": {
    "companyPermissions": (required, array),
    "appGroup": (required, array)
  }
}

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

キー 必須 データタイプ 説明
companyPermissions オプション 配列 会社レベルの権限文字列の配列です。文字列が存在する場合、ユーザーが対応する権限を持っていることを示します。
roles オプション 配列 ロールオブジェクトの配列です。
appGroup 必須 配列 ワークスペース権限オブジェクトの配列です。

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

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

キー 必須 データタイプ 説明
appGroupName オプション 文字列 ワークスペースの名前です。このオブジェクトに含まれる権限がどのワークスペースに対するものかを指定するために使用されます。
appGroupId appGroupName がない場合は必須 文字列 ワークスペースのIDです。ワークスペースを指定する代替方法として機能します。
appGroupPermissionSets オプション 配列 単一のワークスペース権限セットオブジェクトを持つ配列です。
appGroupPermissions 必須 配列 ワークスペース権限文字列テーブルに基づくワークスペースレベルの権限文字列の配列です。文字列が存在する場合、指定されたワークスペースに対してユーザーが対応する権限を持っていることを示します。
team オプション 配列 チーム権限オブジェクトの配列です。

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

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

キー 必須 データタイプ 説明
appGroupPermissionSetName オプション 文字列 このワークスペースでユーザーに割り当てられるワークスペース権限セットの名前です。
appGroupPermissionSetID appGroupPermissionSetName がない場合は必須 文字列 ワークスペースのIDです。このワークスペースでユーザーに割り当てられるワークスペース権限セットを指定する代替方法として機能します。

チーム権限オブジェクト

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

キー 必須 データタイプ 説明
teamName オプション 文字列 チームの名前です。このオブジェクト内の権限がどのチームに対するものかを指定するために使用できます。
teamId teamName がない場合は必須 文字列 チームのIDです。チームを指定する代替方法として機能します。
teamPermissions 必須 配列 チーム権限文字列テーブルに基づくチームレベルの権限文字列の配列です。文字列が存在する場合、指定されたチームに対してユーザーが対応する権限を持っていることを示します。

ロールオブジェクト

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

キー 必須 データタイプ 説明
roleName オプション 文字列 ユーザーに割り当てられるロールの名前です。
roleId roleName がない場合は必須 文字列 ロールのIDです。ロールを指定する代替方法として機能します。

付録

会社の権限文字列

UIでの表示 SCIM API文字列
管理者 admin
会社の設定を管理 manage_company_settings
ワークスペースの作成と削除 add_remove_app_groups

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

権限名 SCIM API文字列
Campaignsを表示 view_campaigns
Campaignsを編集 edit_campaigns
Campaignsをアーカイブ archive_campaigns
Canvasesを表示 view_canvases
Canvasesを編集 edit_canvases
Canvasesをアーカイブ archive_canvases
フリークエンシーキャップルールを表示 view_frequency_caps
フリークエンシーキャップルールを編集 edit_frequency_caps
メッセージの優先順位付けを表示 view_message_prioritization
メッセージの優先順位付けを編集 edit_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
Segmentsを表示 view_segments
Segmentsを編集 edit_segments
Segmentsをアーカイブ archive_segments
グローバルコントロールグループを表示 view_global_control_group
グローバルコントロールグループを編集 edit_global_control_group
IAMテンプレートを表示 view_iam_templates
IAMテンプレートを編集 edit_iam_templates
IAMテンプレートをアーカイブ 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
Campaignsを起動 launch_campaigns
Canvasesを起動 launch_canvases
ダッシュボードユーザーを編集 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文字列
Campaignsを表示 view_campaigns
Campaignsを編集 edit_campaigns
Campaignsをアーカイブ archive_campaigns
Canvasesを表示 view_canvases
Canvasesを編集 edit_canvases
Canvasesをアーカイブ archive_canvases
フリークエンシーキャップルールを表示 view_frequency_caps
フリークエンシーキャップルールを編集 edit_frequency_caps
メッセージの優先順位付けを表示 view_message_prioritization
メッセージの優先順位付けを編集 edit_message_prioritization
Content Blocksを表示 view_content_blocks
フィーチャーフラグを表示 view_feature_flags
フィーチャーフラグを編集 edit_feature_flags
フィーチャーフラグをアーカイブ archive_feature_flags
Segmentsを表示 view_segments
Segmentsを編集 edit_segments
グローバルコントロールグループを編集 edit_global_control_group
IAMテンプレートを表示 view_iam_templates
IAMテンプレートを編集 edit_iam_templates
IAMテンプレートをアーカイブ 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
レポートを表示 view_reports
レポートを作成 create_reports
レポートを編集 edit_reports
バナーテンプレートを表示 view_banner_templates
多言語設定を表示 view_multi_language_settings
BrazeAI OperatorTMを使用 use_operator
Decisioning Studioエージェントを表示 view_decisioning_studio_agents
Campaignsを起動 launch_campaigns
Canvasesを起動 launch_canvases
ダッシュボードユーザーを編集 edit_dashboard_users

部門の文字列

UIでの表示 SCIM API文字列
代理店 / サードパーティ agency
BI / 分析 bi
経営幹部 c_suite
エンジニアリング engineering
ファイナンス finance
マーケティング / 編集 marketing
製品管理 pm
New Stuff!