SSO 사용자 정의 매핑 규칙 일괄 삭제¶
POST /api/v1/login_mapping/field/batch_delete
개요¶
현재 워크스페이스의 사용자 정의 로그인 매핑 규칙을 일괄 삭제합니다.
호출 전 및 사용 단계¶
이 그룹은 현재 워크스페이스의 isSystem=false인 배포 플랜 사용자 정의 로그인 속성 매핑을 유지 관리하며, ssoUUID로 ID 공급자를 바인딩하는 SAML 매핑 및 External/Inner 시스템 매핑과는 다릅니다. 실제 적용을 위해서는 워크스페이스에서 isOpenCustomMappingRule을 활성화해야 하며, 사용자 정의 매핑에서 스위치를 구성하고 로그인 정책을 확인할 수 있습니다. 저장/삭제는 규칙만 변경하며 기존 구성원의 역할을 즉시 변경하지 않고 기존 세션을 취소하지 않습니다. 이후 LDAP/OIDC 공유 로그인 흐름은 실제 userinfo를 기준으로 다시 매칭합니다.
매칭은 userinfo 최상위 속성을 사용합니다. 배열은 각 요소를 str(value)로 비교하고, 그 외 값은 Python 문자열 형식으로 비교하며, 필드와 값은 데이터베이스 동등성 의미론을 사용합니다(대소문자/정렬 규칙은 배포 데이터베이스에 따름). 정규식/포함 관계 또는 중첩 경로 추출은 수행하지 않습니다. ID 소스의 안정적인 문자열만 사용할 것을 권장합니다. 여러 매칭 규칙의 역할은 합집합을 취한 후 사용 가능한 역할을 필터링합니다. 워크스페이스 사용자 정의 스위치가 켜져 있으면 시스템 규칙보다 우선합니다. 매칭이 있으면 일반적으로 역할을 재설정하고, 매칭이 없으면 기존 연결이 비워질 수 있습니다. 기존 Owner 역할에는 보호 로직이 있습니다. 먼저 전용 테스트 ID로 실제 권한을 검증해야 하며, 이번 HTTP 성공만으로 다음 로그인 시 역할이 올바르다고 판단해서는 안 됩니다.
매핑 설정을 소프트 삭제하며, 대상 역할이나 계정을 삭제하지 않고 구성원이 이미 보유한 역할/세션을 즉시 취소하지 않습니다. 이후 로그인 시 사용자 정의 스위치가 켜져 있고 매칭이 없으면 기존 역할 관계가 비워질 수 있으므로, 삭제는 ‘향후 로그인 권한을 그대로 유지’하는 것이 아닙니다. 일괄 처리는 삭제되지 않은 항목 중 매칭된 집합만 처리하며 일부 유효하지 않은 UUID는 무시합니다. 그러나 비어 있거나 모두 미매칭이거나 모든 기존 대상 역할에 조회 가능한 레코드가 없으면 NotFoundRole이 발생하며, true를 항목별 삭제 수로 간주해서는 안 됩니다. 타임아웃/오류 후에는 먼저 목록에서 최종 레코드 상태를 확인한 후 재시도를 결정하십시오.
요청 헤더¶
| 파라미터 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
| DF-API-KEY | string | Y | 워크스페이스의 OpenAPI 인증 자격 증명입니다. 예: <DF-API-KEY>획득 또는 입력 방법: 대상 워크스페이스의 API Key 관리에서 해당 작업 권한이 있는 OpenAPI Key를 획득합니다. |
Body 요청 파라미터¶
| 파라미터 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
| lgmpUUIDs[*] | string | 이전 YAML 예시 fdmp_는 이 그룹에 적용되지 않으므로 SAML 매핑 접두사를 그대로 사용하지 마십시오. 예: lgmp_example획득 또는 입력 방법: 단일 lgmp_ 매핑 uuid를 가져옵니다. |
|
| lgmpUUIDs | array | Y | 필수 배열이며 비어 있지 않을 것을 권장합니다. 현재 워크스페이스의 isSystem=false이고 삭제되지 않은 매칭 항목만 처리하며, 항목별 미매칭을 보고하지 않습니다. 비어 있거나 모두 미매칭이면 기존 역할 요약 검증에서 NotFoundRole이 발생하며, 멱등적인 true가 아닙니다. 예: ["lgmp_example"]획득 또는 입력 방법: 현재 워크스페이스의 사용자 정의 매핑 목록에서 여러 lgmp_ UUID를 가져옵니다. |
요청 예시¶
curl --request POST 'https://openapi.guance.com/api/v1/login_mapping/field/batch_delete' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json' \
--data-raw '{"lgmpUUIDs":["lgmp_example"]}'
응답¶
HTTP 200, application/json. 아래 예시는 바로 읽을 수 있는 주요 필드를 보여줍니다.
| 필드 | 유형 | 설명 |
|---|---|---|
| content | boolean | 성공 시 true이며 삭제 건수는 반환하지 않습니다. |
{
"code": 200,
"content": true,
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
오류 응답¶
인증, 속도 제한 및 공통 요청 오류는 공통 오류 정의를 참조하십시오.
| HTTP 상태 | errorCode | 발생 조건 | 메시지 또는 응답 설명 | 처리 방법 |
|---|---|---|---|---|
| 404 | ft.NotFoundRole | 대상/기존 매핑 역할 집합에 일치하는 조회 가능한 역할 레코드가 하나도 없습니다(빈 배열 [] 포함). 단건 삭제 또는 일괄 삭제 감사에서 기존 역할을 파싱할 때도 발생할 수 있습니다. | 지정한 역할을 찾을 수 없거나 역할이 이미 삭제되었습니다. | 먼저 현재 워크스페이스의 역할 목록과 매핑 목록에서 확인하십시오. 알 수 없는 역할이 일부 섞여 있으면 필터링됩니다. 기존의 비어 있거나 매칭되지 않는 집합은 삭제 가능하다고 직접 가정할 수 없으며, 관리자가 수정한 후 처리해야 합니다. |
| 500 | ft.InternalServerError | 매핑/역할/데이터베이스 저장 또는 데이터 형식 지정 중 처리되지 않은 예외가 발생했습니다. | 내부 오류 | 먼저 목록에서 규칙이 저장되었는지와 최종 targetValues를 확인한 후, 특정 필드에 대해 처리하고 traceId를 보관하십시오. |
| 406 | ft.ParameterValidationFailed | 요청 필드가 누락되었거나 필드 값이 선언된 검증 조건을 위반했습니다. | 파라미터 파싱 실패 | 파라미터 위치, 필드 이름, 유형 및 값을 확인하십시오. |
| 400 | ft.RequestJsonFormatError | 요청 JSON 구문이 유효하지 않습니다. | 요청 JSON 형식 오류 | content.reason, line, column에 따라 JSON을 수정하십시오. |
| 400 | ft.JsonFormatError | Body가 객체가 아닙니다. | 일부 json 파일 형식 오류 | lgmpUUIDs 배열이 포함된 객체를 제출하십시오. |