Skip to content

Bestehendes Dashboard-Nutzerkonto per E-Mail durchsuchen

get

scim/v2/Users?filter=userName%20eq%20”user%40test.com”

Verwenden Sie diesen Endpunkt, um ein bestehendes Dashboard-Nutzerkonto zu suchen, indem Sie die E-Mail-Adresse im Filter-Abfrageparameter angeben.

Beachten Sie, dass der Abfrageparameter in URL-kodierter Form wie folgt aussieht:

/scim/v2/Users?filter=userName%20eq%20%[email protected]%22

See me in Postman

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 Bereitstellung von Nutzer:innen.

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

Abfrageparameter

Parameter Erforderlich Datentyp Beschreibung
filter Erforderlich String SCIM-Filterausdruck zur Suche per E-Mail. Braze unterstützt ausschließlich userName eq "[email protected]". Der E-Mail-Wert muss in doppelte Anführungszeichen eingeschlossen sein.

Anfrageparameter

1
2
3

Content-Type: application/json
X-Request-Origin: YOUR-REQUEST-ORIGIN-HERE
Authorization: Bearer YOUR-SCIM-TOKEN-HERE

Beispielanfrage

1
2
3
4

curl --location --request GET \ 'https://rest.iad-01.braze.com/scim/v2/Users?filter=userName%20eq%20%[email protected]%22' \
--header 'Content-Type: application/json' \
--header 'X-Request-Origin: YOUR-REQUEST-ORIGIN-HERE' \
--header 'Authorization: Bearer YOUR-SCIM-TOKEN-HERE' \

Antwort

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34

{
    "schemas": ["urn:ietf:params:scim:api:messages:2.0:ListResponse"],
    "totalResults": 1,
    "Resources": [
        {
            "userName": "[email protected]",
            "id": "dfa245b7-24195aec-887bb3ad-602b3340",
            "name": {
                "givenName": "Test",
                "familyName": "User"
            },
            "department": "finance",
            "createdAt": "2024 Nov 11, 4:20 PM",
            "lastSignInAt": "N/A",
            "permissions": {
                "companyPermissions": ["manage_company_settings"],
                "appGroup": [
                    {
                        "appGroupId": "241adcd25789fabcded",
                        "appGroupName": "Test Workspace",
                        "appGroupPermissions": ["basic_access","send_campaigns_canvases"],
                        "team": [
                            {
                                "teamId": "241adcd25789fabcded",
                                "teamName": "Test Team",
                                "teamPermissions": ["admin"]
                            }
                        ]
                    }
                ]
            }
        }
    ]
}

Antwortparameter

Parameter Datentyp Beschreibung
schemas String-Array SCIM-Listenantwortschema.
totalResults Integer Anzahl der übereinstimmenden Dashboard-Nutzer:innen (0, wenn keine Übereinstimmung).
Resources Array Array von Nutzerobjekten. Jedes Objekt verwendet dieselben Felder wie GET: Bestehendes Dashboard-Nutzerkonto nachschlagen.

Felder des Nutzerobjekts

Parameter Datentyp Beschreibung
id String Die Ressourcen-ID der/des Nutzer:in.
userName String Die E-Mail-Adresse der/des Nutzer:in.
name Object Enthält givenName und familyName.
department String Die Abteilung der/des Nutzer:in, falls festgelegt.
createdAt String Zeitpunkt der Erstellung des Nutzerkontos. Gibt N/A zurück, wenn nicht festgelegt; ansonsten im Format YYYY Mon DD, H:MM AM/PM.
lastSignInAt String Zeitpunkt der letzten Anmeldung der/des Nutzer:in. Gibt N/A zurück, wenn sich die/der Nutzer:in noch nie angemeldet hat; ansonsten im Format YYYY Mon DD, H:MM AM/PM.
permissions Object Berechtigungen für Unternehmen, Workspace, Team und Rolle. Siehe das Berechtigungsobjekt.

Fehlerzustände

Wenn der filter-Parameter fehlt oder fehlerhaft ist, gibt der Endpunkt Folgendes zurück:

1
2
3
4
5
6
7
8

HTTP/1.1 400 Bad Request
Content-Type: application/json

{
  "schemas": ["urn:ietf:params:scim:api:messages:2.0:Error"],
  "status": 400,
  "detail": "Request is unparsable, syntactically incorrect, or violates schema."
}
New Stuff!