Skip to content

Pesquise a conta de usuário existente do dashboard por e-mail

get

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

Use esse ponto de extremidade para procurar uma conta de usuário existente no dashboard especificando seu e-mail no parâmetro de consulta do filtro.

Observe que, quando o parâmetro de consulta estiver codificado em URL, ele terá a seguinte leitura:

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

See me in Postman

Pré-requisitos

Para usar esse endpoint, você precisará de um token SCIM. Você usará a origem de seu serviço como o cabeçalho X-Request-Origin. Para saber mais, consulte Provisionamento automatizado de usuários.

Limite de taxa

Esse endpoint tem um limite de frequência de 5.000 solicitações por dia, por empresa. Esse limite de frequência é compartilhado com os endpoints /scim/v2/Users/ PUT, GET, DELETE e POST, conforme documentado em Limites de frequência da API.

Parâmetros da jornada

Parâmetros de solicitação

1
2
3

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

Exemplo de solicitação

1
2
3
4

curl --location --request GET \ 'https://rest.iad-01.braze.com/scim/v2/Users?filter=userName%20eq%20%22[email protected]%22' \
--header 'Content-Type: application/json' \
--header 'X-Request-Origin: YOUR-REQUEST-ORIGIN-HERE' \
--header 'Authorization: Bearer YOUR-API-KEY-HERE' \

Resposta

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"]
                            }
                        ]
                    } 
                ]
            }
        }
    ]
}
Github   Editar esta página no GitHub
QUÃO ÚTIL FOI ESTA PÁGINA?
New Stuff!