menu
Is this helpful?

# 사용자 관리 API

호출 방법에 대해서는 오픈 API의 호출 방법 설명을 참조하십시오.

# 1. 사용자 관리

# 사용자 ID 조회

::: 팁

회사 키만 지원합니다.

:::

인터페이스 URL

/open/list-auth-users-by-login-names?token=xxx

요청 방법

POST

콘텐츠 유형

application/json

요청 쿼리 파라미터

Parameter name

Sample value

Parameter type

Is required

Parameter description

token

xxx

String

Yes

token

요청 본문 파라미터

{
    "loginNames": [
        "test_user1",
        "test_user2"
    ]
}

Parameter name

Sample value

Parameter type

Is required

Parameter description

loginNames

["test_user1"]

List

Yes

Login user name into list

성공적인 응답 예시

{
    "return_code": 0,
    "return_message": "success",
    "data": {
        "authUsers": [
            {
                "userId": 88,
                "loginName": "test_user1"
            },
            {
                "userId": 89,
                "loginName": "test_user2"
            }
        ]
    }
}

$$Parameter name

Sample value

Parameter type

Parameter description

return_code

0

Integer

Return code

return_message

success

String

Return message

data

-

Object

Return results

data.authUsers

-

List

User list

data.authUsers.userId

88

Integer

User ID

data.authUsers.loginName

test_user1

String

User name

# 개별 사용자 정보 조회 (역할 포함)

::: 팁

  • 사용자가 관리자일 때 companyRole을 반환하고, 관리자가 아닐 때 projectRoles를 반환합니다.
  • 회사 키만 지원합니다.

:::

인터페이스 URL

/open/get-auth-user-info-by-login-name?token=xxx&loginName= test_user1

호출 방법

GET

콘텐츠 유형

application/json

요청 쿼리 파라미터

Parameter name

Sample value

Parameter type

Is required

Parameter description

token

xxx

String

Yes

token

loginName

test_user1

String

Yes

Login name

성공적인 응답 예시

사용자가 관리자일 때 companyRole을 반환합니다:

{
  "return_code": 0,
  "return_message": "success",
  "data": {
    "userId": 88,
    "loginName": "test_user1",
    "userName": "test user A",
    "roleInfo": {
      "companyRole": {
        "roleName": "root",
        "roleDesc": "company supervisor"
      }
    }
  }
}

$$Parameter name

Sample value

Parameter type

Parameter description

data

-

Object

Return results

data.loginName

test_user1

String

Login name

data.roleInfo

-

Object

Role information

data.roleInfo.companyRole

-

List

Company Roles List

data.roleInfo.companyRole.roleName

root

String

Role description

data.roleInfo.companyRole.roleDesc

Company Supertube

String

Role name

data.userId

88

Integer

User ID

data.userName

Test user A

String

User name

return_code

0

Integer

Return code

return_message

success

String

Return message

사용자가 관리자가 아닐 때, projectRoles를 반환합니다:

{
  "return_code": 0,
  "return_message": "success",
  "data": {
    "userId": 88,
    "loginName": "test_user1",
    "userName": "test user A",
    "roleInfo": {
      "projectRoles": [
        {
          "projectId": 3,
          "roleName": "admin",
          "roleDesc": "adminstrator"
        },
        {
          "projectId": 4,
          "roleName": "analyst",
          "roleDesc": "analyst"
        }
      ]
    }
  }
}

$$Parameter name

Sample value

Parameter type

Parameter description

data

-

Object

Return results

data.loginName

test_user1

String

Login name

data.roleInfo

-

Object

Role information

data.roleInfo.projectRoles

-

List

Project Roles List

data.roleInfo.projectRoles.projectId

3

Integer

Project ID

data.roleInfo.projectRoles.roleDesc

Administrator

String

Role description

data.roleInfo.projectRoles.roleName

admin

String

Role name

data.userId

88

Integer

User ID

data.userName

Test user A

String

User name

return_code

0

Integer

Return code

return_message

success

String

Return message

오류 응답 예시

{
    "return_code": -1008,
    "return_message": "Find no user with loginName: test007"
}

Parameter name

Sample value

Parameter type

Parameter description

return_code

-1008

Integer

Return code

return_message

Find no user with loginName: test007

String

Return message

# 사용자 계정 상태 조회

