콘텐츠로 이동

현재 테넌트 정보 조회



GET /api/v1/tenant/resolve

개요

현재 API Key가 속한 테넌트와 바인딩된 사용자 식별자를 확인합니다.

호출 전 및 사용 단계

이 엔드포인트는 테넌트 확인이 필요한 통합에서 사용하며, 엔드포인트 허용 권한이 있는 현재 워크스페이스의 API Key를 사용합니다. Query 또는 Body를 받지 않습니다. tenantId는 현재 워크스페이스 UUID이고, userId는 해당 Key의 accountUUID이며, 수동 워크스페이스 Key에서는 일반적으로 빈 문자열입니다. token과 expiresAt은 현재 항상 빈 문자열이며, 로그인 Token 또는 만료 자격 증명을 발급하지 않습니다.

현재 Key 리소스 UUID 기준으로 1800초 동안 캐시되므로 캐시가 먼저 반환될 수 있습니다. 이 API를 실시간 권한, 삭제 또는 만료 검증 용도로 사용하지 마십시오. 성공 시 code/content/success/declaration이 없는 원시 JSON 객체를 반환하며, 오류는 공통 오류 래퍼를 사용합니다.

요청 헤더

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

요청 예시

curl --get 'https://openapi.guance.com/api/v1/tenant/resolve' \
  -H 'DF-API-KEY: <DF-API-KEY>'

응답

HTTP200, application/json 원시 객체이며, 통합된 성공 래퍼나 declaration이 없습니다. 오류는 공통 오류 구조를 사용합니다.

필드 유형 설명
tenantId string 현재 Key가 속한 워크스페이스 UUID로, 테넌트 식별자로 사용됩니다.
userId string Key에 바인딩된 계정 UUID이며, 바인딩되지 않은 수동 Key는 ""입니다.
token string 현재 고정된 빈 문자열이며, 사용 가능한 인증 자격 증명이 아닙니다.
expiresAt string 현재 고정된 빈 문자열이며, Unix 시간 또는 영구 만료 없음에 대한 보장이 아닙니다.
{
  "tenantId": "wksp_example",
  "userId": "",
  "token": "",
  "expiresAt": ""
}

오류 응답

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

HTTP 상태 errorCode 트리거 조건 메시지 또는 응답 설명 처리 방법
401 ft.InvalidAPIKey 캐시 미스 상태에서 현재 워크스페이스 내 해당 Key의 활성 레코드를 찾을 수 없음 유효하지 않은 API Key Key가 삭제/비활성화되지 않았고 현재 워크스페이스에 속하는지 확인하고, wsak_ 리소스 UUID를 요청 헤더 Key로 사용하지 마십시오.
406 ft.NotFoundWorkspace Key에 해당하는 워크스페이스가 없음/비활성 지정한 워크스페이스를 찾을 수 없음 워크스페이스 상태와 Key 연결을 확인하십시오.
500 ft.InternalServerError 워크스페이스/사이트/권한 구성, 데이터베이스 또는 캐시 읽기 및 응답 형식 지정 실패 내부 오류 traceId와 쿼리 조건을 보관하고, 재시도해도 계속 실패하면 관리자에게 구성을 점검하도록 요청하십시오. 빈 결과만으로 사이트에 데이터가 없다고 판단하지 마십시오.

문서 평가

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