コンテンツにスキップ

新規追加¶

POST /api/v1/account/add

概要¶

Body リクエストパラメータ¶

パラメータ名	型	必須	説明
brandKey	string		ブランドキー例: guance 空を許可: False
username	string	Y	ログインアカウント名（exterId が存在しない場合、このフィールドの値は一意）例: test_wang 空を許可: True 空文字列を許可: True
password	string	Y	ログインパスワード（パスワードが空文字列の場合、サードパーティログインアカウントはパスワードを空文字列に設定する必要があります）例: I am password 空文字列を許可: True 空を許可: True
name	string	Y	ニックネーム例: test_wang 空を許可: False 空文字列を許可: False
email	string	Y	ユーザーメールアドレス例: xxx@guance.com 空を許可: False 空文字列を許可: True $isEmail: True
mobile	string		電話番号（ローカル番号）。旧バージョンの 11 桁の中国国内携帯番号は countryCode=86 として互換処理されます。例: 1762xxx9836 空を許可: False 空文字列を許可: False
countryCode	string		電話番号の国/地域コード例: 86 空を許可: False 空文字列を許可: True
exterId	string		サードパーティアカウントシステムの一意識別 ID。このフィールドが存在する場合、このフィールドの値は一意になります（username フィールドは重複を許可）。例: 29ab8d31-ac52-4485-a572-f4cf25d355d9 空を許可: False 空文字列を許可: False
extend	json		追加情報空を許可: True
language	string		言語情報例: zh 空を許可: True 空文字列を許可: True 選択可能な値: ['zh', 'en', 'zh-hant', 'id']
isDisable	boolean		無効にするかどうか例: True 空を許可: False 選択可能な値: [True, False]
attributes	json		アカウントの属性情報（JSON 構造、KV 構造、V 部はできるだけ文字列を使用。SSO ログイン時の自動更新に適用）。例: {'部門': 'A部門'} 空を許可: False
customAttributes	json		アカウントのカスタム属性情報（JSON 構造、KV 構造、V 部はできるだけ文字列を使用。ビジネス側の更新のみに適用）。例: {'部門': 'A部門'} 空を許可: 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"
}