1.2.9 NASアクセスグループ

機能

NASアクセスグループ一覧

処理概要

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

パラメーター

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

ステータスコード

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

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

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

レスポンス詳細

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

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

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

コード	キー	説明	表示	形式
200	name	名前	Yes	string
	id	グループID	Yes	integer
	used_by_shared_folders	このグループがいずれかの共有フォルダで使用されているかどうか “true”: 使用されている “false”: 使用されていない	Yes	string
	users_belonging_to	グループに所属するユーザーの名前(複数存在する場合はコンマ区切りの文字列で表示)	Yes	string

1.2.9.2 POST /v1/nas_access/groups

機能

NASアクセスグループ作成

処理概要

グループの名前とグループIDを入力してください。

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

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

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

パラメーター

パラメーター名

説明

指定

形式

タイプ

token

認証トークン

必須

string

query

name

グループ名を指定します。

使用可能文字: 半角英数字
使用可能記号: -_$
最大文字数: 32

半角スペースは使用できません。
グループ名の予約語は指定できません。
グループ名の予約語については、『ユーザーズガイド』の「NASアクセスグループ設定」を参照してください。

必須

string

query

グループIDを指定します。

範囲: 500-999

省略時は500-999の空き番号が自動的に割り当てられます。

任意

integer

query

ステータスコード

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

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

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

レスポンス詳細

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

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

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

コード	キー	説明	形式
200	name	名前	string
	id	グループID	integer
	used_by_shared_folders	このグループがいずれかの共有フォルダで使用されているかどうか “true”: 使用されている “false”: 使用されていない	string
	users_belonging_to	グループに所属するユーザーの名前(複数存在する場合はコンマ区切りの文字列で表示)	string

1.2.9.3 DELETE /v1/nas_access/groups

機能

NASアクセスグループ削除

処理概要

ユーザーが所属しているグループ、および共有フォルダに設定されているグループは削除できません。

そのようなグループを削除する場合、先にユーザーまたは共有フォルダを削除してください。

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

パラメーター

パラメーター名	説明	指定	形式	タイプ
token	認証トークン	必須	string	query
ids	削除するグループID(数値)をコンマ区切りで指定します。 [例] 1,2,3,4,5	必須	string	query

ステータスコード

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

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

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

レスポンス詳細

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

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

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

ステータスコード	キー	説明	形式	列挙型定数
200	ids	削除されたグループID(複数の場合はコンマ区切りの文字列)	string