Diese Seite wurde automatisch übersetzt und kann Ungenauigkeiten enthalten. Um einen Übersetzungsfehler zu melden, nutzen Sie das Feedback unten im Inhaltsverzeichnis rechts auf der Seite.

SCIM-API-Objekte und Anhang

Dieser Artikel erklärt die verschiedenen SCIM-API-Objekte und den Anhang.

legacy scim api
granular scim api

Wichtig

Braze führt detaillierte Berechtigungen ein, eine flexiblere Methode zur Verwaltung des Zugriffs von Nutzer:innen. Unter Migration zu detaillierten Berechtigungen erfahren Sie mehr über den Migrationsprozess. Auf dem Tab Detaillierte SCIM-API können Sie die detaillierten SCIM-API-Objekte und den Anhang einsehen.

Berechtigungsobjekt

Das Berechtigungsobjekt ist ein Feld, das in einigen Anfragen und Antworten vorkommt, wenn Sie über SCIM-ID-Berechtigungen mit der Nutzer:innen-Ressource interagieren.

Hinweis

App-Gruppen wurden in Braze in Workspaces umbenannt, aber die Schlüssel auf dieser Seite beziehen sich noch auf die alte Terminologie (zum Beispiel appGroup, appGroupName).

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

Ein gültiges Berechtigungsobjekt ist ein JSON-Objekt mit den folgenden Schlüssel-Wert-Paaren:

Schlüssel	Erforderlich	Datentyp	Beschreibung
`companyPermissions`	Optional	Array	Array von Berechtigungsstrings auf Unternehmensebene aus der Tabelle Unternehmens-Berechtigungsstrings, wobei das Vorhandensein des Strings bedeutet, dass die Nutzer:in die entsprechende Berechtigung besitzt.
`roles`	Optional	Array	Array von Rollenobjekten.
`appGroup`	Erforderlich	Array	Array von Workspace-Berechtigungsobjekten.

Workspace-Berechtigungsobjekt

Ein gültiges App-Gruppen-Berechtigungsobjekt ist ein JSON-Objekt mit den folgenden Schlüssel-Wert-Paaren:

Schlüssel	Erforderlich	Datentyp	Beschreibung
`appGroupName`	Optional	String	Name des Workspace. Wird verwendet, um anzugeben, für welchen Workspace die in diesem Objekt enthaltenen Berechtigungen gelten.
`appGroupId`	Erforderlich, wenn `appGroupName` fehlt	String	ID des Workspace, die als alternative Methode zur Angabe des Workspace dient.
`appGroupPermissionSets`	Optional	Array	Array mit einem einzelnen Workspace-Berechtigungssatz-Objekt.
`appGroupPermissions`	Erforderlich	Array	Array von Berechtigungsstrings auf Workspace-Ebene aus der Tabelle Workspace-Berechtigungsstrings, wobei das Vorhandensein des Strings bedeutet, dass die Nutzer:in die entsprechende Berechtigung für den angegebenen Workspace besitzt.
`team`	Optional	Array	Array von Team-Berechtigungsobjekten.

Workspace-Berechtigungssatz-Objekt

Ein gültiges Workspace-Berechtigungssatz-Objekt ist ein JSON-Objekt mit den folgenden Schlüssel-Wert-Paaren:

Schlüssel	Erforderlich	Datentyp	Beschreibung
`appGroupPermissionSetName`	Optional	String	Name des Workspace-Berechtigungssatzes, der der Nutzer:in für diesen Workspace zugewiesen wird.
`appGroupPermissionSetID`	Erforderlich, wenn `appGroupPermissionSetName` fehlt	String	ID des Workspace, die als alternative Methode zur Angabe des der Nutzer:in zugewiesenen Workspace-Berechtigungssatzes dient.

Team-Berechtigungsobjekt

Ein gültiges Team-Berechtigungsobjekt ist ein JSON-Objekt mit den folgenden Schlüssel-Wert-Paaren:

Schlüssel	Erforderlich	Datentyp	Beschreibung
`teamName`	Optional	String	Name des Teams, der verwendet werden kann, um anzugeben, für welches Team die Berechtigungen in diesem Objekt gelten.
`teamId`	Erforderlich, wenn `teamName` fehlt	String	ID des Teams, die als alternative Methode zur Angabe des Teams dient.
`teamPermissions`	Erforderlich	Array	Array von Berechtigungsstrings auf Team-Ebene aus der Tabelle Team-Berechtigungsstrings, wobei das Vorhandensein des Strings bedeutet, dass die Nutzer:in die entsprechende Berechtigung für das angegebene Team besitzt.

