SSO 구성 목록 조회¶
GET /api/v1/sso/list
개요¶
현재 워크스페이스의 SSO 공급자 및 연결된 멤버 수를 조회합니다.
호출 전 준비 및 사용 단계¶
현재 워크스페이스의 삭제되지 않은 공급자 배열을 updateAt 내림차순으로 반환하며, 페이지네이션은 적용되지 않습니다. saml/oidc로 필터링할 수 있습니다. 이 공개 route는 항상 멤버 수 집계가 활성화되어 있으며 showMemberCount를 전달하여 재정의할 수 없습니다. memberCount는 현재 워크스페이스 활성 관계에 있는 삭제되지 않은 계정 네임스페이스를 기준으로 집계되며, 최근 로그인 수, 온라인 인원 수 또는 현재 매핑에서 허용된 전체 인원 수를 의미하지 않습니다.
목록은 의도적으로 uploadData/config를 반환하지 않으며, 목록에서 clientSecret 또는 전체 XML을 읽지 않습니다. 상세 정보를 사용하십시오. updatorInfo는 현재 사용 가능한 ID 요약이며, 계정, API Key 또는 시스템/AI ID일 수 있고, 누락 시 {}입니다. 그중 email을 일괄적으로 이메일로 간주할 수 없습니다. 구성 status와 isOpenSAMLMapping은 두 개의 스위치이며, 비활성화된 구성도 목록/get에서 조회할 수 있습니다. 조회되었다고 해서 해당 구성으로 로그인할 수 있는 것은 아닙니다.
요청 헤더¶
| 매개변수 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
| DF-API-KEY | string | Y | 워크스페이스의 OpenAPI 인증 자격 증명입니다. 예시: <DF-API-KEY>획득 또는 입력 방법: 대상 워크스페이스의 API Key 관리에서 해당 작업 권한이 있는 OpenAPI Key를 획득합니다. |
Query 요청 매개변수¶
| 매개변수 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
| type | string | 선택 사항, 생략 시 삭제되지 않은 모든 유형을 조회합니다. 빈 문자열은 유효한 필터 열거형이 아니므로 생략할 것을 권장합니다. null 허용: False 허용 값: ['saml', 'oidc'] 예시: oidc획득 또는 입력 방법: 공급자의 실제 프로토콜에 따라 saml/oidc를 선택합니다. |
요청 예시¶
curl --get 'https://openapi.guance.com/api/v1/sso/list' \
-H 'DF-API-KEY: <DF-API-KEY>' \
--data-urlencode type=oidc
응답¶
HTTP 200, application/json. 아래 예시는 직접 읽을 수 있는 주요 필드를 보여줍니다.
| 필드 | 유형 | 설명 |
|---|---|---|
| content | array<object> | 공급자 배열, 비어 있으면 []. |
| content[].id | integer 또는 null | 현재 레코드 번호, 신규 생성 제출 전 구성 결과는 null일 수 있습니다. |
| content[].uuid | string | sso_구성 UUID. |
| content[].type | string | saml/oidc. |
| content[].workspaceUUID | string | 소속 워크스페이스. |
| content[].idpName | string | 공급자 표시 이름. |
| content[].remark | string 또는 null | 비고, 기존/신규 생성 이력에 따라 null일 수 있습니다. |
| content[].role | string | 기본 역할 식별자. |
| content[].idpMd5 | string | 공급자 ID/계정 네임스페이스 요약이며, 클라이언트 키 또는 쓰기 가능한 ID가 아닙니다. |
| content[].tokenHoldTime | integer | 무작업 세션 유지 시간(초). |
| content[].tokenMaxValidDuration | integer | 로그인 세션 최대 시간(초). |
| content[].isOpenSAMLMapping | integer 또는 boolean | 역할 매핑 스위치 1/0, SSO 구성 status와 동일하지 않습니다. |
| content[].status | integer | 0 활성화, 2 비활성화, 삭제되지 않은 조회 시 다른 이력 상태가 포함될 수 있습니다. |
| content[].creator | string | 생성 ID. |
| content[].updator | string | 수정 ID. |
| content[].createAt | integer | 생성 Unix 초. |
| content[].updateAt | integer | 수정 Unix 초, 미수정 시 -1일 수 있습니다. |
| content[].deleteAt | integer | 삭제 Unix 초, 미삭제 시 -1. |
| content[].memberCount | integer | 현재 워크스페이스에 연결된 계정 네임스페이스 수. |
| content[].updatorInfo | object | 수정 ID 요약, 계정/Key/시스템/AI일 수 있으며, 누락 시 {}이고 필드는 ID에 따라 달라집니다. |
| content[].updatorInfo.uuid | string | 조건부 반환, 수정 ID UUID, 시스템 ID는 빈 문자열일 수 있습니다. |
| content[].updatorInfo.name | string | 조건부 반환, 표시 이름. |
| content[].updatorInfo.email | string | 조건부 반환, 인간 ID는 이메일일 수 있으며, API Key ID는 Key UUID, 시스템/AI ID는 표시 레이블로 유효한 이메일로 사용할 수 없습니다. |
| content[].updatorInfo.username | string | 조건부 반환, 로그인 이름. |
| content[].updatorInfo.status | integer | 조건부 반환, ID 상태, 계정/API Key/시스템 ID별로 각각 해석되며 공급자 status와 동일하지 않습니다. |
| content[].updatorInfo.wsAccountStatus | integer | 조건부 반환, 해당 ID의 워크스페이스 관계/호환 상태, ID 유형에 따라 해석되며 일반 멤버 관계임을 보장하지 않습니다. |
| content[].updatorInfo.iconUrl | string | 조건부 반환, 프로필 이미지. |
| content[].updatorInfo.mobile | string | 조건부 반환, 휴대폰 번호. |
| content[].updatorInfo.countryCode | string | 조건부 반환, 휴대폰 번호 국가 코드. |
| content[].updatorInfo.acntWsNickname | string | 조건부 반환, 워크스페이스 닉네임. |
| content[].declaration | object | 비어 있지 않은 각 객체의 공통 선언. |
{
"code": 200,
"content": [
{
"id": 1,
"uuid": "sso_example",
"type": "oidc",
"workspaceUUID": "wksp_example",
"idpName": "ExampleIdP",
"remark": "企业登录",
"role": "general",
"idpMd5": "IDP-IDENTITY-HASH",
"tokenHoldTime": 604800,
"tokenMaxValidDuration": 2592000,
"isOpenSAMLMapping": 0,
"status": 0,
"creator": "wsak_example",
"updator": "wsak_example",
"createAt": 1785427200,
"updateAt": 1785427200,
"deleteAt": -1,
"memberCount": 2,
"updatorInfo": {},
"declaration": {}
}
],
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
오류 응답¶
인증, 속도 제한 및 공통 요청 오류는 공통 오류 정의를 참조하십시오.
| HTTP 상태 | errorCode | 발생 조건 | 메시지 또는 응답 설명 | 처리 방법 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | 요청 필드 누락 또는 필드 값이 선언된 검증 조건 위반 | 매개변수 파싱 실패 | 매개변수 위치, 필드 이름, 유형 및 값을 확인하십시오. |
| 500 | ft.InternalServerError | 구성/데이터베이스/키 복호화, XML 도구 또는 관련 자료 포맷팅 중 처리되지 않은 예외 발생 | 내부 오류 | traceId를 보관하고 현재 구성 및 서비스 의존성을 확인하십시오. 조회는 구성 업데이트를 수행하지 않으며, 해당 실패를 공급자가 존재하지 않는 것으로 간주하지 마십시오. |