Skip to content

Rechercher un compte utilisateur du tableau de bord existant par ID de ressource

get

/scim/v2/Users/{id}

Utilisez cet endpoint pour rechercher un compte utilisateur du tableau de bord existant en spécifiant la ressource id renvoyée par la méthode SCIM POST.

See me in Postman

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 5 000 requêtes par jour et par société. Cette limite de débit est partagée avec les endpoints PUT, GET, DELETE et POST /scim/v2/Users/, comme documenté dans Limites de débit de l’API.

Paramètres de chemin

Paramètre Requis Type de données Description
id Requis Chaîne de caractères L’ID de ressource de l’utilisateur. Ce paramètre est renvoyé par les méthodes POST /scim/v2/Users/ ou GET /scim/v2/Users?filter=userName eq "[email protected]".

Paramètres de la requête

1
2
3

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

Exemple de requête

1
2
3
4

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

Réponse

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
35
36
37
38
39
40
41
42
43
44
45
46
47
48

{
    "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": "23125dad23dfaae7",
                "appGroup": [
                    {
                        "appGroupId": "241adcd25adfabcded",
                        "appGroupName": "Production Workspace",
                        "appGroupPermissionSets": [
                            {
                                "appGroupPermissionSetName": "A Permission Set",
                                "appGroupPermissionSetId": "dfa385109bc38",
                                "permissions": ["basic_access","publish_cards"]
                            }
                        ]
                    }
                ]
            }
        ],
        "appGroup": [
            {
                "appGroupId": "241adcd25789fabcded",
                "appGroupName": "Test Workspace",
                "appGroupPermissions": ["basic_access","send_campaigns_canvases"],
                "team": [
                    {
                         "teamId": "241adcd25789fabcded",
                         "teamName": "Test Team",
                         "teamPermissions": ["admin"]
                    }
                ]
            }
        ]
    }
}

Paramètres de réponse

Paramètre Type de données Description
schemas Tableau de chaînes de caractères Schéma utilisateur SCIM.
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 service 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éfini ; sinon au format 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 au format YYYY Mon DD, H:MM AM/PM.
permissions Objet Permissions de l’utilisateur au niveau de l’entreprise, de l’espace de travail, de l’équipe et du rôle. Consultez l’objet permissions.

États d’erreur

Si aucun utilisateur n’existe pour l’id de ressource fourni, l’endpoint renvoie :

1
2
3
4
5
6
7
8

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!