Skip to main content

ユーザーとグループ

Hexabase アプリケーションにアクセスする利用者の情報は、ユーザーとグループで管理できます。

Hexabase では、ユーザー・グループの設定に従って、API の戻り値が自動的にフィルタされます。

「ユーザー」 「グループ」の設定は、管理画面の「ワークスペースの設定」ポップアップにあるグループ設定タブでおこないます。なお、グループに登録したユーザーを「メンバー」と呼びます。

グループ設定タブ

ユーザー​

Hexabaseを利用するには、該当のワークスペースにユーザーを追加する必要があります。

  • 新規ユーザーを追加すると、任意のワークスペースに登録されます。
  • ユーザーは、１つ以上のワークスペースに所属する必要があります。
  • ユーザーは、１つ以上のグループに所属する必要があります。デフォルトでは、最上位の「ワークスペース」グループ(TopGroup)に所属します。
  • ユーザーは、一人ずつ招待するか、まとめてインポートできます。
  • Hexabaseをはじめて利用するときは招待が必要です。複数のワークスペースに登録する場合、2回目以降は招待は不要です。

限定ユーザー​

限定ユーザーは、特定のワークスペースのみ限定して利用させたい利用者を登録する機能です。通常ユーザーとは異なり、限定ユーザーとして登録された利用者は、他のワークスペースに登録できません。

管理画面で限定ユーザーを登録するには、次のように操作します。

  1. 管理画面の「ワークスペースの設定」を呼び出す
  2. 「グループ設定」タブをクリック
  3. 「このワークスペース限定ユーザーの追加」ボタンをクリック
  4. 限定ユーザーとして追加したい利用者のEメールアドレスを入力する
  5. 追加ボタンをクリック

限定ユーザー

限定ユーザーとして登録された利用者には、カギ！マークを表示します。

APIで限定ユーザーを登録するにはAddUser APIを利用します。

ユーザーコード​

ユーザーコードは、単一のメールアドレスで複数のユーザーを登録するための機能です。メールアドレスに付与した任意のユーザーコードを使って利用者を識別します。共通のメールアドレスを家族で共有するといった利用方法を想定しています。

ユーザーコードは次の方法で指定できます。

  • 管理画面の「ワークスペースの設定」>「グループ設定」で、ユーザー追加時に指定する
  • 管理画面の「ワークスペースの設定」>「グループ設定」で、限定ユーザーを追加時に指定する
  • 管理画面のユーザープロファイル設定で、ユーザーごとに指定する
  • AddUser APIを利用する
  • UpdateUserInfo APIを利用する

登録したユーザーコードは、「ワークスペースの設定」>「グループ設定」で確認できます。

ユーザーコードを付与した場合、ログイン時にユーザーコードを指定しないと認証エラーとなります。

ユーザーコード設定​

ユーザーコードは、ワークスペースごとに条件を指定できます。

  • ユーザーコードの最小長
  • ユーザーコードの最大長
  • ユーザーコード文字の組合せ(制限なし、英・数字、英・数字・特殊文字)

ユーザーコード設定

ユーザーコード設定は、管理画面の「ワークスペースの設定」>「ユーザーコード設定」で指定できます。

設定内容は、GetUserCodeSettings APIで取得できます。

グループ​

「グループ」は、ユーザーをまとめる機能です。

グループには、１つ以上の子グループを作成できるため、ツリー構造にできます。最上位にあるグループは、「ワークスペース」グループです。これは、各ワークスペースにひとつあります。

ユーザーは、１つ以上のグループに所属する必要があります。デフォルトでは最上位の「ワークスペース」グループ(TopGroup)に所属します。ユーザーは、複数のグループに所属することが可能です。

グループとユーザー

※Tips：グループ階層に制限はありませんが、複雑さの回避とパフォーマンス劣化の防止のため、3－5 階層程度のシンプルな構造にすることを強く勧めます。グループ階層を現実の組織に合わせるのではなく、利用者の役割とアプリケーションの機能に応じて、グループを設定すると良いでしょう。

API によるグループとユーザーの制御​

API を利用してグループ作成やユーザー追加・ロール付与が可能です。たとえば『新しい取引先を作成する』といったケースで、一定の閲覧権限をもつユーザをシステムに参加させる場合に、新規グループを作成して、そのグループ配下にユーザを追加できます。

詳しくは、Hexabase API リファレンスを参照ください。

グループ一覧の取得​

  • GetGroup：グループ情報取得
  • GetGroupTree：グループツリー情報取得

グループの登録、変更、削除​

  • CreateGroup：新規グループ作成
  • CreateTopGroup：新規グループ作成(第 1 階層)
  • UpdateGroup：グループ更新
  • DeleteGroup：グループ削除

ユーザーの追加、削除​

  • AddUser：ユーザー追加
  • RemoveUser：ユーザー削除