Rollenobjekt

Ein gültiges Rollenobjekt ist ein JSON-Objekt mit den folgenden Schlüssel-Wert-Paaren:

Schlüssel	Erforderlich	Datentyp	Beschreibung
`roleName`	Optional	String	Name der Rolle, die der Nutzer:in zugewiesen wird.
`roleId`	Erforderlich, wenn `roleName` fehlt	String	ID der Rolle, die als alternative Methode zur Angabe der Rolle dient.

Anhang

Unternehmens-Berechtigungsstrings

Anzeige in der UI	SCIM-API-String
Administrator	`admin`
Kann Unternehmenseinstellungen verwalten	`manage_company_settings`
Kann Workspaces hinzufügen/entfernen	`add_remove_app_groups`

Workspace-Berechtigungsstrings

Berechtigungsname	SCIM-API-String
Admin	`admin`
Zugriff auf Campaigns, Canvases, Cards, Segmente, Medienbibliothek	`basic_access`
Canvases genehmigen und ablehnen	`approve_deny_campaigns`
Campaigns, Canvases senden	`send_campaigns_canvases`
Cards veröffentlichen	`publish_cards`
Segmente bearbeiten	`edit_segments`
Nutzerdaten exportieren	`export_user_data`
PII ansehen	`view_pii`
Nutzerprofile PII-konform anzeigen	`view_user_profile`
Dashboard-Nutzer:innen verwalten	`manage_dashboard_users`
Medienbibliothek-Assets verwalten	`manage_media_library`
Nutzungsdaten anzeigen	`view_usage_data`
Nutzerdaten importieren und aktualisieren	`import_update_user_data`
Rechnungsdetails anzeigen	`view_billing_details`
Dev-Konsole öffnen	`dev_console`
Content Blocks starten	`launch_content_blocks`
Externe Integrationen verwalten	`manage_external_integrations`
Apps verwalten	`manage_apps`
Teams verwalten	`manage_teams`
Ereignisse, Attribute und Käufe verwalten	`manage_events_attributes_purchases`
Tags verwalten	`manage_tags`
E-Mail-Einstellungen verwalten	`manage_email_settings`
Abo-Gruppen verwalten	`manage_subscription_groups`
Genehmigungseinstellungen verwalten	`manage_approval_settings`
Kataloge-Dashboard-Berechtigung verwalten	`manage_catalogs_dashboard_permission`

Team-Berechtigungsstrings

Berechtigungsname	SCIM-API-String
Admin	`admin`
Zugriff auf Campaigns, Canvases, Cards, Segmente, Medienbibliothek	`basic_access`
Canvases genehmigen und ablehnen	`approve_deny_campaigns`
Campaigns, Canvases senden	`send_campaigns_canvases`
Cards veröffentlichen	`publish_cards`
Segmente bearbeiten	`edit_segments`
Nutzerdaten exportieren	`export_user_data`
Nutzerprofil anzeigen	`view_user_profile`
Dashboard-Nutzer:innen verwalten	`manage_dashboard_users`
Medienbibliothek-Assets verwalten	`manage_media_library`

Abteilungsstrings

Anzeige in der UI	SCIM-API-String
Agentur / Drittanbieter	`agency`
BI / Analytics	`bi`
C-Suite	`c_suite`
Engineering	`engineering`
Finanzen	`finance`
Marketing / Redaktion	`marketing`
Produktmanagement	`pm`

Migration granularer Berechtigungen

Bestehende SCIM-Integrationen und ältere SCIM-API-Objekte werden nach der Migration der granularen Berechtigungen Ende April weiterhin funktionieren.

Es ist nicht erforderlich, dass Sie sofort Maßnahmen ergreifen. Wir empfehlen Ihnen jedoch, Ihre Integrationen auf Berechtigungen zu überprüfen, die granularisiert werden. Wenn Sie derzeit beispielsweise basic_access in der API senden, empfehlen wir Ihnen, Ihre Integration nach der Granularisierung zu aktualisieren, um die spezifischen Berechtigungen einzubeziehen (z. B. "appGroupPermissions":["view_campaigns","edit_campaigns"]). Braze wird auch nach der Migration der granularen Berechtigungen weiterhin ältere Strings wie basic_access akzeptieren, damit bestehende Integrationen weiterhin funktionieren.