Skip to main content

AddUser

AddUser

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

Description

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

Method

POST

Request URL Format

/api/v0/users

Payload

Content-Type : application/json

{
"email": "グループに追加したいemailアドレス", //必須
"g_id": "ユーザーを追加するグループを識別するID", //必須
"w_id": "ユーザーを追加するワークスペースのID",
"username": "グループに追加したいユーザー名",
"send_password_to_email": true, // API実行時に登録完了メールを送信する。デフォルト false
"sender_address": "[email protected]" // 登録完了メールのfromを任意の値に変更したい場合に指定します
"no_confirm_email": true, // 省略可。trueを指定すると、confirmメールが送信されず、管理者が指定した初期パスワード(tmp_password)がセットされます。
"tmp_password": "123456", // no_confirm_email:true の場合に指定。管理者による、初期パスワードを指定します。
"invitor_id": "5af30766baa8df0007918ed8", // no_confirm_email:true の場合に指定。招待元のユーザーIDを指定します。このユーザーが所属するワークスペースのパスワードポリシーが利用されます。
"conf_email_template_id": string, // メール通知のテンプレートID
"confirm_email_ack": bool, // メール通知するフラグです。true -> 有効、false -> 無効
"exclusive_w_id": "624bea3a879f4e8d8b5dcc6c" // ワークスペース限定ユーザとして追加する場合に対象のワークスペースIDを指定します
}

Request URL Sample

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

Response Sample

{
"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": "登録されたユーザー名"
}
}