Objetos e apêndice da API do SCIM
Este artigo explica os diferentes objetos e o apêndice da API do SCIM.
Migração de permissões granulares
As permissões granulares estão em acesso antecipado. Quando a migração estiver planejada para sua empresa, seus administradores do Braze receberão e-mails e banners no painel notificando-os sobre a migração de permissões granulares.
Integrações SCIM existentes e objetos da API SCIM legada continuarão a funcionar após a migração de permissões granulares no final de abril.
Você não é obrigado a tomar nenhuma ação imediata. No entanto, encorajamos você a revisar suas integrações para quaisquer permissões que serão granularizadas. Por exemplo, se você estiver atualmente enviando basic_access na API, sugerimos que você atualize sua integração após a granularização para incluir as permissões específicas (por exemplo, "appGroupPermissions":["view_campaigns","edit_campaigns"]). O Braze continuará a aceitar strings legadas, como basic_access, após a migração de permissões granulares para que as integrações existentes não quebrem.
Objeto de permissões
O objeto de permissões é um campo encontrado em algumas das solicitações e respostas ao fazer interface com o recurso do usuário por meio de permissões de ID SCIM.
Os grupos de apps foram renomeados como espaços de trabalho na Braze, mas as chaves nesta página ainda fazem referência à terminologia antiga (por exemplo, appGroup, appGroupName).
1
2
3
4
5
6
{
"permissions": {
"companyPermissions": (required, array),
"appGroup": (required, array)
}
}
Um objeto de permissões válido é um objeto JSON com os seguintes pares de chave/valor:
| Chave | Obrigatória | Tipo de dados | Descrição |
|---|---|---|---|
companyPermissions |
Opcional | Vetor | Array de strings de permissão em nível de empresa, em que a presença da string corresponde ao usuário ter a permissão correspondente. |
roles |
Opcional | Vetor | Vetor de objetos de função. |
appGroup |
Obrigatória | Vetor | Vetor de objetos de permissão do espaço de trabalho. |
Objeto de permissões do espaço de trabalho
Um objeto de permissão de grupo de apps válido é um objeto JSON com os seguintes pares de chave/valor:
| Chave | Obrigatória | Tipo de dados | Descrição |
|---|---|---|---|
appGroupName |
Opcional | String | Nome do espaço de trabalho. Usado para especificar para qual espaço de trabalho as permissões contidas nesse objeto se destinam. |
appGroupId |
Obrigatório se appGroupName estiver ausente |
String | ID do espaço de trabalho, servindo como um método alternativo de especificação do espaço de trabalho. |
appGroupPermissionSets |
Opcional | Vetor | Vetor com um único objeto de conjunto de permissões de espaço de trabalho. |
appGroupPermissions |
Obrigatória | Vetor | Vetor de strings de permissão no nível do espaço de trabalho da tabela de strings de permissão do espaço de trabalho, na qual a presença da string corresponde ao usuário que tem a permissão correspondente para o espaço de trabalho especificado. |
team |
Opcional | Vetor | Vetor de objetos de permissão da equipe. |
Objeto do conjunto de permissões do espaço de trabalho
Um objeto válido de conjunto de permissões de espaço de trabalho é um objeto JSON com os seguintes pares de valores-chave:
| Chave | Obrigatória | Tipo de dados | Descrição |
|---|---|---|---|
appGroupPermissionSetName |
Opcional | String | Nome do conjunto de permissões do espaço de trabalho que está sendo atribuído ao usuário para esse espaço de trabalho. |
appGroupPermissionSetID |
Obrigatório se appGroupPermissionSetName estiver ausente |
String | ID do espaço de trabalho, servindo como um método alternativo de especificar o conjunto de permissões do espaço de trabalho atribuído ao usuário para esse espaço de trabalho. |
Objeto de permissões de equipe
Um objeto de permissão de equipe válido é um objeto JSON com os seguintes pares de valores-chave:
| Chave | Obrigatória | Tipo de dados | Descrição |
|---|---|---|---|
teamName |
Opcional | String | Nome da equipe, que pode ser usado para especificar a qual equipe se destinam as permissões desse objeto. |
teamId |
Obrigatório se teamName estiver ausente |
String | ID da equipe, servindo como um método alternativo de especificar a equipe. |
teamPermissions |
Obrigatória | Vetor | Matriz de strings de permissão em nível de equipe da tabela de strings de permissão de equipes, na qual a presença da string corresponde ao usuário que tem a permissão correspondente para a equipe especificada. |
Objeto de função
Um objeto de função válido é um objeto JSON com os seguintes pares de valores-chave:
| Chave | Obrigatória | Tipo de dados | Descrição |
|---|---|---|---|
roleName |
Opcional | String | Nome da função que está sendo atribuída ao usuário. |
roleId |
Obrigatório se roleName estiver ausente |
String | ID da função, servindo como um método alternativo de especificação da função. |
Apêndice
Strings de permissão da empresa
| Conforme exibido na interface do usuário | String da API SCIM |
|---|---|
| Administrador | admin |
| Gerenciar Configurações da Empresa | manage_company_settings |
| Criar e excluir espaços de trabalho | add_remove_app_groups |
Strings de permissão do espaço de trabalho
| Nome da permissão | String da API SCIM |
|---|---|
| Ver campanhas | view_campaigns |
| Editar campanhas | edit_campaigns |
| Arquivar campanha | archive_campaigns |
| Ver canvas | view_canvases |
| Editar canvas | edit_canvases |
| Arquivar canvas | archive_canvases |
| Ver regras de limite de frequência | view_frequency_caps |
| Editar regras de limite de frequência | edit_frequency_caps |
| Ver priorização de mensagens | view_message_prioritization |
| Editar priorização de mensagens | edit_message_prioritization |
| Ver blocos de conteúdo | view_content_blocks |
| Editar blocos de conteúdo | edit_content_blocks |
| Arquivar blocos de conteúdo | archive_content_blocks |
| Visualizar Feature Flags | view_feature_flags |
| Editar Feature Flag | edit_feature_flags |
| Arquivar Feature Flags | archive_feature_flags |
| Exibir segmentos | view_segments |
| Editar segmentos | edit_segments |
| Arquivar segmentos | archive_segments |
| Exibir o grupo de controle global | view_global_control_group |
| Editar grupo de controle global | edit_global_control_group |
| Exibir modelos de IAM | view_iam_templates |
| Editar modelos de IAM | edit_iam_templates |
| Arquivar modelos de IAM | archive_iam_templates |
| Exibir modelos de e-mail | view_email_templates |
| Editar modelo de e-mail | edit_email_templates |
| Arquivar modelos de e-mail | archive_email_templates |
| Exibir modelos de webhook | view_webhook_templates |
| Editar modelos de webhook | edit_webhook_templates |
| Arquivar modelos de webhooks | archive_webhook_templates |
| Exibir modelos de links | view_link_templates |
| Editar modelos de links | edit_link_templates |
| Exibir ativos da biblioteca de mídia | view_media_library_assets |
| Ver locais | view_locations |
| Editar locais | edit_locations |
| Arquivar locais | archive_locations |
| Ver Códigos de Promoção | view_promotion_codes |
| Editar Códigos de Promoção | edit_promotion_codes |
| Exportar Códigos de Promoção | export_promotion_codes |
| Ver Centrais de Preferências | view_preference_centers |
| Editar Centrais de Preferências | edit_preference_centers |
| Editar Relatórios | edit_reports |
| Ver colocações | view_placements |
| Editar Posicionamentos | edit_placements |
| Arquivar colocações? | archive_placements |
| Ver modelos de banner | view_banner_templates |
| Ver Configurações de Múltiplas Línguas | view_multi_language_settings |
| Usar Operador | use_operator |
| Ver Agentes do Estúdio de Decisão | view_decisioning_studio_agents |
| Exibir o público do Decisioning Studio | view_decisioning_studio_audience |
| Ver Evento de Conversão do Estúdio de Decisão | view_decisioning_studio_conversion_event |
| Exibir as proteções do Decisioning Studio | view_decisioning_studio_guardrails |
| Lançar campanha | launch_campaigns |
| Lançar canvas | launch_canvases |
| Editar usuários do painel | edit_dashboard_users |
| Editar ativos da biblioteca de mídia | edit_media_library_assets |
| Excluir ativos da biblioteca de mídia | delete_media_library_assets |
| Exibir importação de usuários | view_import_users |
| Importar usuários | import_users |
| Editar dados de usuários | edit_user_data |
| Exibir registros de mesclagem de usuários | view_user_merge_records |
| Mesclar usuários duplicados | merge_duplicate_users |
| Exibir chaves de API | view_api_keys |
| Editar chaves de API | edit_api_keys |
| Ver Grupos Internos | view_internal_user_groups |
| Editar Grupos Internos | edit_internal_user_groups |
| Excluir Grupos Internos | delete_internal_user_groups |
| Visualizar registro de atividades de envio de mensagem | view_message_activity_log |
| Exibir registro de usuários de eventos | view_event_user_log |
| Exibir identificadores de API | view_api_identifiers |
| Exibir o dashboard de uso da API | view_api_usage_dashboard |
| Exibir limites da API | view_api_limits |
| Exibir alertas de uso da API | view_api_usage_alerts |
| Editar alertas de uso da API | edit_api_usage_alerts |
| Exibir depurador do SDK | view_sdk_debugger |
| Editar depurador do SDK | edit_sdk_debugger |
| Lançar blocos de conteúdo | launch_content_blocks |
| Editar ingestão de dados na nuvem | edit_cloud_data_ingestion |
| Exibir configurações do app | view_app_settings |
| Editar configurações do app | edit_app_settings |
| Exibir configurações push | view_push_settings |
| Editar configurações de push | edit_push_settings |
| Ver equipes | view_teams |
| Editar equipe | edit_teams |
| Arquivar equipes | archive_teams |
| Visualizar atributos personalizados | view_custom_attributes |
| Editar atributos personalizados | edit_custom_attributes |
| Lista de bloqueio de atributos personalizados | blocklist_custom_attributes |
| Excluir atributos personalizados | delete_custom_attributes |
| Exportar atributos personalizados | export_custom_attributes |
| Visualizar eventos personalizados | view_custom_events |
| Editar eventos personalizados | edit_custom_events |
| Lista de bloqueio de eventos personalizados | blocklist_custom_events |
| Excluir eventos personalizados | delete_custom_events |
| Exportar eventos personalizados | export_custom_events |
| Editar segmentação de propriedades de eventos personalizados | edit_custom_event_property_segmentation |
| Visualizar produtos | view_products |
| Editar produtos | edit_products |
| Lista de bloqueio de produtos | blocklist_products |
| Editar segmentação de propriedades de compra | edit_purchase_property_segmentation |
| Exibir tags | view_tags |
| Editar tags | edit_tags |
| Excluir tags | delete_tags |
| Ver configurações de e-mail | view_email_settings |
| Editar configurações de e-mail | edit_email_settings |
| Ver catálogos | view_catalogs |
| Editar catálogos | edit_catalogs |
| Exportar catálogo | export_catalogs |
| Excluir catálogos | delete_catalogs |
| Ver Configurações do Whatsapp | view_whatsapp_settings |
| Editar Parceiros de Tecnologia | edit_technology_partners |
Strings de permissão da equipe
| Nome da permissão | String da API SCIM |
|---|---|
| Ver campanhas | view_campaigns |
| Editar campanhas | edit_campaigns |
| Arquivar campanha | archive_campaigns |
| Ver canvas | view_canvases |
| Editar canvas | edit_canvases |
| Arquivar canvas | archive_canvases |
| Ver regras de limite de frequência | view_frequency_caps |
| Editar regras de limite de frequência | edit_frequency_caps |
| Ver priorização de mensagens | view_message_prioritization |
| Editar priorização de mensagens | edit_message_prioritization |
| Ver blocos de conteúdo | view_content_blocks |
| Visualizar Feature Flags | view_feature_flags |
| Editar Feature Flag | edit_feature_flags |
| Arquivar Feature Flags | archive_feature_flags |
| Exibir segmentos | view_segments |
| Editar segmentos | edit_segments |
| Editar grupo de controle global | edit_global_control_group |
| Exibir modelos de IAM | view_iam_templates |
| Editar modelos de IAM | edit_iam_templates |
| Arquivar modelos de IAM | archive_iam_templates |
| Exibir modelos de e-mail | view_email_templates |
| Editar modelo de e-mail | edit_email_templates |
| Arquivar modelos de e-mail | archive_email_templates |
| Exibir modelos de webhook | view_webhook_templates |
| Editar modelos de webhook | edit_webhook_templates |
| Arquivar modelos de webhooks | archive_webhook_templates |
| Exibir modelos de links | view_link_templates |
| Editar modelos de links | edit_link_templates |
| Exibir ativos da biblioteca de mídia | view_media_library_assets |
| Ver locais | view_locations |
| Editar locais | edit_locations |
| Arquivar locais | archive_locations |
| Ver Códigos de Promoção | view_promotion_codes |
| Editar Códigos de Promoção | edit_promotion_codes |
| Exportar Códigos de Promoção | export_promotion_codes |
| Ver Centrais de Preferências | view_preference_centers |
| Editar Centrais de Preferências | edit_preference_centers |
| Ver Relatórios | view_reports |
| Criar Relatórios | create_reports |
| Editar Relatórios | edit_reports |
| Ver modelos de banner | view_banner_templates |
| Ver Configurações de Múltiplas Línguas | view_multi_language_settings |
| Usar Operador | use_operator |
| Ver Agentes do Estúdio de Decisão | view_decisioning_studio_agents |
| Ver Evento de Conversão do Estúdio de Decisão | view_decisioning_studio_conversion_event |
| Lançar campanha | launch_campaigns |
| Lançar canvas | launch_canvases |
| Editar usuários do painel | edit_dashboard_users |
Strings do departamento
| Conforme exibido na interface do usuário | String da API SCIM |
|---|---|
| Agência/Terceiro | agency |
| BI/Análise de dados | bi |
| Diretoria | c_suite |
| Engenharia | engineering |
| Financeiro | finance |
| Marketing/Editorial | marketing |
| Gestão de produto | pm |
Braze está introduzindo permissões granulares, uma forma mais flexível de gerenciar o acesso do usuário. Consulte Migrando para permissões granulares para aprender sobre o processo de migração, e a aba Granular SCIM API para visualizar os objetos e apêndice da API SCIM granular.
Objeto de permissões
O objeto de permissões é um campo encontrado em algumas das solicitações e respostas ao fazer interface com o recurso do usuário por meio de permissões de ID SCIM.
Os grupos de apps foram renomeados como espaços de trabalho na Braze, mas as chaves nesta página ainda fazem referência à terminologia antiga (por exemplo, appGroup, appGroupName).
1
2
3
4
5
6
{
"permissions": {
"companyPermissions": (required, array),
"appGroup": (required, array)
}
}
Um objeto de permissões válido é um objeto JSON com os seguintes pares de chave/valor:
| Chave | Obrigatória | Tipo de dados | Descrição |
|---|---|---|---|
companyPermissions |
Opcional | Vetor | Matriz de strings de permissão no nível da empresa da tabela de strings de permissão da empresa, na qual a presença da string corresponde ao usuário que tem a permissão correspondente. |
roles |
Opcional | Vetor | Vetor de objetos de função. |
appGroup |
Obrigatória | Vetor | Vetor de objetos de permissão do espaço de trabalho. |
Objeto de permissões do espaço de trabalho
Um objeto de permissão de grupo de apps válido é um objeto JSON com os seguintes pares de chave/valor:
| Chave | Obrigatória | Tipo de dados | Descrição |
|---|---|---|---|
appGroupName |
Opcional | String | Nome do espaço de trabalho. Usado para especificar para qual espaço de trabalho as permissões contidas nesse objeto se destinam. |
appGroupId |
Obrigatório se appGroupName estiver ausente |
String | ID do espaço de trabalho, servindo como um método alternativo de especificação do espaço de trabalho. |
appGroupPermissionSets |
Opcional | Vetor | Vetor com um único objeto de conjunto de permissões de espaço de trabalho. |
appGroupPermissions |
Obrigatória | Vetor | Vetor de strings de permissão no nível do espaço de trabalho da tabela de strings de permissão do espaço de trabalho, na qual a presença da string corresponde ao usuário que tem a permissão correspondente para o espaço de trabalho especificado. |
team |
Opcional | Vetor | Vetor de objetos de permissão da equipe. |
Objeto do conjunto de permissões do espaço de trabalho
Um objeto válido de conjunto de permissões de espaço de trabalho é um objeto JSON com os seguintes pares de valores-chave:
| Chave | Obrigatória | Tipo de dados | Descrição |
|---|---|---|---|
appGroupPermissionSetName |
Opcional | String | Nome do conjunto de permissões do espaço de trabalho que está sendo atribuído ao usuário para esse espaço de trabalho. |
appGroupPermissionSetID |
Obrigatório se appGroupPermissionSetName estiver ausente |
String | ID do espaço de trabalho, servindo como um método alternativo de especificar o conjunto de permissões do espaço de trabalho atribuído ao usuário para esse espaço de trabalho. |
Objeto de permissões de equipe
Um objeto de permissão de equipe válido é um objeto JSON com os seguintes pares de valores-chave:
| Chave | Obrigatória | Tipo de dados | Descrição |
|---|---|---|---|
teamName |
Opcional | String | Nome da equipe, que pode ser usado para especificar a qual equipe se destinam as permissões desse objeto. |
teamId |
Obrigatório se teamName estiver ausente |
String | ID da equipe, servindo como um método alternativo de especificar a equipe. |
teamPermissions |
Obrigatória | Vetor | Matriz de strings de permissão em nível de equipe da tabela de strings de permissão de equipes, na qual a presença da string corresponde ao usuário que tem a permissão correspondente para a equipe especificada. |
Objeto de função
Um objeto de função válido é um objeto JSON com os seguintes pares de valores-chave:
| Chave | Obrigatória | Tipo de dados | Descrição |
|---|---|---|---|
roleName |
Opcional | String | Nome da função que está sendo atribuída ao usuário. |
roleId |
Obrigatório se roleName estiver ausente |
String | ID da função, servindo como um método alternativo de especificação da função. |
Apêndice
Strings de permissão da empresa
| Conforme exibido na interface do usuário | String da API SCIM |
|---|---|
| Administrador | admin |
| Pode gerenciar configurações da empresa | manage_company_settings |
| Pode adicionar/remover espaços de trabalho | add_remove_app_groups |
Strings de permissão do espaço de trabalho
| Nome da permissão | String da API SCIM |
|---|---|
| Administrador | admin |
| Campanhas de acesso, canvas, cartões, segmentos, biblioteca de mídia | basic_access |
| Aprovar e rejeitar canvas | approve_deny_campaigns |
| Enviar campanhas, canvas | send_campaigns_canvases |
| Publicar cartões | publish_cards |
| Editar segmentos | edit_segments |
| Exportar dados de usuários | export_user_data |
| Ver IPI | view_pii |
| Ver perfis de usuário em conformidade com IPI | view_user_profile |
| Gerenciar usuários do dashboard | manage_dashboard_users |
| Gerenciar ativos da biblioteca de mídia | manage_media_library |
| Ver dados de uso | view_usage_data |
| Importação e atualização de dados de usuários | import_update_user_data |
| Ver informações de faturamento | view_billing_details |
| Acessar console de desenvolvedores | dev_console |
| Lançar blocos de conteúdo | launch_content_blocks |
| Gerenciar integrações externas | manage_external_integrations |
| Gerenciar apps | manage_apps |
| Gerenciar equipes | manage_teams |
| Gerenciar eventos, atributos, compras | manage_events_attributes_purchases |
| Gerenciar tags | manage_tags |
| Gerenciar configurações de e-mail | manage_email_settings |
| Gerenciar grupos de inscrição | manage_subscription_groups |
| Gerenciar configurações de aprovação | manage_approval_settings |
| Permissão para gerenciar catálogos do dashboard | manage_catalogs_dashboard_permission |
Strings de permissão da equipe
| Nome da permissão | String da API SCIM |
|---|---|
| Administrador | admin |
| Campanhas de acesso, canvas, cartões, segmentos, biblioteca de mídia | basic_access |
| Aprovar e rejeitar canvas | approve_deny_campaigns |
| Enviar campanhas, canvas | send_campaigns_canvases |
| Publicar cartões | publish_cards |
| Editar segmentos | edit_segments |
| Exportar dados de usuários | export_user_data |
| Ver perfil do usuário | view_user_profile |
| Gerenciar usuários do dashboard | manage_dashboard_users |
| Gerenciar ativos da biblioteca de mídia | manage_media_library |
Strings do departamento
| Conforme exibido na interface do usuário | String da API SCIM |
|---|---|
| Agência/Terceiro | agency |
| BI/Análise de dados | bi |
| Diretoria | c_suite |
| Engenharia | engineering |
| Financeiro | finance |
| Marketing/Editorial | marketing |
| Gestão de produto | pm |
Editar esta página no GitHub