Skip to content

Buscar cuenta de usuario existente en el panel por correo electrónico

get

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

Usa este endpoint para buscar una cuenta de usuario del panel existente especificando su correo electrónico en el parámetro de consulta del filtro.

Ten en cuenta que cuando el parámetro de consulta está codificado en URL se leerá así:

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

See me in Postman

Requisitos previos

Para usar este endpoint, necesitarás un token SCIM. Utilizarás el Origin de tu servicio como encabezado X-Request-Origin. Para más información, consulta Aprovisionamiento automatizado de usuarios.

Límite de velocidad

Este endpoint tiene un límite de velocidad de 5000 solicitudes por día y empresa. Este límite de velocidad se comparte con los endpoints PUT, GET, DELETE y POST de /scim/v2/Users/, como se documenta en Límites de velocidad de la API.

Parámetros de ruta

Parámetro Obligatorio Tipo de datos Descripción
[email protected] Obligatorio Cadena El correo electrónico del usuario.

Parámetros de la solicitud

1
2
3

Content-Type: application/json
X-Request-Origin: YOUR-REQUEST-ORIGIN-HERE
Authorization: Bearer YOUR-REST-API-KEY

Ejemplo de solicitud

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-API-KEY-HERE' \

Respuesta

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

{
    "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",
            "lastSignInAt": "Thursday, January 1, 1970 12:00:00 AM",
            "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"]
                            }
                        ]
                    }
                ]
            }
        }
    ]
}
New Stuff!