ユーザ情報設定
ユーザ情報を設定します。
(1) 必要な権限
RegisterUserInformation APIを使用するには以下の権限が必要です。
-
システム管理の更新権限
管理対象種別による違いは以下のとおりです。
- システム全体
-
任意のユーザの情報を設定可能
- グループ単位
-
管理対象グループに所属するユーザの情報のみ設定可能
権限がなくても、APIを使用するユーザ自身の情報は設定できます。
ただし、その場合でも以下の項目はすでに登録されている内容と同じ値をリクエストする必要があります。
-
auth_id（権限グループID）
-
available（状態）
-
login_type（ログイン方法）
-
user_auth_flag（認証設定方法）
-
auth_available_flag（ID／パスワード認証方法）
-
ldap_auth_id（LDAP認証ID）
(2) リクエストURL
http(s)://Domain:xxxx/コンテキスト名/RegisterUserInformation
(3) リクエストインタフェース
|
項目名 |
説明 |
文字 |
省略 |
省略値 |
||||||
|---|---|---|---|---|---|---|---|---|---|---|
|
group_id |
グループID （*1）（*4） グループIDを32バイト以内で指定します。 |
半角 |
× |
|
||||||
|
user_id |
ユーザID （*1） ユーザIDを32バイト以内で指定します。 |
半角 |
× |
|
||||||
|
passwd |
パスワード パスワードを99バイト以内で指定します。 |
半角 |
*2 |
|
||||||
|
user_name |
ユーザ名 ユーザの表示名を128バイト以内で指定します。 |
混在 |
○ |
user_id |
||||||
|
e_mail |
メールアドレス フォルダイベントのメール連携で使用するメールアドレスを255バイト以内で指定します。 |
半角 |
○ |
ブランク |
||||||
|
auth_id |
権限グループID 権限グループIDを32バイト以内で指定します。 |
半角 |
× |
|
||||||
|
available |
状態 登録するユーザの状態を指定します。
|
半角 |
○ |
0 |
||||||
|
user_auth_flag |
認証設定方法
|
半角 |
○ |
false |
||||||
|
auth_available_flag |
ID／パスワード認証方法
|
半角 |
○ |
false |
||||||
|
ldap_auth_id |
LDAP認証ID 認証サーバを利用する場合、認証に使用するLDAPサーバのLDAP認証IDを32バイトで指定します。 |
半角 |
○ |
ブランク （auth_available_flagがtrueの場合は省略不可） |
||||||
|
comment |
コメント コメントを255バイト以内で指定します。 |
混在 |
○ |
ブランク |
||||||
|
edit_user_mail_flag |
ユーザ編集メール通知 ユーザ情報を登録または修正した場合に、当該ユーザにメールで通知するかを設定します。
|
半角 |
○ |
false |
||||||
|
edit_user_mail_template_flag |
ユーザ編集通知メールテンプレート（*3）
|
半角 |
○ |
false |
||||||
|
edit_user_mail_subject |
ユーザ編集通知メールタイトル メールのタイトルを512 バイト以内で指定します。 |
混在 |
○ |
ブランク |
||||||
|
edit_user_mail_message |
ユーザ編集通知メール本文 メールの本文を2048 バイト以内で指定します。 |
混在 |
○ |
ブランク |
||||||
|
force_change_passwd_flag |
パスワード変更の強制（*5） 次回ログイン時に強制的にパスワードを変更させるかを設定します。
|
半角 |
○ |
false |
||||||
|
login_type |
ログイン方法 ログイン時の認証方法を指定します。
|
半角 |
○ |
0 |
||||||
|
timezone_id |
ユーザに対して指定するタイムゾーンIDを指定します。 指定可能なタイムゾーンIDの一覧はタイムゾーン情報取得（GetTimeZoneInformation）で取得します。 |
半角 |
○ |
ブランク |
|
*1 |
: |
「system_service」、「everyone」、「unknown」以外の値を指定します。 |
|
*2 |
: |
以下のいずれかの場合は省略可です。
また、以下の場合は指定できません。
|
|
*3 |
: |
“true”（テンプレートを使用する）にした場合、システム動作環境情報のedit_user_mail_subjectとedit_user_mail_messageの設定値が適用され、ユーザ情報設定APIのリクエストインタフェースで指定したedit_user_mail_subject（ユーザ編集通知メールタイトル）とedit_user_mail_message（ユーザ編集通知メール本文）の設定値は無視されます。 |
|
*4 |
: |
新規登録の場合、登録ユーザ数がregisterable_user_limit（登録可能ユーザ数）に達しているグループを指定するとエラーになります。 |
|
*5 |
: |
“true”（強制的にパスワードを変更させる）にした場合、次回ログイン時にパスワードの有効期限が切れた状態（制限付きログイン）として扱われます。 |
(4) レスポンスインタフェース
|
項目名 |
説明 |
備考 |
|---|---|---|
|
group_id |
グループID 正常に登録したユーザ情報のグループIDが返却されます。 |
|
|
user_id |
ユーザID 正常に登録したユーザ情報のユーザIDが返却されます。 |
|