Kullanıcıları listele

GET /v1/users · izin users:read

Ortamdaki kullanıcıları imleç tabanlı sayfalama ile listeler; varsayılan olarak en yenisi önce gelir. Burada yalnızca kişisel veri içermeyen filtreler kabul edilir. Kullanıcıları e-posta adresi, telefon numarası veya kullanıcı adına göre aramak için Kullanıcıları ara bölümünü kullanın.

İstek

Parametre Konum Zorunlu Açıklama
limit query hayır Sayfa boyutu, 1 ile 100 arası. Varsayılan 20.
after query hayır list_metadata.after değerinden gelen opak imleç. before ile birlikte kullanılamaz.
before query hayır list_metadata.before değerinden gelen opak imleç. after ile birlikte kullanılamaz.
order query hayır Oluşturulma zamanına göre asc veya desc. Varsayılan desc.
status query hayır active, blocked veya pending_deletion.
external_id query hayır Sizin kendi tanımlayıcınızla tam eşleşme.
created_after query hayır RFC 3339 zamanı; bu zamandan sonra oluşturulan kullanıcılar.
created_before query hayır RFC 3339 zamanı; bu zamandan önce oluşturulan kullanıcılar.

İmleç yalnızca üretildiği filtre ve sıralama ile geçerlidir; aksi halde istek invalid_cursor hatasıyla başarısız olur.

Yanıt

200 OK. data alanı sayfadaki kullanıcıları içerir; list_metadata.before ve list_metadata.after önceki ve sonraki sayfanın imleçleridir (yoksa null). Toplam sayı döndürülmez.

Anahtarda users:read_pii izni yoksa kişisel veriler maskelenir: email değeri a***@e***.com olur, phone_number yalnızca son 2 hanesini korur (+**********67), name, given_name, family_name, middle_name ve nickname alanları baş harflere dönüşür (A. L.), username yalnızca ilk karakterini korur (a***), birthdate değeri ****-**-** olur ve address alanı {"redacted": true} olur. user_metadata ve app_metadata maskelenmez.

{
  "data": [ {
    "id": "usr_0a1b2c3d4e5f6g7h8j9k0m1n2p",
    "kind": "regular",
    "status": "active",
    "external_id": null,
    "username": null,
    "name": "Ada Lovelace",
    "email": "ada@example.com",
    "email_verified": true,
    "phone_number": null,
    "phone_verified": false,
    "user_metadata": {},
    "app_metadata": {},
    "created_via": "admin_api",
    "created_at": "2026-01-15T09:30:00Z",
    "updated_at": "2026-01-15T09:30:00Z",
    "last_sign_in_at": null,
    "deletion_requested_at": null,
    "deletion_due_at": null
  } ],
  "list_metadata": { "before": null, "after": "<opaque cursor>" }
}

Hatalar

Her hata, kararlı bir code değeri içeren bir application/problem+json gövdesidir.

HTTP code Ne zaman
400 invalid_cursor İmleç bozuksa, değiştirilmişse veya başka filtreler için üretilmişse.
422 validation_failed Bir sorgu parametresi geçersizse (limit aralık dışında, hatalı zaman damgası, tekrarlanan parametre).
401 unauthenticated API anahtarı eksik, geçersiz veya iptal edilmişse.
403 insufficient_permissions Anahtarda users:read izni yoksa.
429 rate_limited Hız sınırı aşılmışsa; Retry-After değerine uyun.
503 service_unavailable Bir bağımlılık geçici olarak kullanılamıyorsa; daha sonra yeniden deneyin.

Örnek

curl "https://api.eu.keenauth.com/v1/users?limit=20&status=active" \
  -H "Authorization: Bearer $KEENAUTH_SECRET_KEY"

Kişisel veriler

Bu uç nokta kişisel veri içerir: son kullanıcı profili. KeenAuth API'lerinde kişisel veriler bölümünde neyin saklandığı, ne kadar süre tutulduğu ve nasıl silindiği açıklanır. Hiçbir alanda özel nitelikli kişisel verileri (sağlık, biyometrik veriler, din, siyasi görüşler, cinsel yönelim) göndermeyin.