Find bruger
Find bruger-id fra e-mail
POST/api/v1/users/resolve
Find det numeriske Auditply-bruger-id for en bruger i nøglens virksomhed. Id'et bruges i X-On-Behalf-Of-User på alle andre kald.
Scope: users:lookup
Kaldet kræver ingen handlende bruger — det er netop det, du bruger til at finde den — så X-On-Behalf-Of-User skal ikke sendes. E-mailen ligger i body og ikke i URL'en, så den ikke ender i access-logs.
Request body
| Felt | Type | Beskrivelse |
|---|---|---|
email | string | Brugerens e-mail. Mellemrum før og efter fjernes, og store/små bogstaver ignoreres |
Response-felter
| Felt | Type | Beskrivelse |
|---|---|---|
user_id | integer | Auditply-bruger-id |
name | string | Brugerens navn |
email | string | Brugerens e-mail, som den står i Auditply |
Fejl
| Kode | HTTP | Årsag |
|---|---|---|
USER_NOT_FOUND | 404 | Ingen bruger med e-mailen i nøglens virksomhed |
AMBIGUOUS_USER_EMAIL | 409 | Flere brugere i virksomheden har e-mails, der kun adskiller sig i store/små bogstaver |
VALIDATION_ERROR | 400 | Manglende email eller ukendte felter |
Kaldet kan gentages sikkert.
Eksempel
- curl
- JavaScript
- Python
curl -X POST https://auditply.dk/api/v1/users/resolve \
-H "X-API-Key: ap_live_..." \
-H "Content-Type: application/json" \
-d '{"email": "raadgiver@example.dk"}'
const res = await fetch("https://auditply.dk/api/v1/users/resolve", {
method: "POST",
headers: { "X-API-Key": apiKey, "Content-Type": "application/json" },
body: JSON.stringify({ email: "raadgiver@example.dk" }),
});
const { data } = await res.json();
response = requests.post(
"https://auditply.dk/api/v1/users/resolve",
headers={"X-API-Key": api_key},
json={"email": "raadgiver@example.dk"},
)
data = response.json()["data"]
200 OK
{
"data": {
"user_id": 42,
"name": "Rådgiver",
"email": "Raadgiver@example.dk"
}
}