APIを使った新規ユーザの初期登録方法

Q&A
#1

新規ユーザの初期登録をHexabaseの管理画面からではなく、
APIで行い同タイミングでグループへの追加、ロール付与を行い、ユーザへパスワード初期設定の依頼メールを送信したいのですが可能でしょうか。
例えば以下の順でAPIを実行することで実現可能でしょうか。

１．RegisterUser API（ユーザー初期登録）
２．AddUser API（グループへユーザー追加）
３．AddRoleToUser API（ユーザーへロール付与）
４．ResetPassword API（パスワード初期化リクエスト）

また、RegisterUser API（ユーザー初期登録）を実行するには、
事前にユーザー招待（UserInvite API）、初回ユーザー登録（UserRegistration）、ユーザー情報確認（ConfirmRegistration API）
のAPIの実行が必要でしょうか。

#2

@k-otani はい、こちら対応可能です。多くのSPA開発において、ユーザ管理画面や招待ページを実装されています。

順序としては、
グループへユーザを追加
ロールの付与（グループにロールがついていれば、これは不要）
ユーザの招待（Invite）APIの呼び出し
となります。

このあたりの手順について、別途資料を作成してご説明できるよう準備いたします。

ユーザ初期登録に関しては、 RegisterUser APIから初めてのユーザーをシステムへ登録させることが可能ですが、これは一般公開されたPublicサイトから初期ユーザをアクティベーションさせる仕組みです。企業内システムのケースでは、システム初期設定は管理者側でおこない、グループへユーザーを招待する部分から画面開発するケースがほとんどとなります。

#3

@hexa_support
ユーザー登録に至るまでのAPI実行順を含めた、シーケンス図を公開していただくことは可能でしょうか？

#4

@k-otani 現在、こちらにてドキュメントを更新中です。 ※現在、まだドキュメントリリースされていませんが、先だって連絡いたします。


（シーケンス図を見るために、ブラウザのプラグインをインストールする必要があります）

更新できましたら、順次公開いたしますので、追って連絡いたします。
その他、ユーザ招待、パスワード忘れ時の対応、などについてドキュメント準備を計画しております。

「いいね！」 1