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 선택 사항 배열 Teams 권한 오브젝트의 배열입니다.

워크스페이스 권한 세트 오브젝트

유효한 워크스페이스 권한 세트 오브젝트는 다음 키-값 페어를 가진 JSON 오브젝트입니다.

필수 데이터 유형 설명
appGroupPermissionSetName 선택 사항 문자열 이 워크스페이스에 대해 사용자에게 할당되는 워크스페이스 권한 세트의 이름입니다.
appGroupPermissionSetID appGroupPermissionSetName이 없으면 필수 문자열 워크스페이스의 ID로, 이 워크스페이스에 대해 사용자에게 할당된 워크스페이스 권한 세트를 지정하는 대체 방법으로 사용됩니다.

Teams 권한 오브젝트

유효한 Teams 권한 오브젝트는 다음 키-값 페어를 가진 JSON 오브젝트입니다.

필수 데이터 유형 설명
teamName 선택 사항 문자열 팀의 이름으로, 이 오브젝트 내의 권한이 어떤 팀에 적용되는지 지정하는 데 사용할 수 있습니다.
teamId teamName이 없으면 필수 문자열 팀의 ID로, 팀을 지정하는 대체 방법으로 사용됩니다.
teamPermissions 필수 배열 Teams 권한 문자열 테이블의 팀 수준 권한 문자열 배열로, 문자열이 존재하면 사용자가 지정된 팀에 대한 해당 권한을 가지고 있음을 나타냅니다.

역할 오브젝트

유효한 역할 오브젝트는 다음 키-값 페어를 가진 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

Teams 권한 문자열

권한 이름 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 선택 사항 배열 Teams 권한 오브젝트의 배열입니다.

워크스페이스 권한 세트 오브젝트

유효한 워크스페이스 권한 세트 오브젝트는 다음 키-값 페어를 가진 JSON 오브젝트입니다:

필수 데이터 유형 설명
appGroupPermissionSetName 선택 사항 문자열 이 워크스페이스에 대해 사용자에게 할당되는 워크스페이스 권한 세트의 이름입니다.
appGroupPermissionSetID appGroupPermissionSetName이 없으면 필수 문자열 워크스페이스의 ID로, 이 워크스페이스에 대해 사용자에게 할당된 워크스페이스 권한 세트를 지정하는 대체 방법입니다.

Teams 권한 오브젝트

유효한 Teams 권한 오브젝트는 다음 키-값 페어를 가진 JSON 오브젝트입니다:

필수 데이터 유형 설명
teamName 선택 사항 문자열 팀의 이름으로, 이 오브젝트 내의 권한이 어떤 팀에 적용되는지 지정하는 데 사용할 수 있습니다.
teamId teamName이 없으면 필수 문자열 팀의 ID로, 팀을 지정하는 대체 방법입니다.
teamPermissions 필수 배열 Teams 권한 문자열 테이블의 팀 수준 권한 문자열 배열로, 문자열이 존재하면 사용자가 지정된 팀에 대한 해당 권한을 가지고 있음을 나타냅니다.

역할 오브젝트

유효한 역할 오브젝트는 다음 키-값 페어를 가진 JSON 오브젝트입니다:

필수 데이터 유형 설명
roleName 선택 사항 문자열 사용자에게 할당되는 역할의 이름입니다.
roleId roleName이 없으면 필수 문자열 역할의 ID로, 역할을 지정하는 대체 방법입니다.

부록

회사 권한 문자열

UI 표시 이름 SCIM API 문자열
Administrator admin
Manage Company Settings manage_company_settings
Create and delete workspaces add_remove_app_groups

워크스페이스 권한 문자열

