콘텐츠로 이동

목록¶

GET /api/v1/role/list

개요¶

역할 목록을 가져옵니다.

Query 요청 매개변수¶

매개변수명	유형	필수	설명
search	string		이름/검색 기준 예: read 빈 값 허용: False
statMember	boolean		멤버 통계 정보 표시 여부 예: read 빈 값 허용: False
pageSize	integer		페이지당 반환 개수 빈 값 허용: False 예: 10
pageIndex	integer		페이지 번호 빈 값 허용: False 예: 10

매개변수 추가 설명¶

요청 예시¶

curl 'https://openapi.guance.com/api/v1/role/list?pageIndex=1&pageSize=3&statMember=true' \
-H 'DF-API-KEY: <DF-API-KEY>' \
--compressed

응답¶

{
    "code": 200,
    "content": [
        {
            "createAt": -1,
            "creator": "SYS",
            "creatorInfo": {
                "uuid": "xx",
                "status": 0,
                "username": "xx",
                "name": "xx",
                "iconUrl": "",
                "email": "xx",
                "acntWsNickname": "xx"
            },
            "deleteAt": -1,
            "desc": "Owner",
            "id": 1,
            "isSystem": 1,
            "memberCount": 1,
            "name": "Owner",
            "status": 0,
            "updateAt": -1,
            "updator": "SYS",
            "updatorInfo": {
                "uuid": "xx",
                "status": 0,
                "username": "xx",
                "name": "xx",
                "iconUrl": "",
                "email": "xx",
                "acntWsNickname": "xx"
            },
            "uuid": "owner",
            "workspaceUUID": ""
        },
        {
            "createAt": -1,
            "creator": "SYS",
            "creatorInfo": {
                "uuid": "xx",
                "status": 0,
                "username": "xx",
                "name": "xx",
                "iconUrl": "",
                "email": "xx",
                "acntWsNickname": "xx"
            },
            "deleteAt": -1,
            "desc": "Administrator",
            "id": 2,
            "isSystem": 1,
            "memberCount": 45,
            "name": "Administrator",
            "status": 0,
            "updateAt": -1,
            "updator": "SYS",
            "updatorInfo": {
                "uuid": "xx",
                "status": 0,
                "username": "xx",
                "name": "xx",
                "iconUrl": "",
                "email": "xx",
                "acntWsNickname": "xx"
            },
            "uuid": "wsAdmin",
            "workspaceUUID": ""
        },
        {
            "createAt": -1,
            "creator": "SYS",
            "creatorInfo": {
                "uuid": "xx",
                "status": 0,
                "username": "xx",
                "name": "xx",
                "iconUrl": "",
                "email": "xx",
                "acntWsNickname": "xx"
            },
            "deleteAt": -1,
            "desc": "Standard Member",
            "id": 3,
            "isSystem": 1,
            "memberCount": 29,
            "name": "Standard",
            "status": 0,
            "updateAt": -1,
            "updator": "SYS",
            "updatorInfo": {
                "uuid": "xx",
                "status": 0,
                "username": "xx",
                "name": "xx",
                "iconUrl": "",
                "email": "xx",
                "acntWsNickname": "xx"
            },
            "uuid": "general",
            "workspaceUUID": ""
        }
    ],
    "errorCode": "",
    "message": "",
    "pageInfo": {
        "count": 3,
        "pageIndex": 1,
        "pageSize": 3,
        "totalCount": 41
    },
    "success": true,
    "traceId": "TRACE-BE9CDC06-73DF-434D-813A-5BDBA94DD4E6"
}