グループ情報設定
グループ情報を設定します。
(1) 必要な権限
RegisterGroupInformation APIを使用するには以下の権限が必要です。
-
システム管理の更新権限
管理対象種別による違いは以下のとおりです。
- システム全体
-
任意のグループの情報を設定可能
- グループ単位
-
使用不可
(2) リクエストURL
http(s)://Domain:xxxx/コンテキスト名/RegisterGroupInformation
(3) リクエストインタフェース
|
項目名 |
説明 |
文字 |
省略 |
省略値 |
||||||
|---|---|---|---|---|---|---|---|---|---|---|
|
group_id |
グループID （*1） 32バイト以内で指定します。 |
半角 |
× |
|
||||||
|
group_name |
所属 128バイト以内で指定します。 |
混在 |
○ |
group_idの設定値 |
||||||
|
auth_available_flag |
ID／パスワード認証方法
|
半角 |
○ |
false |
||||||
|
ldap_auth_id |
LDAP認証ID LDAP認証情報設定で登録済みのIDを32バイトで指定します。 |
半角 |
○ |
ブランク （ただし、auth_available_flagがtrueの場合は省略不可） |
||||||
|
comment |
コメント 255バイト以内で指定します。 |
混在 |
○ |
ブランク |
||||||
|
storage_warn |
クォータの警告値（*2）（*3） グループのクォータの警告値を設定します。
|
半角 |
○ |
0 |
||||||
|
storage_limit |
クォータの上限値（*2） グループのクォータの上限値を設定します。
|
半角 |
○ |
0 |
||||||
|
object_limit |
1ファイルあたりの最大サイズ（*5） グループの1ファイルあたりの最大サイズを設定します。
|
半角 |
○ |
0 |
||||||
|
registerable_user_limit |
登録可能ユーザ数（*4）
|
半角 |
○ |
0 |
||||||
|
sysconf_id |
システム動作環境設定ID グループに割り当てられるシステム動作環境設定IDを32バイト以内で指定します。 |
半角 |
○ |
default |
||||||
|
login_type |
ログイン方法 ログイン時の認証方法を指定します。
|
半角 |
○ |
0 |
||||||
|
timezone_id |
グループに対して指定するタイムゾーンIDを指定します。 指定可能なタイムゾーンIDの一覧はタイムゾーン情報取得（GetTimeZoneInformation）で取得します。 |
半角 |
○ |
ブランク |
|
*1 |
: |
「system_service」、「everyone」、「unknown」以外の値を指定します。 |
|
*2 |
: |
storage_warn（クォータの警告値）およびstorage_limit（クォータの上限値）は、システムの上限値（システム動作環境情報のstorage_limitの設定値）以下の値のみ設定可能です。 |
|
*3 |
: |
storage_limit（クォータの上限値）が1～999999の範囲内の場合、storage_warn（クォータの警告値）はstorage_limit（クォータの上限値）より小さい値のみ設定可能です。 |
|
*4 |
: |
グループ情報を更新する場合、すでに登録されているユーザ数より小さい値（0以外）を指定するとエラーになります。 |
|
*5 |
: |
object_limit（1ファイルあたりの最大サイズ）は、システムの上限値（システム動作環境情報のobject_limit）以下の値のみ設定可能です。 |
以下は下位互換のために残されている非推奨の項目です。ldap_auth_id（LDAP認証ID）とauth_domain（認証サーバドメイン）/auth_host（認証サーバ接続先）を同時に指定することはできません。
|
項目名 |
説明 |
文字 |
省略 |
省略値 |
||
|---|---|---|---|---|---|---|
|
auth_domain |
認証サーバドメイン 認証サーバを利用する場合、ユーザIDに指定する文字列の「@」（アットマーク）後の文字列（ドメイン名）を255バイト以内で指定します。
|
半角 |
○ |
ブランク （ただし、auth_available_flagがtrueでldap_auth_idがブランクの場合は省略不可） |
||
|
auth_host |
認証サーバ接続先 接続する認証サーバを255バイト以内で指定します。 |
半角 |
○ |
ブランク （ただし、auth_available_flagがtrueでldap_auth_idがブランクの場合は省略不可） |
(4) レスポンスインタフェース
|
項目名 |
説明 |
備考 |
|---|---|---|
|
group_id |
グループID 正常に登録したグループIDが返却されます。 |
|