콘텐츠로 이동

SSO 구성 활성화/비활성화



POST /api/v1/sso/{sso_uuid}/set_disable

개요

SSO 공급자 로그인 구성을 활성화하거나 비활성화합니다.

호출 전 및 사용 단계

SSO 구성의 status만 업데이트합니다. true는 비활성화, false는 활성화이며, 모두 XML/OIDC/허용 목록/역할 매핑을 유지합니다. IdP에서 클라이언트를 삭제하거나 해당 계정을 수정하지 않습니다. 비활성화 후에는 더 이상 활성 로그인 진입점으로 사용되지 않습니다. 비동기 워크스페이스/멤버 캐시 새로 고침으로 인해 기존 SSO ID의 후속 액세스가 더 이상 통과하지 않을 수 있으므로, ‘새 로그인만 차단하고 기존 세션은 전혀 영향을 받지 않는다’고 간주해서는 안 됩니다.

다시 활성화해도 XML, 디스커버리 문서, 클라이언트 secret, 기본 역할 또는 모든 매핑의 일치 여부를 다시 검증하지 않습니다. status=0은 실제 로그인이 복구되었음을 증명하지 않으므로 테스트 ID로 실제 프로세스를 거쳐 검증해야 합니다. 인터페이스 자체는 해당 로그인을 수행하지 않습니다. 이 페이지에는 needNotify 파라미터가 없으며, 컨트롤러가 성공할 때마다 워크스페이스 Owner/관리자에게 알림을 시도하고 감사합니다. create/modify의 알림 스위치를 그대로 적용해서는 안 됩니다.

상태를 먼저 커밋한 후 캐시 작업을 디스패치하므로 비동기 작업이 완료되지 않으면 일시적인 불일치가 있을 수 있습니다. 디스패치 예외 시 500이 발생할 수 있지만 상태는 이미 변경되었으므로 먼저 get으로 다시 읽어야 합니다. 메일 helper는 실패를 기록하고 예외를 삼키며, 이로 인해 상태를 롤백하지 않습니다.

라우트 파라미터

파라미터 이름 유형 필수 설명
sso_uuid string Y 현재 공급자 UUID이며 fdmp_ 매핑, IdP 다이제스트 또는 클라이언트 ID가 아닙니다.
예: sso_example
가져오기 또는 입력 방법: 현재 워크스페이스의 SSO 목록 content[].uuid에서 삭제되지 않은 구성을 가져옵니다.

요청 헤더

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

Body 요청 파라미터

파라미터 이름 유형 필수 설명
isDisable boolean Y 필수 Boolean이며 status=2/0으로 변경합니다. isOpenSAMLMapping 또는 그 안의 매핑 행은 변경하지 않습니다.
null 허용: False
예: true
가져오기 또는 입력 방법: true는 공급자를 비활성화하고 false는 활성화합니다.

요청 예시

curl --request POST 'https://openapi.guance.com/api/v1/sso/sso_example/set_disable' \
  -H 'DF-API-KEY: <DF-API-KEY>' \
  -H 'Content-Type: application/json' \
  --data-raw '{"isDisable":true}'

응답

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

필드 유형 설명
content.name string 처리된 공급자의 표시 이름이며, 이름이 비어 있으면 빈 문자열일 수 있습니다.
content.declaration object 공통 선언.
{
  "code": 200,
  "content": {
    "name": "ExampleIdP",
    "declaration": {}
  },
  "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 파일 형식 오류 isDisable Boolean이 포함된 객체를 제출하세요.
406 ft.NotFoundSAML UUID가 현재 워크스페이스의 삭제되지 않은 SSO 구성에 속하지 않습니다 sso 구성을 찾을 수 없습니다 SSO 목록에서 sso_ UUID를 다시 가져오며, fdmp_ 매핑 또는 idpMd5를 사용하지 않습니다.
500 ft.InternalServerError 데이터베이스/연관 정리 또는 커밋 후 워크스페이스/멤버 캐시 작업 디스패치가 실패했습니다 내부 오류 먼저 get/list로 status와 연관 관계를 확인하세요. 멤버 정리가 이미 배치로 커밋되었을 수 있습니다. traceId를 보존하고, 오류를 구성이 전혀 변경되지 않은 것으로 간주해서는 안 됩니다.

문서 평가

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