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.
Neues Dashboard-Nutzerkonto erstellen
post
/scim/v2/Users
Verwenden Sie diesen Endpunkt, um ein neues Dashboard-Nutzerkonto zu erstellen, indem Sie E-Mail, Vor- und Nachnamen sowie Berechtigungen (für die Festlegung von Berechtigungen auf Unternehmens-, Workspace- und Team-Ebene) angeben.
Wichtig
Dieser Endpunkt erfordert die angepasste SCIM-Integration. Wenn Sie eine Identity-Provider-Integration (IdP) eingerichtet haben (Okta oder Entra ID), können Sie diesen Endpunkt nicht verwenden. Pro Unternehmen kann nur eine SCIM-Bridge eingerichtet werden.
Voraussetzungen
Um diesen Endpunkt zu verwenden, benötigen Sie ein SCIM-Token. Verwenden Sie die Herkunft Ihres Dienstes als X-Request-Origin-Header. Weitere Informationen finden Sie unter Automatisierte Nutzer:innen-Bereitstellung.
Rate-Limit
Dieser Endpunkt hat ein Rate-Limit von 20.000 Anfragen pro Tag und Unternehmen. Dieses Rate-Limit wird mit den /scim/v2/Users/ PUT-, GET- und DELETE-Endpunkten geteilt, wie in API-Rate-Limits dokumentiert.
Anfragetext
Content-Type: application/json
X-Request-Origin: YOUR-REQUEST-ORIGIN-HERE
Authorization: Bearer YOUR-SCIM-TOKEN-KEY
{
"schemas": ["urn:ietf:params:scim:schemas:core:2.0:User"],
"userName": "[email protected]",
"name": {
"givenName": "Test",
"familyName": "User"
},
"department": "finance",
"permissions": {
"companyPermissions": ["manage_company_settings"],
"roles": [
{
"roleName": "Test Role"
},
{
"roleId": "1f16c016-8e44-48f3-9fd7-2b8d5d70d9bd"
}
],
"appGroup": [
{
"appGroupName": "Test Workspace",
"appGroupPermissions": ["view_campaigns","view_canvases"],
"team": [
{
"teamName": "Test Team",
"teamPermissions": ["edit_campaigns","launch_campaigns","edit_canvases","launch_canvases"]
}
]
},
{
"appGroupName": "Other Test Workspace",
"appGroupPermissionSets": [
{
"appGroupPermissionSetName": "Test Permission Set"
}
]
}
]
}
}
Anfrageparameter
| Parameter | Erforderlich | Datentyp | Beschreibung |
|---|---|---|---|
schemas |
Erforderlich | String-Array | Erwarteter SCIM-2.0-Schemaname für das Nutzer:innen-Objekt. |
userName |
Erforderlich | String | Die E-Mail-Adresse der Nutzer:in. |
name |
Erforderlich | JSON-Objekt | Dieses Objekt enthält den Vornamen und den Nachnamen der Nutzer:in. |
department |
Optional | String | Gültiger Abteilungs-String aus der Dokumentation zu Abteilungs-Strings. Lassen Sie den Wert weg oder übergeben Sie einen leeren String, wenn die Abteilung unbekannt ist. |
permissions |
Optional | JSON-Objekt | Berechtigungsobjekt wie in der Dokumentation zum Berechtigungsobjekt beschrieben. Wenn weggelassen oder leer, weist Braze standardmäßig schreibgeschützte Workspace-Berechtigungen für den unter SCIM Provisioning konfigurierten Standard-Workspace zu. Nach der Migration zu granularen Berechtigungen umfasst dies schreibgeschützte Workspace-Berechtigungen. |
Beispielanfrage
curl --location --request POST 'https://rest.iad-01.braze.com/scim/v2/Users' \
--header 'Content-Type: application/json' \
--header 'X-Request-Origin: YOUR-REQUEST-ORIGIN-HERE' \
--header 'Authorization: Bearer YOUR-SCIM–TOKEN-HERE' \
--data raw '{
"schemas": ["urn:ietf:params:scim:schemas:core:2.0:User"],
"userName": "[email protected]",
"name": {
"givenName": "Test",
"familyName": "User"
},
"department": "finance",
"permissions": {
"companyPermissions": ["manage_company_settings"],
"roles": [
{
"roleName": "Test Role"
},
{
"roleId": "1f16c016-8e44-48f3-9fd7-2b8d5d70d9bd"
}
],
"appGroup": [
{
"appGroupName": "Test Workspace",
"appGroupPermissions": ["view_campaigns","view_canvases"],
"team": [
{
"teamName": "Test Team",
"teamPermissions": ["edit_campaigns","launch_campaigns","edit_canvases","launch_canvases"]
}
]
}
]
}
}'
Antwort
{
"schemas": ["urn:ietf:params:scim:schemas:core:2.0:User"],
"id": "dfa245b7-24195aec-887bb3ad-602b3340",
"userName": "[email protected]",
"name": {
"givenName": "Test",
"familyName": "User"
},
"department": "finance",
"lastSignInAt": "NA",
"createdAt": "NA",
"permissions": {
"companyPermissions": ["manage_company_settings"],
"roles": [
{
"roleName": "Test Role",
"roleId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
"appGroup": [
{
"appGroupId": "a1b2c3d4-e5f6-4a1b-8c2d-3e4f5a6b7c8d",
"appGroupName": "Some Workspace",
"appGroupPermissions": ["view_campaigns","view_canvases"],
"team": [
{
"teamId": "1f16c016-8e44-48f3-9fd7-2b8d5d70d9bd",
"teamName": "Some Team",
"teamPermissions": ["edit_campaigns","launch_campaigns","edit_canvases","launch_canvases"]
}
]
}
]
},
{
"roleName": "Another Test Role",
"roleId": "b2c3d4e5-f6a7-4b1c-9d2e-4f5a6b7c8d9e",
"appGroup": [
{
"appGroupId": "c3d4e5f6-a7b8-4c1d-8e2f-5a6b7c8d9e0f",
"appGroupName": "Production Workspace",
"appGroupPermissionSets": [
{
"appGroupPermissionSetName": "A Permission Set",
"appGroupPermissionSetId": "d4e5f6a7-b8c9-4d1e-9f2a-6b7c8d9e0f1a",
"permissions": ["view_campaigns","edit_campaigns","view_content_blocks"]
}
]
}
]
}
],
"appGroup": [
{
"appGroupId": "a1b2c3d4-e5f6-4a1b-8c2d-3e4f5a6b7c8d",
"appGroupName": "Test Workspace",
"appGroupPermissions": ["view_campaigns","view_canvases"],
"team": [
{
"teamId": "1f16c016-8e44-48f3-9fd7-2b8d5d70d9bd",
"teamName": "Test Team",
"teamPermissions": ["edit_campaigns","launch_campaigns","edit_canvases","launch_canvases"]
}
]
},
{
"appGroupName": "Other Test Workspace",
"appGroupPermissionSets": [
{
"appGroupPermissionSetName": "Test Permission Set"
}
]
}
]
}
}
Antwortparameter
| Parameter | Datentyp | Beschreibung |
|---|---|---|
schemas |
String-Array | Erwarteter SCIM-2.0-Schemaname für das Nutzer:innen-Objekt. |
userName |
String | Die E-Mail-Adresse der Nutzer:in. |
name |
JSON-Objekt | Dieses Objekt enthält den Vornamen und den Nachnamen der Nutzer:in. |
department |
String | Gültiger Abteilungs-String aus der Dokumentation zu Abteilungs-Strings. |
permissions |
JSON-Objekt | Berechtigungsobjekt wie in der Dokumentation zum Berechtigungsobjekt beschrieben. |
id |
String | Von Braze generierte ID, die für die Suche und Verwaltung von Nutzer:innen-Konten verwendet wird. |
createdAt |
String | Datum, an dem das Nutzer:innen-Konto erstellt wurde, in UTC. Gibt NA zurück, wenn nicht festgelegt. |
lastSignInAt |
String | Datum der letzten erfolgreichen Anmeldung in UTC. Gibt NA zurück, wenn sich die Nutzer:in noch nicht angemeldet hat. Format: YYYY Mon DD, H:MM AM/PM. |
Fehlerzustände
Wenn eine Nutzer:in mit diesem userName oder dieser E-Mail-Adresse bereits in Braze existiert, antwortet der Endpunkt mit:
HTTP/1.1 409 Conflict
Date: Tue, 10 Sep 2019 02:22:30 GMT
Content-Type: text/json;charset=UTF-8
{
"schemas": ["urn:ietf:params:scim:api:messages:2.0:Error"],
"detail": "User already exists in the database.",
"status": 409
}
New Stuff!