sonar-users

Logpresso Sonarに登録されたアカウント一覧を照会します。オプションはなく、実行すると登録されたすべてのアカウントを返します。

コマンドプロパティ

項目説明
コマンドタイプドライバークエリ
必要な権限管理者
ライセンス使用量集計あり
並列実行非対応
分散実行非対応

構文

sonar-users

出力フィールド

フィールドタイプ説明
guid文字列36文字の固有識別子
login文字列認証時に使用するアカウント名
name文字列アカウントユーザーの氏名
title文字列アカウントユーザーの役職
dept文字列アカウントユーザーが属する部署
phone文字列アカウントユーザーの固定電話番号
mobile文字列アカウントユーザーの携帯電話番号
email文字列アカウントユーザーのメールアドレス
locale文字列アカウントユーザーのデフォルト言語設定(en または ko
role_id32ビット整数アカウントの役割ID(0: ゲスト、1: クラスター管理者、2: 会社管理者、3: ユーザー)
role_name文字列アカウントの役割名
home_menu_id32ビット整数ログイン後に表示するデフォルトメニューID
granted_tables配列アカウントがアクセスできるテーブル権限の一覧
user_granted_profiles配列アカウントに付与された接続プロファイルの使用権限一覧
group_granted_profiles配列ユーザーが属するグループに付与された接続プロファイルの使用権限一覧
user_group_guids配列ユーザーが属するグループのGUID一覧
trust_hosts配列アカウントのログインが許可されたIPアドレス一覧(アクセス制御リスト)
idle_behavior文字列セッションアイドル状態での保護動作(lock: 画面ロック、logout: 自動ログアウト)
idle_timeout32ビット整数セッションアイドル状態を判定する基準時間(秒単位、0は無制限)
password_expiration32ビット整数パスワード変更要求期間(-1: システムデフォルト、0: 無制限、7-3650日)
last_pw_change日付アカウントの最終パスワード変更日時
login_lock_count32ビット整数連続ログイン失敗時にアカウントがロックされる最大試行回数(0-5)
login_lock_interval32ビット整数アカウントがロックされた後、自動解除までにかかる時間(1-100000000分)
login_lock_until日付アカウントロック解除が予定されている時刻。既に解除時刻を過ぎている場合は null
login_fail_count32ビット整数連続したログイン失敗回数。ロック解除時刻を過ぎている場合は0
last_login日付アカウントの最終ログイン時刻
auth_mode32ビット整数認証方式の選択(0: 内部/外部認証、1: 外部認証専用)
has_api_keyブーリアンアカウントにAPIキーが発行されているかどうか。APIキーの値自体は含みません
preferencesマップアカウントの個人設定一覧
otp_enabledブーリアンアカウントログイン時にOTP認証を強制するかどうか
otp_registeredブーリアンユーザーがアカウントにOTP機器を登録したかどうか
created日付ユーザーアカウントが生成された時刻
updated日付ユーザーアカウントが最後に修正された時刻

エラーコード

パースエラー
エラーコードメッセージ説明
300165No permission to enumerate users.管理者権限のないセッションで実行した場合
ランタイムエラー

該当なし

説明

sonar-users はLogpresso Sonarに登録されたすべてのアカウントを照会する管理者専用コマンドです。管理者権限のないセッションで実行するとパース段階でエラーが発生し、クエリは実行されません。

出力フィールドには granted_tables(テーブル権限)、trust_hosts(アクセス制御リスト)、ログインロック・失敗状態、OTP登録の有無など、アカウントのセキュリティに直結する属性が多数含まれます。ただし、REST APIと同じフィールドのみを出力するように制限されているため、パスワードハッシュやAPIキーの値自体は含まれず、has_api_key フィールドでAPIキーの発行有無のみを確認できます。この性質のため、照会結果を他のユーザーと共有したりダッシュボードに表示する際は、アカウントのセキュリティ属性が漏洩しないよう注意する必要があります。

login_lock_until に記録されたロック解除時刻が既に過ぎている場合、アカウントは実際にはロックが解除されたものとみなされ、login_lock_untilnull として、login_fail_count は0として返されます。

使用例

  1. 登録されたすべてのアカウントを照会

    sonar-users
    
  2. 管理者の役割を持つアカウントのみをフィルタリング

    sonar-users
    | search role_id == 1 or role_id == 2
    | fields login, name, role_name, dept, email
    
  3. アカウントロックまたはOTP未登録のアカウントを点検

    sonar-users
    | search login_lock_until not null or (otp_enabled == true and otp_registered == false)
    | fields login, name, login_lock_until, login_fail_count, otp_enabled, otp_registered
    
  4. 役割別のアカウント数を集計

    sonar-users
    | stats count by role_name
    | sort -count
    

変更履歴

sonar-users コマンドはSonar 4.0.2609.0バージョンから利用可能です。Experimental アプリが提供していたコマンドをSonarコアに内蔵したものです。内蔵されていないバージョンでは、Experimental アプリをインストールして使用できます。