::: 팁

  • 사용자 로그인 이름에 따라 사용자 계정 상태를 조회합니다.

:::

인터페이스 URL

/open/get-auth-user-status?token=xxx&loginName=user007

요청 방법

GET

콘텐츠 유형

application/json

요청 쿼리 파라미터

Parameter name

Sample value

Parameter type

Is required

Parameter description

token

xxx

String

Yes

token

loginName

user007

String

Yes

Login name

성공적인 응답 예시

{
    "data": {
        "accountStatus": "NORMAL",
        "loginName": "user007"
    },
    "return_code": 0,
    "return_message": "success"
}

$$Parameter name

Sample value

Parameter type

Parameter description

data

-

Object

Return results

data.accountStatus

NORMAL

String

Account Status

  • INVALID: Invalid

  • NORMAL: Normal state

  • LOCK: Locked state

data.loginName

user007

String

Login name

return_code

0

Integer

Return code

return_message

success

String

Return message

오류 응답 예시

{
    "return_code": -1008,
    "return_message": "The parameter (token) is empty"
}

Parameter name

Sample value

Parameter type

Parameter description

return_code

-1008

Integer

Return code

return_message

The parameter (token) is empty

String

Return message

# 사용자 계정 잠금

::: 팁

  • 로그인 이름을 기반으로 사용자 계정을 잠급니다.

:::

인터페이스 URL

/open/member-lock?token=xxx&loginName=user007

요청 방법

POST

콘텐츠 유형

application/json

요청 쿼리 파라미터

Parameter name

Sample value

Parameter type

Is required

Parameter description

token

xxx

String

Yes

token

loginName

user007

String

Yes

Login name

성공적인 응답 예시

{
    "data": true,
    "return_code": 0,
    "return_message": "success"
}

Parameter name

Sample value

Parameter type

Parameter description

data

true

Object

Return results

return_code

0

Integer

Return code

return_message

success

String

Return message

오류 응답 예시

{
    "return_code": -1006,
    "return_message": "You do not have permission to operate, please check that the token value is correct"
}

Parameter name

Sample value

Parameter type

Parameter description

return_code

-1006

Integer

Return code

return_message

You do not have permission to operate, please check whether the token value is correct

String

Return message

# 사용자 계정 잠금 해제

::: 팁

  • 로그인 이름에 따라 사용자 계정을 잠금 해제합니다.

:::

인터페이스 URL

/open/member-unlock?token=xxx&loginName=user007

요청 방법

POST

콘텐츠 유형

application/json

요청 쿼리 파라미터

Parameter name

Sample value

Parameter type

Is required

Parameter description

token

xxx

String

Yes

token

loginName

user007

String

Yes

Login name

성공적인 응답 예시

{
    "data": true,
    "return_code": 0,
    "return_message": "success"
}

Parameter name

Sample value

Parameter type

Parameter description

data

true

Object

Return results

return_code

0

Integer

Return code

return_message

success

String

Return message

오류 응답 예시

{
    "return_code": -1006,
    "return_message": "You do not have permission to operate, please check that the token value is correct"
}

Parameter name

Sample value

Parameter type

Parameter description

return_code

-1006

Integer

Return code

return_message

You do not have permission to operate, please check whether the token value is correct

String

Return message

# 사용자의 MFA 바인딩 해제

::: 팁

회사 키만 지원합니다.

:::

인터페이스 URL

/open/unbind-auth-user-mfa?token=xxx&loginName=root

요청 방법

POST

콘텐츠 유형

application/json

요청 쿼리 파라미터

Parameter name

Sample value

Parameter type

Is required

Parameter description

token

xxx

String

Yes

token

loginName

root

String

Yes

Login name

성공적인 응답 예시

{
    "return_code": 0,
    "return_message": "success"
}

Parameter name

Sample value

Parameter type

Parameter description

return_code

0

Integer

Return code

return_message

success

String

Return message

오류 응답 예시

{
    "return_code": -1009,
    "return_message": "user name does not exist"
}

Parameter name

Sample value

Parameter type

Parameter description

return_code

-1009

Integer

Return code

return_message

User name does not exist

String

Return message

# 사용자 역할 일괄 생성

