계정 생성

관리자 권한으로 새 계정을 생성합니다.

HTTP 요청

POST /api/model/users
cURL 예시
curl -H "Authorization: Bearer <API_KEY>" \
    -d login_name=xeraph \
    -d password=PASSWORD \
    -d role=member \
    -d name=Yang \
    -X POST https://HOSTNAME/api/model/users
요청 매개변수
필수타입설명비고
login_nameO문자열로그인 계정 이름최소 1자, 최대 25자
passwordO문자열암호최소 9자
roleO문자열역할admin, member
nameO문자열사용자 성명최소 1자, 최대 60자
titleX문자열직위최대 60자
descriptionX문자열설명최대 250자
emailX문자열이메일 주소최대 60자
phoneX문자열전화번호최대 60자
langX문자열언어en, ko, ja, zh
org_unit_nameX문자열부서 이름최소 1자, 최대 60자
use_login_lockX불리언로그인 자동 차단 여부미지정 시 false
login_lock_countX32비트 정수로그인 차단 기준 실패 횟수최소 1, 최대 100
enforce_password_changeX불리언암호 변경 강제 여부미지정 시 false
password_history_countX32비트 정수최근 암호 기억 횟수최소 0, 최대 24
use_idle_timeoutX불리언세션 유휴 시 화면 잠금 사용미지정 시 false
idle_timeoutX32비트 정수화면 잠금 기준 (초)최소 60, 최대 604800
table_namesX문자열접근 허용 테이블 이름 목록여러 개의 이름을 쉼표로 구분
security_groupsX문자열보안 그룹 이름 목록여러 개의 이름을 쉼표로 구분
is_enabledX불리언로그인 허용미지정 시 true
use_otpX불리언OTP 로그인미지정 시 false
use_aclX불리언IP 접근 제한 사용미지정 시 false
trust_hostsX문자열로그인 허용 IP 주소 목록쉼표로 구분된 IP 주소
grantable_menu_profilesX문자열부여 가능 메뉴 구성admin, member
Note
security_groups 매개변수로 전달된 이름의 보안 그룹이 존재하지 않으면 시스템이 자동으로 생성합니다.

정상 응답

{}

오류 응답

계정 생성 권한이 없는 경우
{
    "error_code": "security-violation",
    "error_msg": "[xeraph] has no [dom/user_edit] permission"
}
필수 매개변수가 누락된 경우
{
    "error_code": "null-argument",
    "error_msg": "password should be not null"
}
매개변수 값의 길이가 잘못된 경우
{
    "error_code": "invalid-argument",
    "error_msg": "'login_name' must be less than or equal to 25 characters."
}
존재하지 않는 역할을 지정한 경우
{
    "error_code": "invalid-role",
    "error_msg": null
}
계정 이름이 중복된 경우
{
    "error_code": "user-already-exist",
    "error_msg": null
}
계정 이름에 허용되지 않는 문자가 포함된 경우
{
    "error_code": "invalid-argument",
    "error_msg": "'login_name' contains invalid character: space bar"
}
암호 강도가 약한 경우
{
    "error_code": "invalid-argument",
    "error_msg": "password should contain digits, alphabets, and special characters"
}
암호에 계정명을 포함한 경우
{
    "error_code": "invalid-argument",
    "error_msg": "password contains login name"
}
암호에 동일 문자가 반복된 경우
{
    "error_code": "invalid-argument",
    "error_msg": "password should not repeat same characters"
}
사용자 성명이 공백인 경우
{
    "error_code": "invalid-argument",
    "error_msg": "'name' parameter should not be an whitespace literal."
}
이메일 형식이 잘못된 경우
{
    "error_code": "invalid-argument",
    "error_msg": "'email' parameter is not a valid email address: test"
}
전화번호 형식이 잘못된 경우
{
    "error_code": "invalid-argument",
    "error_msg": "'phone' contains invalid character (allow only digits, space and plus sign): test"
}
유효하지 않은 로케일을 지정한 경우
{
    "error_code": "invalid-argument",
    "error_msg": "specify 'en', 'ko', 'ja', or 'zh' for 'lang' parameter: kr"
}
상위 권한의 계정 생성을 시도한 경우
{
    "error_code": "security-violation",
    "error_msg": "cannot create a user equal to or higher than your role."
}
로그인 허용 IP 주소에 잘못된 값을 입력한 경우
{
    "error_code": "invalid-argument",
    "error_msg": "trust_hosts parameter should contain IP addresses: `256.0.0.1`"
}