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.

legacy scim api
granular scim api

Important

Braze propose désormais des permissions granulaires, un moyen plus flexible de gérer l’accès des utilisateurs. Pour en savoir plus, consultez Migration vers les permissions granulaires et l’onglet API SCIM granulaire pour afficher les objets et annexes de l’API SCIM granulaire.

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

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

Un objet permissions valide est un objet JSON avec 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 provenant 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 avec 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. Utilisé pour spécifier à quel espace de travail les permissions contenues dans cet objet s’appliquent.
`appGroupId`	Obligatoire si `appGroupName` est absent	Chaîne de caractères	ID de l’espace de travail, servant de méthode alternative pour spécifier l’espace de travail.
`appGroupPermissionSets`	Facultatif	Tableau	Tableau contenant un seul objet ensemble de permissions d’espace de travail.
`appGroupPermissions`	Obligatoire	Tableau	Tableau de chaînes de permissions au niveau de l’espace de travail provenant du tableau Chaînes de permissions d’espace de travail, dans lequel la présence de la chaîne indique que l’utilisateur dispose de la permission correspondante pour l’espace de travail spécifié.
`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 avec 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	ID de l’espace de travail, servant de méthode alternative 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 avec les paires clé-valeur suivantes :

Clé	Obligatoire	Type de données	Description
`teamName`	Facultatif	Chaîne de caractères	Nom de l’équipe, qui peut être utilisé pour spécifier à quelle équipe les permissions contenues dans cet objet s’appliquent.
`teamId`	Obligatoire si `teamName` est absent	Chaîne de caractères	ID de l’équipe, servant de méthode alternative pour spécifier l’équipe.
`teamPermissions`	Obligatoire	Tableau	Tableau de chaînes de permissions au niveau de l’équipe provenant 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 avec 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	ID du rôle, servant de méthode alternative 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 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`

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 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`

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`

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 de fin avril.

Aucune action immédiate n’est requise de votre part. Cependant, passez en revue vos intégrations pour 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 granularisation 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.