조회¶
GET /api/v1/account/get
개요¶
계정 UUID 또는 서드파티 계정 ID로 계정 정보를 조회합니다.
호출 전 및 사용 단계¶
r 또는 w 권한의 External 자격 증명을 사용합니다. accountUUID는 계정 목록의 uuid에서 가져오고, exterId는 귀사의 ID 시스템에서 가져옵니다. 두 값 중 최소 하나를 입력해야 하며, 동시에 제공하면 교집합 조건으로 조회합니다. 비활성화된 계정은 오류가 발생하며, 비활성화된 계정 정보를 조회하려면 목록을 사용합니다. 워크스페이스 역할이 필요하면 유효한 accountUUID와 wsRoleNeeded=true를 함께 제공해야 하며, exterId만 제공하는 경우 현재 구현은 wsInfo=[]를 반환합니다.
요청 헤더¶
| 파라미터명 | 타입 | 필수 | 설명 |
|---|---|---|---|
| X-Df-SVersion | string | 원본 경로 및 요청 본문 서명 버전이며, 이를 생략하고 이 페이지의 알고리즘을 계속 사용할 수 없습니다. 예시: v20240417획득 또는 입력 방법: 이 페이지의 예시는 이 고정 버전을 사용하며, 예시 서명 알고리즘과 함께 동작합니다. |
|
| X-Df-Access-Key | string | Y | 읽기 API는 r 또는 w 자격 증명을 사용할 수 있고, 쓰기 API는 w 자격 증명이 필요합니다. 예시: <external-access-key>획득 또는 입력 방법: 사이트 관리자가 할당한 External API AK를 사용하며, 워크스페이스 OpenAPI Key는 사용할 수 없습니다. |
| X-Df-Nonce | string | Y | 임시 일련 번호이며, 실패 후 재전송 시에도 새 값을 생성하고 서명을 다시 계산합니다. 예시: 97d275ee9f774315a7885ba7347acbd9획득 또는 입력 방법: 매 요청마다 uuid.uuid4().hex를 새로 생성합니다. |
| X-Df-Signature | string | Y | 대문자 메서드, nonce, 원본 전체 경로, timestamp, 원본 UTF-8 요청 본문을 공백으로 연결한 뒤 HMAC-SHA256으로 계산하여 hex 다이제스트를 사용합니다. 예시: <hmac-sha256-hex>획득 또는 입력 방법: External API 서명 인증에 따라 함께 제공된 SK로 계산하며, 전체 실행 가능한 템플릿은 아래를 참조합니다. |
| X-Df-Timestamp | string | Y | 사이트에 설정된 서명 유효 시간 범위 내여야 하며, 예시 시간을 재사용할 수 없습니다. 예시: 1785427200획득 또는 입력 방법: 전송 시 str(int(time.time()))으로 현재 Unix 초 문자열을 생성합니다. |
Query 요청 파라미터¶
| 파라미터명 | 타입 | 필수 | 설명 |
|---|---|---|---|
| accountUUID | string | 계정 UUID로, exterId와 함께 제공할 수 있습니다. 생략하면 exterId로 조회합니다. null 허용: False 예시: acnt_example001획득 또는 입력 방법: 계정 목록의 content.data[].uuid 또는 생성 성공 응답의 content.uuid에서 가져옵니다. |
|
| exterId | string | 서드파티 ID로, accountUUID와 함께 제공할 수 있으며, 둘 다 전달할 경우 동일한 계정을 가리켜야 합니다. null 허용: False 예시: sso-user-1001획득 또는 입력 방법: 해당 서드파티 계정 생성 시 전달한 고유 식별자를 사용합니다. |
|
| wsRoleNeeded | string | 문자열 true, 1이면 활성화되고 그 외 문자열은 비활성화되며, 기본값은 wsInfo를 반환하지 않습니다. null 허용: False 예시: true획득 또는 입력 방법: 워크스페이스 및 역할을 직접 받으려면 문자열 true 또는 1을 전달하고, 필요 없으면 생략하거나 false를 전달합니다. |
파라미터 추가 설명¶
사이트 수준 External API 자격 증명을 사용하며, 인증 방식은 External API 서명 인증을 참조합니다. 아래 예시는 v20240417 서명 버전을 사용하며, 서명 경로, Query 인코딩 및 원본 요청 본문은 실제 전송 내용과 완전히 일치해야 합니다. 반환되는 계정 정보에는 password 필드가 포함되지 않으며, mfaSecret은 고정 마스크일 뿐 로그인에 사용할 수 있는 키가 아닙니다.
요청 예시¶
import hashlib
import hmac
import json
import time
import uuid
from urllib.parse import urlencode
from urllib.request import Request, urlopen
# 대상 사이트 주소와 관리자가 할당한 External API AK/SK로 교체합니다.
server = "https://external-api.guance.com"
access_key = "<external-access-key>"
secret_key = "<external-secret-key>"
method = 'GET'
path = '/api/v1/account/get'
query = {'accountUUID': 'acnt_example001', 'wsRoleNeeded': 'true'}
data = None
full_path = path + ("?" + urlencode(query) if query else "")
body = "" if data is None else json.dumps(data, ensure_ascii=False, separators=(",", ":"))
timestamp = str(int(time.time()))
nonce = uuid.uuid4().hex
string_to_sign = " ".join([method, nonce, full_path, timestamp, body])
signature = hmac.new(secret_key.encode("utf-8"), string_to_sign.encode("utf-8"), hashlib.sha256).hexdigest()
headers = {
"X-Df-Access-Key": access_key,
"X-Df-Timestamp": timestamp,
"X-Df-Nonce": nonce,
"X-Df-Signature": signature,
"X-Df-SVersion": "v20240417",
}
if data is not None:
headers["Content-Type"] = "application/json"
request = Request(server + full_path, data=None if data is None else body.encode("utf-8"), headers=headers, method=method)
with urlopen(request) as result:
print(result.read().decode("utf-8"))
응답¶
HTTP 200, Content-Type은 application/json이며 통합 응답 래퍼를 사용합니다. 비즈니스 데이터는 content에 위치합니다. External API는 declaration을 자동으로 추가하지 않으며, 목록 페이지네이션은 content.pageInfo에 유지됩니다.
| 필드 | 타입 | 설명 |
|---|---|---|
| content.id | integer | 사이트 내 계정 레코드 번호로, 정보 조회 응답에만 사용됩니다. 다른 API 호출 시에는 uuid를 사용합니다. |
| content.uuid | string | 계정 UUID로, 이후 조회, 수정, 비활성화, 삭제 시 이 필드를 사용합니다. |
| content.status | integer | 계정 상태: 0 정상, 2 비활성화. 목록 필터의 3은 삭제됨이며, 그 외 과거 상태가 나타날 수 있습니다. |
| content.creator | string | 생성 주체 식별자로, External 생성 시 일반적으로 SYS입니다. |
| content.updator | string | 최근 수정 주체 식별자로, 수정 이력이 없으면 비어 있을 수 있습니다. |
| content.createAt | number | 생성 시간, Unix 초. |
| content.updateAt | number | 업데이트 시간, Unix 초. 업데이트 시간이 없으면 -1일 수 있습니다. |
| content.deleteAt | number | 상태 작업 시간 필드로 초기값은 보통 -1입니다. 활성화/비활성화 시에도 이 값이 기록되므로 이를 단독으로 삭제 여부 판단에 사용하지 말고 status를 사용해야 합니다. |
| content.name | string | 표시 닉네임. |
| content.username | string | 로그인 계정 이름. 서드파티 계정은 비어 있거나 다른 계정과 중복될 수 있습니다. |
| content.email | string | 계정 연락 이메일. 생성 시 비어 있고 username이 이메일 형식이면 username으로 채워집니다. |
| content.mobile | string | 휴대폰 번호의 로컬 번호로, 복호화되어 표시되며 국가 코드는 포함되지 않습니다. 설정되지 않으면 빈 문자열입니다. |
| content.countryCode | string | 휴대폰 번호의 국가/지역 코드(숫자만), 예: 86. 설정되지 않으면 빈 문자열입니다. |
| content.exterId | string | 서드파티 ID 시스템의 고유 ID. 로컬 계정은 보통 비어 있습니다. |
| content.extend | object 또는 null | 기존 확장 정보로 user_icon 아바타 주소가 포함될 수 있습니다. 이 API 생성 시 전달한 extend는 현재 저장되지 않으며, 수정 API에서도 이 입력 파라미터를 공개하지 않습니다. |
| content.extend.user_icon | string | 선택적 아바타 URL 또는 정적 리소스 파일명. 기존 정보를 읽을 때 나타날 수 있으며, 이 페이지의 쓰기 가능한 파라미터가 아닙니다. |
| content.source | string | ID 소스 식별자로, 예: local, unknown, oidc, ldap. agent 등 과거 내부 소스도 존재할 수 있습니다. |
| content.nameSpace | string | ID 네임스페이스로, External 생성 시 기본값은 비어 있으며 이 모듈의 공개 파라미터로는 설정할 수 없습니다. |
| content.isUsed | integer 또는 boolean | 계정 사용 여부 표시. |
| content.agreeTerms | integer | 약관 동의 표시. |
| content.canaryPublic | boolean | 카나리 표시. |
| content.enableMFA | boolean | MFA 활성화 여부. |
| content.mfaSecret | string | 고정 마스크*********************로, 사용 가능한 MFA 키를 포함하지 않습니다. |
| content.language | string | 언어 식별자: zh, en, zh-hant, id, ja, ko. |
| content.tokenHoldTime | integer | 계정 무작업 세션 유지 시간(초). 신규 계정은 사이트 보안 세션 설정에 따라 초기화되며, 예시 값으로 고정된다는 보장은 없습니다. |
| content.tokenMaxValidDuration | integer | 계정 세션 최대 유효 기간(초). 신규 계정은 사이트 보안 세션 설정에 따라 초기화됩니다. |
| content.timezone | string | 시간대 식별자, 미설정 시 비어 있습니다. |
| content.attributes | object | SSO 동기화 속성 KV 객체로, 이후 SSO 로그인으로 덮어쓰여질 수 있습니다. 키와 값은 연동 주체가 약정합니다. |
| content.attributes.{属性名} | 임의의 JSON 값 | 사용자 정의 속성 값으로, 문자열 사용을 권장합니다. 예: 부서=개발부. |
| content.customAttributes | object | 비즈니스 측에서 관리하는 속성 KV 객체. |
| content.customAttributes.{属性名} | 임의의 JSON 값 | 비즈니스 사용자 정의 값으로, 문자열 사용을 권장합니다. 예: costCenter=CC-1001. |
| content.statusPageSubs | integer | 상태 페이지 구독 표시. |
| content.defaultWorkspace | string | 계정 기본 워크스페이스 UUID, 미설정 시 비어 있습니다. |
| content.brandKey | string | 계정의 현재 브랜드 식별자로, 사이트에서 허용된 브랜드 집합에 의해 결정됩니다. |
| content.scheduleMobile | string | 교대 근무 전용 휴대폰 번호의 로컬 번호, 미설정 시 비어 있습니다. |
| content.scheduleEmail | string | 교대 근무 전용 이메일, 미설정 시 비어 있습니다. |
| content.ifScheduleMobileEnable | boolean | 교대 근무 휴대폰 번호 사용 여부. |
| content.ifScheduleEmailEnable | boolean | 교대 근무 이메일 사용 여부. |
| content.accountStatus | string | 계정 추가 상태 식별자, 미설정 시 비어 있습니다. |
| content.userIconUrl | string 또는 null | 기존 extend.user_icon을 기반으로 생성된 아바타 URL이며, 아바타가 없으면 null입니다. |
| content.wsInfo | 객체 배열 또는 null | 계정에 직접 바인딩된 활성 워크스페이스 및 역할이며, 관리 백엔드 그룹에서 상속된 권한만은 포함하지 않습니다. |
| content.wsInfo[].uuid | string | 워크스페이스 UUID. |
| content.wsInfo[].name | string | 워크스페이스 이름. |
| content.wsInfo[].roles | 객체 배열 | 해당 계정에 직접 연결된 유효 역할. |
| content.wsInfo[].roles[].uuid | string | 역할 UUID, 예: owner. |
| content.wsInfo[].roles[].name | string | 역할 표시 이름. |
| content.wsInfo[].roles[].workspaceUUID | string | 역할 정의가 속한 워크스페이스 UUID. 시스템 공용 역할은 빈 문자열입니다. |
{
"code": 200,
"content": {
"id": 1001,
"uuid": "acnt_example001",
"status": 0,
"creator": "SYS",
"updator": "",
"createAt": 1785427200,
"deleteAt": -1,
"updateAt": -1,
"name": "예시 멤버",
"username": "xxx@guance.com",
"email": "xxx@guance.com",
"mobile": "",
"countryCode": "",
"exterId": "",
"extend": null,
"source": "local",
"nameSpace": "",
"isUsed": 0,
"agreeTerms": 0,
"canaryPublic": false,
"enableMFA": false,
"mfaSecret": "*********************",
"language": "zh",
"tokenHoldTime": 86400,
"tokenMaxValidDuration": 604800,
"timezone": "",
"attributes": {
"부서": "개발부"
},
"customAttributes": {
"costCenter": "CC-1001"
},
"statusPageSubs": 0,
"defaultWorkspace": "",
"brandKey": "guance",
"scheduleMobile": "",
"scheduleEmail": "",
"ifScheduleMobileEnable": false,
"ifScheduleEmailEnable": false,
"accountStatus": "",
"userIconUrl": null,
"wsInfo": [
{
"uuid": "wksp_example001",
"name": "예시 워크스페이스",
"roles": [
{
"uuid": "general",
"name": "일반 멤버",
"workspaceUUID": ""
}
]
}
]
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
오류 응답¶
인증, 속도 제한 및 공통 요청 오류는 공통 오류 정의를 참조합니다.
| HTTP 상태 | errorCode | 발생 조건 | 메시지 또는 응답 설명 | 처리 방법 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | 요청 필드 누락 또는 필드 값이 선언된 검증 조건 위반 | 파라미터 파싱 실패 | 파라미터 위치, 필드명, 타입 및 값을 확인합니다. |
| 404 | ft.NotFoundAccount | 조회 조건을 만족하는 계정을 찾을 수 없거나 계정이 이미 삭제됨 | 지정된 계정을 찾을 수 없음 | 계정 목록에서 유효한 uuid를 다시 가져오고, 두 조건 조회 시 두 값이 동일 계정에 속하는지 확인합니다. |
| 403 | ft.AccountIsDisabled | 대상 계정 status=2 | 계정이 비활성화됨 | 먼저 활성화/비활성화 API로 활성화하거나 목록에서 계정 상태를 확인합니다. |
| 500 | ft.InternalServerError | 데이터베이스, 캐시, 비동기 작업 전달 또는 명시적으로 처리되지 않은 필드 예외 | 내부 오류 | traceId를 저장하고 관리자에게 문의합니다. 쓰기 요청은 먼저 계정 현재 상태를 다시 조회하여 확인한 후 재시도 여부를 결정하며, 500을 곧바로 미적용으로 간주해서는 안 됩니다. |