1.2.10 NASアクセスユーザー

機能

NASアクセスユーザー一覧

処理概要

共有フォルダに内部認証を使用する場合の、ユーザー定義の一覧を表示します。

パラメーター

パラメーター名	説明	指定	形式	タイプ
token	認証トークン	必須	string	query
filter_cols	フィルターするカラム名を指定します。 “,”で連結して複数のカラムを指定することが可能です。 [例] id,primary_group	任意	string	query
filter_vals	filter_colsで指定したカラム名に対して、指定順にフィルターの条件を指定します。数値の場合、“~”で範囲を指定することが可能です。 [例] 500~*,group1	任意	string	query
sort_cols	ソートするカラム名を指定します。 [例] id,primary_group,secondary_groups	任意	string	query
sort_vals	sort_colsで指定したカラム名に対して、指定順にソートの条件を指定します。昇順: asc 降順: desc [例] asc,asc,desc	任意	string	query
show_cols	表示するカラム名を指定します。 [例] id,primary_group,secondary_groups	任意	string	query
hide_cols	非表示にするカラム名を指定します。 [例] id,primary_group,secondary_groups	任意	string	query
limit	表示する項目数を指定します。	任意	integer	query
offset	項目の表示開始位置を指定します。	任意	integer	query

ステータスコード

本REST APIの実行が正常終了した場合は、以下のステータスコードで復帰します。

ステータスコードの詳細は、「ステータスコード」を参照してください。

ステータスコードに応じてメッセージが出力されます。メッセージの詳細は、「第2章メッセージ」を参照してください。

レスポンス詳細

JSON形式のレスポンスとして表示されます。

データを格納するキー名: users
オブジェクトの配列を返却

表示形式は、「1.1.2.2 レスポンス」の「レスポンスボディー」を参照してください。

コード	キー	説明	表示	形式
200	name	名前	Yes	string
	id	ユーザーID	Yes	integer
	primary_group	ユーザーが所属するグループの名前	Yes	string
	secondary_groups	ユーザーが所属するグループの名前(複数の場合はコンマ区切りの文字列)	Yes	string

1.2.10.2 POST /v1/nas_access/users

機能

NASアクセスユーザー作成

処理概要

ユーザー情報と所属させるグループを選択してください。

ユーザーの名前はシステム内で一意である必要があります。また、大文字小文字を区別しません。

ユーザーIDは省略可能で、省略時は自動的に昇順で採番します。

プライマリグループのIDは省略可能で、省略時は自動的に“sharegroup$(451) ”がプライマリグループに指定されます。

プライマリグループのIDには、“BUILTIN_Administrators(1002)”, “BUILTIN_Users(1003)”, “BUILTIN_BackupOperators(1004)”は指定できません。

セカンダリグループのIDに、プライマリグループのIDを含むことはできません。

実行ユーザーが“Monitor”ロールの場合は、実行できません。

パラメーター

パラメーター名	説明	指定	形式	タイプ
token	認証トークン	必須	string	query
name	ユーザー名を指定します。使用可能文字: 半角英数字使用可能記号: -_$ 最大文字数: 32 半角スペースは使用できません。ユーザー名の予約語は指定できません。ユーザー名の予約語については、『ユーザーズガイド』の「NASアクセスユーザー設定」を参照してください。 [例] username	必須	string	query
password	ユーザーパスワードを指定します。使用可能文字: 半角英数字使用可能記号: !"#$&'()*+,-./@[\]^_`{\|}~:;<=>? 文字数: 8～32 半角スペースは使用できません。大文字・小文字は区別されます。 A-Z(英大文字)、a-z(英小文字)、0-9(数字)、記号の中から3種類以上の文字を使用する必要があります。 [例] Password123#	必須	string	query
id	ユーザーIDを指定します。範囲: 500-999 省略時は500-999の空き番号が自動的に割り当てられます。	任意	integer	query
primary_group_id	ユーザーを所属させるプライマリグループのIDを指定します。省略時は451が設定されます。 [例] 500	任意	integer	query
secondary_group_ids	ユーザーを所属させるセカンダリグループのIDを指定します(複数指定する場合はコンマ区切りの文字列)。最大16個指定できます。 [例] 501,502,503	任意	string	query

ステータスコード

本REST APIの実行が正常終了した場合は、以下のステータスコードで復帰します。

ステータスコードの詳細は、「ステータスコード」を参照してください。

