Skip to content

Buscar una cuenta de usuario existente en el panel por ID de recurso

get

/scim/v2/Users/{id}

Utiliza este endpoint para buscar una cuenta de usuario existente en el panel especificando el recurso id devuelto por el método SCIM POST.

See me in Postman

Requisitos previos

Para utilizar este endpoint, necesitarás un token SCIM. Utilizarás el origen 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
id Obligatorio Cadena El ID de recurso del usuario. Este parámetro lo devuelven los métodos POST /scim/v2/Users/ o GET /scim/v2/Users?filter=userName eq "[email protected]".

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/dfa245b7-24195aec-887bb3ad-602b3340' \
--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
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"]
                    }
                ]
            }
        ]
    }
}

Parámetros de respuesta

Parámetro Tipo de datos Descripción
schemas Matriz de cadenas Esquema de usuario SCIM.
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 se ha establecido.
createdAt Cadena Fecha en que se creó la cuenta de usuario. Devuelve N/A cuando no se ha establecido; de lo contrario, tiene el formato YYYY Mon DD, H:MM AM/PM.
lastSignInAt Cadena Fecha en 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 del usuario. Consulta el objeto de permisos.

Estados de error

Si no existe ningún usuario para el id de recurso proporcionado, el endpoint devuelve:

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!