Esta página foi traduzida automaticamente e pode conter imprecisões. Para relatar um erro de tradução, use o componente de feedback na parte inferior do sumário, à direita da página.

Objetos e apêndice da API SCIM

Este artigo explica os diferentes objetos e o apêndice da API SCIM.

legacy scim api
granular scim api

Importante

A 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 saber mais sobre o processo de migração, e a guia API SCIM granular para visualizar os objetos e o 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 interagir com o recurso de usuário por meio de permissões de ID SCIM.

Nota

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).

{
  "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	Vetor 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 do 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 do espaço de trabalho é um objeto JSON com os seguintes pares de chave-valor:

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 da equipe

Um objeto de permissão de equipe válido é um objeto JSON com os seguintes pares de chave-valor:

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	Vetor de strings de permissão no nível da equipe da tabela de strings de permissão da equipe, 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 chave-valor:

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
Administrator	`admin`
Can Manage Company Settings	`manage_company_settings`
Can Add/Remove Workspaces	`add_remove_app_groups`

Strings de permissão do espaço de trabalho

Nome da permissão	String da API SCIM
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`

Strings de permissão da equipe

Nome da permissão	String da API SCIM
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`

Strings do departamento

Conforme exibido na interface do usuário	String da API SCIM
Agency / Third Party	`agency`
BI / Analytics	`bi`
C-Suite	`c_suite`
Engineering	`engineering`
Finance	`finance`
Marketing / Editorial	`marketing`
Product Management	`pm`

Migração de permissões granulares

Importante

As permissões granulares estão em acesso antecipado. Quando a migração estiver planejada para sua empresa, seus administradores da Braze receberão e-mails e banners no dashboard 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 precisa tomar nenhuma ação imediata. No entanto, recomendamos que você revise suas integrações para quaisquer permissões que serão granularizadas. Por exemplo, se você estiver enviando basic_access na API, sugerimos que atualize sua integração após a granularização para incluir as permissões específicas (por exemplo, "appGroupPermissions":["view_campaigns","edit_campaigns"]). A 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 interagir com o recurso do usuário por meio de permissões de ID SCIM.

Nota

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).

{
  "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	Vetor 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 do 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, em que a presença da string corresponde ao usuário ter 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 do espaço de trabalho é um objeto JSON com os seguintes pares de chave/valor:

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 chave/valor:

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	Vetor de strings de permissão em nível de equipe da tabela de strings de permissão de equipes, em que a presença da string corresponde ao usuário ter a permissão correspondente para a equipe especificada.