Ir al contenido

Esta página fue traducida automáticamente y puede contener errores. Para informar de un error de traducción, usa el componente de comentarios situado bajo el sumario, a la derecha de la página.

Objetos y apéndice de la API SCIM

Este artículo explica los diferentes objetos de la API SCIM y el apéndice.

granular scim api
legacy scim api

Migración a permisos granulares

Las integraciones SCIM existentes y los objetos de la API SCIM heredada siguen funcionando después de la migración a permisos granulares, pero Braze dejará de aceptar valores de la API SCIM heredada en diciembre de 2026.

No tienes que hacer nada de inmediato. Sin embargo, revisa tus integraciones para detectar permisos que pasan a ser permisos granulares. Por ejemplo, si actualmente envías basic_access en la API, actualiza tu integración después de migrar a permisos granulares para incluir los permisos específicos (por ejemplo, "appGroupPermissions":["view_campaigns","edit_campaigns"]). Braze sigue aceptando cadenas heredadas, como basic_access, después de la migración a permisos granulares para que las integraciones existentes no dejen de funcionar.

Objeto de permisos

El objeto de permisos es un campo que aparece en algunas de las solicitudes y respuestas al interactuar con el recurso de usuario a través de los permisos de ID SCIM.

Nota

Los grupos de aplicaciones ahora se llaman espacios de trabajo en Braze, pero las claves de esta página aún usan la terminología anterior (por ejemplo, appGroup, appGroupName).

Importante

Los campos appGroupId, teamId, roleId y appGroupPermissionSetId hacen referencia al identificador de API de un recurso, un UUID como 1f16c016-8e44-48f3-9fd7-2b8d5d70d9bd. Es distinto del ID interno del recurso en la base de datos. Para encontrar estos identificadores, usa GET: Buscar una cuenta de usuario del panel existente; el objeto permissions devuelto incluye los valores de appGroupId, teamId, roleId y appGroupPermissionSetId del usuario.

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

Un objeto de permisos válido es un objeto JSON con los siguientes pares clave-valor:

Clave	Obligatorio	Tipo de datos	Descripción
`companyPermissions`	Opcional	Array	Array de cadenas de permisos a nivel de empresa, en el que la presencia de la cadena indica que el usuario tiene el permiso correspondiente.
`roles`	Opcional	Array	Array de objetos de rol.
`appGroup`	Obligatorio	Array	Array de objetos de permisos de espacio de trabajo.

Objeto de permisos de espacio de trabajo

Un objeto de permisos de espacio de trabajo válido es un objeto JSON con los siguientes pares clave-valor:

Clave	Obligatorio	Tipo de datos	Descripción
`appGroupName`	Opcional	String	Nombre del espacio de trabajo. Se utiliza para especificar a qué espacio de trabajo corresponden los permisos contenidos en este objeto.
`appGroupId`	Obligatorio si falta `appGroupName`	String	El identificador de API del espacio de trabajo (un UUID), que sirve como método alternativo para especificar el espacio de trabajo.
`appGroupPermissionSets`	Opcional	Array	Array de uno o más objetos de conjunto de permisos de espacio de trabajo. El usuario obtiene todos los permisos incluidos en los conjuntos de permisos indicados para este espacio de trabajo. El array no puede estar vacío. Proporciona `appGroupPermissions` o `appGroupPermissionSets` en cada entrada de espacio de trabajo, pero no ambos.
`appGroupPermissions`	Obligatorio según el caso	Array	Array de cadenas de permisos a nivel de espacio de trabajo de la tabla cadenas de permisos de espacio de trabajo. Obligatorio cuando no se proporciona `appGroupPermissionSets`.
`team`	Opcional	Array	Array de objetos de permisos de equipo.

Objeto de conjunto de permisos de espacio de trabajo

Un objeto de conjunto de permisos de espacio de trabajo válido es un objeto JSON con los siguientes pares clave-valor:

Clave	Obligatorio	Tipo de datos	Descripción
`appGroupPermissionSetName`	Opcional	String	Nombre del conjunto de permisos de espacio de trabajo que se asigna al usuario para este espacio de trabajo.
`appGroupPermissionSetId`	Obligatorio si falta `appGroupPermissionSetName`	String	El identificador de API del conjunto de permisos (un UUID), que sirve como método alternativo para especificar el conjunto de permisos de espacio de trabajo asignado al usuario para este espacio de trabajo.

Objeto de permisos de equipo

Un objeto de permisos de equipo válido es un objeto JSON con los siguientes pares clave-valor:

Clave	Obligatorio	Tipo de datos	Descripción
`teamName`	Opcional	String	Nombre del equipo, que se puede utilizar para especificar a qué equipo corresponden los permisos de este objeto.
`teamId`	Obligatorio si falta `teamName`	String	El identificador de API del equipo (un UUID), que sirve como método alternativo para especificar el equipo.
`teamPermissions`	Obligatorio	Array	Array de cadenas de permisos a nivel de equipo de la tabla cadenas de permisos de equipo, en el que la presencia de la cadena indica que el usuario tiene el permiso correspondiente para el equipo especificado.