ステータスコードに応じてメッセージが出力されます。メッセージの詳細は、「第2章メッセージ」を参照してください。

レスポンス詳細

JSON形式のレスポンスとして表示されます。

データを格納するキー名: user
単一のオブジェクトを返却

表示形式は、「1.1.2.2 レスポンス」の「レスポンスボディー」を参照してください。

コード	キー	説明	形式
200	name	名前	string
	id	ユーザーID	integer
	primary_group	ユーザーが所属するグループの名前	string
	secondary_groups	ユーザーが所属するグループの名前(複数の場合はコンマ区切りの文字列)	string

1.2.10.3 PUT /v1/nas_access/users/{id}

機能

NASアクセスユーザー変更

処理概要

ユーザー情報を変更します。変更するパラメーターだけを指定してください。

ユーザー名とIDは変更できません。

プライマリグループのIDには、“BUILTIN_Administrators(1002)”, “BUILTIN_Users(1003)”, “BUILTIN_BackupOperators(1004)”は指定できません。

セカンダリグループのIDに、プライマリグループのIDを含むことはできません。

実行ユーザーが“Monitor”ロールの場合は、実行できません。

パラメーター

パラメーター名	説明	指定	形式	タイプ
token	認証トークン	必須	string	query
id	ユーザーIDを指定します。範囲: 500-999	必須	integer	path
password	ユーザーパスワードを指定します。使用可能文字: 半角英数字使用可能記号: !"#$&'()*+,-./@[\]^_`{\|}~:;<=>? 文字数: 8～32 半角スペースは使用できません。大文字・小文字は区別されます。 A-Z(英大文字)、a-z(英小文字)、0-9(数字)、記号の中から3種類以上の文字を使用する必要があります。 [例] Password123#	任意	string	query
primary_group_id	ユーザーを所属させるプライマリグループのIDを指定します。空文字列（""）を指定した場合、451が設定されます。 [例] 500	任意	integer	query
secondary_group_ids	ユーザーを所属させるセカンダリグループのIDを指定します(複数指定する場合はコンマ区切りの文字列)。最大16個指定できます。 [例] 501,502,503	任意	string	query
delete_all_secondary_groups	ユーザーが所属するすべてのセカンダリグループを登録解除する場合、“true”を指定します。“false”を指定した場合、“secondary_group_ids”で指定したセカンダリグループに更新されます。選択: [true \| false] [例] true	任意	string	query

ステータスコード

本REST APIの実行が正常終了した場合は、以下のステータスコードで復帰します。

ステータスコードの詳細は、「ステータスコード」を参照してください。

ステータスコードに応じてメッセージが出力されます。メッセージの詳細は、「第2章メッセージ」を参照してください。

レスポンス詳細

JSON形式のレスポンスとして表示されます。

データを格納するキー名: user
以下の値のうち、パラメーターとして指定された値を単一のオブジェクトとして返却

表示形式は、「1.1.2.2 レスポンス」の「レスポンスボディー」を参照してください。

コード	キー	説明	形式
200	id	ユーザーID	string
	primary_group_id	ユーザーを所属させたプライマリグループのID	string
	secondary_group_ids	ユーザーを所属させたセカンダリグループのID(複数存在する場合はコンマ区切りの文字列で表示)	string
	delete_all_secondary_groups	パラメーターで指定した“true”または“false”	string

1.2.10.4 DELETE /v1/nas_access/users

機能

NASアクセスユーザー削除

処理概要

NASアクセスユーザーを削除します。

実行ユーザーが“Monitor”ロールの場合は、実行できません。

パラメーター

パラメーター名

説明

指定

形式

タイプ

token

認証トークン

必須

string

query

ids

削除するユーザーID(数値)をコンマ区切りで指定します。

[例]
501,502,503,504,505

必須

string

query

ステータスコード

本REST APIの実行が正常終了した場合は、以下のステータスコードで復帰します。

ステータスコードの詳細は、「ステータスコード」を参照してください。

ステータスコードに応じてメッセージが出力されます。メッセージの詳細は、「第2章メッセージ」を参照してください。

レスポンス詳細

JSON形式のレスポンスとして表示されます。

データを格納するキー名: user
単一のオブジェクトを返却

表示形式は、「1.1.2.2 レスポンス」の「レスポンスボディー」を参照してください。

コード	キー	説明	形式	列挙型定数
200	ids	削除されたユーザーID(数値)をコンマ区切りで表示	string