Ir para o conteúdo

Esta página foi traduzida automaticamente e pode conter imprecisões. Para relatar um erro de tradução, use o componente de feedback na parte inferior do sumário, à direita da página.

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

get

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

Use esse endpoint para procurar uma conta de usuário existente no dashboard especificando o 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

Importante

Esse endpoint exige a integração SCIM personalizada. Se você configurou uma integração de provedor de identidade (IdP) (Okta ou Entra ID), não é possível usar esse endpoint; apenas uma ponte SCIM pode ser configurada por empresa.

Pré-requisitos

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

Limite de frequência

Esse endpoint tem um limite de frequência de 20.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 de consulta

Parâmetro	Obrigatório	Tipo de dados	Descrição
`filter`	Obrigatório	String	Expressão de filtro SCIM para pesquisar por e-mail. A Braze suporta apenas `userName eq "[email protected]"`. O valor do e-mail deve estar entre aspas duplas.

Importante

A Braze suporta apenas filtros de correspondência exata em userName usando o operador eq. Outros campos ou operadores de filtro SCIM retornam uma resposta 400.

Parâmetros de solicitação

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

Nota

Se você receber uma resposta 401, confirme se está usando um token SCIM (não uma chave da API REST), se o X-Request-Origin corresponde à origem do seu serviço e se o seu endereço IP está na lista de permissões SCIM. Para saber mais, consulte Provisionamento automatizado de usuários.

Exemplo de solicitação

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

Resposta

{
    "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 resposta

Parâmetro	Tipo de dados	Descrição
`schemas`	Array de strings	Esquema de resposta de lista SCIM.
`totalResults`	Inteiro	Número de usuários do dashboard correspondentes (0 se não houver correspondência).
`Resources`	Array	Array de objetos de usuário. Cada objeto usa os mesmos campos que GET: Consultar conta de usuário existente do dashboard.

Campos do objeto de usuário

Parâmetro	Tipo de dados	Descrição
`id`	String	O ID de recurso do usuário.
`userName`	String	O endereço de e-mail do usuário.
`name`	Objeto	Contém `givenName` e `familyName`.
`department`	String	O departamento do usuário, se definido.
`createdAt`	String	Quando a conta do usuário foi criada. Retorna `N/A` quando não definido; caso contrário, no formato `YYYY Mon DD, H:MM AM/PM`.
`lastSignInAt`	String	Quando o usuário fez login pela última vez. Retorna `N/A` se o usuário nunca fez login; caso contrário, no formato `YYYY Mon DD, H:MM AM/PM`.
`permissions`	Objeto	Permissões de empresa, espaço de trabalho, equipe e função. Consulte o objeto de permissões.

Estados de erro

Se o parâmetro filter estiver ausente ou malformado, o endpoint retornará:

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!