유저 관리 API
호출 방법은 Open API 문서의 호출 방법 설명을 참고하십시오.
1. 유저 관리
1. 유저 ID 조회
회사 수준 token만 지원합니다.
인터페이스 URL
/open/list-auth-users-by-login-names?token=xxx
요청 방식
POST
Content-Type
application/json
요청 Query 파라미터
| 파라미터 이름 | 예시 값 | 파라미터 타입 | 필수 여부 | 파라미터 설명 |
|---|---|---|---|---|
| token | xxx | String | 예 | 조회 키 |
요청 Body 파라미터
{
"loginNames": [
"test_user1",
"test_user2"
]
}
| 파라미터 이름 | 예시 값 | 파라미터 타입 | 필수 여부 | 파라미터 설명 |
|---|---|---|---|---|
| loginNames | ["test_user1"] | List | 예 | 로그인 사용자 이름 목록 |
성공 응답 예시
{
"return_code": 0,
"return_message": "success",
"data": {
"authUsers": [
{
"userId": 88,
"loginName": "test_user1"
},
{
"userId": 89,
"loginName": "test_user2"
}
]
}
}
| $$파라미터 이름 | 예시 값 | 파라미터 타입 | 파라미터 설명 |
|---|---|---|---|
| return_code | 0 | Integer | 반환 코드 |
| return_message | success | String | 반환 정보 |
| data | - | Object | 검증 결과 조회 key |
| data.authUsers | - | List | 유저 목록 |
| data.authUsers.userId | 88 | Integer | 유저 ID |
| data.authUsers.loginName | test_user1 | String | 사용자 이름 |
2. 단일 유저 정보 조회(역할 포함)
- 유저가 슈퍼 관리자이면 companyRole을 반환하고, 슈퍼 관리자가 아니면 projectRoles를 반환합니다.
- 회사 수준 token만 지원합니다.
인터페이스 URL
/open/get-auth-user-info-by-login-name?token=xxx&loginName= test_user1
요청 방식
GET
Content-Type
application/json
요청 Query 파라미터
| 파라미터 이름 | 예시 값 | 파라미터 타입 | 필수 여부 | 파라미터 설명 |
|---|---|---|---|---|
| token | xxx | String | 예 | 조회 키 |
| loginName | test_user1 | String | 예 | 로그인 이름 |
성공 응답 예시
유저가 슈퍼 관리자인 경우 companyRole을 반환합니다.
{
"return_code": 0,
"return_message": "success",
"data": {
"userId": 88,
"loginName": "test_user1",
"userName": "테스트 유저A",
"roleInfo": {
"companyRole": {
"roleName": "root",
"roleDesc": "슈퍼 관리자"
}
}
}
}
| $$파라미터 이름 | 예시 값 | 파라미터 타입 | 파라미터 설명 |
|---|---|---|---|
| data | - | Object | 반환 데이터 |
| data.loginName | test_user1 | String | 로그인 이름 |
| data.roleInfo | - | Object | 역할 정보 |
| data.roleInfo.companyRole | - | List | 회사 역할 목록 |
| data.roleInfo.companyRole.roleName | root | String | 역할 이름 |
| data.roleInfo.companyRole.roleDesc | 슈퍼 관리자 | String | 역할 설명 |
| data.userId | 88 | Integer | 유저 ID |
| data.userName | 테스트 유저A | String | 유저 이름 |
| return_code | 0 | Integer | 반환 코드 |
| return_message | success | String | 반환 정보 |
유저가 슈퍼 관리자가 아닌 경우 projectRoles를 반환합니다.
{
"return_code": 0,
"return_message": "success",
"data": {
"userId": 88,
"loginName": "test_user1",
"userName": "테스트 유저A",
"roleInfo": {
"projectRoles": [
{
"projectId": 3,
"roleName": "admin",
"roleDesc": "관리자"
},
{
"projectId": 4,
"roleName": "analyst",
"roleDesc": "분석가"
}
]
}
}
}
| $$파라미터 이름 | 예시 값 | 파라미터 타입 | 파라미터 설명 |
|---|---|---|---|
| data | - | Object | 반환 데이터 |
| data.loginName | test_user1 | String | 로그인 이름 |
| data.roleInfo | - | Object | 역할 정보 |
| data.roleInfo.projectRoles | - | List | 프로젝트 역할 목록 |
| data.roleInfo.projectRoles.projectId | 3 | Integer | 프로젝트 ID |
| data.roleInfo.projectRoles.roleDesc | 관리자 | String | 역할 설명 |
| data.roleInfo.projectRoles.roleName | admin | String | 역할 이름 |
| data.userId | 88 | Integer | 유저 ID |
| data.userName | 테스트 유저A | String | 유저 이름 |
| return_code | 0 | Integer | 반환 코드 |
| return_message | success | String | 반환 정보 |
오류 응답 예시
{
"return_code": -1008,
"return_message": "Find no user with loginName: test007"
}
| 파라미터 이름 | 예시 값 | 파라미터 타입 | 파라미터 설명 |
|---|---|---|---|
| return_code | -1008 | Integer | 반환 코드 |
| return_message | Find no user with loginName: test007 | String | 반환 정보 |
3. 유저 계정 상태 조회
- 유저 로그인 이름으로 유저 계정 상태를 조회합니다.
인터페이스 URL
/open/get-auth-user-status?token=xxx&loginName=user007
요청 방식
GET
Content-Type
application/json
요청 Query 파라미터
| 파라미터 이름 | 예시 값 | 파라미터 타입 | 필수 여부 | 파라미터 설명 |
|---|---|---|---|---|
| token | xxx | String | 예 | 조회 키 |
| loginName | user007 | String | 예 | 로그인 이름 |
성공 응답 예시
{
"data": {
"accountStatus": "NORMAL",
"loginName": "user007"
},
"return_code": 0,
"return_message": "success"
}
| $$파라미터 이름 | 예시 값 | 파라미터 타입 | 파라미터 설명 |
|---|---|---|---|
| data | - | Object | 반환 데이터 |
| data.accountStatus | NORMAL | String | 계정 상태
|
| data.loginName | user007 | String | 로그인 이름 |
| return_code | 0 | Integer | 반환 코드 |
| return_message | success | String | 반환 정보 |
오류 응답 예시
{
"return_code": -1008,
"return_message": "파라미터(token)가 비어 있습니다"
}
| 파라미터 이름 | 예시 값 | 파라미터 타입 | 파라미터 설명 |
|---|---|---|---|
| return_code | -1008 | Integer | 반환 코드 |
| return_message | 파라미터(token)가 비어 있습니다 | String | 반환 정보 |
4. 유저 비활성화
- 유저 로그인 이름으로 유저를 비활성화합니다.
인터페이스 URL
/open/member-lock?token=xxx&loginName=user007
요청 방식
POST
Content-Type
application/json
요청 Query 파라미터
| 파라미터 이름 | 예시 값 | 파라미터 타입 | 필수 여부 | 파라미터 설명 |
|---|---|---|---|---|
| token | xxx | String | 예 | 조회 키 |
| loginName | user007 | String | 예 | 로그인 이름 |
성공 응답 예시
{
"data": true,
"return_code": 0,
"return_message": "success"
}
| 파라미터 이름 | 예시 값 | 파라미터 타입 | 파라미터 설명 |
|---|---|---|---|
| data | true | Object | 반환 데이터 |
| return_code | 0 | Integer | 반환 코드 |
| return_message | success | String | 반환 정보 |
오류 응답 예시
{
"return_code": -1006,
"return_message": "작업 권한이 없습니다. token 값이 올바른지 확인하십시오"
}
| 파라미터 이름 | 예시 값 | 파라미터 타입 | 파라미터 설명 |
|---|---|---|---|
| return_code | -1006 | Integer | 반환 코드 |
| return_message | 작업 권한이 없습니다. token 값이 올바른지 확인하십시오 | String | 반환 정보 |
5. 유저 비활성화 해제
- 유저 로그인 이름으로 유저의 비활성화를 해제합니다.
인터페이스 URL
/open/member-unlock?token=xxx&loginName=user007
요청 방식
POST
Content-Type
application/json
요청 Query 파라미터
| 파라미터 이름 | 예시 값 | 파라미터 타입 | 필수 여부 | 파라미터 설명 |
|---|---|---|---|---|
| token | xxx | String | 예 | 조회 키 |
| loginName | user007 | String | 예 | 로그인 이름 |
성공 응답 예시
{
"data": true,
"return_code": 0,
"return_message": "success"
}
| 파라미터 이름 | 예시 값 | 파라미터 타입 | 파라미터 설명 |
|---|---|---|---|
| data | true | Object | 반환 데이터 |
| return_code | 0 | Integer | 반환 코드 |
| return_message | success | String | 반환 정보 |
오류 응답 예시
{
"return_code": -1006,
"return_message": "작업 권한이 없습니다. token 값이 올바른지 확인하십시오"
}
| 파라미터 이름 | 예시 값 | 파라미터 타입 | 파라미터 설명 |
|---|---|---|---|
| return_code | -1006 | Integer | 반환 코드 |
| return_message | 작업 권한이 없습니다. token 값이 올바른지 확인하십시오 | String | 반환 정보 |
6. 유저의 MFA 연결 해제
회사 수준 token만 지원합니다.
인터페이스 URL
/open/unbind-auth-user-mfa?token=xxx&loginName=root
요청 방식
POST
Content-Type
application/json
요청 Query 파라미터
| 파라미터 이름 | 예시 값 | 파라미터 타입 | 필수 여부 | 파라미터 설명 |
|---|---|---|---|---|
| token | xxx | String | 예 | 조회 키 |
| loginName | root | String | 예 | 로그인 이름 |
성공 응답 예시
{
"return_code": 0,
"return_message": "success"
}
| 파라미터 이름 | 예시 값 | 파라미터 타입 | 파라미터 설명 |
|---|---|---|---|
| return_code | 0 | Integer | 반환 코드 |
| return_message | success | String | 반환 정보 |
오류 응답 예시
{
"return_code": -1009,
"return_message": "유저 이름이 존재하지 않습니다"
}
| 파라미터 이름 | 예시 값 | 파라미터 타입 | 파라미터 설명 |
|---|---|---|---|
| return_code | -1009 | Integer | 반환 코드 |
| return_message | 사용자 이름이 존재하지 않습니다 | String | 반환 정보 |
7. 유저 역할 일괄 생성
계정을 일괄 생성하고 회사 내 각 프로젝트의 분석 역할을 전체 설정합니다. 같은 요청에서 각 프로젝트의 데이터 권한도 지정할 수 있습니다. 회사 토큰만 지원하며 한 요청으로 같은 회사의 여러 프로젝트를 처리할 수 있습니다. 프라이빗 배포 환경용 API이며 SaaS는 지원하지 않습니다.
이전 버전에서는 분석 관리자 역할을 생성할 때 전달해야 하는 역할 이름이 관리자였습니다.
위 제한은 v5.0 버전의 역할 최적화 이후 해제되었으며, 프로젝트의 분석 역할 이름을 그대로 전달하면 됩니다.
역할 이름은 변경할 수 있으므로 AE 시스템의 시스템 관리 / 프로젝트 관리에 있는 역할 관리 페이지에서 필요한 이름을 확인하세요.
인터페이스 URL
/open/batch-create-auth-user-and-set-roles?token=xxx
요청 방식
POST
Content-Type
application/json
요청 Query 파라미터
| 파라미터 | 타입 | 필수 | 설명 |
|---|---|---|---|
| token | String | 예 | 회사 토큰입니다. 프로젝트 토큰, 유저 토큰, 임시 토큰은 사용할 수 없습니다. |
요청 Body 파라미터 및 예시
다음 예시는 test_user1의 프로젝트 57과 390에 분석 역할을 설정하고 각각 사용자 정의 데이터 권한과 전체 데이터 권한을 부여합니다. 예시의 역할 및 데이터 권한 이름은 해당 프로젝트에 이미 존재하는 이름으로 바꿔 사용하세요. 역할만 설정하려면 dataPowers를 생략할 수 있습니다.
{
"authUsers": [
{
"loginName": "test_user1",
"roles": [
{
"projectId": 57,
"roleDesc": "数据分析师A"
},
{
"projectId": 390,
"roleDesc": "普通成员"
}
],
"dataPowers": [
{
"projectId": 57,
"dataPowerName": "华东地区数据"
},
{
"projectId": 390,
"allData": true
}
]
}
]
}
| 파라미터 | 타입 | 필수 | 설명 |
|---|---|---|---|
| authUsers | Array | 예 | 비어 있을 수 없는 계정 목록입니다. |
| authUsers[].loginName | String | 예 | 유저 로그인 계정 이름입니다. 형식은 유저 일괄 생성 API와 같습니다. |
| authUsers[].roles | Array | 예 | 이번 요청의 각 대상 프로젝트에 설정할 해당 계정의 전체 분석 역할 목록입니다. 비어 있을 수 없으며 회사 내 여러 프로젝트를 포함할 수 있습니다. |
| authUsers[].roles[].projectId | Integer | 아니요 | 프로젝트 ID입니다. 토큰에 해당하는 회사의 프로젝트여야 합니다. 명시적으로 전달하는 것을 권장합니다. 생략하면 프로젝트 ID 0으로 처리하며 프로젝트 0도 실제로 존재해야 합니다. |
| authUsers[].roles[].roleDesc | String | 예 | 프로젝트에 이미 정의된 분석 역할의 표시 이름이며 내부 식별자가 아닙니다. 현재 운영 역할 설정은 지원하지 않습니다. 역할 이름은 변경할 수 있으므로 시스템 관리 / 프로젝트 관리의 역할 관리 페이지에서 확인하세요. |
| authUsers[].dataPowers | Array | 아니요 | 해당 계정의 데이터 권한 설정입니다. 생략, null, 빈 배열은 모두 기존 데이터 권한을 유지합니다. 새 계정이나 새로 프로젝트에 참여하는 계정에 권한을 지정하지 않으면 기본 전체 데이터 권한을 사용합니다. 배열 요소는 null일 수 없습니다. |
| authUsers[].dataPowers[].projectId | Integer | 예 | 데이터 권한이 속한 프로젝트 ID입니다. 실제로 존재하는 0 이상의 정수이며 같은 요청의 해당 계정 roles에 포함되어야 합니다. 같은 계정에 같은 프로젝트를 중복 설정할 수 없습니다. |
| authUsers[].dataPowers[].dataPowerName | String | 둘 중 하나 | 프로젝트에 이미 존재하는 사용자 정의 데이터 권한의 원래 전체 이름입니다. 정확히 일치하는 설정이 하나만 있어야 합니다. 내부 ID를 전달하지 않으며 유사 검색이나 자동 생성은 지원하지 않습니다. 전체 데이터를 뜻하는 이름도 사용자 정의 권한으로 해석합니다. 이름을 선택할 때 allData는 생략하거나 null로 설정하세요. |
| authUsers[].dataPowers[].allData | Boolean | 둘 중 하나 | 허용되는 값은 true뿐이며 요청 언어와 관계없이 전체 데이터 권한을 명시적으로 부여합니다. 이때 dataPowerName은 생략하거나 null로 설정하세요. false, 공백 이름, 둘 다 미지정, 둘 다 지정은 모두 거부됩니다. |
처리 규칙
- 계정이 없으면 초기 비밀번호 ta2020으로 생성합니다. 기존 계정은 재사용하며 비밀번호를 재설정하지 않습니다. 새로 프로젝트에 참여하는 계정은 기본 유저 그룹에 추가됩니다.
- 지정한 각 프로젝트의 분석 역할을 추가가 아닌 전체 교체로 설정합니다. 예를 들어 기존 역할이 A와 B이고 이번에 B만 전달하면 성공 후 B만 남습니다. 각 대상 프로젝트에서 유지할 전체 역할 목록을 전달하세요. 나열하지 않은 프로젝트는 변경하지 않습니다.
- dataPowers에 명시한 프로젝트의 데이터 권한만 변경하며 나열하지 않은 프로젝트는 유지합니다. dataPowers 생략, null, 빈 배열은 모두 기존 데이터 권한을 유지합니다. 새 계정이나 새로 프로젝트에 참여하는 계정에 권한을 지정하지 않으면 기본 전체 데이터 권한을 사용합니다. 서로 다른 프로젝트에 같은 이름의 사용자 정의 권한이 있으면 각 프로젝트의 설정으로 해석합니다.
- 사용자 정의 데이터 권한 이름이 없거나 중복되거나 다른 프로젝트에만 존재하면 배치 전체가 실패하며 전체 데이터 권한으로 대체하지 않습니다. 권한 이름을 변경해도 기존 할당은 유지되지만 이후 요청에는 새 이름을 사용해야 합니다. 데이터 권한을 지정할 때 계정은 현재 회사에 속해야 합니다.
- 이 API로 슈퍼 관리자 권한을 부여할 수 없습니다. 기존 슈퍼 관리자 계정의 역할과 데이터 권한은 변경하지 않습니다. 이번에 프로젝트 소유자 역할과 해당 프로젝트의 데이터 권한을 함께 지정하면 allData: true만 허용됩니다. dataPowers를 생략하여 기존 동작을 유지할 수도 있습니다.
- 배치 전체를 한 번에 처리합니다. 어느 계정이든 파라미터, 권한, 역할, 데이터 권한 검증에 실패하거나 계정, 역할, 기본 그룹, 데이터 권한 쓰기에 실패하면 배치 전체를 롤백합니다. 일부 성공 결과는 반환하지 않습니다.
성공 응답 예시
{
"return_code": 0,
"return_message": "success"
}
| 파라미터 이름 | 예시 값 | 파라미터 타입 | 파라미터 설명 |
|---|---|---|---|
| return_code | 0 | Integer | 반환 코드 |
| return_message | success | String | 반환 정보 |
오류 응답 예시
{
"return_code": -1006,
"return_message": "This API is Forbidden in SAAS"
}
| 파라미터 이름 | 예시 값 | 파라미터 타입 | 파라미터 설명 |
|---|---|---|---|
| return_code | -1006 | Integer | 반환 코드 |
| return_message | This API is Forbidden in SAAS | String | 반환 정보 |
9. SSO 유저 생성
- SSO 유저 정보를 생성하는 데 사용합니다.
인터페이스 URL
/open/create/ssoUser?token=xxx&loginType=dingtalk&loginName=user007
요청 방식
GET
요청 Query 파라미터
| 파라미터 이름 | 예시 값 | 파라미터 타입 | 필수 여부 | 파라미터 설명 |
|---|---|---|---|---|
| token | xxx | String | 예 | 조회 키 |
| loginType | dingtalk | String | 예 | 서드파티 로그인 타입 |
| loginName | user007 | String | 예 | 로그인 이름 |
| password | - | String | 아니요 | 로그인 비밀번호(전달하지 않으면 시스템에서 자동 생성) |
성공 응답 예시
{
"data": true,
"return_code": 0,
"return_message": "success"
}
| 파라미터 이름 | 예시 값 | 파라미터 타입 | 파라미터 설명 |
|---|---|---|---|
| data | true | Object | 반환 데이터 |
| return_code | 0 | Integer | 반환 코드 |
| return_message | success | String | 반환 정보 |
오류 응답 예시
{
"return_code": -1006,
"return_message": "작업 권한이 없습니다. token 값이 올바른지 확인하십시오"
}
| 파라미터 이름 | 예시 값 | 파라미터 타입 | 파라미터 설명 |
|---|---|---|---|
| return_code | -1006 | Integer | 반환 코드 |
| return_message | 작업 권한이 없습니다. token 값이 올바른지 확인하십시오 | String | 반환 정보 |
10. 프로젝트에서 유저 삭제(작업 이관 선택 가능)
인터페이스 URL
/open/delete-auth-user-from-project?token=xxx&projectId=0&loginName=user007&handoverToLoginName=user008
요청 방식
POST
Content-Type
application/json
요청 Query 파라미터
| 파라미터 이름 | 예시 값 | 파라미터 타입 | 필수 여부 | 파라미터 설명 |
|---|---|---|---|---|
| token | xxx | String | 예 | 조회 키 |
| projectId | 0 | Integer | 예 | 프로젝트 ID |
| loginName | user007 | String | 예 | 삭제할 유저의 로그인 이름 |
| handoverToLoginName | user008 | String | 예 | 작업을 이관받을 유저의 로그인 이름 |
성공 응답 예시
{
"return_code": 0,
"return_message": "success"
}
| 파라미터 이름 | 예시 값 | 파라미터 타입 | 파라미터 설명 |
|---|---|---|---|
| return_code | 0 | Integer | 반환 코드 |
| return_message | success | String | 반환 정보 |
오류 응답 예시
{
"return_code": -1023,
"return_message": "user user007이(가) 존재하지 않습니다"
}
| 파라미터 이름 | 예시 값 | 파라미터 타입 | 파라미터 설명 |
|---|---|---|---|
| return_code | -1023 | Integer | 반환 코드 |
| return_message | user user007이(가) 존재하지 않습니다 | String | 반환 정보 |
11. 시스템에서 유저 삭제(작업 이관 선택 가능)
회사 수준 token만 지원합니다.
인터페이스 URL
/open/delete-auth-user-from-system?token=xxx&loginName=user007&handoverToLoginName=user008
요청 방식
POST
Content-Type
application/json
요청 Query 파라미터
| 파라미터 이름 | 예시 값 | 파라미터 타입 | 필수 여부 | 파라미터 설명 |
|---|---|---|---|---|
| token | xxx | String | 예 | 조회 키 |
| loginName | user007 | Integer | 예 | 로그인 이름 |
| handoverToLoginName | user008 | String | 예 | 작업을 이관받을 유저의 로그인 이름 |
성공 응답 예시
{
"return_code": 0,
"return_message": "success"
}
| 파라미터 이름 | 예시 값 | 파라미터 타입 | 파라미터 설명 |
|---|---|---|---|
| return_code | 0 | Integer | 반환 코드 |
| return_message | success | String | 반환 정보 |
오류 응답 예시
{
"return_code": -1010,
"return_message": "Unsupported in SAAS"
}
| 파라미터 이름 | 예시 값 | 파라미터 타입 | 파라미터 설명 |
|---|---|---|---|
| return_code | -1010 | Integer | 반환 코드 |
| return_message | Unsupported in SAAS | String | 반환 정보 |
2. 유저 그룹 관리
1. 유저 그룹 ID 및 멤버 목록 조회
인터페이스 URL
/open/get-user-group-by-name?token=xxx&projectId=0&userGroupName=demo007
요청 방식
GET
Content-Type
application/json
요청 Query 파라미터
| 파라미터 이름 | 예시 값 | 파라미터 타입 | 필수 여부 | 파라미터 설명 |
|---|---|---|---|---|
| token | xxx | String | 예 | 조회 키 |
| projectId | 0 | Integer | 예 | 프로젝트 ID |
| userGroupName | demo007 | String | 예 | 유저 그룹 이름 |
성공 응답 예시
{
"data": {
"groupName": "demo007",
"id": 133,
"isDefault": false,
"members": [
{
"userId": 16426
}
],
"updateTime": "2021-11-22 19:22:15"
},
"return_code": 0,
"return_message": "success"
}
| $$파라미터 이름 | 예시 값 | 파라미터 타입 | 파라미터 설명 |
|---|---|---|---|
| data | - | Object | 반환 데이터 |
| data.groupName | demo007 | String | 그룹 이름 |
| data.id | 133 | Integer | id |
| data.isDefault | false | Boolean | 기본 여부 |
| data.members | - | List | 멤버 리스트 |
| data.members.userId | 16426 | Integer | 유저 ID |
| data.updateTime | 2021-11-22 19:22:15 | Date | 업데이트 시간 |
| return_code | 0 | Integer | 반환 코드 |
| return_message | success | String | 반환 정보 |
오류 응답 예시
{
"return_code": -1023,
"return_message": "유저 그룹이 존재하지 않습니다"
}
| 파라미터 이름 | 예시 값 | 파라미터 타입 | 파라미터 설명 |
|---|---|---|---|
| return_code | -1023 | Integer | 반환 코드 |
| return_message | 유저 그룹이 존재하지 않습니다 | String | 반환 정보 |
2. 유저 그룹 생성
인터페이스 URL
/open/create-user-group?token=xxx&projectId=2
요청 방식
POST
Content-Type
application/json
요청 Query 파라미터
| 파라미터 이름 | 예시 값 | 파라미터 타입 | 필수 여부 | 파라미터 설명 |
|---|---|---|---|---|
| token | xxx | String | 예 | 조회 키 |
| projectId | 2 | Integer | 예 | 프로젝트 ID |
요청 Body 파라미터
{
"groupName": "demo007",
"isDefault": false,
"members": [
{
"userId": 16426,
"userName": "user007"
}
]
}
| $$파라미터 이름 | 예시 값 | 파라미터 타입 | 필수 여부 | 파라미터 설명 |
|---|---|---|---|---|
| groupName | demo007 | String | 예 | 그룹 이름. 최대 64자 |
| isDefault | false | Boolean | 아니요 | 신규 유저를 기본적으로 그룹에 추가할지 여부 |
| members | - | List | 아니요 | 멤버 리스트 |
| members.userId | 16426 | Integer | 아니요 | 멤버 유저 ID |
| members.userName | user007 | String | 아니요 | 멤버 유저 이름 |
성공 응답 예시
{
"data": {
"id": 135
},
"return_code": 0,
"return_message": "success"
}
| $$파라미터 이름 | 예시 값 | 파라미터 타입 | 파라미터 설명 |
|---|---|---|---|
| data | - | Object | 반환 데이터 |
| data.id | 135 | Integer | id |
| return_code | 0 | Integer | 반환 코드 |
| return_message | success | String | 반환 정보 |
오류 응답 예시
{
"return_code": -1015,
"return_message": "이미 존재합니다"
}
| 파라미터 이름 | 예시 값 | 파라미터 타입 | 파라미터 설명 |
|---|---|---|---|
| return_code | -1015 | Integer | 반환 코드 |
| return_message | 이미 존재합니다 | String | 반환 정보 |
3. 유저 그룹 멤버 목록 업데이트
유저 그룹 이름을 추가하거나 업데이트하고, 그룹 멤버 정보를 추가하거나 업데이트하는 데 사용할 수 있습니다.
제출한 멤버 목록이 기존 멤버 목록 전체를 대체합니다.
인터페이스 URL
/open/update-user-group?token=xxx&projectId=0
요청 방식
POST
Content-Type
application/json
요청 Query 파라미터
| 파라미터 이름 | 예시 값 | 파라미터 타입 | 필수 여부 | 파라미터 설명 |
|---|---|---|---|---|
| token | xxx | String | 예 | 조회 키 |
| projectId | 0 | Integer | 예 | 프로젝트 ID |
요청 Body 파라미터
{
"id": 99,
"groupName": "testGroup",
"isDefault": false,
"members": [
{
"userId": 88,
"userName": "test88"
},
{
"userId": 100,
"userName": "test100"
}
]
}
| $$파라미터 이름 | 예시 값 | 파라미터 타입 | 필수 여부 | 파라미터 설명 |
|---|---|---|---|---|
| id | 99 | Integer | 예 | 유저 그룹 id |
| groupName | testGroup | String | 아니요 | 유저 그룹 이름. 최대 64자 지원 |
| isDefault | false | Boolean | 아니요 | 프로젝트 신규 유저를 기본적으로 이 그룹에 추가 |
| members | - | List | 아니요 | 유저 그룹 멤버 |
| members.userId | 88 | String | 아니요 | 멤버 유저의 유저 ID |
| members.userName | test88 | String | 아니요 | 멤버 유저의 유저 이름 |
성공 응답 예시
{
"return_code": 0,
"return_message": "success"
}
| 파라미터 이름 | 예시 값 | 파라미터 타입 | 파라미터 설명 |
|---|---|---|---|
| return_code | 0 | Integer | 반환 코드 |
| return_message | success | String | 반환 정보 |
오류 응답 예시
{
"return_code": -1023,
"return_message": "유저 그룹이 존재하지 않습니다"
}
| 파라미터 이름 | 예시 값 | 파라미터 타입 | 파라미터 설명 |
|---|---|---|---|
| return_code | -1023 | Integer | 반환 코드 |
| return_message | 유저 그룹이 존재하지 않습니다 | String | 반환 정보 |
5. 유저 그룹 삭제
인터페이스 URL
/open/delete-user-group?token=xxx&projectId=0&groupId=1
요청 방식
POST
Content-Type
application/json
요청 Query 파라미터
| 파라미터 이름 | 예시 값 | 파라미터 타입 | 필수 여부 | 파라미터 설명 |
|---|---|---|---|---|
| token | xxx | String | 예 | 조회 키 |
| projectId | 0 | Integer | 예 | 프로젝트 ID |
| groupId | 1 | String | 예 | 그룹 ID |
성공 응답 예시
{
"return_code": 0,
"return_message": "success"
}
| 파라미터 이름 | 예시 값 | 파라미터 타입 | 파라미터 설명 |
|---|---|---|---|
| return_code | 0 | Integer | 반환 코드 |
| return_message | success | String | 반환 정보 |
오류 응답 예시
{
"return_code": -1023,
"return_message": "유저 그룹이 존재하지 않습니다"
}
| 파라미터 이름 | 예시 값 | 파라미터 타입 | 파라미터 설명 |
|---|---|---|---|
| return_code | -1023 | Integer | 반환 코드 |
| return_message | 유저 그룹이 존재하지 않습니다 | String | 반환 정보 |
3. 프로젝트 역할 관리
1. 프로젝트 역할 상세 정보 가져오기
인터페이스 URL
/open/get-project-role-by-role-desc?token=xxx&projectId=2&roleDesc=분석가007
요청 방식
GET
Content-Type
application/json
요청 Query 파라미터
| 파라미터 이름 | 예시 값 | 파라미터 타입 | 필수 여부 | 파라미터 설명 |
|---|---|---|---|---|
| token | xxx | String | 예 | 조회 키 |
| projectId | 2 | Integer | 예 | 프로젝트 ID |
| roleDesc | 분석가007 | String | 예 | 역할 설명 |
성공 응답 예시
{
"data": {
"projectId": 2,
"roleDesc": "분석가007",
"roleName": "analyst_1462717171385241600",
"funcList": [
{
"functionClass": "유저 코호트 설정",
"functionDesc": "조건 코호트, 결과 코호트, 업로드 ID 코호트 목록 보기",
"functionId": 14,
"functionName": "viewCluster",
"functionType": "보기"
},
{
"functionId": 34,
"functionClass": "대시보드 사용",
"functionDesc": "대시보드 및 대시보드 설정 보기",
"functionName": "viewDashbord",
"functionType": "보기"
},
{
"functionId": 35,
"preFunctionId": 34,
"functionClass": "대시보드 사용",
"functionDesc": "대시보드 필터 조건 임시 조정, 전체 필터 사용",
"functionName": "useDashbordFilter",
"functionType": "보기"
}
]
},
"return_code": 0,
"return_message": "success"
}
| $$파라미터 이름 | 예시 값 | 파라미터 타입 | 파라미터 설명 |
|---|---|---|---|
| data | - | Object | 반환 데이터 |
| data.projectId | 2 | Integer | 프로젝트 ID |
| data.roleDesc | 분석가007 | String | 역할 설명 |
| data.roleName | analyst_1462717171385241600 | String | 역할 이름 |
| data.funcList | - | List | 기능 목록 |
| data.funcList.functionClass | 대시보드 사용 | String | 기능 분류 |
| data.funcList.functionDesc | 대시보드 필터 조건 임시 조정, 전체 필터 사용 | String | 기능 설명 |
| data.funcList.functionId | 35 | Integer | 기능 ID |
| data.funcList.functionName | useDashbordFilter | String | 기능 이름 |
| data.funcList.functionType | 보기 | String | 기능 타입 |
| data.funcList.preFunctionId | 34 | Integer | 의존 기능 ID |
| return_code | 0 | Integer | 반환 코드 |
| return_message | success | String | 반환 정보 |
오류 응답 예시
{
"return_code": -1023,
"return_message": "role test이(가) 존재하지 않습니다"
}
| 파라미터 이름 | 예시 값 | 파라미터 타입 | 파라미터 설명 |
|---|---|---|---|
| return_code | -1023 | Integer | 반환 코드 |
| return_message | role test이(가) 존재하지 않습니다 | String | 반환 정보 |
2. (지원 중단) 기본 역할 기능 목록 가져오기
AE 5.0 버전에서 역할 권한 관리 기능이 업그레이드되어, 더 이상 baseRole을 기반으로 커스텀 역할을 생성할 필요가 없습니다.
"모든 기능 목록 가져오기" API로 전체 기능 목록을 조회한 후, 역할의 기능 요구 사항과 기능 의존 관계에 따라 커스텀 역할을 직접 생성하십시오.
3. 모든 기능 목록 가져오기
회사 수준 token만 지원합니다.
인터페이스 URL
/open/get-all-functions?token=xxx
요청 방식
GET
Content-Type
application/json
요청 Query 파라미터
| 파라미터 이름 | 예시 값 | 파라미터 타입 | 필수 여부 | 파라미터 설명 |
|---|---|---|---|---|
| token | xxx | String | 예 | 조회 키 |
성공 응답 예시
{
"data": [
{
"functionId":6,
"functionName":"viewProjectInfo",
"functionDesc":"프로젝트 연동 정보 보기",
"functionType":"보기",
"functionClass":"프로젝트 연동"
},
{
"functionId":8,
"functionName":"configProjectParm",
"functionDesc":"프로젝트 연동 정보 편집",
"functionType":"편집",
"functionClass":"프로젝트 연동",
"preFunctionId":6
},
{
"functionId":14,
"functionName":"viewCluster",
"functionDesc":"코호트 목록 보기",
"functionType":"보기",
"functionClass":"유저 코호트 관리"
}
],
"return_code": 0,
"return_message": "success"
}
| $$파라미터 이름 | 예시 값 | 파라미터 타입 | 파라미터 설명 |
|---|---|---|---|
| data | - | Object | 반환 데이터 |
| data.functionId | 8 | Integer | 기능 ID |
| data.functionName | configProjectParm | String | 기능 이름 |
| data.functionDesc | 프로젝트 연동 정보 편집 | String | 기능 설명 |
| data.functionType | 편집 | String | 기능 카테고리 |
| data.functionClass | 프로젝트 연동 | String | 기능 모듈 |
| data.preFunctionId | 6 | Interger | 의존 기능 ID |
| return_code | 0 | Integer | 반환 코드 |
| return_message | success | String | 반환 정보 |
오류 응답 예시
{
"return_code": -1008,
"return_message": "파라미터(token)가 비어 있습니다"
}
| 파라미터 이름 | 예시 값 | 파라미터 타입 | 파라미터 설명 |
|---|---|---|---|
| return_code | -1008 | Integer | 반환 코드 |
| return_message | 파라미터(token)가 비어 있습니다 | String | 반환 정보 |
3. 프로젝트 역할 생성
프로젝트 역할을 새로 만들고 권한을 할당합니다. 먼저 "모든 기능 목록 가져오기" API로 필요한 기능 권한을 조회한 다음, 그중 권한 ID를 사용하여 이 API를 호출하는 것을 권장합니다.
인터페이스 URL
/open/create-project-role?token=xxx&projectId=2
요청 방식
POST
Content-Type
application/json
요청 Query 파라미터
| 파라미터 이름 | 예시 값 | 파라미터 타입 | 필수 여부 | 파라미터 설명 |
|---|---|---|---|---|
| token | xxx | String | 예 | 조회 키 |
| projectId | 2 | Integer | 예 | 프로젝트 ID |
요청 Body 파라미터
{
"roleDesc": "분석가007",
"roleFuncList": [
14,34,53
]
}
| 파라미터 이름 | 예시 값 | 파라미터 타입 | 필수 여부 | 파라미터 설명 |
|---|---|---|---|---|
| roleDesc | 분석가007 | String | 예 | 역할 설명. 최대 60자 |
| roleFuncList | [14] | List | 예 | 역할 기능 ID 목록. 반드시 유효한 ID여야 함 |
성공 응답 예시
{
"data": {
"roleName": "analyst_1462717171385241600"
},
"return_code": 0,
"return_message": "success"
}
| $$파라미터 이름 | 예시 값 | 파라미터 타입 | 파라미터 설명 |
|---|---|---|---|
| data | - | Object | 반환 데이터 |
| data.roleName | analyst_1462717171385241600 | String | 역할 이름 |
| return_code | 0 | Integer | 반환 코드 |
| return_message | success | String | 반환 정보 |
오류 응답 예시
{
"return_code": -3004,
"return_message": "유효하지 않은 프로젝트"
}
| 파라미터 이름 | 예시 값 | 파라미터 타입 | 파라미터 설명 |
|---|---|---|---|
| return_code | -3004 | Integer | 반환 코드 |
| return_message | 유효하지 않은 프로젝트 | String | 반환 정보 |
4. 프로젝트 역할 수정
인터페이스 URL
/open/update-project-role?token=xxx&projectId=2&roleName=admin
요청 방식
POST
Content-Type
application/json
요청 Query 파라미터
| 파라미터 이름 | 예시 값 | 파라미터 타입 | 필수 여부 | 파라미터 설명 |
|---|---|---|---|---|
| token | xxx | String | 예 | 조회 키 |
| projectId | 2 | Integer | 예 | 프로젝트 ID |
| roleName | admin | String | 예 | 역할 이름 |
요청 Body 파라미터
{
"roleDesc": "분석가009",
"roleFuncList": [
14,34,53
]
}
| 파라미터 이름 | 예시 값 | 파라미터 타입 | 필수 여부 | 파라미터 설명 |
|---|---|---|---|---|
| roleDesc | 분석가009 | String | 아니요 | 역할 설명 |
| roleFuncList | [14] | List | 아니요 | 역할 기능 ID 목록 |
성공 응답 예시
{
"return_code": 0,
"return_message": "success"
}
| 파라미터 이름 | 예시 값 | 파라미터 타입 | 파라미터 설명 |
|---|---|---|---|
| return_code | 0 | Integer | 반환 코드 |
| return_message | success | String | 반환 정보 |
오류 응답 예시
{
"return_code": -3004,
"return_message": "유효하지 않은 프로젝트"
}
| 파라미터 이름 | 예시 값 | 파라미터 타입 | 파라미터 설명 |
|---|---|---|---|
| return_code | -3004 | Integer | 반환 코드 |
| return_message | 유효하지 않은 프로젝트 | String | 반환 정보 |
5. 프로젝트 역할 삭제
AE 5.0 버전에서 커스텀 기능 권한이 업그레이드되어, 기존 역할을 삭제할 때는 대체할 새 역할을 지정해야 기존 역할의 계정을 정상적으로 사용할 수 있습니다.
인터페이스 URL
/open/delete-project-role?token=xxx&projectId=0&roleName=role_1&newRoleName=role_2
요청 방식
POST
Content-Type
application/json
요청 Query 파라미터
| 파라미터 이름 | 예시 값 | 파라미터 타입 | 필수 여부 | 파라미터 설명 |
|---|---|---|---|---|
| token | xxx | String | 예 | 조회 키 |
| projectId | 0 | Integer | 예 | 프로젝트 ID |
| roleName | role_1 | String | 예 | 역할 이름 |
| newRoleName | role_2 | String | 예 | 지정할 새 역할 이름 |
성공 응답 예시
{
"return_code": 0,
"return_message": "success"
}
| 파라미터 이름 | 예시 값 | 파라미터 타입 | 파라미터 설명 |
|---|---|---|---|
| return_code | 0 | Integer | 반환 코드 |
| return_message | success | String | 반환 정보 |
오류 응답 예시
{
"return_code": -1023,
"return_message": "role 'role_1'이(가) 존재하지 않습니다"
}
| 파라미터 이름 | 예시 값 | 파라미터 타입 | 파라미터 설명 |
|---|---|---|---|
| return_code | -1023 | Integer | 반환 코드 |
| return_message | role 'test'이(가) 존재하지 않습니다 | String | 반환 정보 |
4. 대시보드 공유 블랙리스트
사용 시나리오: 대시보드 공유를 설정할 때 모든 멤버에게 공개하도록 공유한 경우, 블랙리스트를 사용하여 일부 유저를 제외할 수 있습니다.
1. 블랙리스트 추가
회사 수준 token만 지원합니다.
인터페이스 URL
/open/share/add-black?token=xxx&loginName=root&blackProjectId=0
요청 방식
POST
Content-Type
application/json
요청 Query 파라미터
| 파라미터 이름 | 예시 값 | 파라미터 타입 | 필수 여부 | 파라미터 설명 |
|---|---|---|---|---|
| token | xxx | String | 예 | 조회 키 |
| loginName | root | String | 예 | 로그인 이름 |
| blackProjectId | 0 | Integer | 예 | 블랙리스트 프로젝트 ID 0: 모든 프로젝트 공통 블랙리스트 프로젝트 ID: 해당 프로젝트의 블랙리스트만 해당 |
성공 응답 예시
{
"return_code": 0,
"return_message": "success"
}
| 파라미터 이름 | 예시 값 | 파라미터 타입 | 파라미터 설명 |
|---|---|---|---|
| return_code | 0 | Integer | 반환 코드 |
| return_message | success | String | 반환 정보 |
| data | Object | 반환 결과 |
오류 응답 예시
{
"return_code": -1008,
"return_message": "파라미터(token)가 비어 있습니다"
}
| 파라미터 이름 | 예시 값 | 파라미터 타입 | 파라미터 설명 |
|---|---|---|---|
| return_code | -1008 | Integer | 반환 코드 |
| return_message | 파라미터(token)가 비어 있습니다 | String | 반환 정보 |
2. 블랙리스트 일괄 추가(csv)
회사 수준 token만 지원합니다.
인터페이스 URL
/open/share/add-black-list?token=xxx
요청 방식
POST
Content-Type
application/json
요청 Query 파라미터
| 파라미터 이름 | 예시 값 | 파라미터 타입 | 필수 여부 | 파라미터 설명 |
|---|---|---|---|---|
| token | xxx | String | 예 | 조회 키 |
파일 템플릿은 다음과 같습니다.
loginName,blackProjectId
demo@thinkingdata,-1
user1,298
성공 응답 예시
{
"return_code": 0,
"return_message": "success"
}
| 파라미터 이름 | 예시 값 | 파라미터 타입 | 파라미터 설명 |
|---|---|---|---|
| return_code | 0 | Integer | 반환 코드 |
| return_message | success | String | 반환 정보 |
오류 응답 예시
{
"return_code": -1008,
"return_message": "파라미터(token)가 비어 있습니다"
}
| 파라미터 이름 | 예시 값 | 파라미터 타입 | 파라미터 설명 |
|---|---|---|---|
| return_code | -1008 | Integer | 반환 코드 |
| return_message | 파라미터(token)가 비어 있습니다 | String | 반환 정보 |
3. 블랙리스트 그룹 설정
- 회사 수준 token만 지원합니다.
- 그룹을 블랙리스트 그룹으로 설정하면 그룹의 모든 멤버가 블랙리스트에 추가됩니다.
인터페이스 URL
/open/share/add-black-group-list?token=xxx&groupIdList=[1]&groupType=1
요청 방식
POST
Content-Type
application/json
요청 Query 파라미터
| 파라미터 이름 | 예시 값 | 파라미터 타입 | 필수 여부 | 파라미터 설명 |
|---|---|---|---|---|
| token | xxx | String | 예 | 조회 키 |
| groupIdList | [1] | List | 예 | 그룹 ID 목록 |
| groupType | 1 | Integer | 예 | 1: 블랙리스트 그룹 |
성공 응답 예시
{
"return_code": 0,
"return_message": "success"
}
| 파라미터 이름 | 예시 값 | 파라미터 타입 | 파라미터 설명 |
|---|---|---|---|
| return_code | 0 | Integer | 반환 코드 |
| return_message | success | String | 반환 정보 |
오류 응답 예시
{
"return_code": -1008,
"return_message": "파라미터(token)가 비어 있습니다"
}
| 파라미터 이름 | 예시 값 | 파라미터 타입 | 파라미터 설명 |
|---|---|---|---|
| return_code | -1008 | Integer | 반환 코드 |
| return_message | 파라미터(token)가 비어 있습니다 | String | 반환 정보 |
4. 블랙리스트 삭제
- 회사 수준 token만 지원합니다.
- 특정 유저를 특정 프로젝트의 블랙리스트에서 제거하거나, 모든 블랙리스트에서 제거할 수 있습니다.
인터페이스 URL
/open/share/cancel-black?token=xxx&loginName=root&blackProjectId=0
요청 방식
POST
Content-Type
application/json
요청 Query 파라미터
| 파라미터 이름 | 예시 값 | 파라미터 타입 | 필수 여부 | 파라미터 설명 |
|---|---|---|---|---|
| token | xxx | String | 예 | 조회 키 |
| loginName | root | String | 예 | 로그인 이름 |
| blackProjectId | 0 | Integer | 아니요 | 블랙리스트 프로젝트 ID |
성공 응답 예시
{
"return_code": 0,
"return_message": "success"
}
| 파라미터 이름 | 예시 값 | 파라미터 타입 | 파라미터 설명 |
|---|---|---|---|
| return_code | 0 | Integer | 반환 코드 |
| return_message | success | String | 반환 정보 |
오류 응답 예시
{
"return_code": -1008,
"return_message": "파라미터(token)가 비어 있습니다"
}
| 파라미터 이름 | 예시 값 | 파라미터 타입 | 파라미터 설명 |
|---|---|---|---|
| return_code | -1008 | Integer | 반환 코드 |
| return_message | 파라미터(token)가 비어 있습니다 | String | 반환 정보 |
5. 블랙리스트 다운로드
- 회사 수준 token만 지원합니다.
인터페이스 URL
/open/share/download-share-black?token=xxx
요청 방식
POST
Content-Type
application/json
요청 Query 파라미터
| 파라미터 이름 | 예시 값 | 파라미터 타입 | 필수 여부 | 파라미터 설명 |
|---|---|---|---|---|
| token | xxx | String | 예 | 조회 키 |
성공 응답 예시
csv 파일이며, 예시 스크린샷은 다음과 같습니다.
오류 응답 예시
{
"return_code": -1008,
"return_message": "파라미터(token)가 비어 있습니다"
}
| 파라미터 이름 | 예시 값 | 파라미터 타입 | 파라미터 설명 |
|---|---|---|---|
| return_code | -1008 | Integer | 반환 코드 |
| return_message | 파라미터(token)가 비어 있습니다 | String | 반환 정보 |

