일괄 사용자 삭제 결과 목록
GET /v1/jobs/user-deletions/{job_id}/results · 권한 users:delete
일괄 사용자 삭제 작업에서 각 사용자의 결과를 요청 순서대로 나열합니다(position은 1부터 시작합니다). 각 결과는 다음 중 하나입니다.
pending: 사용자에게 아직 결과가 없습니다.succeeded: 사용자의 삭제가 시작되었습니다.deletion_id는 해당 사용자에 대해DELETE /v1/users/{user_id}가 반환하는 것과 같은 ID입니다.not_found: 사용자가 이 환경에 없거나 이미 삭제되었습니다.failed: 여러 번 시도한 뒤 삭제에 실패했습니다.error_code는internal입니다. 해당 사용자를 개별적으로 또는 새 작업에서 다시 삭제하십시오.
결과에는 사용자 ID만 포함되며, 다른 개인정보는 반환되지 않습니다. 목록은 앞으로만 넘길 수 있습니다. 다음 페이지는 list_metadata.after를 사용하십시오. before와 order는 지원되지 않습니다.
요청
| 매개변수 | 위치 | 필수 | 설명 |
|---|---|---|---|
job_id |
path | 예 | 작업 ID, job_ 접두사가 붙습니다. |
limit |
query | 아니요 | 페이지 크기, 1에서 100. 기본값 20. |
after |
query | 아니요 | list_metadata.after에서 얻은 불투명 커서. 같은 작업에서만 유효합니다. |
응답
200 OK. list_metadata.after는 다음 페이지의 커서입니다(마지막 페이지에서는 null). list_metadata.before는 항상 null입니다.
{
"data": [
{
"position": 1,
"user_id": "usr_01h455vb4pex5vsknk084sn02q",
"status": "succeeded",
"deletion_id": "0191f0a0-0000-8000-8000-000000000001"
},
{
"position": 2,
"user_id": "usr_01h455vb4pex5vsknk084sn02r",
"status": "not_found"
}
],
"list_metadata": { "before": null, "after": null }
}
오류
모든 오류는 안정적인 code를 담은 application/problem+json 본문입니다.
| HTTP | code |
언제 |
|---|---|---|
| 400 | invalid_cursor |
커서가 잘못되었거나 만료되었거나 다른 작업에 속합니다. |
| 401 | unauthenticated |
API 키가 없거나 잘못되었거나 폐기되었습니다. |
| 403 | insufficient_permissions |
키에 users:delete 권한이 없습니다. |
| 404 | not_found |
이 환경에 작업이 없습니다(또는 ID 형식이 잘못되었습니다). |
| 422 | validation_failed |
limit이 범위를 벗어났거나, before 또는 order가 전송되었습니다(not_supported). |
| 429 | rate_limited |
요청 한도를 초과했습니다. Retry-After를 따르십시오. |
| 503 | service_unavailable |
의존 서비스를 일시적으로 사용할 수 없습니다. 나중에 다시 시도하십시오. |
예제
curl "https://api.eu.keenauth.com/v1/jobs/user-deletions/job_01h455vb4pex5vsknk084sn02q/results?limit=100" \
-H "Authorization: Bearer $KEENAUTH_SECRET_KEY"
CLI: keenauth jobs user-deletions results job_01h455vb4pex5vsknk084sn02q --limit 100