Passer au contenu

Cette page a été traduite automatiquement et peut contenir des inexactitudes. Pour signaler une erreur de traduction, utilisez le module de commentaires en bas de la table des matières, à droite de la page.

Objets API SCIM et annexes

Cet article présente les différents objets de l’API SCIM ainsi que les annexes associées.

granular scim api
legacy scim api

Migration vers les permissions granulaires

Les intégrations SCIM existantes et les objets de l’API SCIM héritée continuent de fonctionner après la migration vers les permissions granulaires, mais Braze cessera d’accepter les valeurs de l’API SCIM héritée en décembre 2026.

Aucune action immédiate n’est requise de votre part. Nous vous recommandons toutefois de passer en revue vos intégrations pour repérer les permissions qui migrent vers les permissions granulaires. Par exemple, si vous envoyez actuellement basic_access dans l’API, mettez à jour votre intégration après la migration vers les permissions granulaires pour inclure les permissions spécifiques (par exemple, "appGroupPermissions":["view_campaigns","edit_campaigns"]). Braze continue d’accepter les chaînes héritées, comme basic_access, après la migration vers les permissions granulaires afin que les intégrations existantes ne soient pas interrompues.

Objet permissions

L’objet permissions est un champ présent dans certaines requêtes et réponses lors de l’interaction avec la ressource utilisateur via les permissions d’ID SCIM.

Remarque

Les groupes d’applications ont été renommés en espaces de travail dans Braze, mais les clés de cette page font toujours référence à l’ancienne terminologie (par exemple, appGroup, appGroupName).

Important

Les champs appGroupId, teamId, roleId et appGroupPermissionSetId font référence à l’identifiant API d’une ressource, c’est-à-dire un UUID tel que 1f16c016-8e44-48f3-9fd7-2b8d5d70d9bd. Cet identifiant est distinct de l’ID interne de la ressource dans la base de données. Pour trouver ces identifiants, utilisez GET : Rechercher un compte utilisateur existant du tableau de bord. L’objet permissions renvoyé contient les valeurs appGroupId, teamId, roleId et appGroupPermissionSetId de l’utilisateur.

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

Un objet permissions valide est un objet JSON contenant les paires clé-valeur suivantes :

Clé	Obligatoire	Type de données	Description
`companyPermissions`	Facultatif	Tableau	Tableau de chaînes de permissions au niveau de l’entreprise, dans lequel la présence de la chaîne indique que l’utilisateur dispose de la permission correspondante.
`roles`	Facultatif	Tableau	Tableau d’objets rôle.
`appGroup`	Obligatoire	Tableau	Tableau d’objets permissions d’espace de travail.

Objet permissions d’espace de travail

Un objet permissions d’espace de travail valide est un objet JSON contenant les paires clé-valeur suivantes :

Clé	Obligatoire	Type de données	Description
`appGroupName`	Facultatif	Chaîne de caractères	Nom de l’espace de travail. Permet d’indiquer à quel espace de travail s’appliquent les permissions contenues dans cet objet.
`appGroupId`	Obligatoire si `appGroupName` est absent	Chaîne de caractères	Identifiant API de l’espace de travail (un UUID), qui constitue une autre méthode pour spécifier l’espace de travail.
`appGroupPermissionSets`	Facultatif	Tableau	Tableau contenant un ou plusieurs objets ensemble de permissions d’espace de travail. L’utilisateur obtient chaque permission incluse dans les ensembles de permissions répertoriés pour cet espace de travail. Le tableau ne peut pas être vide. Fournissez soit `appGroupPermissions`, soit `appGroupPermissionSets` par entrée d’espace de travail, mais pas les deux.
`appGroupPermissions`	Obligatoire sous condition	Tableau	Tableau de chaînes de permissions au niveau de l’espace de travail issues du tableau Chaînes de permissions d’espace de travail. Obligatoire lorsque `appGroupPermissionSets` n’est pas fourni.
`team`	Facultatif	Tableau	Tableau d’objets permissions Teams.

Objet ensemble de permissions d’espace de travail

Un objet ensemble de permissions d’espace de travail valide est un objet JSON contenant les paires clé-valeur suivantes :

Clé	Obligatoire	Type de données	Description
`appGroupPermissionSetName`	Facultatif	Chaîne de caractères	Nom de l’ensemble de permissions d’espace de travail attribué à l’utilisateur pour cet espace de travail.
`appGroupPermissionSetId`	Obligatoire si `appGroupPermissionSetName` est absent	Chaîne de caractères	Identifiant API de l’ensemble de permissions (un UUID), qui constitue une autre méthode pour spécifier l’ensemble de permissions d’espace de travail attribué à l’utilisateur pour cet espace de travail.

Objet permissions Teams

Un objet permissions Teams valide est un objet JSON contenant les paires clé-valeur suivantes :

Clé	Obligatoire	Type de données	Description
`teamName`	Facultatif	Chaîne de caractères	Nom de l’équipe, qui permet d’indiquer à quelle équipe s’appliquent les permissions contenues dans cet objet.
`teamId`	Obligatoire si `teamName` est absent	Chaîne de caractères	Identifiant API de l’équipe (un UUID), qui constitue une autre méthode pour spécifier l’équipe.
`teamPermissions`	Obligatoire	Tableau	Tableau de chaînes de permissions au niveau de l’équipe issues du tableau Chaînes de permissions Teams, dans lequel la présence de la chaîne indique que l’utilisateur dispose de la permission correspondante pour l’équipe spécifiée.

Objet rôle

Un objet rôle valide est un objet JSON contenant les paires clé-valeur suivantes :