::: 팁

  • 이 API는 다음을 수행합니다:
    1. 사용자 계정을 생성하며, 초기 비밀번호는 "ta2020"입니다. 사용자 계정이 이미 존재하는 경우, 사용자 계정 생성 단계를 건너뜁니다.
    2. 각 프로젝트에서 사용자 계정의 역할을 설정합니다. 역할은 프로젝트에서 미리 정의되어 있어야 합니다.
  • 회사 키만 지원합니다.

:::

인터페이스 URL

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

요청 방법

POST

콘텐츠 유형

application/json

요청 쿼리 파라미터

Parameter name

Sample value

Parameter type

Is required

Parameter description

token

xxx

String

Yes

token

요청 본문 파라미터

{
    "authUsers": [{
        "loginName": "test_user1",
        "roles": [{
            "projectId": 57,
            "roleDesc": "data analyst A"
        }, {
            "projectId": 0,
            "roleDesc": "test role A"
        }]
    }, {
        "loginName": "test_user2",
        "roles": [{
            "projectId": 390,
            "roleDesc": "test 2"
        }, {
            "projectId": 377,
            "roleDesc": "regular user"
                }]
        }]
}

$$Parameter name

Sample value

Parameter type

Is required

Parameter description

authUsers

-

List

Yes

User Information Entity

authUsers.loginName

test_user1

String

Yes

User login account name

authUsers.roles

-

List

Yes

Role list

authUsers.roles.projectId

390

Integer

No

Project ID

authUsers.roles.roleDesc

Test 2

String

Yes

Role display name

성공적인 응답 예시

{
    "return_code": 0,
    "return_message": "success"
}

Parameter name

Sample value

Parameter type

Parameter description

return_code

0

Integer

Return code

return_message

success

String

Return message

오류 응답 예시

{
    "return_code": -1006,
    "return_message": "This API is Forbidden in SAAS"
}

Parameter name

Sample value

Parameter type

Parameter description

return_code

-1006

Integer

Return code

return_message

This API is Forbidden in SAAS

String

Return message

# SSO 사용자 생성

::: 팁

  • SSO 사용자 정보 생성을 위한 것입니다.

:::

인터페이스 URL

/open/create/ssoUser?token=xxx&loginType=dingtalk&loginName=user007

요청 방법

GET

요청 쿼리 파라미터

Parameter name

Sample value

Parameter type

Is required

Parameter description

token

xxx

String

Yes

token

loginType

dingtalk

String

Yes

Three-party login type

loginName

user007

String

Yes

Login name

password

-

String

No

Login password (the system will automatically generate it if it is not transmitted)

성공적인 응답 예시

{
    "data": true,
    "return_code": 0,
    "return_message": "success"
}

Parameter name

Sample value

Parameter type

Parameter description

data

true

Object

Return results

return_code

0

Integer

Return code

return_message

success

String

Return message

오류 응답 예시

{
    "return_code": -1006,
    "return_message": "You do not have permission to operate, please check that the token value is correct"
}

Parameter name

Sample value

Parameter type

Parameter description

return_code

-1006

Integer

Return code

return_message

You do not have permission to operate, please check whether the token value is correct

String

Return message

# 프로젝트에서 사용자 삭제 및 업무 인계 옵션

인터페이스 URL

/open/delete-auth-user-from-project?token=xxx&projectId=0&loginName=user007&handoverToLoginName=user008

요청 방법

POST

콘텐츠 유형

application/json

요청 쿼리 파라미터

Parameter name

Sample value

Parameter type

Is required

Parameter description

token

xxx

String

Yes

token

projectId

0

Integer

Yes

Project ID

loginName

user007

String

Yes

User login name to delete

handoverToLoginName

user008

String

Yes

User login names that can be handed over

성공적인 응답 예시

{
    "return_code": 0,
    "return_message": "success"
}

Parameter name

Sample value

Parameter type

Parameter description

return_code

0

Integer

Return code

return_message

success

String

Return message

오류 응답 예시

{
    "return_code": -1023,
    "return_message": "user user007 does not exist"
}

Parameter name

Sample value

Parameter type

Parameter description

return_code

-1023

Integer

Return code

return_message

User user007 does not exist

String

Return message

# 시스템에서 사용자 삭제 및 업무 인계 옵션

::: 팁

회사 키만 지원합니다.

:::

인터페이스 URL

