ユーザーの検索、追加・変更・削除、パスワード管理などを行うためのパラメータ一覧の一覧となります。
ユーザー情報検索
| 利用可能なパラメータ | 必須 | 説明 |
| action_user_read | 〇 | 固定値:true |
| id | 検索するユーザーID | |
| name | 検索する氏名 | |
| empnum | 検索する社員番号 | |
| 検索するメールアドレス | ||
| org | 検索する所属組織 | |
| status | 検索するユーザー状態（active|inactive） |
ユーザー追加
| 利用可能なパラメータ | 必須 | 説明 |
| action_user_create | 〇 | 固定値:true |
| id | 〇 | ユーザーID |
| empnum | 社員番号 | |
| sname | 〇 | 姓 |
| gname | 〇 | 名 |
| skana | 姓（カナ） | |
| gkana | 名（カナ) | |
| 〇 | メールアドレス ※他ユーザーと重複する値は登録できません。 | |
| mailalias[] | メールエイリアス（配列） ※他ユーザーと重複する値は登録できません。 | |
| locale | 〇 | 地域 例：ja_JP、en_US |
| lang | 〇 | 言語 例：ja、en、zh |
| password | 〇 | パスワード |
| status | 〇 | ステータス（active|inactive） |
| admin_role | 管理者権限（tenant_admin|user_admin） | |
| admin_authority | 管理者権限（read_only|privileged_id）（配列） | |
| service[] | 許可するサービス（配列）: googleapps | office365 | salesforce | cybozu.com | adobe | aws | box | dropbox | evernote | lineworks | SAMLサービスプロバイダーのサービスID | 代理認証のアプリケーションID | |
| role_office365[] | Microsoft365ライセンス名・管理者ロール名（配列） ※CSV登録画面に表記されている値 | |
| role_salesforce | Salesforceのプロファイル名 | |
| org | 組織 | |
| addorg[] | 兼務組織（配列） | |
| aliasname | 別名 | |
| nmail | 通知先メールアドレス | |
| simplename | 簡易表示名 | |
| attr_edupersonaffiliation | 職種 ・学生：student 未指定の場合は「なし」が設定されます。 | |
| title | 役職 | |
| company | 会社 | |
| department | 部署 | |
| office | 事業所 | |
| country | 国 | |
| postalcode | 郵便番号 | |
| state | 都道府県 | |
| city | 市区郡 | |
| street | 町名・番地 | |
| telephone | 電話番号 | |
| fax | FAX | |
| mobile | 携帯電話番号 | |
| homephone | 自宅電話番号 | |
| attrvals[] | 追加項目（配列） | |
| 追加属性 | 「システム」-「追加属性」で設定した属性は、”attr_<追加属性の属性名>”をパラメーターとして、値を登録して下さい。 | |
| immutableid | Microsoft 365のImmutableID | |
| add_profiles[] | 割り当てるプロファイルに追加するプロファイルID（配列） |
ユーザー情報更新
| 利用可能なパラメータ | 必須 | 説明 |
| action_user_update | 〇 | 固定値:true |
| id | 〇 | ユーザーID |
| empnum | 社員番号 | |
| sname | 〇 | 姓 |
| gname | 〇 | 名 |
| skana | 姓（カナ） | |
| gkana | 名（カナ) | |
| 〇 | メールアドレス ※他ユーザーと重複する値は登録できません。 | |
| mailalias[] | メールエイリアス（配列） ※他ユーザーと重複する値は登録できません。 | |
| locale | 〇 | 地域 例：ja_JP、en_US |
| lang | 〇 | 言語 例：ja、en、zh |
| password | パスワード (パスワードのみの変更は下記にあるパスワードAPIを利用してください。) | |
| status | 〇 | ステータス（active | inactive） |
| admin_role | 管理者権限（tenant_admin|user_admin） | |
| admin_authority | 管理者権限（read_only|privileged_id）（配列） | |
| service[] | 許可するサービス（配列）: googleapps | office365 | salesforce | cybozu.com | adobe | aws | box | dropbox | evernote | lineworks | SAMLサービスプロバイダーのサービスID | 代理認証のアプリケーションID | |
| role_office365[] | Microsoft365ライセンス名・管理者ロール名（配列） ※CSV登録画面に表記されている値 | |
| role_salesforce | Salesforceのプロファイル名 | |
| org | 組織 | |
| addorg[] | 兼務組織（配列） | |
| aliasname | 別名 | |
| nmail | 通知先メールアドレス | |
| simplename | 簡易表示名 | |
| attr_edupersonaffiliation | 職種 ・なし：none | |
| title | 役職 | |
| company | 会社 | |
| department | 部署 | |
| office | 事業所 | |
| country | 国 | |
| postalcode | 郵便番号 | |
| state | 都道府県 | |
| city | 市区郡 | |
| street | 町名・番地 | |
| telephone | 電話番号 | |
| fax | FAX | |
| mobile | 携帯電話番号 | |
| homephone | 自宅電話番号 | |
| attrvals[] | 追加項目（配列） | |
| 追加属性 | 「システム」-「追加属性」で設定した属性は、”attr_<追加属性の属性名>”をパラメーターとして、値を登録して下さい。 | |
| immutableid | Microsoft 365のImmutableID | |
| add_profiles[] | 割り当てるプロファイルに追加するプロファイルID（配列） | |
| remove_profiles[] | 割り当てるプロファイルから削除するプロファイルID（配列） |
ユーザー情報差分更新
| 利用可能なパラメータ | 必須 | 説明 |
| action_user_partialUpdate | 〇 | 固定値:true |
| id | 〇 | ユーザーID |
| empnum | 社員番号 | |
| sname | 姓 | |
| gname | 名 | |
| skana | 姓（カナ） | |
| gkana | 名（カナ) | |
| メールアドレス ※他ユーザーと重複する値は登録できません。 | ||
| mailalias[] | メールエイリアス（配列） ※他ユーザーと重複する値は登録できません。 | |
| locale | 地域 例：ja_JP、en_US | |
| lang | 言語 例：ja、en、zh | |
| password | パスワード (パスワードのみの変更は下記にあるパスワードAPIを利用してください。) | |
| status | ステータス（active|inactive） | |
| admin_role | 管理者権限（tenant_admin|user_admin） | |
| admin_authority | 管理者権限（read_only|privileged_id）（配列） | |
| service[] | 許可するサービス（配列）: googleapps|office365| salesforce|cybozu.com| adobe|aws|box|dropbox| evernote|lineworks| SAMLサービスプロバイダーのサービスID| 代理認証のアプリケーションID | |
| role_office365[] | Microsoft365ライセンス名・管理者ロール名（配列） ※CSV登録画面に表記されている値 | |
| role_salesforce | Salesforceのプロファイル名 | |
| org | 組織 | |
| addorg[] | 兼務組織（配列） | |
| aliasname | 別名 | |
| nmail | 通知先メールアドレス | |
| simplename | 簡易表示名 | |
| attr_edupersonaffiliation | 職種 ・なし：none | |
| title | 役職 | |
| company | 会社 | |
| department | 部署 | |
| office | 事業所 | |
| country | 国 | |
| postalcode | 郵便番号 | |
| state | 都道府県 | |
| city | 市区郡 | |
| street | 町名・番地 | |
| telephone | 電話番号 | |
| fax | FAX | |
| mobile | 携帯電話番号 | |
| homephone | 自宅電話番号 | |
| attrvals[] | 追加項目（配列） | |
| 追加属性 | 「システム」-「追加属性」で設定した属性は、”attr_<追加属性の属性名>”をパラメーターとして、値を登録して下さい。 | |
| immutableid | Microsoft 365のImmutableID | |
| profile[] | 割り当てるプロファイルのプロファイルID(配列) |
ユーザー削除
| 利用可能なパラメータ | 必須 | 説明 |
| action_user_delete | 〇 | 固定値:true |
| id | 〇 | ユーザーID |
パスワード変更
| 利用可能なパラメータ | 必須 | 説明 |
| action_user_setPasswd | 〇 | 固定値:true |
| id | 〇 | ユーザーID |
| password | 〇 | パスワード |
パスワード初期化
| 利用可能なパラメータ | 必須 | 説明 |
| action_user_initPwd | 〇 | 固定値:true |
| id | 〇 | ユーザーID |
| operation | 〇 | 固定値:initialize |
サービス個別のID・パスワードの設定
| 利用可能なパラメータ | 必須 | 説明 |
| action_user_idUpdate | 〇 | 固定値:true |
| id | 〇 | ユーザーID |
| service | 〇 | サービスID |
| loginid | 〇 | サービス個別のログインID |
| password | サービス個別のパスワード |
プロファイルの割り当て
| 利用可能なパラメータ | 必須 | 説明 |
| action_user_assignProfile | 〇 | 固定値:true |
| id | 〇 | ユーザーID |
| profile[] | 〇 | 割り当てるプロファイルのプロファイルID(配列) |
プロファイルの確認
| 利用可能なパラメータ | 必須 | 説明 |
| action_user_assignProfile | 〇 | 固定値:true |
| id | 〇 | ユーザーID |
| operation | 〇 | 固定値:read |
グループの割り当て
| 利用可能なパラメータ | 必須 | 説明 |
| action_user_assignGroup | 〇 | 固定値:true |
| id | 〇 | ユーザーID |
| operation | 固定値:update | |
| group[] | 割り当てるユーザーグループ | |
| securitygroup[] | 割り当てるセキュリティーグループ |
グループ割り当て状況の確認
| 利用可能なパラメータ | 必須 | 説明 |
| action_user_assignGroup | 〇 | 固定値:true |
| id | 〇 | ユーザーID |
| operation | 〇 | 固定値:read |
ワンタイムパスワードの設定
| 利用可能なパラメータ | 必須 | 説明 |
| action_user_setSecret | 〇 | 固定値:true PIN形式ワンタイムパスワード認証を利用する場合 |
| id | 〇 | ユーザーID |
| pin | 〇 | PIN |
| secret | 〇 | シークレットキー |
| length | 〇 | パスワードの桁数（6| 8） |
| timewindow | 〇 | パスワードの生成間隔（30 | 60） |
RADIUS設定で許可するMACアドレスの取得
| 利用可能なパラメータ | 必須 | 説明 |
| action_user_radius | 〇 | 固定値:true |
| id | 〇 | ユーザーID |
| operation | 〇 | 固定値:read |
RADIUS設定で許可するMACアドレスの設定
| 利用可能なパラメータ | 必須 | 説明 |
| action_user_radius | 〇 | 固定値:true |
| id | 〇 | ユーザーID |
| operation | 〇 | 固定値:update |
| macaddress[] | 〇 | 設定するMACアドレス |
※ユーザーを変更する場合、必須パラメータ以外で設定されていないパラメータについては空値として設定されます。
ただし、”password”については、パラメータが設定されていな場合、値は変更されません。