권한 정보 목록 조회¶
GET /api/v1/permission/list
개요¶
대상 워크스페이스에서 역할 구성에 사용할 수 있는 권한 카탈로그를 읽습니다.
호출 전 및 사용 단계¶
사용자 정의 역할을 구성할 때는 isSupportCustomRole=true로 선택 가능한 권한 항목을 가져온 다음 subs의 key를 읽습니다. 반환되는 것은 권한 카탈로그와 적용 범위입니다. 특정 역할에 부여된 권한을 조회하려면 해당 역할 상세를 읽습니다.
소속 사이트의 OpenAPI 주소를 사이트 도메인 목록에서 선택합니다.
요청 헤더¶
| 매개변수 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
| DF-API-KEY | string | Y | 워크스페이스의 OpenAPI Key 자격 증명입니다. 전체 키 값을 사용하며 API Key 레코드의 UUID는 사용하지 않습니다. 예: <DF-API-KEY>획득 또는 입력 방법: 대상 워크스페이스의 API Key 관리에서 이 API 권한을 가진 Key를 생성하거나 획득합니다. |
Query 요청 매개변수¶
| 매개변수 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
| isSupportCustomRole | boolean | 생략하면 필터링하지 않습니다. true이면 사용자 정의 역할을 지원하는 권한 항목만 반환하고, false이면 지원하지 않는 항목만 반환합니다. 일치하는 항목이 없는 그룹은 생략됩니다. null 허용: False 예: true획득 또는 입력 방법: 양식 요구 사항에 따라 사용자 정의 역할에 구성할 수 있는 권한만 표시할지 선택합니다. |
매개변수 추가 설명¶
워크스페이스는 요청의 DF-API-KEY에 의해 결정됩니다.
요청 예시¶
curl --get -H "DF-API-KEY: <DF-API-KEY>" \
"https://openapi.guance.com/api/v1/permission/list" \
--data-urlencode "isSupportCustomRole=true"
응답¶
HTTP 200, application/json.
| 필드 | 유형 | 설명 |
|---|---|---|
| content | array<object> |
이 페이지의 결과이며, 레코드가 없으면 빈 배열입니다. |
| content[].key | string | 권한 식별자이며 역할 상세의 permissions에 나타날 수 있습니다. |
| content[].name | string | 권한 표시 이름입니다. |
| content[].desc | string | 권한 기능 설명입니다. |
| content[].disabled | integer | 선택 불가 식별자입니다. 사용자 정의 역할에서 선택을 지원하면 0, 그렇지 않으면 1입니다. |
| content[].forbidWorkspaceVersion | array<string> |
사용 안 함으로 구성된 워크스페이스 버전입니다. |
| content[].isSupportOwner | integer | 소유자에게 적용 가능한지 여부입니다. 1은 지원, 0은 미지원입니다. |
| content[].isSupportWsAdmin | integer | 관리자에게 적용 가능한지 여부입니다. 1은 지원, 0은 미지원입니다. |
| content[].isSupportGeneral | integer | 표준 멤버에게 적용 가능한지 여부입니다. 1은 지원, 0은 미지원입니다. |
| content[].isSupportReadOnly | integer | 읽기 전용 멤버에게 적용 가능한지 여부입니다. 1은 지원, 0은 미지원입니다. |
| content[].isSupportAgent | integer | 초대된 에이전트 신원에 적용 가능한지 여부입니다. 1은 지원, 0은 미지원입니다. |
| content[].isSupportCustomRole | integer | 사용자 정의 역할에서 선택을 지원하는지 여부입니다. 1은 지원, 0은 미지원입니다. |
| content[].subPermission | array<string> 또는 string |
기타 종속 권한 식별자입니다. 종속성이 없으면 빈 문자열 또는 빈 배열일 수 있습니다. |
| content[].subs | array<object> |
해당 그룹에서 필터 조건을 충족하는 권한 항목입니다. |
| content[].declaration | object 또는 null | 워크스페이스 선언이며, 비어 있지 않은 결과의 공통 정보입니다. |
| content[].subs[].key | string | 권한 식별자이며 역할 상세의 permissions에 나타날 수 있습니다. |
| content[].subs[].name | string | 권한 표시 이름입니다. |
| content[].subs[].desc | string | 권한 기능 설명입니다. |
| content[].subs[].disabled | integer | 선택 불가 식별자입니다. 사용자 정의 역할에서 선택을 지원하면 0, 그렇지 않으면 1입니다. |
| content[].subs[].forbidWorkspaceVersion | array<string> |
사용 안 함으로 구성된 워크스페이스 버전입니다. |
| content[].subs[].isSupportOwner | integer | 소유자에게 적용 가능한지 여부입니다. 1은 지원, 0은 미지원입니다. |
| content[].subs[].isSupportWsAdmin | integer | 관리자에게 적용 가능한지 여부입니다. 1은 지원, 0은 미지원입니다. |
| content[].subs[].isSupportGeneral | integer | 표준 멤버에게 적용 가능한지 여부입니다. 1은 지원, 0은 미지원입니다. |
| content[].subs[].isSupportReadOnly | integer | 읽기 전용 멤버에게 적용 가능한지 여부입니다. 1은 지원, 0은 미지원입니다. |
| content[].subs[].isSupportAgent | integer | 초대된 에이전트 신원에 적용 가능한지 여부입니다. 1은 지원, 0은 미지원입니다. |
| content[].subs[].isSupportCustomRole | integer | 사용자 정의 역할에서 선택을 지원하는지 여부입니다. 1은 지원, 0은 미지원입니다. |
| content[].subs[].subPermission | array<string> 또는 string |
기타 종속 권한 식별자입니다. 종속성이 없으면 빈 문자열 또는 빈 배열일 수 있습니다. |
{
"code": 200,
"content": [
{
"key": "workspace.*",
"name": "워크스페이스",
"desc": "",
"subPermission": "",
"disabled": 1,
"subs": [
{
"key": "workspace.memberManage",
"name": "멤버 관리",
"desc": "워크스페이스 멤버 관리",
"subPermission": "",
"disabled": 0,
"isSupportCustomRole": 1
}
],
"isSupportCustomRole": 0,
"declaration": null
}
],
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
오류 응답¶
인증, 속도 제한 및 공통 요청 오류는 공통 오류 정의를 참조하세요.
| HTTP 상태 | errorCode | 발생 조건 | 메시지 또는 응답 설명 | 처리 방법 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | 선언되지 않은 Query 매개변수를 전달함 | 메시지에 유효하지 않은 매개변수가 표시됩니다. | 매개변수 표에 나열되지 않은 필드를 제거합니다. |
| 406 | ft.NotFoundWorkspace | API Key에 대응하는 워크스페이스를 찾을 수 없음 | 워크스페이스가 존재하지 않습니다. | Key가 속한 워크스페이스가 유효한지 확인합니다. |