/open/delete-auth-user-from-system?token=xxx&loginName=user007&handoverToLoginName=user008

요청 방법

POST

콘텐츠 유형

application/json

요청 쿼리 파라미터

Parameter name

Sample value

Parameter type

Is required

Parameter description

token

xxx

String

Yes

token

loginName

user007

Integer

Yes

Login name

handoverToLoginName

user008

String

Yes

User login name handed over

성공적인 응답 예시

{
    "return_code": 0,
    "return_message": "success"
}

Parameter name

Sample value

Parameter type

Parameter description

return_code

0

Integer

Return code

return_message

success

String

Return message

오류 응답 예시

{
    "return_code": -1010,
    "return_message": "Unsupported in SAAS"
}

Parameter name

Sample value

Parameter type

Parameter description

return_code

-1010

Integer

Return code

return_message

Unsupported in SAAS

String

Return message

# 2. 사용자 그룹 관리

# 사용자 그룹 ID 및 구성원 목록 조회

인터페이스 URL

/open/get-user-group-by-name?token=xxx&projectId=0&userGroupName=demo007

요청 방법

GET

콘텐츠 유형

application/json

요청 쿼리 파라미터

Parameter name

Sample value

Parameter type

Is required

Parameter description

token

xxx

String

Yes

token

projectId

0

Integer

Yes

Project ID

userGroupName

demo007

String

Yes

User group name

성공적인 응답 예시

{
    "data": {
        "groupName": "demo007",
        "id": 133,
        "isDefault": false,
        "members": [
            {
                "userId": 16426
            }
        ],
        "updateTime": "2021-11-22 19:22:15"
    },
    "return_code": 0,
    "return_message": "success"
}

$$Parameter name

Sample value

Parameter type

Parameter description

data

-

Object

Return data

data.groupName

demo007

String

Group name

data.id

133

Integer

id

data.isDefault

false

Boolean

Whether to default

data.members

-

List

Member list

data.members.userId

16426

Integer

User ID

data.updateTime

2021-11-22 19:22:15

Date

Update time

return_code

0

Integer

Return code

return_message

success

String

Return information

오류 응답 예시

{
    "return_code": -1023,
    "return_message": "User group does not exist"
}

Parameter name

Sample value

Parameter type

Parameter description

return_code

-1023

Integer

Return code

return_message

User grouping does not exist

String

Return information

# 사용자 그룹 생성

인터페이스 URL

/open/create-user-group?token=xxx&projectId=2

요청 방법

POST

콘텐츠 유형

application/json

요청 쿼리 파라미터

Parameter name

Sample value

Parameter type

Is required

Parameter description

token

xxx

String

Yes

token

projectId

2

Integer

Yes

Project ID

요청 본문 파라미터

{
    "groupName": "demo007",
    "isDefault": false,
    "members": [
        {
            "userId": 16426,
            "userName": "user007"
        }
    ]
}
$$Parameter name Sample value Parameter type Is required Parameter description
groupName demo007 String Yes Group name, up to 64 characters
isDefault false Boolean No Whether new users join groups by default
members - List No Member list
members.userId 16426 Integer No Member user ID
members.userName user007 String No Member User Name

성공적인 응답 예시

{
    "data": {
        "id": 135
    },
    "return_code": 0,
    "return_message": "success"
}
$$Parameter name Sample value Parameter type Parameter description
data - Object Return results
data.id 135 Integer id
return_code 0 Integer Return code
return_message success String Return message

오류 응답 예시

{
    "return_code": -1015,
    "return_message": "exist"
}
Parameter name Sample value Parameter type Parameter description
return_code -1015 Integer Return code
return_message Already exist String Return message

# 사용자 그룹 구성원 목록 업데이트

사용자 그룹 이름을 추가하거나 업데이트하고, 그룹 구성원 정보를 추가하거나 업데이트하는 데 사용할 수 있습니다.

::: 팁

  • 제출된 구성원 목록은 원래 구성원 목록을 전체적으로 대체합니다.

:::

인터페이스 URL

/open/update-user-group?token=xxx&projectId=0

요청 방법

POST

콘텐츠 유형

application/json

요청 쿼리 파라미터

Parameter name

Sample value

Parameter type

Is required

Parameter description

token

xxx

String

Yes

token

projectId

0

Integer

Yes

Project ID

