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 consulta

Parámetro Obligatorio Tipo de datos Descripción
filter Obligatorio Cadena Expresión de filtro SCIM para buscar por correo electrónico. Braze solo admite userName eq "[email protected]". El valor del correo electrónico debe estar entre comillas dobles.

Parámetros de la solicitud

1
2
3

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

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-SCIM-TOKEN-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
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"]
                            }
                        ]
                    }
                ]
            }
        }
    ]
}

Parámetros de respuesta

Parámetro Tipo de datos Descripción
schemas Matriz de cadenas Esquema de respuesta de lista SCIM.
totalResults Entero Número de usuarios del panel coincidentes (0 si no hay coincidencias).
Resources Matriz Matriz de objetos de usuario. Cada objeto utiliza los mismos campos que GET: Buscar una cuenta de usuario existente en el panel.

Campos del objeto de usuario

Parámetro Tipo de datos Descripción
id Cadena El ID de recurso del usuario.
userName Cadena La dirección de correo electrónico del usuario.
name Objeto Contiene givenName y familyName.
department Cadena El departamento del usuario, si está configurado.
createdAt Cadena Fecha en la que se creó la cuenta de usuario. Devuelve N/A cuando no está configurado; de lo contrario, tiene el formato YYYY Mon DD, H:MM AM/PM.
lastSignInAt Cadena Fecha en la que el usuario inició sesión por última vez. Devuelve N/A si el usuario no ha iniciado sesión; de lo contrario, tiene el formato YYYY Mon DD, H:MM AM/PM.
permissions Objeto Permisos de empresa, espacio de trabajo, equipo y rol. Consulta el objeto de permisos.

Estados de error

Si el parámetro filter no se incluye o tiene un formato incorrecto, el endpoint devuelve:

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!