Skip to main content

RegisterUser

RegisterUser

ユーザーの初期登録

Description

UserConfirm後、Hexabaseを初めて利用するユーザー情報(ユーザ名、パスワード等)を登録する。additional_infoにはそのユーザー固有の情報をMap形式で登録することができる。

Method

POST

Request URL Format
/api/v0/users/registration/confirm
Payload
{
"confirmation_id":"確認用のID", //必須
"email":"登録されるemail", //必須
"username":"登録されるユーザー名",
"password": "設定するパスワード", // 必須
"workspace":"作成するワークスペース名",
"additional_info":{
"field_name1": "value", // field_name, value 共に自由な値を指定可能
"field_name2": "value"
},
"send_password_to_email": true, // API実行時に登録完了メールを送信する。デフォルト false
"sender_address": "[email protected]" // 登録完了メールのfromを任意の値に変更したい場合に指定します
"conf_email_template_id": string, // メールのテンプレートID
"confirm_email_ack": bool // 通知するフラグです。true -> 有効、false -> 無効
}

Request URL Sample

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

Response Sample