콘텐츠로 이동

매핑 구성 추가



POST /api/v1/login_mapping/field/add

개요

이 워크스페이스의 로그인 속성에서 역할 집합으로의 매핑을 생성합니다.

호출 전 및 사용 단계

이 그룹은 현재 워크스페이스의 isSystem=false인 배포 플랜 사용자 지정 로그인 속성 매핑을 유지 관리합니다. ssoUUID로 ID 공급자를 바인딩하는 SAML 매핑, External/Inner 시스템 매핑과는 다릅니다. 실제 적용을 위해서는 워크스페이스에서 isOpenCustomMappingRule을 활성화해야 합니다. 사용자 지정 매핑에서 스위치를 구성하고 로그인 정책을 확인할 수 있습니다. 저장/삭제는 규칙만 변경하며, 기존 구성원의 역할을 즉시 변경하지 않고 기존 세션을 취소하지 않습니다. 이후 LDAP/OIDC 공유 로그인 흐름은 실제 userinfo에 따라 다시 매칭합니다.

매칭은 userinfo 최상위 속성을 사용합니다. 배열은 각 요소를 str(value)로 비교하고, 그 외 값은 Python 문자열 형식으로 비교하며, 필드와 값은 데이터베이스 등가 의미론(대소문자/정렬 규칙은 배포 데이터베이스에 따라 결정됨)을 사용합니다. 정규식/포함 또는 중첩 경로 추출은 수행하지 않습니다. ID 소스의 안정적인 문자열만 사용할 것을 권장합니다. 여러 매칭 규칙의 역할은 합집합으로 계산한 후 사용 가능한 역할을 필터링합니다. 워크스페이스 사용자 지정 스위치가 켜져 있으면 시스템 규칙보다 우선합니다. 매칭이 있으면 일반적으로 역할을 재설정하고, 매칭이 없으면 기존 연결이 지워질 수 있습니다. 기존 Owner 역할에는 보호 로직이 있습니다. 먼저 전용 테스트 ID로 실제 권한을 검증해야 하며, 이번 HTTP 성공만으로 다음 로그인 시 역할이 올바르다고 판단해서는 안 됩니다.

동일 워크스페이스에서 sourceField+sourceValue 조합에는 활성 사용자 지정 규칙을 하나만 허용합니다. 저장 성공 시 true만 반환하고 새 UUID를 직접 반환하지 않으므로, 이후 목록에서 소스 필드/소스 값으로 확인해야 합니다. 일부 유효하지 않은 역할이 필터링된 후에도 성공할 수 있으므로 targetValues와 roleInfos를 다시 읽어 확인해야 합니다. []는 비우기 명령이 아니며, 역할 레코드가 없으므로 404가 발생합니다. 모든 일치 레코드가 소프트 삭제된 역할인 경우 빈 집합이 저장될 수 있으므로 이를 사용 가능한 구성으로 간주해서는 안 됩니다.

요청 헤더

파라미터 이름 타입 필수 설명
DF-API-KEY string Y 워크스페이스의 OpenAPI 인증 자격 증명입니다.
예: <DF-API-KEY>
가져오기 또는 입력 방법: 대상 워크스페이스의 API Key 관리에서 해당 작업 권한이 있는 OpenAPI Key를 가져옵니다.

Body 요청 파라미터