Objeto de rol

Un objeto de rol válido es un objeto JSON con los siguientes pares clave-valor:

Clave	Obligatorio	Tipo de datos	Descripción
`roleName`	Opcional	String	Nombre del rol que se asigna al usuario.
`roleId`	Obligatorio si falta `roleName`	String	El identificador de API del rol (un UUID), que sirve como método alternativo para especificar el rol.

Apéndice

Cadenas de permisos de empresa

Como se muestra en la interfaz	Cadena de la API SCIM
Administrator	`admin`
Manage Company Settings	`manage_company_settings`
Create and delete workspaces	`add_remove_app_groups`
View Domain Settings	`view_domain_settings`
Edit Domain Settings	`edit_domain_settings`
Delete Dashboard Users	`delete_dashboard_users`

Cadenas de permisos de espacio de trabajo

Nombre del permiso	Cadena de la API SCIM
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 Settings	`view_message_prioritization`
Edit Message Prioritization Settings	`edit_message_prioritization`
Delete Message Prioritization Settings	`delete_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`
View Audience Population	`view_audience_population`
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 Operator^TM	`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`
Approve Campaigns	`approve_deny_campaigns`
Approve Canvases	`approve_deny_canvases`
Send Campaigns, Canvases	`send_campaigns_canvases`
Publish Cards	`publish_cards`
Export User Data	`export_user_data`
View PII	`view_pii`
View User Profiles (PII Redacted)	`view_user_profile`
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`

Cadenas de permisos de equipo

Nombre del permiso	Cadena de la API SCIM
View Campaigns	`view_campaigns`
Edit Campaigns	`edit_campaigns`
Archive Campaigns	`archive_campaigns`
Launch Campaigns	`launch_campaigns`
Approve Campaigns	`approve_deny_campaigns`
View Canvases	`view_canvases`
Edit Canvases	`edit_canvases`
Archive Canvases	`archive_canvases`
Launch Canvases	`launch_canvases`
Approve Canvases	`approve_deny_canvases`
View Canvas Templates	`view_canvas_templates`
Edit Canvas Templates	`create_and_edit_canvas_templates`
Archive Canvas Templates	`archive_canvas_templates`
View Content Blocks	`view_content_blocks`
Edit Content Blocks	`edit_content_blocks`
Archive Content Blocks	`archive_content_blocks`
Launch Content Blocks	`launch_content_blocks`
View Segments	`view_segments`
View Audience Population	`view_audience_population`
Edit Segments	`edit_segments`
Archive Segments	`archive_segments`
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 Banner Templates	`view_banner_templates`
Edit Banner Templates	`edit_banner_templates`
Archive Banner Templates	`archive_banner_templates`
View Landing Page Templates	`view_landing_page_templates`
Edit Landing Page Templates	`edit_landing_page_templates`
Archive Landing Page Templates	`archive_landing_page_templates`
View Media Library Assets	`view_media_library_assets`
Edit Media Library Assets	`edit_media_library_assets`
Delete Media Library Assets	`delete_media_library_assets`
Replace Media Library Assets	`replace_media_library_assets`
View Dashboard Reports	`view_reporting`
Edit Dashboard Reports	`edit_reporting`
Delete Dashboard Reports	`delete_reporting`
Export User Data	`export_user_data`
View User Profiles (PII Redacted)	`view_user_profile`
Edit Dashboard Users	`edit_dashboard_users`
Admin	`admin`

Cadenas de departamento

Como se muestra en la interfaz	Cadena de la API SCIM
Agency / Third Party	`agency`
BI / Analytics	`bi`
C-Suite	`c_suite`
Engineering	`engineering`
Finance	`finance`
Marketing / Editorial	`marketing`
Product Management	`pm`

Importante

Braze ahora ofrece permisos granulares, una forma más flexible de gestionar el acceso de los usuarios. Para más información, consulta Migración a permisos granulares y la pestaña Granular SCIM API para ver los objetos y el apéndice de la API SCIM granular. Braze dejará de aceptar valores de la API SCIM heredada en diciembre de 2026.

Objeto de permisos

El objeto de permisos es un campo que aparece en algunas de las solicitudes y respuestas al interactuar con el recurso de usuario a través de los permisos de ID SCIM.

Nota

Los grupos de aplicaciones ahora se llaman espacios de trabajo en Braze, pero las claves de esta página aún usan la terminología anterior (por ejemplo, appGroup, appGroupName).

Importante

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

Un objeto de permisos válido es un objeto JSON con los siguientes pares clave-valor:

Clave	Obligatorio	Tipo de datos	Descripción
`companyPermissions`	Opcional	Array	Array de cadenas de permisos a nivel de empresa de la tabla cadenas de permisos de empresa, en el que la presencia de la cadena indica que el usuario tiene el permiso correspondiente.
`roles`	Opcional	Array	Array de objetos de rol.
`appGroup`	Obligatorio	Array	Array de objetos de permisos de espacio de trabajo.

Objeto de permisos de espacio de trabajo

Un objeto de permisos de espacio de trabajo válido es un objeto JSON con los siguientes pares clave-valor:

Clave	Obligatorio	Tipo de datos	Descripción
`appGroupName`	Opcional	String	Nombre del espacio de trabajo. Se utiliza para especificar a qué espacio de trabajo corresponden los permisos contenidos en este objeto.
`appGroupId`	Obligatorio si falta `appGroupName`	String	El identificador de API del espacio de trabajo (un UUID), que sirve como método alternativo para especificar el espacio de trabajo.
`appGroupPermissionSets`	Opcional	Array	Array de uno o más objetos de conjunto de permisos de espacio de trabajo. El usuario obtiene todos los permisos incluidos en los conjuntos de permisos indicados para este espacio de trabajo. El array no puede estar vacío. Proporciona `appGroupPermissions` o `appGroupPermissionSets` en cada entrada de espacio de trabajo, pero no ambos.
`appGroupPermissions`	Obligatorio según el caso	Array	Array de cadenas de permisos a nivel de espacio de trabajo de la tabla cadenas de permisos de espacio de trabajo. Obligatorio cuando no se proporciona `appGroupPermissionSets`.
`team`	Opcional	Array	Array de objetos de permisos de equipo.

Objeto de conjunto de permisos de espacio de trabajo

Un objeto de conjunto de permisos de espacio de trabajo válido es un objeto JSON con los siguientes pares clave-valor:

Clave	Obligatorio	Tipo de datos	Descripción
`appGroupPermissionSetName`	Opcional	String	Nombre del conjunto de permisos de espacio de trabajo que se asigna al usuario para este espacio de trabajo.
`appGroupPermissionSetId`	Obligatorio si falta `appGroupPermissionSetName`	String	El identificador de API del conjunto de permisos (un UUID), que sirve como método alternativo para especificar el conjunto de permisos de espacio de trabajo asignado al usuario para este espacio de trabajo.

Objeto de permisos de equipo

Un objeto de permisos de equipo válido es un objeto JSON con los siguientes pares clave-valor:

Clave	Obligatorio	Tipo de datos	Descripción
`teamName`	Opcional	String	Nombre del equipo, que se puede utilizar para especificar a qué equipo corresponden los permisos de este objeto.
`teamId`	Obligatorio si falta `teamName`	String	El identificador de API del equipo (un UUID), que sirve como método alternativo para especificar el equipo.
`teamPermissions`	Obligatorio	Array	Array de cadenas de permisos a nivel de equipo de la tabla cadenas de permisos de equipo, en el que la presencia de la cadena indica que el usuario tiene el permiso correspondiente para el equipo especificado.

Objeto de rol

Un objeto de rol válido es un objeto JSON con los siguientes pares clave-valor:

Clave	Obligatorio	Tipo de datos	Descripción
`roleName`	Opcional	String	Nombre del rol que se asigna al usuario.
`roleId`	Obligatorio si falta `roleName`	String	El identificador de API del rol (un UUID), que sirve como método alternativo para especificar el rol.

Apéndice

Cadenas de permisos de empresa

Como se muestra en la interfaz	Cadena de la API SCIM
Administrator	`admin`
Can Manage Company Settings	`manage_company_settings`
Can Add/Remove Workspaces	`add_remove_app_groups`

Cadenas de permisos de espacio de trabajo

Nombre del permiso	Cadena de la API SCIM
Admin	`admin`
Access Campaigns, Canvases, Cards, Segments, Media Library	`basic_access`
Approve Campaigns	`approve_deny_campaigns`
Approve Canvases	`approve_deny_canvases`
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 Redacted)	`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`

Cadenas de permisos de equipo

Nombre del permiso	Cadena de la API SCIM
Admin	`admin`
Access Campaigns, Canvases, Cards, Segments, Media Library	`basic_access`
Approve Campaigns	`approve_deny_campaigns`
Approve Canvases	`approve_deny_canvases`
Send Campaigns, Canvases	`send_campaigns_canvases`
Publish Cards	`publish_cards`
Edit Segments	`edit_segments`
Export User Data	`export_user_data`
View User Profiles (PII Redacted)	`view_user_profile`
Manage Dashboard Users	`manage_dashboard_users`
Manage Media Library Assets	`manage_media_library`

Cadenas de departamento

Como se muestra en la interfaz	Cadena de la API SCIM
Agency / Third Party	`agency`
BI / Analytics	`bi`
C-Suite	`c_suite`
Engineering	`engineering`
Finance	`finance`
Marketing / Editorial	`marketing`
Product Management	`pm`

New Stuff!