요청 본문 파라미터

{
  "id": 99,
  "groupName": "testGroup",
  "isDefault": false,
  "members": [
    {
      "userId": 88,
      "userName": "test88"
    },
    {
      "userId": 100,
      "userName": "test100"
    }
  ]
}

$$Parameter name

Sample value

Parameter type

Is required

Parameter description

id

99

Integer

Yes

User group id

groupName

testGroup

String

No

User group name, maximum support 64 characters

isDefault

false

Boolean

No

New project users join this group by default

members

-

List

No

User group members

members.userId

88

String

No

User member user ID

members.userName

test88

String

No

User member user name

성공적인 응답 예시

{
    "return_code": 0,
    "return_message": "success"
}

Parameter name

Sample value

Parameter type

Parameter description

return_code

0

Integer

Return code

return_message

success

String

Return message

오류 응답 예시

{
    "return_code": -1023,
    "return_message": "user group does not exist"
}

Parameter name

Sample value

Parameter type

Parameter description

return_code

-1023

Integer

Return code

return_message

User grouping does not exist

String

Return message

# 사용자 그룹 삭제

인터페이스 URL

/open/delete-user-group?token=xxx&projectId=0&groupId=1

요청 방법

POST

콘텐츠 유형

application/json

요청 쿼리 파라미터

Parameter name

Sample value

Parameter type

Is required

Parameter description

token

xxx

String

Yes

token

projectId

0

Integer

Yes

Project ID

groupId

1

String

Yes

Group ID

성공적인 응답 예시

{
    "return_code": 0,
    "return_message": "success"
}

Parameter name

Sample value

Parameter type

Parameter description

return_code

0

Integer

Return code

return_message

success

String

Return message

오류 응답 예시

{
    "return_code": -1023,
    "return_message": "use group does not exist"
}

Parameter name

Sample value

Parameter type

Parameter description

return_code

-1023

Integer

Return code

return_message

User grouping does not exist

String

Return message

# 3. 프로젝트 역할 관리

# 프로젝트 역할 세부 정보 조회

인터페이스 URL

/open/get-project-role-by-role-desc?token=xxx&projectId=2&roleDesc=analyst007

요청 방법

GET

콘텐츠 유형

application/json

요청 쿼리 파라미터

Parameter name

Sample value

Parameter type

Is required

Parameter description

token

xxx

String

Yes

token

projectId

2

Integer

Yes

Project ID

roleDesc

Analyst 007

String

Yes

Role description

성공적인 응답 예시

{
    "data": {
        "baseRole": "analyst",
        "funcList": [
            {
                "functionClass": "User Group Settings",
                "functionDesc": "View list of conditional, result, and upload ID groups",
                "functionId": 14,
                "functionName": "viewCluster",
                "functionType": "view"
            },
            {
                "functionClass": "User Tag Management",
                "functionDesc": "View Tag List",
                "functionId": 53,
                "functionName": "viewTag",
                "functionType": "view"
            },
            {
                "functionClass": "dashboard usage",
                "functionDesc": "View dashboard and dashboard Settings",
                "functionId": 34,
                "functionName": "viewDashbord",
                "functionType": "view"
            }
        ],
        "projectId": 2,
        "roleDesc": "analyst 007",
        "roleName": "analyst_1462717171385241600"
    },
    "return_code": 0,
    "return_message": "success"
}

$$Parameter name

Sample value

Parameter type

Parameter description

data

-

Object

Return results

data.baseRole

analyst

String

Basic roles

data.funcList

-

List

Feature List

data.funcList.functionClass

User grouping settings

String

Functional classification

data.funcList.functionDesc

View the list of conditional grouping, result grouping, upload ID grouping

String

Function description

data.funcList.functionId

14

Integer

Function ID

data.funcList.functionName

viewCluster

String

Function name

data.funcList.functionType

View

String

Function type

data.projectId

2

Integer

Project ID

data.roleDesc

Analyst 007

String

Role description

data.roleName

analyst_1462717171385241600

String

Role name

return_code

0

Integer

Return code

return_message

success

String

Return message

오류 응답 예시

{
    "return_code": -1023,
    "return_message": "role test does not exist"
}

Parameter name

Sample value

Parameter type

Parameter description

return_code

-1023

Integer

Return code

return_message

Role test does not exist

