디렉터리 수정

PATCH /v1/directories/{directory_id} · 권한 directories:write

JSON 병합 패치(RFC 7396, Content-Type: application/merge-patch+json)로 디렉터리 이름과 프로비저닝 설정을 수정합니다. If-Match는 필수이며, 현재 값은 GET /v1/directories/{directory_id}의 ETag 헤더입니다. 어떤 필드도 null을 받지 않습니다. 변경 사항이 없는 패치는 아무것도 쓰지 않고 버전을 유지합니다. 쓰기 작업은 directory.updated로 감사되며, 변경된 설정 각각의 이전 값과 새 값을 함께 기록합니다.

요청

필드 유형 필수 설명
directory_id 경로 예 SCIM 디렉터리 ID(dir_…).
If-Match 헤더 예 디렉터리의 현재 ETag.
name 문자열 아니요 1–64자, 제어 문자 없이, 앞뒤 공백 없이.
provisioning_mode 문자열 아니요 user_store(환경 사용자, 조직 멤버십, 그룹 역할도 함께 기록) 또는 mirror(디렉터리 레코드만 보관).
attribute_allowlist 배열 아니요 저장할 선택 SCIM 속성, 중복 없이: title, usertype, phonenumbers와 엔터프라이즈 확장의 employeenumber, department, division, costcenter, organization, manager(전체 이름 urn:ietf:params:scim:schemas:extension:enterprise:2.0:user:).
unverified_domain_action 문자열 아니요 이메일 도메인이 인증되지 않은 사용자: invite(초대된 멤버십) 또는 mirror_only(디렉터리 레코드만).
delete_action 문자열 아니요 SCIM DELETE /Users: remove_membership 또는 delete_user(디렉터리가 관리하는 사용자를 삭제).
on_delete_memberships 문자열 아니요 디렉터리를 삭제할 때 이 디렉터리에서 생긴 멤버십의 처리: keep, suspend 또는 remove.
mass_deprovision_guard 객체 아니요 enabled(불리언), percent(5–50), absolute_min(10–1000): 5분 안에 두 임계값을 모두 넘는 프로비저닝 해제는 승인 때까지 보류됩니다.
send_welcome_email 불리언 아니요 새 디렉터리 사용자에게 계정 활성화 이메일을 보낼지 여부.

응답

새 ETag와 함께 디렉터리를 담은 200 OK.

{
  "id": "dir_01j9xm2n4p6q8r0s2t4v6w8y0z",
  "organization_id": "org_01j9xk3m7q8r2s4t6v8w0y2z4a",
  "type": "scim",
  "name": "Okta EU",
  "state": "active",
  "base_url": "https://acme.eu.keenauth.app/scim/v2/dir_01j9xm2n4p6q8r0s2t4v6w8y0z",
  "created_at": "2026-10-19T09:31:00.123456Z",
  "last_request_at": null,
  "provisioning_mode": "user_store",
  "attribute_allowlist": ["title", "urn:ietf:params:scim:schemas:extension:enterprise:2.0:user:department"],
  "unverified_domain_action": "invite",
  "delete_action": "remove_membership",
  "on_delete_memberships": "keep",
  "mass_deprovision_guard": {"enabled": true, "percent": 20, "absolute_min": 25},
  "send_welcome_email": false
}

오류

HTTP code 발생 조건
400 malformed_request 본문이 JSON 객체가 아닙니다.
400 unknown_field 패치에 쓸 수 없는 필드가 있습니다(예: state).
404 not_found 이 환경에 디렉터리가 없습니다.
409 conflict 디렉터리에 사용자 레코드가 있는 동안 provisioning_mode를 바꾸거나, 디렉터리가 삭제 중입니다.
412 precondition_failed If-Match가 현재 버전과 일치하지 않습니다.
415 unsupported_media_type Content-Type이 application/merge-patch+json이 아닙니다.
422 validation_failed 필드가 null이거나 잘못되었습니다. 오류에 필드가 표시됩니다(예: /mass_deprovision_guard/percent invalid).
428 precondition_required If-Match가 없습니다.
401 unauthenticated 자격 증명이 없거나, 잘못되었거나, 폐기되었습니다.
403 insufficient_permissions 자격 증명에 필요한 권한이 없습니다.
429 rate_limited 속도 제한을 초과했습니다. Retry-After 시간 후에 다시 시도하세요.
503 service_unavailable 디렉터리 동기화를 일시적으로 사용할 수 없거나 이 배포에서 구성되지 않았습니다. Retry-After 시간 후에 다시 시도하세요.

예시

curl -i -X PATCH "https://api.eu.keenauth.com/v1/directories/dir_01j9xm2n4p6q8r0s2t4v6w8y0z" \
  -H "Authorization: Bearer $KEENAUTH_SECRET_KEY" \
  -H 'If-Match: "3"' \
  -H "Content-Type: application/merge-patch+json" \
  -d '{"name":"Okta EU","mass_deprovision_guard":{"percent":20}}'