Esta página fue traducida automáticamente y puede contener errores. Para reportar un error de traducción, abre un issue en GitHub.
Objetos y apéndice de la API SCIM
Este artículo explica los diferentes objetos de la API SCIM y el apéndice.
important:
Braze presenta los permisos granulares, una forma más flexible de administrar el acceso de los usuarios. Consulta Migración a permisos granulares para obtener más información sobre el proceso de migración, y la pestaña API SCIM granular para ver los objetos API SCIM granulares y el apéndice.
Objeto permisos
El objeto permisos es un campo que se encuentra en algunas de las peticiones y respuestas cuando se interactúa con el recurso usuario a través de los permisos de ID SCIM.
note:
Los grupos de aplicaciones han pasado a llamarse espacios de trabajo en Braze, pero las claves de esta página siguen haciendo referencia a la terminología antigua (por ejemplo, appGroup, appGroupName).
1
2
3
4
5
6
{
"permissions": {
"companyPermissions": (required, array),
"appGroup": (required, array)
}
}
Un objeto de permisos válido es un objeto JSON con los siguientes pares clave-valor:
| Clave | Obligatoria | Tipo de datos | Descripción |
|---|---|---|---|
companyPermissions |
Opcional | Matriz | Matriz de cadenas de permisos a nivel de empresa de la tabla Cadenas de permisos de empresa, en la que la presencia de la cadena corresponde a que el usuario tiene el permiso correspondiente. |
roles |
Opcional | Matriz | Matriz de objetos de rol. |
appGroup |
Obligatoria | Matriz | Matriz de objetos de permiso del espacio de trabajo. |
Objeto de permisos del espacio de trabajo
Un objeto de permiso de grupo de aplicaciones válido es un objeto JSON con los siguientes pares clave-valor:
| Clave | Obligatoria | Tipo de datos | Descripción |
|---|---|---|---|
appGroupName |
Opcional | Cadena | Nombre del espacio de trabajo. Sirve para especificar a qué espacio de trabajo corresponden los permisos contenidos en este objeto. |
appGroupId |
Obligatorio si falta appGroupName |
Cadena | ID del espacio de trabajo, que sirve como método alternativo para especificar el espacio de trabajo. |
appGroupPermissionSets |
Opcional | Matriz | Matriz con un único objeto del conjunto de permisos del espacio de trabajo. |
appGroupPermissions |
Obligatoria | Matriz | Matriz de cadenas de permisos a nivel del espacio de trabajo de la tabla de cadenas de permisos del espacio de trabajo, en la que la presencia de la cadena corresponde a que el usuario tiene el permiso correspondiente para el espacio de trabajo especificado. |
team |
Opcional | Matriz | Matriz de objetos de permiso del equipo. |
Objeto de configuración de permisos del espacio de trabajo
Un objeto válido del conjunto de permisos del espacio de trabajo es un objeto JSON con los siguientes pares clave-valor:
| Clave | Obligatoria | Tipo de datos | Descripción |
|---|---|---|---|
appGroupPermissionSetName |
Opcional | Cadena | Nombre del conjunto de permisos del espacio de trabajo que se está asignando al usuario para este espacio de trabajo. |
appGroupPermissionSetID |
Obligatorio si falta appGroupPermissionSetName |
Cadena | ID del espacio de trabajo, que sirve como método alternativo para especificar el conjunto de permisos del espacio de trabajo asignado al usuario para este espacio de trabajo. |
Objeto de permisos del equipo
Un objeto de permiso de equipo válido es un objeto JSON con los siguientes pares clave-valor:
| Clave | Obligatoria | Tipo de datos | Descripción |
|---|---|---|---|
teamName |
Opcional | Cadena | Nombre del equipo, que puede utilizarse para especificar a qué equipo corresponden los permisos de este objeto. |
teamId |
Obligatorio si falta teamName |
Cadena | ID del equipo, que sirve como método alternativo para especificar el equipo. |
teamPermissions |
Obligatoria | Matriz | Matriz de cadenas de permisos a nivel de equipo de la tabla de cadenas de permisos de equipos, en la que la presencia de la cadena corresponde a 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 | Obligatoria | Tipo de datos | Descripción |
|---|---|---|---|
roleName |
Opcional | Cadena | Nombre del rol que se está asignando al usuario. |
roleId |
Obligatorio si falta roleName |
Cadena | ID del rol, que sirve como método alternativo para especificar el rol. |
Anexo
Cadenas de permisos de empresa
| Como se muestra en la IU | Cadena API SCIM |
|---|---|
| Administrador | admin |
| Puede administrar la configuración de empresa | manage_company_settings |
| Puede añadir/eliminar espacios de trabajo | add_remove_app_groups |
Cadenas de permisos del espacio de trabajo
| Nombre del permiso | Cadena API SCIM |
|---|---|
| Administrador | admin |
| Campañas de Acceso, Lonas, Tarjetas, Segmentos, Mediateca | basic_access |
| Aprobar y denegar Canvas | approve_deny_campaigns |
| Enviar campañas, Canvas | send_campaigns_canvases |
| Publicar tarjetas | publish_cards |
| Editar segmentos | edit_segments |
| Exportar datos de usuario | export_user_data |
| Ver PII | view_pii |
| Ver perfiles de usuarios que cumplen las reglas de PII | view_user_profile |
| Administrar usuarios del dashboard | manage_dashboard_users |
| Administrar activos de biblioteca de medios | manage_media_library |
| Ver datos de consumo | view_usage_data |
| Importar y actualizar datos de usuario | import_update_user_data |
| Ver datos de facturación | view_billing_details |
| Acceso a la consola para desarrolladores | dev_console |
| Lanzar bloques de contenido | launch_content_blocks |
| Administrar integraciones externas | manage_external_integrations |
| Administrar aplicaciones | manage_apps |
| Gestionar equipos | manage_teams |
| Administrar eventos, atributos, compras | manage_events_attributes_purchases |
| Gestionar etiquetas | manage_tags |
| Administrar configuración del correo electrónico | manage_email_settings |
| Administrar grupos de suscripción | manage_subscription_groups |
| Administrar configuración de aprobación | manage_approval_settings |
| Administrar permisos para el dashboard de catálogos | manage_catalogs_dashboard_permission |
Cadenas de permiso del equipo
| Nombre del permiso | Cadena API SCIM |
|---|---|
| Administrador | admin |
| Campañas de Acceso, Lonas, Tarjetas, Segmentos, Mediateca | basic_access |
| Aprobar y denegar Canvas | approve_deny_campaigns |
| Enviar campañas, Canvas | send_campaigns_canvases |
| Publicar tarjetas | publish_cards |
| Editar segmentos | edit_segments |
| Exportar datos de usuario | export_user_data |
| Visualizar perfil de usuario | view_user_profile |
| Administrar usuarios del dashboard | manage_dashboard_users |
| Administrar activos de biblioteca de medios | manage_media_library |
Cadenas del departamento
| Como se muestra en la IU | Cadena API SCIM |
|---|---|
| Agencia / Proveedor externo | agency |
| BI / Análisis | bi |
| Alta dirección | c_suite |
| Ingeniería | engineering |
| Finanzas | finance |
| Marketing / Editorial | marketing |
| Administración de producto | pm |
Migración de permisos granulares
important:
Los permisos granulares se encuentran en fase de acceso anticipado. Cuando se planifique la migración para tu empresa, los administradores de Braze recibirán correos electrónicos y banners en el dashboard notificándoles la migración de permisos granulares.
Las integraciones SCIM existentes y los objetos API SCIM heredados seguirán funcionando después de la migración de permisos granulares a finales de abril.
No es necesario que tomes ninguna medida inmediata. Sin embargo, te recomendamos que revises tus integraciones para ver si hay permisos que vayan a ser granularizados. Por ejemplo, si actualmente estás enviando basic_access en la API, te sugerimos que actualices tu integración después de la granularización para incluir los permisos específicos (por ejemplo, "appGroupPermissions":["view_campaigns","edit_campaigns"]). Braze seguirá aceptando cadenas heredadas, como basic_access, después de la migración de permisos granulares, para que las integraciones existentes no se vean afectadas.
Objeto permisos
El objeto permisos es un campo que se encuentra en algunas de las peticiones y respuestas cuando se interactúa con el recurso usuario a través de los permisos de ID SCIM.
note:
Los grupos de aplicaciones han pasado a llamarse espacios de trabajo en Braze, pero las claves de esta página siguen haciendo referencia a la terminología antigua (por ejemplo, appGroup, appGroupName).
1
2
3
4
5
6
{
"permissions": {
"companyPermissions": (required, array),
"appGroup": (required, array)
}
}
Un objeto de permisos válido es un objeto JSON con los siguientes pares clave-valor:
| Clave | Obligatoria | Tipo de datos | Descripción |
|---|---|---|---|
companyPermissions |
Opcional | Matriz | Matriz de cadenas de permisos a nivel de empresa, en la que la presencia de la cadena corresponde a que el usuario tiene el permiso correspondiente. |
roles |
Opcional | Matriz | Matriz de objetos de rol. |
appGroup |
Obligatoria | Matriz | Matriz de objetos de permisos del espacio de trabajo. |
Objeto de permisos del espacio de trabajo
Un objeto de permisos del espacio de trabajo válido es un objeto JSON con los siguientes pares clave-valor:
| Clave | Obligatoria | Tipo de datos | Descripción |
|---|---|---|---|
appGroupName |
Opcional | Cadena | Nombre del espacio de trabajo. Sirve para especificar a qué espacio de trabajo corresponden los permisos contenidos en este objeto. |
appGroupId |
Obligatorio si falta appGroupName |
Cadena | ID del espacio de trabajo, que sirve como método alternativo para especificar el espacio de trabajo. |
appGroupPermissionSets |
Opcional | Matriz | Matriz con un único objeto de conjunto de permisos del espacio de trabajo. |
appGroupPermissions |
Obligatoria | Matriz | Matriz de cadenas de permisos a nivel del espacio de trabajo de la tabla de cadenas de permisos del espacio de trabajo, en la que la presencia de la cadena corresponde a que el usuario tiene el permiso correspondiente para el espacio de trabajo especificado. |
team |
Opcional | Matriz | Matriz de objetos de permisos del equipo. |
Objeto de conjunto de permisos del espacio de trabajo
Un objeto de conjunto de permisos del espacio de trabajo válido es un objeto JSON con los siguientes pares clave-valor:
| Clave | Obligatoria | Tipo de datos | Descripción |
|---|---|---|---|
appGroupPermissionSetName |
Opcional | Cadena | Nombre del conjunto de permisos del espacio de trabajo que se está asignando al usuario para este espacio de trabajo. |
appGroupPermissionSetID |
Obligatorio si falta appGroupPermissionSetName |
Cadena | ID del espacio de trabajo, que sirve como método alternativo para especificar el conjunto de permisos del espacio de trabajo asignado al usuario para este espacio de trabajo. |
Objeto de permisos del equipo
Un objeto de permisos del equipo válido es un objeto JSON con los siguientes pares clave-valor:
| Clave | Obligatoria | Tipo de datos | Descripción |
|---|---|---|---|
teamName |
Opcional | Cadena | Nombre del equipo, que puede utilizarse para especificar a qué equipo corresponden los permisos de este objeto. |
teamId |
Obligatorio si falta teamName |
Cadena | ID del equipo, que sirve como método alternativo para especificar el equipo. |
teamPermissions |
Obligatoria | Matriz | Matriz de cadenas de permisos a nivel de equipo de la tabla de cadenas de permisos del equipo, en la que la presencia de la cadena corresponde a 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 | Obligatoria | Tipo de datos | Descripción |
|---|---|---|---|
roleName |
Opcional | Cadena | Nombre del rol que se está asignando al usuario. |
roleId |
Obligatorio si falta roleName |
Cadena | ID del rol, que sirve como método alternativo para especificar el rol. |
Anexo
Cadenas de permisos de empresa
| Como se muestra en la IU | Cadena API SCIM |
|---|---|
| Administrador | admin |
| Administrar la configuración de la empresa | manage_company_settings |
| Crear y eliminar espacios de trabajo | add_remove_app_groups |
Cadenas de permisos del espacio de trabajo
| Nombre del permiso | Cadena API SCIM |
|---|---|
| Ver campañas | view_campaigns |
| Editar campañas | edit_campaigns |
| Archivar campañas | archive_campaigns |
| Ver Canvas | view_canvases |
| Editar Canvas | edit_canvases |
| Archivar Canvas | archive_canvases |
| Ver reglas de limitación de frecuencia | view_frequency_caps |
| Editar reglas de limitación de frecuencia | edit_frequency_caps |
| Ver priorización de mensajes | view_message_prioritization |
| Editar priorización de mensajes | edit_message_prioritization |
| Ver bloques de contenido | view_content_blocks |
| Editar bloques de contenido | edit_content_blocks |
| Archivar bloques de contenido | archive_content_blocks |
| Ver conmutadores de características | view_feature_flags |
| Editar conmutadores de características | edit_feature_flags |
| Archivar conmutadores de características | archive_feature_flags |
| Ver segmentos | view_segments |
| Editar segmentos | edit_segments |
| Archivar segmentos | archive_segments |
| Ver grupo de control global | view_global_control_group |
| Editar grupo de control global | edit_global_control_group |
| Ver plantillas IAM | view_iam_templates |
| Editar plantillas IAM | edit_iam_templates |
| Archivar plantillas IAM | archive_iam_templates |
| Ver plantillas de correo electrónico | view_email_templates |
| Editar plantillas de correo electrónico | edit_email_templates |
| Archivar plantillas de correo electrónico | archive_email_templates |
| Ver plantillas de webhook | view_webhook_templates |
| Editar plantillas de webhook | edit_webhook_templates |
| Archivar plantillas de webhook | archive_webhook_templates |
| Ver plantillas de enlaces de correo electrónico | view_link_templates |
| Editar plantillas de enlaces de correo electrónico | edit_link_templates |
| Ver activos de la biblioteca de medios | view_media_library_assets |
| Ver ubicaciones | view_locations |
| Editar ubicaciones | edit_locations |
| Archivar ubicaciones | archive_locations |
| Ver códigos promocionales | view_promotion_codes |
| Editar códigos promocionales | edit_promotion_codes |
| Exportar códigos promocionales | export_promotion_codes |
| Ver centros de preferencia | view_preference_centers |
| Editar centros de preferencia | edit_preference_centers |
| Editar informes | edit_reports |
| Ver colocaciones | view_placements |
| Editar colocaciones | edit_placements |
| Archivar colocaciones | archive_placements |
| Ver plantillas de banners | view_banner_templates |
| Ver configuración multilingüe | view_multi_language_settings |
| Utilizar Operator | use_operator |
| Ver agentes de Decisioning Studio | view_decisioning_studio_agents |
| Ver audiencia de Decisioning Studio | view_decisioning_studio_audience |
| Ver evento de conversión de Decisioning Studio | view_decisioning_studio_conversion_event |
| Ver protecciones de Decisioning Studio | view_decisioning_studio_guardrails |
| Lanzar campañas | launch_campaigns |
| Lanzar Canvas | launch_canvases |
| Editar usuarios del dashboard | edit_dashboard_users |
| Editar activos de la biblioteca de medios | edit_media_library_assets |
| Eliminar activos de la biblioteca de medios | delete_media_library_assets |
| Ver importación de usuarios | view_import_users |
| Importar usuarios | import_users |
| Editar datos de usuario | edit_user_data |
| Ver registros de fusión de usuarios | view_user_merge_records |
| Fusionar usuarios duplicados | merge_duplicate_users |
| Ver claves de API | view_api_keys |
| Editar claves de API | edit_api_keys |
| Ver grupos internos | view_internal_user_groups |
| Editar grupos internos | edit_internal_user_groups |
| Eliminar grupos internos | delete_internal_user_groups |
| Ver registro de actividad de mensajes | view_message_activity_log |
| Ver registro de usuarios del evento | view_event_user_log |
| Ver identificadores de API | view_api_identifiers |
| Ver dashboard de uso de la API | view_api_usage_dashboard |
| Ver límites de la API | view_api_limits |
| Ver alertas de uso de la API | view_api_usage_alerts |
| Editar alertas de uso de la API | edit_api_usage_alerts |
| Ver depurador del SDK | view_sdk_debugger |
| Editar depurador del SDK | edit_sdk_debugger |
| Lanzar bloques de contenido | launch_content_blocks |
| Editar ingesta de datos en la nube | edit_cloud_data_ingestion |
| Ver configuración de la aplicación | view_app_settings |
| Editar configuración de la aplicación | edit_app_settings |
| Ver configuración push | view_push_settings |
| Editar configuración push | edit_push_settings |
| Ver equipos | view_teams |
| Editar equipos | edit_teams |
| Archivar equipos | archive_teams |
| Ver atributos personalizados | view_custom_attributes |
| Editar atributos personalizados | edit_custom_attributes |
| Bloquear atributos personalizados | blocklist_custom_attributes |
| Eliminar atributos personalizados | delete_custom_attributes |
| Exportar atributos personalizados | export_custom_attributes |
| Ver eventos personalizados | view_custom_events |
| Editar eventos personalizados | edit_custom_events |
| Bloquear eventos personalizados | blocklist_custom_events |
| Eliminar eventos personalizados | delete_custom_events |
| Exportar eventos personalizados | export_custom_events |
| Editar segmentación de propiedades de eventos personalizados | edit_custom_event_property_segmentation |
| Ver productos | view_products |
| Editar productos | edit_products |
| Bloquear productos | blocklist_products |
| Editar segmentación de propiedades de compra | edit_purchase_property_segmentation |
| Ver etiquetas | view_tags |
| Editar etiquetas | edit_tags |
| Eliminar etiquetas | delete_tags |
| Ver configuración del correo electrónico | view_email_settings |
| Editar configuración de correo electrónico | edit_email_settings |
| Ver catálogos | view_catalogs |
| Editar catálogos | edit_catalogs |
| Exportar catálogos | export_catalogs |
| Eliminar catálogos | delete_catalogs |
| Ver configuración de WhatsApp | view_whatsapp_settings |
| Editar socios tecnológicos | edit_technology_partners |
Cadenas de permisos del equipo
| Nombre del permiso | Cadena API SCIM |
|---|---|
| Ver campañas | view_campaigns |
| Editar campañas | edit_campaigns |
| Archivar campañas | archive_campaigns |
| Ver Canvas | view_canvases |
| Editar Canvas | edit_canvases |
| Archivar Canvas | archive_canvases |
| Ver reglas de limitación de frecuencia | view_frequency_caps |
| Editar reglas de limitación de frecuencia | edit_frequency_caps |
| Ver priorización de mensajes | view_message_prioritization |
| Editar priorización de mensajes | edit_message_prioritization |
| Ver bloques de contenido | view_content_blocks |
| Ver conmutadores de características | view_feature_flags |
| Editar conmutadores de características | edit_feature_flags |
| Archivar conmutadores de características | archive_feature_flags |
| Ver segmentos | view_segments |
| Editar segmentos | edit_segments |
| Editar grupo de control global | edit_global_control_group |
| Ver plantillas IAM | view_iam_templates |
| Editar plantillas IAM | edit_iam_templates |
| Archivar plantillas IAM | archive_iam_templates |
| Ver plantillas de correo electrónico | view_email_templates |
| Editar plantillas de correo electrónico | edit_email_templates |
| Archivar plantillas de correo electrónico | archive_email_templates |
| Ver plantillas de webhook | view_webhook_templates |
| Editar plantillas de webhook | edit_webhook_templates |
| Archivar plantillas de webhook | archive_webhook_templates |
| Ver plantillas de enlaces de correo electrónico | view_link_templates |
| Editar plantillas de enlaces de correo electrónico | edit_link_templates |
| Ver activos de la biblioteca de medios | view_media_library_assets |
| Ver ubicaciones | view_locations |
| Editar ubicaciones | edit_locations |
| Archivar ubicaciones | archive_locations |
| Ver códigos promocionales | view_promotion_codes |
| Editar códigos promocionales | edit_promotion_codes |
| Exportar códigos promocionales | export_promotion_codes |
| Ver centros de preferencia | view_preference_centers |
| Editar centros de preferencia | edit_preference_centers |
| Ver informes | view_reports |
| Crear informes | create_reports |
| Editar informes | edit_reports |
| Ver plantillas de banners | view_banner_templates |
| Ver configuración multilingüe | view_multi_language_settings |
| Utilizar Operator | use_operator |
| Ver agentes de Decisioning Studio | view_decisioning_studio_agents |
| Ver evento de conversión de Decisioning Studio | view_decisioning_studio_conversion_event |
| Lanzar campañas | launch_campaigns |
| Lanzar Canvas | launch_canvases |
| Editar usuarios del dashboard | edit_dashboard_users |
Cadenas del departamento
| Como se muestra en la IU | Cadena API SCIM |
|---|---|
| Agencia / Proveedor externo | agency |
| BI / Análisis | bi |
| Alta dirección | c_suite |
| Ingeniería | engineering |
| Finanzas | finance |
| Marketing / Editorial | marketing |
| Administración de producto | pm |
Editar esta página en GitHub
New Stuff!