권한 이름 SCIM API 문자열
View Campaigns view_campaigns
Edit Campaigns edit_campaigns
Archive Campaigns archive_campaigns
View Canvases view_canvases
Edit Canvases edit_canvases
Archive Canvases archive_canvases
View Frequency Capping Rules view_frequency_caps
Edit Frequency Capping Rules edit_frequency_caps
View Message Prioritization view_message_prioritization
Edit Message Prioritization edit_message_prioritization
View Content Blocks view_content_blocks
Edit Content Blocks edit_content_blocks
Archive Content Blocks archive_content_blocks
View Feature Flags view_feature_flags
Edit Feature Flags edit_feature_flags
Archive Feature Flags archive_feature_flags
View Segments view_segments
Edit Segments edit_segments
Archive Segments archive_segments
View Global Control Group view_global_control_group
Edit Global Control Group edit_global_control_group
View IAM Templates view_iam_templates
Edit IAM Templates edit_iam_templates
Archive IAM Templates archive_iam_templates
View Email Templates view_email_templates
Edit Email Templates edit_email_templates
Archive Email Templates archive_email_templates
View Webhook Templates view_webhook_templates
Edit Webhook Templates edit_webhook_templates
Archive Webhook Templates archive_webhook_templates
View Email Link Templates view_link_templates
Edit Email Link Templates edit_link_templates
View Media Library Assets view_media_library_assets
View Locations view_locations
Edit Locations edit_locations
Archive Locations archive_locations
View Promotion Codes view_promotion_codes
Edit Promotion Codes edit_promotion_codes
Export Promotion Codes export_promotion_codes
View Preference Centers view_preference_centers
Edit Preference Centers edit_preference_centers
Edit Reports edit_reports
View Placements view_placements
Edit Placements edit_placements
Archive Placements archive_placements
View Banner Templates view_banner_templates
View Multi Language Settings view_multi_language_settings
Use BrazeAI OperatorTM use_operator
View Decisioning Studio Agents view_decisioning_studio_agents
View Decisioning Studio Audience view_decisioning_studio_audience
View Decisioning Studio Conversion Event view_decisioning_studio_conversion_event
View Decisioning Studio Guardrails view_decisioning_studio_guardrails
Launch Campaigns launch_campaigns
Launch Canvases launch_canvases
Edit Dashboard Users edit_dashboard_users
Edit Media Library Assets edit_media_library_assets
Delete Media Library Assets delete_media_library_assets
View Import Users view_import_users
Import Users import_users
Edit User Data edit_user_data
View User Merge Records view_user_merge_records
Merge Duplicate Users merge_duplicate_users
View API Keys view_api_keys
Edit API Keys edit_api_keys
View Internal Groups view_internal_user_groups
Edit Internal Groups edit_internal_user_groups
Delete Internal Groups delete_internal_user_groups
View Message Activity Log view_message_activity_log
View Event User Log view_event_user_log
View API Identifiers view_api_identifiers
View API Usage Dashboard view_api_usage_dashboard
View API Limits view_api_limits
View API Usage Alerts view_api_usage_alerts
Edit API Usage Alerts edit_api_usage_alerts
View SDK Debugger view_sdk_debugger
Edit SDK Debugger edit_sdk_debugger
Launch Content Blocks launch_content_blocks
Edit Cloud Data Ingestion edit_cloud_data_ingestion
View App Settings view_app_settings
Edit App Settings edit_app_settings
View Push Settings view_push_settings
Edit Push Settings edit_push_settings
View Teams view_teams
Edit Teams edit_teams
Archive Teams archive_teams
View Custom Attributes view_custom_attributes
Edit Custom Attributes edit_custom_attributes
Blocklist Custom Attributes blocklist_custom_attributes
Delete Custom Attributes delete_custom_attributes
Export Custom Attributes export_custom_attributes
View Custom Events view_custom_events
Edit Custom Events edit_custom_events
Blocklist Custom Events blocklist_custom_events
Delete Custom Events delete_custom_events
Export Custom Events export_custom_events
Edit Custom Event Property Segmentation edit_custom_event_property_segmentation
View Products view_products
Edit Products edit_products
Blocklist Products blocklist_products
Edit Purchase Property Segmentation edit_purchase_property_segmentation
View Tags view_tags
Edit Tags edit_tags
Delete Tags delete_tags
View Email Settings view_email_settings
Edit Email Settings edit_email_settings
View Catalogs view_catalogs
Edit Catalogs edit_catalogs
Export Catalogs export_catalogs
Delete Catalogs delete_catalogs
View Whatsapp Settings view_whatsapp_settings
Edit Technology Partners edit_technology_partners

Teams 권한 문자열

권한 이름 SCIM API 문자열
View Campaigns view_campaigns
Edit Campaigns edit_campaigns
Archive Campaigns archive_campaigns
View Canvases view_canvases
Edit Canvases edit_canvases
Archive Canvases archive_canvases
View Frequency Capping Rules view_frequency_caps
Edit Frequency Capping Rules edit_frequency_caps
View Message Prioritization view_message_prioritization
Edit Message Prioritization edit_message_prioritization
View Content Blocks view_content_blocks
View Feature Flags view_feature_flags
Edit Feature Flags edit_feature_flags
Archive Feature Flags archive_feature_flags
View Segments view_segments
Edit Segments edit_segments
Edit Global Control Group edit_global_control_group
View IAM Templates view_iam_templates
Edit IAM Templates edit_iam_templates
Archive IAM Templates archive_iam_templates
View Email Templates view_email_templates
Edit Email Templates edit_email_templates
Archive Email Templates archive_email_templates
View Webhook Templates view_webhook_templates
Edit Webhook Templates edit_webhook_templates
Archive Webhook Templates archive_webhook_templates
View Email Link Templates view_link_templates
Edit Email Link Templates edit_link_templates
View Media Library Assets view_media_library_assets
View Locations view_locations
Edit Locations edit_locations
Archive Locations archive_locations
View Promotion Codes view_promotion_codes
Edit Promotion Codes edit_promotion_codes
Export Promotion Codes export_promotion_codes
View Preference Centers view_preference_centers
Edit Preference Centers edit_preference_centers
View Reports view_reports
Create Reports create_reports
Edit Reports edit_reports
View Banner Templates view_banner_templates
View Multi Language Settings view_multi_language_settings
Use BrazeAI OperatorTM use_operator
View Decisioning Studio Agents view_decisioning_studio_agents
Launch Campaigns launch_campaigns
Launch Canvases launch_canvases
Edit Dashboard Users edit_dashboard_users

부서 문자열

UI 표시 이름 SCIM API 문자열
Agency / Third Party agency
BI / Analytics bi
C-Suite c_suite
Engineering engineering
Finance finance
Marketing / Editorial marketing
Product Management pm
New Stuff!