조직 역할 업데이트

PATCH /fapi/v1/organizations/{org_id}/roles/{role_id} · 환경의 로그인 호스트에서 호출

조직 역할의 이름이나 설명을 변경합니다(JSON merge patch, RFC 7396). 환경 역할은 여기서 변경할 수 없습니다. 인증된 사용자의 __Host-idp_session 쿠키가 필요합니다. 쿠키가 없거나, 만료되었거나, 취소된 경우 401 unauthenticated를 반환합니다. 다른 출처의 자사 애플리케이션은 대신 프론트 API 액세스 토큰(DPoP 증명을 포함한 Authorization: DPoP <token>, 프론트 API 액세스 토큰 참조)을 보낼 수 있습니다. 사용자는 조직의 활성 구성원이어야 하며 idp_roles:manage 권한이 있어야 합니다. 구성원이 아닌 사용자는 404 not_found를 받으므로 조직의 존재 여부가 드러나지 않습니다. 권한이 없는 구성원은 403 insufficient_permissions를 받습니다. 조직 역할은 환경에서 활성화되어 있고 해당 요금제에 포함되어 있어야 합니다.

요청

헤더:

헤더 필수 설명
Idp-Client 예 SDK 식별자입니다.
Origin 예 정확히 https://<sign-in host>와 같아야 합니다.
Content-Type 본문이 있을 때 application/json 또는 application/merge-patch+json입니다.
If-Match 아니요 마지막으로 읽은 역할의 "<version>"입니다. 그 이후 역할이 변경되었다면 412 precondition_failed를 반환하며 아무것도 변경되지 않습니다.

org_id: 조직 식별자(org_…). role_id: 역할 식별자(rol_…).

본문(최소 한 개의 필드 필요):

필드 필수 설명
name 아니요 새 표시 이름입니다.
description 아니요 새 설명입니다.

응답

200 OK와 새 ETag를 반환합니다. 본문은 역할입니다(조직 역할 조회 참조).

오류

상태 코드 발생 시점
401 unauthenticated 유효한 세션 쿠키가 없습니다.
403 origin_not_allowed Origin이 없거나 잘못되었습니다.
403 insufficient_permissions 사용자에게 조직의 idp_roles:manage 권한이 없습니다.
403 plan_feature_unavailable 환경의 요금제에 조직 역할이 포함되어 있지 않습니다(feature, required_plan).
403 org_custom_roles_disabled 환경에서 조직 역할이 꺼져 있습니다.
403 role_not_assignable 역할이 사용자가 가지고 있지 않은 권한을 부여하거나, 사용자 자신의 구성원 자격에 해당 권한이 포함되어 있습니다.
404 not_found 이 사용자에게 해당 조직 또는 조직 역할이 없습니다. 환경 역할, 알 수 없거나 형식이 잘못되었거나 다른 식별자도 같은 응답을 받습니다.
409 organization_pending_deletion 조직이 삭제 예정입니다.
412 precondition_failed If-Match가 현재 버전과 일치하지 않거나, 요청 처리 중 역할이 변경되었습니다.
422 validation_failed 필드가 잘못되었거나 패치가 비어 있습니다(empty_patch).
503 service_unavailable 일시적으로 사용할 수 없습니다. Retry-After 이후 다시 시도하십시오.

예시

curl -X PATCH https://example.keenauth.app/fapi/v1/organizations/org_01jbz6x8kq3m2n4p5r6s7t8v9a/roles/rol_01jbz6x8kq3m2n4p5r6s7t8v9w \
  -H "Idp-Client: my-app/1.0.0 (node/22.0.0)" \
  -H "Origin: https://example.keenauth.app" \
  -H "Content-Type: application/merge-patch+json" \
  -H 'If-Match: "1"' \
  -b cookies.txt \
  -d '{"name":"Auditors"}'