String

Return message

# 기본 역할 기능 열 조회

::: 팁

회사 키만 지원합니다.

:::

인터페이스 URL

/open/get-base-role-functions?token=xxx&baseRoleName=analyst

요청 방법

GET

콘텐츠 유형

application/json

요청 쿼리 파라미터

Parameter name

Sample value

Parameter type

Is required

Parameter description

token

xxx

String

Yes

token

baseRoleName

analyst

String

Yes

Basic role name

  • Analyst: analyst

  • Member: Ordinary member

성공적인 응답 예시

{
    "data": {
        "defaultHaveCouldRemove": [
            {
                "functionClass": "dashboard usage",
                "functionDesc": "Temporarily adjust the filter conditions of Kanban, use global filter",
                "functionId": 35,
                "functionName": "useDashbordFilter",
                "functionType": "view"
            }
        ],
        "defaultNotHaveCouldAdd": [
            {
                "functionClass": "model usage",
                "functionDesc": "Use models, save reports, manage reports",
                "functionId": 28,
                "functionName": "useModel",
                "functionType": "Function Use"
            }
        ],
        "mustHave": [
            {
                "functionClass": "dashboard usage",
                "functionDesc": "View dashbaord and Kanban Settings",
                "functionId": 34,
                "functionName": "viewDashbord",
                "functionType": "view"
            }
        ],
        "mustNotHave": [
            {
                "functionClass": "system management",
                "functionDesc": "add project",
                "functionId": 1,
                "functionName": "addProject",
                "functionType": "Access Management"
            }
        ]
    },
    "return_code": 0,
    "return_message": "success"
}

$$Parameter name

Sample value

Parameter type

Parameter description

data

-

Object

Return results

data.defaultHaveCouldRemove

-

Object

Default Features Removable Feature List

data.defaultHaveCouldRemove.functionClass

Dashboard use

String

Functional classification

data.defaultHaveCouldRemove.functionDesc

Temporarily adjust the filter criteria of Dashboard, use global filter

String

Function description

data.defaultHaveCouldRemove.functionId

35

Integer

Function ID

data.defaultHaveCouldRemove.functionName

useDashbordFilter

String

Function name

data.defaultHaveCouldRemove.functionType

View

String

Function type

data.defaultNotHaveCouldAdd

-

Object

No new features list by default

data.defaultNotHaveCouldAdd.functionClass

Model use

String

Functional classification

data.defaultNotHaveCouldAdd.functionDesc

Use models, save reports, manage reports

String

Function description

data.defaultNotHaveCouldAdd.functionId

28

Integer

Function ID

data.defaultNotHaveCouldAdd.functionName

useModel

String

Function name

data.defaultNotHaveCouldAdd.functionType

Function Use

String

Function type

data.mustHave

-

Object

List of must-have features

data.mustHave.functionClass

Dashboard use

String

Functional classification

data.mustHave.functionDesc

View Dashboard and Dashboard Settings

String

Function description

data.mustHave.functionId

34

Integer

Function ID

data.mustHave.functionName

viewDashbord

String

Function name

data.mustHave.functionType

View

String

Function type

data.mustNotHave

-

Object

List of must-have features

data.mustNotHave.functionClass

System management

String

Functional classification

data.mustNotHave.functionDesc

New items

String

Function description

data.mustNotHave.functionId

1

Integer

Function ID

data.mustNotHave.functionName

addProject

String

Function name

data.mustNotHave.functionType

Access Management

String

Function type

return_code

0

Integer

Return code

return_message

success

String

Return message

오류 응답 예시

{
    "return_code": -1008,
    "return_message": "getBaseRoleFunctions.baseRoleName 需要匹配正则表达式\"analyst|member\""
}

Parameter name

Sample value

Parameter type

Parameter description

return_code

-1008

Integer

Return code

return_message

getBaseRoleF unctions.base RoleName needs to match regular expression "analyst

String

Return message

# 새로운 프로젝트 역할 생성

::: 팁

새로운 프로젝트 역할을 생성하고 권한을 할당합니다. 기본 역할 기능 열 조회 인터페이스와 함께 사용할 것을 권장합니다.

:::

인터페이스 URL

/open/create-project-role?token=xxx&projectId=2

요청 방법

POST

콘텐츠 유형

application/json

