Passer au contenu

Cette page a été traduite automatiquement et peut contenir des inexactitudes. Pour signaler une erreur de traduction, utilisez le module de commentaires en bas de la table des matières, à droite de la page.

Rechercher un compte utilisateur de tableau de bord existant par e-mail

get

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

Utilisez cet endpoint pour rechercher un compte utilisateur de tableau de bord existant en spécifiant son e-mail dans le paramètre de requête du filtre.

Notez que lorsque le paramètre de requête est encodé en URL, il s’affiche ainsi :

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

See me in Postman

Important

Cet endpoint nécessite l’intégration SCIM personnalisée. Si vous avez configuré une intégration de fournisseur d’identité (IdP), comme Okta ou Entra ID, vous ne pouvez pas utiliser cet endpoint, car une seule passerelle SCIM peut être configurée par entreprise.

Prérequis

Pour utiliser cet endpoint, vous aurez besoin d’un jeton SCIM. Vous utiliserez l’origine de votre service comme en-tête X-Request-Origin. Pour plus d’informations, consultez la section Provisionnement automatisé des utilisateurs.

Limite de débit

Cet endpoint a une limite de débit de 20 000 requêtes par jour et par entreprise. Cette limite de débit est partagée avec les endpoints PUT, GET, DELETE et POST /scim/v2/Users/, comme indiqué dans Limites de débit de l’API.

Paramètres de requête

Paramètre	Requis	Type de données	Description
`filter`	Requis	Chaîne de caractères	Expression de filtre SCIM pour la recherche par e-mail. Braze ne prend en charge que `userName eq "[email protected]"`. La valeur de l’e-mail doit être encadrée par des guillemets doubles.

Important

Braze ne prend en charge que les filtres de correspondance exacte sur userName avec l’opérateur eq. Les autres champs ou opérateurs de filtre SCIM renvoient une réponse 400.

En-têtes de la requête

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

Remarque

Si vous recevez une réponse 401, vérifiez que vous utilisez un jeton SCIM (et non une clé REST API), que X-Request-Origin correspond à l’origine de votre service et que votre adresse IP figure sur la liste d’autorisation SCIM. Pour plus de détails, consultez la section Provisionnement automatisé des utilisateurs.

Exemple de requête

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' \

Réponse

{
    "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": "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"]
                            }
                        ]
                    }
                ]
            }
        }
    ]
}

Paramètres de réponse

Paramètre	Type de données	Description
`schemas`	Tableau de chaînes de caractères	Schéma de réponse de liste SCIM.
`totalResults`	Entier	Nombre d’utilisateurs du tableau de bord correspondants (0 si aucune correspondance).
`Resources`	Tableau	Tableau d’objets utilisateur. Chaque objet utilise les mêmes champs que GET : Consulter un compte utilisateur de tableau de bord existant.

Champs de l’objet utilisateur

Paramètre	Type de données	Description
`id`	Chaîne de caractères	L’ID de ressource de l’utilisateur.
`userName`	Chaîne de caractères	L’adresse e-mail de l’utilisateur.
`name`	Objet	Contient `givenName` et `familyName`.
`department`	Chaîne de caractères	Le département de l’utilisateur, s’il est défini.
`createdAt`	Chaîne de caractères	Date de création du compte utilisateur. Renvoie `N/A` si non définie ; sinon formatée comme `YYYY Mon DD, H:MM AM/PM`.
`lastSignInAt`	Chaîne de caractères	Date de la dernière connexion de l’utilisateur. Renvoie `N/A` si l’utilisateur ne s’est jamais connecté ; sinon formatée comme `YYYY Mon DD, H:MM AM/PM`.
`permissions`	Objet	Autorisations de l’entreprise, de l’espace de travail, de l’équipe et des rôles. Consultez l’objet des autorisations.

États d’erreur

Si le paramètre filter est manquant ou mal formé, l’endpoint renvoie :

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!