콘텐츠로 이동

생성¶

POST /api/v1/account/add

개요¶

Body 요청 매개변수¶

매개변수명	타입	필수	설명
brandKey	string		브랜드 키 예시: guance null 허용: False
username	string	Y	로그인 계정명(exterId가 없을 경우 이 필드 값은 고유함) 예시: test_wang null 허용: True 빈 문자열 허용: True
password	string	Y	로그인 비밀번호(비밀번호가 빈 문자열인 경우 타사 로그인 계정은 비밀번호를 빈 문자열로 설정해야 함) 예시: I am password 빈 문자열 허용: True null 허용: True
name	string	Y	닉네임 예시: test_wang null 허용: False 빈 문자열 허용: False
email	string	Y	사용자 이메일 예시: xxx@guance.com null 허용: False 빈 문자열 허용: True $isEmail: True
mobile	string		휴대폰 번호(로컬 번호). 구버전 11자리 국내 번호는 countryCode=86으로 호환됨 예시: 1762xxx9836 null 허용: False 빈 문자열 허용: False
countryCode	string		휴대폰 국가/지역 코드 예시: 86 null 허용: False 빈 문자열 허용: True
exterId	string		타사 계정 시스템의 고유 식별자 ID. 이 필드가 존재하면 이 필드 값은 고유함(username 필드는 중복 허용) 예시: 29ab8d31-ac52-4485-a572-f4cf25d355d9 null 허용: False 빈 문자열 허용: False
extend	json		추가 정보 null 허용: True
language	string		언어 정보 예시: zh null 허용: True 빈 문자열 허용: True 허용 값: ['zh', 'en', 'zh-hant', 'id']
isDisable	boolean		비활성화 여부 예시: True null 허용: False 허용 값: [True, False]
attributes	json		계정 속성 정보(JSON 구조, KV 구조, V 부분은 문자열 사용 권장, SSO 로그인 시 자동 업데이트에 적합) 예시: {'부서': 'A부서'} null 허용: False
customAttributes	json		계정 사용자 정의 속성 정보(JSON 구조, KV 구조, V 부분은 문자열 사용 권장, 비즈니스 측 업데이트에만 사용) 예시: {'부서': 'A부서'} null 허용: False

매개변수 추가 설명¶

요청 예시¶

curl 'http://127.0.0.1:5000/api/v1/account/add' \
  -H 'Content-Type: application/json' \
  -H 'X-Df-Access-Key: abcd' \
  -H 'X-Df-Nonce: 4' \
  -H 'X-Df-Signature: test123' \
  -H 'X-Df-Timestamp: 1715321116' \
  --data-raw $'{ "username": "xxx@guance.com", "password": "xxx", "name": "lwc_xxxx_002", "email": "xxx@guance.com"}'

응답¶

{
    "code": 200,
    "content": {
        "attributes": {},
        "canaryPublic": false,
        "createAt": 1715322612,
        "creator": "SYS",
        "deleteAt": -1,
        "email": "xxx@guance.com",
        "enableMFA": false,
        "extend": null,
        "exterId": "",
        "id": 3026,
        "isUsed": 0,
        "language": "zh",
        "mfaSecret": "*********************",
        "mobile": "",
        "name": "xxxx",
        "nameSpace": "",
        "status": 0,
        "statusPageSubs": 0,
        "timezone": "",
        "tokenHoldTime": 604800,
        "tokenMaxValidDuration": 2592000,
        "updateAt": 1715322612,
        "updator": "SYS",
        "username": "xxx@guance.com",
        "uuid": "acnt_67792938b21148ff8f2b17afdbd92c27"
    },
    "errorCode": "",
    "message": "",
    "success": true,
    "traceId": "TRACE-9833FF30-E419-42E1-B999-047E609D4EE3"
}