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.

Ein bestehendes Dashboard-Nutzerkonto anhand der Ressourcen-ID suchen

get

/scim/v2/Users/{id}

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

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

Pfad-Parameter

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

Anfrage-Parameter

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

Hinweis

Wenn Sie eine 401-Antwort erhalten, überprüfen Sie, ob Sie ein SCIM-Token verwenden (keinen REST-API-Schlüssel), ob X-Request-Origin mit Ihrer Dienst-Herkunft übereinstimmt und ob Ihre IP-Adresse auf der SCIM-Allowlist steht. Weitere Details finden Sie unter Automatisierte Nutzer:innenbereitstellung.

Beispielanfrage

curl --location --request GET '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' \

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": "2024 Nov 11, 4:20 PM",
    "createdAt": "2024 Nov 11, 4:20 PM",
    "permissions": {
        "companyPermissions": ["manage_company_settings"],
        "roles": [
            {
                "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": "a1b2c3d4-e5f6-4a1b-8c2d-3e4f5a6b7c8d",
                         "teamName": "Test Team",
                         "teamPermissions": ["edit_campaigns","launch_campaigns","edit_canvases","launch_canvases"]
                    }
                ]
            }
        ]
    }
}

Antwort-Parameter

Parameter	Datentyp	Beschreibung
`schemas`	String-Array	SCIM-Nutzer:innenschema.
`id`	String	Die Ressourcen-ID der Nutzer:in.
`userName`	String	Die E-Mail-Adresse der Nutzer:in.
`name`	Objekt	Enthält `givenName` und `familyName`.
`department`	String	Die Abteilung der Nutzer:in, falls festgelegt.
`createdAt`	String	Zeitpunkt der Erstellung des Nutzer:innenkontos. Gibt `N/A` zurück, wenn nicht festgelegt; andernfalls im Format `YYYY Mon DD, H:MM AM/PM`.
`lastSignInAt`	String	Zeitpunkt der letzten Anmeldung der Nutzer:in. Gibt `N/A` zurück, wenn sich die Nutzer:in noch nicht angemeldet hat; andernfalls im Format `YYYY Mon DD, H:MM AM/PM`.
`permissions`	Objekt	Unternehmens-, Workspace-, Team- und Rollenberechtigungen der Nutzer:in. Siehe das Berechtigungsobjekt.

Fehlerzustände

Wenn für die angegebene Ressource id keine Nutzer:in existiert, gibt der Endpunkt Folgendes zurück:

HTTP/1.1 404 Not Found
Content-Type: application/json

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

New Stuff!