Clé	Obligatoire	Type de données	Description
`roleName`	Facultatif	Chaîne de caractères	Nom du rôle attribué à l’utilisateur.
`roleId`	Obligatoire si `roleName` est absent	Chaîne de caractères	Identifiant API du rôle (un UUID), qui constitue une autre méthode pour spécifier le rôle.

Annexes

Chaînes de permissions d’entreprise

Affichage dans l’interface	Chaîne 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`

Chaînes de permissions d’espace de travail

Nom de la permission	Chaîne 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`

Chaînes de permissions Teams

Nom de la permission	Chaîne 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`

Chaînes de départements

Affichage dans l’interface	Chaîne API SCIM
Agency / Third Party	`agency`
BI / Analytics	`bi`
C-Suite	`c_suite`
Engineering	`engineering`
Finance	`finance`
Marketing / Editorial	`marketing`
Product Management	`pm`

Important

Braze propose désormais des permissions granulaires, une manière plus flexible de gérer l’accès des utilisateurs. Pour en savoir plus, consultez Migration vers les permissions granulaires et l’onglet Granular SCIM API pour afficher les objets et les annexes de l’API SCIM granulaire. Braze cessera d’accepter les valeurs de l’API SCIM héritée en décembre 2026.

Objet permissions

L’objet permissions est un champ présent dans certaines requêtes et réponses lors de l’interaction avec la ressource utilisateur via les permissions d’ID SCIM.

Remarque

Important

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

Un objet permissions valide est un objet JSON contenant les paires clé-valeur suivantes :

Clé	Obligatoire	Type de données	Description
`companyPermissions`	Facultatif	Tableau	Tableau de chaînes de permissions au niveau de l’entreprise issues du tableau Chaînes de permissions d’entreprise, dans lequel la présence de la chaîne indique que l’utilisateur dispose de la permission correspondante.
`roles`	Facultatif	Tableau	Tableau d’objets rôle.
`appGroup`	Obligatoire	Tableau	Tableau d’objets permissions d’espace de travail.

Objet permissions d’espace de travail

Un objet permissions d’espace de travail valide est un objet JSON contenant les paires clé-valeur suivantes :

Clé	Obligatoire	Type de données	Description
`appGroupName`	Facultatif	Chaîne de caractères	Nom de l’espace de travail. Permet d’indiquer à quel espace de travail s’appliquent les permissions contenues dans cet objet.
`appGroupId`	Obligatoire si `appGroupName` est absent	Chaîne de caractères	Identifiant API de l’espace de travail (un UUID), qui constitue une autre méthode pour spécifier l’espace de travail.
`appGroupPermissionSets`	Facultatif	Tableau	Tableau contenant un ou plusieurs objets ensemble de permissions d’espace de travail. L’utilisateur obtient chaque permission incluse dans les ensembles de permissions répertoriés pour cet espace de travail. Le tableau ne peut pas être vide. Fournissez soit `appGroupPermissions`, soit `appGroupPermissionSets` par entrée d’espace de travail, mais pas les deux.
`appGroupPermissions`	Obligatoire sous condition	Tableau	Tableau de chaînes de permissions au niveau de l’espace de travail issues du tableau Chaînes de permissions d’espace de travail. Obligatoire lorsque `appGroupPermissionSets` n’est pas fourni.
`team`	Facultatif	Tableau	Tableau d’objets permissions Teams.

Objet ensemble de permissions d’espace de travail

Un objet ensemble de permissions d’espace de travail valide est un objet JSON contenant les paires clé-valeur suivantes :

Clé	Obligatoire	Type de données	Description
`appGroupPermissionSetName`	Facultatif	Chaîne de caractères	Nom de l’ensemble de permissions d’espace de travail attribué à l’utilisateur pour cet espace de travail.
`appGroupPermissionSetId`	Obligatoire si `appGroupPermissionSetName` est absent	Chaîne de caractères	Identifiant API de l’ensemble de permissions (un UUID), qui constitue une autre méthode pour spécifier l’ensemble de permissions d’espace de travail attribué à l’utilisateur pour cet espace de travail.

Objet permissions Teams

Un objet permissions Teams valide est un objet JSON contenant les paires clé-valeur suivantes :

Clé	Obligatoire	Type de données	Description
`teamName`	Facultatif	Chaîne de caractères	Nom de l’équipe, qui permet d’indiquer à quelle équipe s’appliquent les permissions contenues dans cet objet.
`teamId`	Obligatoire si `teamName` est absent	Chaîne de caractères	Identifiant API de l’équipe (un UUID), qui constitue une autre méthode pour spécifier l’équipe.
`teamPermissions`	Obligatoire	Tableau	Tableau de chaînes de permissions au niveau de l’équipe issues du tableau Chaînes de permissions Teams, dans lequel la présence de la chaîne indique que l’utilisateur dispose de la permission correspondante pour l’équipe spécifiée.

Objet rôle

Un objet rôle valide est un objet JSON contenant les paires clé-valeur suivantes :

Clé	Obligatoire	Type de données	Description
`roleName`	Facultatif	Chaîne de caractères	Nom du rôle attribué à l’utilisateur.
`roleId`	Obligatoire si `roleName` est absent	Chaîne de caractères	Identifiant API du rôle (un UUID), qui constitue une autre méthode pour spécifier le rôle.

Annexes

Chaînes de permissions d’entreprise

Affichage dans l’interface	Chaîne API SCIM
Administrator	`admin`
Can Manage Company Settings	`manage_company_settings`
Can Add/Remove Workspaces	`add_remove_app_groups`

Chaînes de permissions d’espace de travail

Nom de la permission	Chaîne 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`

Chaînes de permissions Teams

Nom de la permission	Chaîne 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`

Chaînes de départements

Affichage dans l’interface	Chaîne 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!