Dizin kullanıcılarını listeleyin

GET /v1/directories/{directory_id}/users · izin directories:read

Kimlik sağlayıcının dizine sağladığı canlı kullanıcı kayıtlarını kimliğe göre sıralı olarak listeler: normalleştirilmiş öznitelikleri, kullanıcının dizin grupları, ortam kullanıcısına bağlantısı ve sapma işaretini içerir. Silinmiş kayıtlar döndürülmez. state ve group_id filtreleri birlikte kullanılabilir. Yalnızca ileri sayfalama vardır; imleç dizine ve filtrelere bağlıdır.

users:read_pii izni olmadan kimlik bilgisi, maskelenmiş kişisel veriler alır: user_name ilk karakteri ve *** olarak, emails[].value a***@e***.com olarak, given_name, family_name ve display_name baş harfler olarak, attributes ise null olarak döner. external_id, locale, zoneinfo, gruplar ve kimlikler hiçbir zaman maskelenmez. Gizli anahtar tüm izinleri taşır.

İstek

Alan Tür Zorunlu Açıklama
directory_id yol evet SCIM dizin kimliği (dir_…).
state sorgu hayır Yalnızca bu durumdaki kullanıcılar: active, inactive veya held (toplu hesap kaldırma beklemesinde).
group_id sorgu hayır Yalnızca bu dizin grubunun (dsg_…) üyeleri; başka bir dizinin grubu boş bir sayfa döndürür.
limit sorgu hayır 1–100, varsayılan 20.
after sorgu hayır list_metadata.after değerinden gelen imleç.

İstek gövdesi yoktur.

Yanıt

Dizin kullanıcılarından oluşan bir sayfa içeren 200 OK.

{
  "data": [
    {
      "id": "dsu_01j9xp4q6r8s0t2v4w6x8y0z2b",
      "directory_id": "dir_01j9xm2n4p6q8r0s2t4v6w8y0z",
      "external_id": "00u1a2b3c4",
      "user_name": "jane@example.com",
      "emails": [{ "value": "jane@example.com", "primary": true }],
      "given_name": "Jane",
      "family_name": "Doe",
      "display_name": "Jane Doe",
      "locale": "en-US",
      "zoneinfo": "Europe/Berlin",
      "state": "active",
      "attributes": { "department": "Engineering" },
      "groups": [{ "id": "dsg_01j9xn3p5q7r9s1t3v5w7x9y1a", "name": "Engineering" }],
      "user_id": "usr_01j9xq5r7s9t1v3w5x7y9z1a3c",
      "link_status": "linked",
      "drift": false,
      "created_at": "2026-10-20T09:00:00Z",
      "updated_at": "2026-10-20T09:05:00Z"
    }
  ],
  "list_metadata": {
    "before": null,
    "after": null
  }
}

link_status değeri linked, invited, blocked_other_org, duplicate, mirror_only veya unlinked olabilir; kayıt bağlı değilse user_id null olur. Boş değerler null olarak gösterilir.

Hatalar

HTTP code Ne zaman
400 invalid_cursor İmleç geçersiz veya başka bir dizine ya da filtreye ait.
404 not_found Dizin bu ortamda mevcut değil.
422 validation_failed state veya group_id geçersiz ya da tekrarlanmış, limit aralık dışında veya before ya da order verilmiş (unsupported).
401 unauthenticated Kimlik bilgisi eksik, geçersiz veya iptal edilmiş.
403 insufficient_permissions Kimlik bilgisinin gerekli izni yok.
429 rate_limited Hız sınırı aşıldı; Retry-After süresinden sonra yeniden deneyin.
503 service_unavailable Dizin senkronizasyonu geçici olarak kullanılamıyor veya bu dağıtımda yapılandırılmamış; Retry-After süresinden sonra yeniden deneyin.

Örnek

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

Kişisel veriler

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