Hop til hovedindhold

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​

FeltTypeBeskrivelse
emailstringBrugerens e-mail. Mellemrum før og efter fjernes, og store/små bogstaver ignoreres

Response-felter​

FeltTypeBeskrivelse
user_idintegerAuditply-bruger-id
namestringBrugerens navn
emailstringBrugerens e-mail, som den står i Auditply

Fejl​

KodeHTTPÅrsag
USER_NOT_FOUND404Ingen bruger med e-mailen i nøglens virksomhed
AMBIGUOUS_USER_EMAIL409Flere brugere i virksomheden har e-mails, der kun adskiller sig i store/små bogstaver
VALIDATION_ERROR400Manglende email eller ukendte felter

Kaldet kan gentages sikkert.

Eksempel​

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"}'
200 OK
{
"data": {
"user_id": 42,
"name": "Rådgiver",
"email": "Raadgiver@example.dk"
}
}