조회¶
GET /api/v1/workspace/accesskey/{ak_uuid}/get
개요¶
레코드 UUID로 현재 워크스페이스 내 지정된 API Key의 정보와 권한을 조회합니다.
호출 전 준비 및 사용 단계¶
호출에는 현재 워크스페이스의 workspace.openAPIKeyManage 권한이 필요합니다. 아래 예시는 주요 필드만 발췌한 것입니다. API Key 목록의 content[].uuid에서 레코드 UUID를 가져옵니다. 수동으로 생성되어 계정이 바인딩되지 않은 워크스페이스 Key는 워크스페이스 Owner가 전체 자격 증명을 조회할 수 있습니다. Owner가 아닌 경우 이번 호출에 사용한 이 Key에 대해서만 전체 값을 조회할 수 있고, 다른 레코드는 마스킹됩니다. 개인, Agent 등 다른 출처도 마스킹됩니다. 로그와 티켓에 남기는 응답은 비식별화 처리하세요.
라우트 파라미터¶
| 파라미터명 | 타입 | 필수 | 설명 |
|---|---|---|---|
| ak_uuid | string | Y | 대상 레코드 UUID이며, 실제 Secret Key를 입력할 수 없습니다. 예시: wsak_example조회 또는 입력 방법: API Key 목록의 content[].uuid에서 가져옵니다. |
요청 헤더¶
| 파라미터명 | 타입 | 필수 | 설명 |
|---|---|---|---|
| DF-API-KEY | string | Y | 워크스페이스 호출 자격 증명입니다. 레코드 UUID와 호출 자격 증명은 서로 다른 필드입니다. 예시: <DF-API-KEY>조회 또는 입력 방법: 현재 워크스페이스의 API Key 관리에서 전체 자격 증명을 가져옵니다. |
파라미터 추가 설명¶
예시의 리소스 식별자는 자리 표시자이므로 대상 워크스페이스의 실제 값으로 교체하세요.
요청 예시¶
curl --get -H "DF-API-KEY: <DF-API-KEY>" \
'https://openapi.guance.com/api/v1/workspace/accesskey/wsak_example/get'
응답¶
HTTP 200, application/json.
| 필드 | 타입 | 설명 |
|---|---|---|
| content.uuid | string | API Key 레코드의 UUID이며, 일반적으로 wsak_ 접두사를 사용합니다. API Key 관리 API의 경로에 사용됩니다. |
| content.name | string | API Key의 이름입니다. |
| content.workspaceUUID | string | 소속 워크스페이스입니다. |
| content.createdWay | string | API Key의 생성 출처입니다. |
| content.remark | string | API Key의 비고입니다. |
| content.isOwnerRole | integer 또는 boolean | 해당 API Key가 워크스페이스 소유자 역할을 보유하는지 여부입니다. |
| content.callCount | integer | 기록된 호출 횟수입니다. |
| content.lastCallAt | integer | 마지막으로 기록된 호출 시간으로, Unix 초 단위이며 기록이 없으면 -1일 수 있습니다. |
| content.createAt | integer | 레코드 생성 시간이며 Unix 초 단위입니다. |
| content.accountUUID | string | 명시적으로 바인딩된 계정 UUID이며, 바인딩되지 않은 경우 빈 문자열입니다. |
| content.effectiveAccountUUID | string | 인증에 사용되는 신원 식별자입니다. 바인딩되지 않은 경우 해당 API Key 레코드 UUID입니다. |
| content.accountInfo | object 또는 null | 바인딩된 계정 정보이며, 바인딩되지 않은 경우 null입니다. |
| content.roles | array<object> |
유효한 역할 집합이며 순서는 고정되지 않습니다. |
| content.roles[].uuid | string | 역할 UUID입니다. |
| content.roles[].name | string | 역할 이름입니다. |
| content.permissions | array<string> |
유효한 권한 식별자 집합이며 순서는 고정되지 않습니다. |
| content.rolePermissions | object | 각 역할이 보유한 권한 식별자로, 역할 UUID를 키로 하고 권한 문자열 배열을 값으로 합니다. |
| content.declaration | object 또는 null | 워크스페이스 선언입니다. |
| content.ak | string | Access Key 식별자입니다. 현재 신원에 따라 마스킹될 수 있습니다. |
| content.sk | string | Secret Key 자격 증명입니다. 현재 신원에 따라 마스킹될 수 있습니다. 응답은 민감 정보로 취급해야 합니다. |
| content.creatorInfo | object | 생성자 정보이며, 조회되지 않으면 빈 객체입니다. |
{
"code": 200,
"content": {
"uuid": "wsak_example",
"name": "애플리케이션 데이터 조회",
"workspaceUUID": "wksp_example",
"createdWay": "manual",
"remark": "",
"isOwnerRole": 0,
"callCount": 14,
"lastCallAt": 1785427200,
"createAt": 1785423600,
"accountUUID": "",
"effectiveAccountUUID": "wsak_example",
"accountInfo": null,
"roles": [
{
"uuid": "role_example",
"name": "애플리케이션 데이터 읽기 전용"
}
],
"permissions": [
"routine.defaultAccess"
],
"rolePermissions": {
"role_example": [
"routine.defaultAccess"
]
},
"declaration": null,
"ak": "*************abcd",
"sk": "*************ef01",
"creatorInfo": {}
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
오류 응답¶
인증, 속도 제한 및 공통 요청 오류는 공통 오류 정의를 참조하세요.
| HTTP 상태 | errorCode | 발생 조건 | 메시지 또는 응답 설명 | 처리 방법 |
|---|---|---|---|---|
| 404 | ft.AKNotExistOrDelete | 동일한 워크스페이스 내에 일치하는 유효한 비시스템 API Key가 없음 | API Key가 존재하지 않거나 삭제되었습니다. | 현재 워크스페이스 목록에서 반환된 UUID를 사용하세요. |
| 403 | ft.Forbidden | Owner가 아닌 사용자가 Owner Key를 조회하려 함 | 작업 권한이 없습니다. | 권한 요구 사항을 충족하는 호출 신원을 사용하세요. |
| 403 | ft.AgentMemberDisabled | API Key에 바인딩된 계정이 비활성화됨 | 바인딩된 계정을 사용할 수 없습니다. | 바인딩된 계정이 사용 가능한 상태인지 확인하세요. |
| 404 | ft.AgentMemberNotFound | API Key에 바인딩된 계정이 존재하지 않거나 삭제됨 | 바인딩된 계정을 찾을 수 없습니다. | 바인딩 관계와 계정 상태를 확인하세요. |
| 404 | ft.WorkspaceAgentMemberNotFound | 바인딩된 계정에 유효한 워크스페이스 멤버 관계가 없음 | 해당 워크스페이스 멤버를 찾을 수 없습니다. | 해당 계정이 여전히 현재 워크스페이스의 멤버인지 확인하세요. |