Zum Inhalt springen

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.

Dashboard-Nutzerkonto aktualisieren

put

/scim/v2/Users/{id}

Verwenden Sie diesen Endpunkt, um ein bestehendes Dashboard-Nutzerkonto zu aktualisieren, indem Sie die Ressource id angeben, die von der SCIM-Methode POST zurückgegeben wird.

Damit können Sie Vor- und Nachnamen, Berechtigungen (zum Festlegen von Berechtigungen auf Unternehmens-, Workspace- und Teamebene) sowie die Abteilung aktualisieren.

Aus Sicherheitsgründen kann userName (E-Mail-Adresse) nicht über diesen Endpunkt aktualisiert werden. Wenn Sie den userName (E-Mail-Adresse) für eine:n Nutzer:in ändern möchten, wenden Sie sich an den Support.

See me in Postman

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 Ihre Dienstherkunft als X-Request-Origin-Header. Weitere Informationen finden Sie unter Automatisierte Nutzer:innenbereitstellung.

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/ GET-, DELETE- und POST-Endpunkten geteilt, wie in API-Rate-Limits dokumentiert.

Pfadparameter

Parameter	Erforderlich	Datentyp	Beschreibung
`id`	Erforderlich	String	Die Ressourcen-ID der/des Nutzer:in. Dieser Parameter wird von den Methoden `POST` `/scim/v2/Users/` oder `GET` `/scim/v2/Users?filter=userName eq "[email protected]"` zurückgegeben.

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"],
    "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 Nutzerobjekt.
`name`	Erforderlich	JSON-Objekt	Dieses Objekt enthält den Vornamen und den Nachnamen der/des Nutzer:in.
`department`	Erforderlich	String	Gültiger Abteilungs-String aus der Dokumentation zu Abteilungs-Strings.
`permissions`	Erforderlich	JSON-Objekt	Berechtigungsobjekt wie in der Dokumentation zum Berechtigungsobjekt beschrieben.

Beispielanfrage

curl --location --request PUT 'https://rest.iad-01.braze.com/scim/v2/Users/dfa245b7-24195aec-887bb3ad-602b3340' \
--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"],
    "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": "Thursday, January 1, 1970 12:00:00 AM",
    "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"]
                    }
                ]
            }
        ]
    }
}

Fehlerzustände

Wenn eine:r Nutzer:in mit dieser ID nicht in Braze existiert, antwortet der Endpunkt mit:

HTTP/1.1 404 Not Found
Content-Type: text/html; charset=UTF-8

{
    "schemas": ["urn:ietf:params:scim:api:messages:2.0:Error"],
    "detail": "User not found",
    "status": 404
}

New Stuff!