요청 쿼리 파라미터

Parameter name

Sample value

Parameter type

Is required

Parameter description

token

xxx

String

Yes

token

projectId

2

Integer

Yes

Project ID

요청 본문 파라미터

{
    "baseRole": "analyst",
    "roleDesc": "analyst 007",
    "roleFuncList": [
        14,34,53
    ]
}

Parameter name

Sample value

Parameter type

Is required

Parameter description

baseRole

analyst

String

Yes

Basic role name

  • Analyst: analyst

  • (Member: ordinary member)

roleDesc

Analyst 007

String

Yes

Character description, max. 60 characters

roleFuncList

[14]

List

Yes

Role function ID list, must be a valid ID

성공적인 응답 예시

{
    "data": {
        "roleName": "analyst_1462717171385241600"
    },
    "return_code": 0,
    "return_message": "success"
}

$$Parameter name

Sample value

Parameter type

Parameter description

data

-

Object

Return results

data.roleName

analyst_1462717171385241600

String

Role name

return_code

0

Integer

Return code

return_message

success

String

Return message

오류 응답 예시

{
    "return_code": -3004,
    "return_message": "invalid item"
}

Parameter name

Sample value

Parameter type

Parameter description

return_code

-3004

Integer

Return code

return_message

Invalid item

String

Return message

# 대시보드 공유 블랙리스트

인터페이스 URL

/open/update-project-role?token=xxx&projectId=2&roleName=admin

요청 방법

POST

콘텐츠 유형

application/json

요청 쿼리 파라미터

Parameter name

Sample value

Parameter type

Is required

Parameter description

token

xxx

String

Yes

token

projectId

2

Integer

Yes

Project ID

roleName

admin

String

Yes

Role name

요청 본문 파라미터

{
    "baseRole": "analyst",
    "roleDesc": "analyst 009",
    "roleFuncList": [
        14,34,53
    ]
}

Parameter name

Sample value

Parameter type

Is required

Parameter description

baseRole

analyst

String

Yes

Basic role name

  • Analyst: analyst

  • (Member: ordinary member)

roleDesc

Analyst 009

String

No

Role description

roleFuncList

[14]

List

No

Role function ID list

성공적인 응답 예시

{
    "return_code": 0,
    "return_message": "success"
}

Parameter name

Sample value

Parameter type

Parameter description

return_code

0

Integer

Return code

return_message

success

String

Return message

오류 응답 예시

{
    "return_code": -3004,
    "return_message": "invalid item"
}

Parameter name

Sample value

Parameter type

Parameter description

return_code

-3004

Integer

Return code

return_message

Invalid item

String

Return message

# 프로젝트 역할 삭제

인터페이스 URL

/open/delete-project-role?token=xxx&projectId=0&roleName=test

요청 방법

POST

콘텐츠 유형

application/json

요청 쿼리 파라미터

Parameter name

Sample value

Parameter type

Is required

Parameter description

token

xxx

String

Yes

token

projectId

0

Integer

Yes

Project ID

roleName

test

String

Yes

Role name

성공적인 응답 예시

{
    "return_code": 0,
    "return_message": "success"
}
Parameter name Sample value Parameter type Parameter description
return_code 0 Integer Return code
return_message success String Return information

오류 응답 예시

{
    "return_code": -1023,
    "return_message": "role 'test'does not exist"
}

Parameter name

Sample value

Parameter type

Parameter description

return_code

-1023

Integer

Return code

return_message

Role'test 'does not exist

String

Return message

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

대시보드 공유를 설정할 때, 공유가 모든 구성원에게 보이도록 설정된 경우, 블랙리스트를 사용하여 일부 사용자를 제외할 수 있습니다.

# 블랙리스트 추가

::: 팁

  • 회사 토큰만 지원합니다.

:::

인터페이스 URL

/open/share/add-black?token=xxx&loginName=root&blackProjectId=0

요청 방법

POST

콘텐츠 유형

application/json

요청 쿼리 파라미터

Parameter name

Sample value

Parameter type

Is required

Parameter description

token

xxx

String

Yes

token

loginName

root

String

Yes

Login name

blackProjectId

0

Integer

Yes

Black List Project ID

0: All projects share blacklist

Project ID: blacklist under this project only

성공적인 응답 예시

{
    "return_code": 0,
    "return_message": "success"
}

