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 bietet jetzt granulare Berechtigungen, eine flexiblere Möglichkeit, den Zugriff von Nutzer:innen zu verwalten. Weitere Informationen finden Sie unter Migration zu granularen Berechtigungen und im Tab Granular SCIM API, um die granularen SCIM-API-Objekte und den Anhang einzusehen.

Berechtigungsobjekt

Das Berechtigungsobjekt ist ein Feld, das in einigen Anfragen und Antworten bei der Interaktion mit der Nutzerressource über SCIM-ID-Berechtigungen vorkommt.

Hinweis

App-Gruppen wurden in Braze in Workspaces umbenannt, aber die Schlüssel auf dieser Seite verwenden weiterhin 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 Berechtigungs-Strings auf Unternehmensebene aus der Tabelle Unternehmens-Berechtigungs-Strings, wobei das Vorhandensein des Strings bedeutet, dass die Nutzer:in die entsprechende Berechtigung hat.
`roles`	Optional	Array	Array von Rollenobjekten.
`appGroup`	Erforderlich	Array	Array von Workspace-Berechtigungsobjekten.

Workspace-Berechtigungsobjekt

Ein gültiges Workspace-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, dient als alternative Methode zur Angabe des Workspace.
`appGroupPermissionSets`	Optional	Array	Array mit einem einzelnen Workspace-Berechtigungsset-Objekt.
`appGroupPermissions`	Erforderlich	Array	Array von Berechtigungs-Strings auf Workspace-Ebene aus der Tabelle Workspace-Berechtigungs-Strings, wobei das Vorhandensein des Strings bedeutet, dass die Nutzer:in die entsprechende Berechtigung für den angegebenen Workspace hat.
`team`	Optional	Array	Array von Team-Berechtigungsobjekten.

Workspace-Berechtigungsset-Objekt

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

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

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, dient als alternative Methode zur Angabe des Teams.
`teamPermissions`	Erforderlich	Array	Array von Berechtigungs-Strings auf Team-Ebene aus der Tabelle Team-Berechtigungs-Strings, wobei das Vorhandensein des Strings bedeutet, dass die Nutzer:in die entsprechende Berechtigung für das angegebene Team hat.

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, dient als alternative Methode zur Angabe der Rolle.

Anhang

Unternehmens-Berechtigungs-Strings

Anzeige in der UI	SCIM-API-String
Administrator	`admin`
Can Manage Company Settings	`manage_company_settings`
Can Add/Remove Workspaces	`add_remove_app_groups`

Workspace-Berechtigungs-Strings

Berechtigungsname	SCIM-API-String
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`

Team-Berechtigungs-Strings

Berechtigungsname	SCIM-API-String
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`

Abteilungs-Strings

Anzeige in der UI	SCIM-API-String
Agency / Third Party	`agency`
BI / Analytics	`bi`
C-Suite	`c_suite`
Engineering	`engineering`
Finance	`finance`
Marketing / Editorial	`marketing`
Product Management	`pm`

Migration zu granularen Berechtigungen

Bestehende SCIM-Integrationen und Legacy-SCIM-API-Objekte funktionieren auch nach der Migration zu granularen Berechtigungen Ende April weiterhin.

Sie müssen nicht sofort handeln. Überprüfen Sie jedoch Ihre Integrationen auf Berechtigungen, die zu granularen Berechtigungen migriert werden. Wenn Sie beispielsweise derzeit basic_access in der API senden, aktualisieren Sie Ihre Integration nach der Granularisierung, um die spezifischen Berechtigungen einzuschließen (zum Beispiel "appGroupPermissions":["view_campaigns","edit_campaigns"]). Braze akzeptiert weiterhin Legacy-Strings wie basic_access nach der Migration zu granularen Berechtigungen, damit bestehende Integrationen nicht unterbrochen werden.