파라미터 이름 타입 필수 설명
targetValues[*] string 단일 문자열이며 역할 표시 이름이 아닙니다. 배열 요소에는 일관된 강타입 제약이 없으며, 잘못된 형태는 500을 유발할 수 있으므로 객체나 중첩 배열을 제출하지 마세요.
예: general
가져오기 또는 입력 방법: 해당 워크스페이스에서 볼 수 있는 단일 역할 UUID 또는 시스템 역할 식별자를 사용합니다.
sourceField string Y 필수 문자열이며, 비어 있지 않고 대소문자가 실제 속성과 일치할 것을 권장합니다. 점 경로 탐색/와일드카드는 지원하지 않습니다. API 선언은 최대 256자이지만 현재 저장 컬럼은 128자이므로, 데이터베이스 오류를 방지하려면 128자 이하로 제한할 것을 권장합니다. 자동 trim은 수행되지 않습니다.
null 허용: False
최대 길이: 256
예: department
가져오기 또는 입력 방법: 배포 LDAP/OIDC ID 소스 관리자로부터 실제 userinfo 최상위 속성 이름을 가져오며, 성공적으로 로그인한 후의 계정 attributes와 대조할 수 있습니다.
sourceValue string Y 필수 문자열(최대 256자)이며, 원래 값을 정확히 입력할 것을 권장합니다. JSON 배열 텍스트나 정규식이 아닙니다. 빈 문자열은 현재 일괄적으로 거부되지 않으며, 매칭 여부는 실제 userinfo에 따라 달라집니다.
null 허용: False
최대 길이: 256
예: engineering
가져오기 또는 입력 방법: 해당 속성이 로그인 시 가지는 실제 값을 사용하며, 배열 속성인 경우 그중 한 요소의 문자열 값을 사용합니다.
targetValues array Y 필수 배열이며 비어 있지 않을 것을 권장합니다. 알 수 없거나 다른 워크스페이스의 역할은 필터링됩니다. 상태 0/2는 유지되며, 모두 존재하지 않거나 []이면 NotFoundRole이 발생합니다. 상태 2/삭제된 역할은 이후 로그인에서 유효한 권한을 얻지 못하므로, 저장된 true를 모든 역할이 적용되었다는 의미로 간주해서는 안 됩니다. 현재 워크스페이스의 사용자 지정 진입점에는 External 시스템 매핑의 Owner 금지가 적용되지 않으므로, 클라이언트는 실제 권한 부여 용도에 따라 대상 역할을 선택해야 합니다.
예: ["general"]
가져오기 또는 입력 방법: 대상 워크스페이스의 역할 목록에서 현재 사용 가능한 역할 UUID/시스템 역할 식별자를 선택합니다(예: general/readOnly 및 사용자 지정 role_).

요청 예시

curl --request POST 'https://openapi.guance.com/api/v1/login_mapping/field/add' \
  -H 'DF-API-KEY: <DF-API-KEY>' \
  -H 'Content-Type: application/json' \
  --data-raw '{"sourceField":"department","sourceValue":"engineering","targetValues":["general"]}'

응답

HTTP 200, application/json. 아래 예시는 직접 읽을 수 있는 주요 필드를 보여줍니다.

필드 타입 설명
content boolean 성공 시 true이며, 새 엔터티/UUID 또는 역할 목록은 없습니다. 다시 list로 확인하세요.
{
  "code": 200,
  "content": true,
  "errorCode": "",
  "message": "",
  "success": true,
  "traceId": "TRACE-EXAMPLE"
}

오류 응답

인증, 속도 제한 및 공통 요청 오류는 공통 오류 정의를 참조하세요.

HTTP 상태 errorCode 발생 조건 메시지 또는 응답 설명 처리 방법
406 ft.ParameterValidationFailed 요청 필드가 누락되었거나 필드 값이 선언된 검증 조건을 위반했습니다. 파라미터 파싱 실패 파라미터 위치, 필드 이름, 타입 및 값을 확인하세요.
400 ft.RequestJsonFormatError 요청 JSON 구문이 유효하지 않습니다. 요청 JSON 형식 오류 content.reason, line, column에 따라 JSON을 수정하세요.
400 ft.JsonFormatError Body 최상위가 JSON 객체가 아닙니다. 일부 json 파일 형식 오류 sourceField/sourceValue/targetValues 전체 객체를 제출하세요.
404 ft.SamlMappingFieldAlreadyExists 현재 워크스페이스의 사용자 지정 규칙에 동일한 sourceField+sourceValue 조합이 이미 있습니다(수정 시 자기 자신은 제외). 워크스페이스에 동일한 매핑 필드 이름과 필드 값이 이미 존재합니다. 조합을 변경하거나 기존 UUID를 수정하세요. 기존 오류 코드는 404이고 Saml 접두사를 포함하지만, 여전히 이 사용자 지정 그룹에 사용됩니다.
404 ft.NotFoundRole 대상/기존 매핑 역할 집합에 일치하는 가시 역할 레코드가 없습니다([] 포함). 단일 삭제 또는 일괄 삭제 감사에서 이전 역할을 분석할 때도 발생할 수 있습니다. 지정한 역할을 찾을 수 없거나 역할이 삭제되었습니다. 먼저 이 워크스페이스의 역할 목록과 매핑 목록에서 확인하세요. 알 수 없는 역할이 일부 섞여 있으면 필터링됩니다. 기존 빈/일치 없는 집합은 바로 삭제 가능하다고 가정할 수 없으며, 관리자가 복구한 후 처리해야 합니다.
500 ft.InternalServerError 매핑/역할/데이터베이스 저장 또는 데이터 형식 지정 중 처리되지 않은 예외가 발생했습니다. 내부 오류 먼저 목록에서 규칙이 저장되었는지와 최종 targetValues를 확인한 뒤 특정 필드에 대해 처리하고 traceId를 보존하세요.

문서 평가

이 페이지가 도움이 되었나요?