유저 관리 API

최근 업데이트 2026. 10. 03.

호출 방법은 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	계정 상태 INVALID: 유효하지 않음 NORMAL: 정상 상태 LOCK: 잠금 상태
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는 다음 기능을 수행합니다.
1. 유저 계정을 생성하며, 초기 비밀번호는 "ta2020"입니다. 유저 계정이 이미 있으면 유저 계정 생성 단계를 건너뜁니다.
2. 각 프로젝트에서 유저 계정의 역할을 설정합니다. 역할은 프로젝트에 이미 정의되어 있어야 합니다.
회사 수준 token만 지원합니다.

주의

이전 버전에서는 분석 관리자 역할을 생성할 때 전달해야 하는 역할 이름이 관리자였습니다.

위 제한은 v5.0 버전의 역할 최적화 이후 해제되었으며, 프로젝트의 분석 역할 이름을 그대로 전달하면 됩니다.

이름은 수정할 수 있으므로 AE 시스템의 시스템 관리/프로젝트 관리에 있는 <역할 관리> 페이지에서 필요한 역할 이름을 확인하십시오.

인터페이스 URL

/open/batch-create-auth-user-and-set-roles?token=xxx

요청 방식

POST

Content-Type

application/json

요청 Query 파라미터

파라미터 이름	예시 값	파라미터 타입	필수 여부	파라미터 설명
token	xxx	String	예	조회 키

요청 Body 파라미터

{
    "authUsers": [{
        "loginName": "test_user1",
        "roles": [{
            "projectId": 57,
            "roleDesc": "데이터 분석가A"
        }, {
            "projectId": 0,
            "roleDesc": "역할 테스트A"
        }]
    }, {
        "loginName": "test_user2",
        "roles": [{
            "projectId": 390,
            "roleDesc": "테스트2"
        }, {
            "projectId": 377,
            "roleDesc": "일반 멤버"
                }]
        }]
}

$$파라미터 이름	예시 값	파라미터 타입	필수 여부	파라미터 설명
authUsers	-	List	예	유저 정보 엔티티
authUsers.loginName	test_user1	String	예	유저 로그인 계정 이름
authUsers.roles	-	List	예	역할 목록
authUsers.roles.projectId	390	Integer	아니요	프로젝트 ID
authUsers.roles.roleDesc	테스트2	String	예	분석 역할 표시 이름. 현재 API로 운영 역할을 설정하는 것은 지원하지 않음

성공 응답 예시

{
    "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	반환 정보

사용 시나리오: 대시보드 공유를 설정할 때 모든 멤버에게 공개하도록 공유한 경우, 블랙리스트를 사용하여 일부 유저를 제외할 수 있습니다.

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

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 파일이며, 예시 스크린샷은 다음과 같습니다.

WPS 打开的看板分享黑名单 CSV，含 loginName、blackProjectId、createTime

오류 응답 예시

{
    "return_code": -1008,
    "return_message": "파라미터(token)가 비어 있습니다"
}

파라미터 이름	예시 값	파라미터 타입	파라미터 설명
return_code	-1008	Integer	반환 코드
return_message	파라미터(token)가 비어 있습니다	String	반환 정보

이 문서가 도움이 되었나요?

1. 유저 관리​

1. 유저 ID 조회​

2. 단일 유저 정보 조회(역할 포함)​

3. 유저 계정 상태 조회​

4. 유저 비활성화​

5. 유저 비활성화 해제​

6. 유저의 MFA 연결 해제​

7. 유저 역할 일괄 생성​

9. SSO 유저 생성​

10. 프로젝트에서 유저 삭제(작업 이관 선택 가능)​

11. 시스템에서 유저 삭제(작업 이관 선택 가능)​

2. 유저 그룹 관리​

1. 유저 그룹 ID 및 멤버 목록 조회​

2. 유저 그룹 생성​

3. 유저 그룹 멤버 목록 업데이트​

5. 유저 그룹 삭제​

3. 프로젝트 역할 관리​

1. 프로젝트 역할 상세 정보 가져오기​

2. (지원 중단) 기본 역할 기능 목록 가져오기​

3. 모든 기능 목록 가져오기​

3. 프로젝트 역할 생성​

4. 프로젝트 역할 수정​

5. 프로젝트 역할 삭제​

4. 대시보드 공유 블랙리스트​

1. 블랙리스트 추가​

2. 블랙리스트 일괄 추가(csv)​

3. 블랙리스트 그룹 설정​

4. 블랙리스트 삭제​

5. 블랙리스트 다운로드​

1. 유저 관리

1. 유저 ID 조회

2. 단일 유저 정보 조회(역할 포함)

3. 유저 계정 상태 조회

4. 유저 비활성화

5. 유저 비활성화 해제

6. 유저의 MFA 연결 해제

7. 유저 역할 일괄 생성

9. SSO 유저 생성

10. 프로젝트에서 유저 삭제(작업 이관 선택 가능)

11. 시스템에서 유저 삭제(작업 이관 선택 가능)

2. 유저 그룹 관리

1. 유저 그룹 ID 및 멤버 목록 조회

2. 유저 그룹 생성

3. 유저 그룹 멤버 목록 업데이트

5. 유저 그룹 삭제

3. 프로젝트 역할 관리

1. 프로젝트 역할 상세 정보 가져오기

2. (지원 중단) 기본 역할 기능 목록 가져오기

3. 모든 기능 목록 가져오기

3. 프로젝트 역할 생성

4. 프로젝트 역할 수정

5. 프로젝트 역할 삭제

4. 대시보드 공유 블랙리스트

1. 블랙리스트 추가

2. 블랙리스트 일괄 추가(csv)

3. 블랙리스트 그룹 설정

4. 블랙리스트 삭제

5. 블랙리스트 다운로드