User groupオブジェクト

次のオブジェクトは、usergroupAPIに直接関連しています。

ユーザーグループ

ユーザーグループオブジェクトには、以下のプロパティがあります。

プロパティ 型 説明
usrgrpid ID ユーザーグループのID。

プロパティの動作:
- 読み取り専用
- 更新操作では 必須
name string ユーザーグループ名。

プロパティの動作:
- 作成操作では 必須
debug_mode integer デバッグモードが有効か無効か。

指定可能な値:
0 - (デフォルト) 無効;
1 - 有効。
gui_access integer グループ内のユーザーのWebインターフェース認証方式。

指定可能な値:
0 - (デフォルト) システムのデフォルト認証方式を使用;
1 - 内部認証を使用;
2 - LDAP認証を使用;
3 - Webインターフェースへのアクセスを無効化。
mfa_status integer グループ内のユーザーに対してMFAが有効か無効か。

指定可能な値:
0 - 無効（設定済みのすべてのMFA方式に対して）;
1 - 有効（設定済みのすべてのMFA方式に対して）。
mfaid ID グループ内のユーザーに使用されるMFA方式。

プロパティの動作:
- Super admin タイプのユーザーで サポート
- Authentication object の mfa_status が「Enabled」に設定されている場合に サポート
users_status integer ユーザーグループが有効か無効か。
deprovisioned ユーザーについては、ユーザーグループを有効にできません。

指定可能な値:
0 - (デフォルト) 有効;
1 - 無効。
userdirectoryid ID 認証に使用されるユーザーディレクトリのID。

プロパティの動作:
- Super admin タイプのユーザーで サポート
- gui_access が「システムのデフォルト認証方式を使用」または「LDAP認証を使用」に設定されている場合に サポート

権限

permissionオブジェクトには、以下のプロパティがあります。

プロパティ 型 説明
id ID 権限を追加するホストグループまたはテンプレートグループのID。

プロパティの動作:
- 必須
permission integer ホストグループまたはテンプレートグループに対するアクセスレベル。

使用可能な値:
0 - アクセス拒否;
2 - 読み取り専用アクセス;
3 - 読み書きアクセス。

プロパティの動作:
- create操作で 必須

タグベースの権限

タグベースの権限オブジェクトには、以下のプロパティがあります。

プロパティ Type 説明
groupid ID 権限を追加するホストグループのID。

Property behavior:
- required
tag string タグ名。
value string タグの値。