Parameter name

Sample value

Parameter type

Parameter description

return_code

0

Integer

Return code

return_message

success

String

Return message

data

Object

Return results

오류 응답 예시

{
    "return_code": -1008,
    "return_message": "The parameter (token) is empty"
}

Parameter name

Sample value

Parameter type

Parameter description

return_code

-1008

Integer

Return code

return_message

The parameter (token) is empty

String

Return message

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

::: 팁

  • 회사 키만 지원합니다.

:::

인터페이스 URL

/open/share/add-black-list?token=xxx

요청 방법

POST

콘텐츠 유형

application/json

요청 쿼리 파라미터

Parameter name

Sample value

Parameter type

Is required

Parameter description

token

xxx

String

Yes

token

파일 템플릿의 스크린샷은 다음과 같습니다:

성공적인 응답 예시

{
    "return_code": 0,
    "return_message": "success"
}

Parameter name

Sample value

Parameter type

Parameter description

return_code

0

Integer

Return code

return_message

success

String

Return message

오류 응답 예시

{
    "return_code": -1008,
    "return_message": "The parameter (token) is empty"
}

Parameter name

Sample value

Parameter type

Parameter description

return_code

-1008

Integer

Return code

return_message

The parameter (token) is empty

String

Return message

# 블랙리스트 그룹 설정

::: 팁

  • 회사 키만 지원합니다.
  • 그룹을 블랙리스트 그룹으로 설정하면 해당 그룹의 모든 구성원이 블랙리스트에 추가됩니다.

:::

인터페이스 URL

/open/share/add-black-group-list?token=xxx&groupIdList=[1]&groupType=1

요청 방법

POST

콘텐츠 유형

application/json

요청 쿼리 파라미터

Parameter name

Sample value

Parameter type

Is required

Parameter description

token

xxx

String

Yes

token

groupIdList

[1]

List

Yes

Group ID List

groupType

1

Integer

Yes

1: Blacklist grouping

성공적인 응답 예시

{
    "return_code": 0,
    "return_message": "success"
}

Parameter name

Sample value

Parameter type

Parameter description

return_code

0

Integer

Return code

return_message

success

String

Return message

오류 응답 예시

{
    "return_code": -1008,
    "return_message": "The parameter (token) is empty"
}

Parameter name

Sample value

Parameter type

Parameter description

return_code

-1008

Integer

Return code

return_message

The parameter (token) is empty

String

Return message

# 블랙리스트 삭제

::: 팁

  • 회사 키만 지원합니다.
  • 특정 항목의 블랙리스트에서 사용자를 제거하거나 모든 블랙리스트를 제거할 수 있습니다.

:::

인터페이스 URL

/open/share/cancel-black?token=xxx&loginName=root&blackProjectId=0

요청 방법

POST

콘텐츠 유형

application/json

요청 쿼리 파라미터

Parameter name

Sample value

Parameter type

Is required

Parameter description

token

xxx

String

Yes

token

loginName

root

String

Yes

Login name

blackProjectId

0

Integer

No

Black List Project ID

성공적인 응답 예시

{
    "return_code": 0,
    "return_message": "success"
}

Parameter name

Sample value

Parameter type

Parameter description

return_code

0

Integer

Return code

return_message

success

String

Return message

오류 응답 예시

{
    "return_code": -1008,
    "return_message": "The parameter (token) is empty"
}

Parameter name

Sample value

Parameter type

Parameter description

return_code

-1008

Integer

Return code

return_message

The parameter (token) is empty

String

Return message

# 블랙리스트 다운로드

::: 팁

  • 회사 키만 지원합니다.

:::

인터페이스 URL

/open/share/download-share-black?token=xxx

요청 방법

POST

콘텐츠 유형

application/json

요청 쿼리 파라미터

Parameter name

Sample value

Parameter type

Is required

Parameter description

token

xxx

String

Yes

token

성공적인 응답 예시

CSV 파일의 샘플 스크린샷은 다음과 같습니다.

오류 응답 예시

{
    "return_code": -1008,
    "return_message": "The parameter (token) is empty"
}

Parameter name

Sample value

Parameter type

Parameter description

return_code

-1008

Integer

Return code

return_message

The parameter (token) is empty

String

Return message

← 프로젝트 관리 API →