メインコンテンツまでスキップ

AddUser

グループに新規ユーザーを作成する

Description​

指定されたグループに新規ユーザーを作成します。

※user_codeを使用する場合は、UserInvite APIのPayloadでもuser_codeの値を設定します。

Method​

POST

Request URL Format​

/api/v0/users

Payload​

Content-Type : application/json

パラメータ名説明データ型必須備考
emailグループに追加したいemailアドレス文字列必須
g_idユーザーを追加するグループを識別するID文字列必須
usernameグループに追加したいユーザー名文字列
send_password_to_emailAPI実行時に登録完了メールを送信するbooleanデフォルト false
sender_address登録完了メールのfromアドレスに指定する任意のメールアドレス文字列
sender_name登録完了メールのfrom名前に指定する任意のメールアドレス文字列
no_confirm_email省略可。trueを指定すると、confirmメールを送信せず、管理者が指定した初期パスワード(tmp_password)をセットするboolean
tmp_passwordno_confirm_email:trueの場合、管理者による初期パスワードを指定する文字列
invitor_idno_confirm_email:trueの場合、招待元のユーザーIDを指定する文字列このユーザーが所属するワークスペースのパスワードポリシーを利用する
conf_email_template_idメール通知のテンプレートID文字列
confirm_email_ackメール通知するフラグbooleantrue -> 有効、false -> 無効
exclusive_w_idワークスペース限定ユーザとして追加する場合、対象のワークスペースIDを指定する文字列
user_code単一メールアドレスを複数ユーザーで共有するためユーザーコードを指定する文字列

Payload Example​

{
  "email": "[email protected]",
  "g_id": "Grp-pgI1GFDL"
  "username": "Hexa_Taro",
  "send_password_to_email": true,
  "sender_address": "[email protected]",
  "sender_name": "Hexabase",
  "no_confirm_email": true,
  "tmp_password": "123456",
  "invitor_id": "5af30766baa8df0007918ed8",
  "conf_email_template_id": string,
  "confirm_email_ack": true,
  "exclusive_w_id": "63c00e67be62647c659f8b4b",
  "user_code": "UserCode12345"
}

Request URL Example​

POST https://api.xxx.com/api/v0/users

Response Example​

{
    "added": false,　//("bool 追加済みかどうか")
    "exists": false, //("b0ol 既に存在するユーザー　false=新規で存在しない新しいユーザー")
    "user_profile": { //("ユーザープロファイルオブジェクト")
        "confirmed": false,　//("bool ユーザーemail確認済み　false=email上確認されていない")
        "email": "登録されたユーザーのemail", 
        "email_sent": false, //("bool emailが送られたかどうか　false=既に対象emailにemailが送られている")
        "profile_pics": [//("ユーザープロファイル画像オブジェクト")
            {
                "mediaLink": "https://storage.googleapis.com/linker/pub/default.png"　//("ユーザープロファイルに使用されている画像の保存先")
            }
        ],
        "u_id": "登録されたユーザーのID",
        "username": "登録されたユーザー名"
    }
}