콘텐츠로 이동

조회



GET /api/v1/role/{role_uuid}/get

개요

현재 워크스페이스 내 지정된 역할의 기본 정보 및 권한 식별자를 조회합니다.

호출 전 준비 및 사용 단계

먼저 역할 목록을 호출하여 역할 UUID를 가져옵니다. 권한 식별자를 이름으로 표시해야 할 때는 권한 목록에서 카탈로그를 읽을 수 있습니다. 역할이 보유한 권한과 현재 API Key가 보유한 권한은 각각 다른 호출로 결정됩니다.

사이트 도메인 표에서 소속 사이트의 OpenAPI 주소를 선택합니다.

라우트 파라미터

파라미터 이름 타입 필수 설명
role_uuid string Y 대상 역할 UUID입니다.
예시: role_example
가져오기 또는 입력 방법: 역할 목록 응답의 content.data[].uuid에서 가져옵니다.

요청 헤더

파라미터 이름 타입 필수 설명
DF-API-KEY string Y 워크스페이스의 OpenAPI Key 자격 증명입니다. API Key 레코드의 UUID가 아닌 전체 키 값을 사용합니다.
예시: <DF-API-KEY>
가져오기 또는 입력 방법: 대상 워크스페이스의 API Key 관리에서 본 인터페이스 권한을 가진 Key를 생성하거나 가져옵니다.

파라미터 추가 설명

워크스페이스는 요청의 DF-API-KEY로 결정됩니다.

요청 예시

curl --get -H "DF-API-KEY: <DF-API-KEY>" \
  "https://openapi.guance.com/api/v1/role/role_example/get"

응답

HTTP 200, application/json.

필드 타입 설명
content.id integer 역할 레코드 ID입니다.
content.uuid string 역할 UUID이며, 이후 역할 상세를 조회할 때 이 필드를 사용합니다.
content.name string 역할 이름입니다.
content.desc string 역할 설명입니다.
content.isSystem integer 1은 시스템 내장 역할, 0은 기타 역할을 의미합니다.
content.workspaceUUID string 역할이 속하거나 적용되는 워크스페이스이며, 시스템 내장 역할은 비어 있을 수 있습니다.
content.builtinRoleUUID string 관리 콘솔 내장 역할 템플릿 UUID이며, 템플릿이 없으면 비어 있습니다.
content.isAllWorkspace integer 관리 콘솔 내장 역할이 모든 워크스페이스에 적용되는지 여부이며, 0은 아니요, 1은 예입니다.
content.isManageBuiltinRole boolean 관리 콘솔을 통해 정의되고 적용된 내장 역할인지 여부입니다.
content.creator string 생성자 식별자입니다.
content.updator string 최종 수정자 식별자입니다.
content.createAt integer 생성 시간입니다. Unix 초 단위입니다.
content.updateAt integer 최종 수정 시간입니다. Unix 초 단위입니다.
content.deleteAt integer 삭제 시간이며 Unix 초 단위이고, 삭제되지 않은 경우 -1입니다.
content.status integer 역할 레코드 상태입니다.
content.creatorInfo object 생성자 정보이며, 조회할 수 없으면 {}입니다.
content.updatorInfo object 최종 수정자 정보이며, 조회할 수 없으면 {}입니다.
content.permissions array<string> 현재 역할의 권한 식별자 집합입니다.
content.declaration object 또는 null 워크스페이스의 공개 선언 데이터이며, 설정이 비어 있으면 null일 수 있습니다.
{
  "code": 200,
  "content": {
    "id": 101,
    "uuid": "role_example",
    "name": "로그 읽기 전용",
    "desc": "애플리케이션 로그 조회",
    "isSystem": 0,
    "workspaceUUID": "wksp_example",
    "builtinRoleUUID": "",
    "isAllWorkspace": 0,
    "isManageBuiltinRole": false,
    "status": 0,
    "creatorInfo": {},
    "updatorInfo": {},
    "permissions": [
      "routine.defaultAccess"
    ],
    "declaration": null
  },
  "errorCode": "",
  "message": "",
  "success": true,
  "traceId": "TRACE-EXAMPLE"
}

오류 응답

인증, 속도 제한 및 공통 요청 오류는 공통 오류 정의를 참고합니다.

HTTP 상태 errorCode 발생 조건 메시지 또는 응답 설명 처리 방법
404 ft.NotFoundRole 해당 역할이 존재하지 않거나, 삭제되었거나, 현재 공간에서 사용할 수 없음 지정된 역할을 찾을 수 없거나 역할이 삭제되었습니다. 현재 공간의 역할 목록을 다시 조회하여 실제 반환된 uuid를 사용합니다.

문서 평가

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