AWS Mainframe Modernization Service (マネージドランタイム環境エクスペリエンス) は、新規のお客様に公開されなくなりました。 AWS Mainframe Modernization Service (マネージドランタイム環境エクスペリエンス) と同様の機能については、 AWS Mainframe Modernization Service (セルフマネージドエクスペリエンス) をご覧ください。既存のお客様は、通常どおりサービスを引き続き使用できます。詳細については、[AWS 「 Mainframe Modernization の可用性の変更](https://docs.aws.amazon.com/m2/latest/userguide/mainframe-modernization-availability-change.html)」を参照してください。
翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
# Blusam アプリケーションコンソールの REST エンドポイント
このセクションでは、モダナイズされた VSAM データセットの管理を簡素化するために設計された API であるBlusamアプリケーションコンソールについて説明します。Blusam ウェブアプリケーションのエンドポイントはルートパス を使用します`/bac`。
**Topics**
+ [エンドポイントに関連付けられたデータセット](#ba-endpoints-bac-datasets)
+ [エンドポイントに関連付けられたバルクデータセット](#ba-endpoints-bac-bulk)
+ [レコード](#ba-endpoints-bac-records)
+ [マスク](#ba-endpoints-bac-masks)
+ [その他](#ba-endpoints-bac-other)
+ [BAC ユーザー管理エンドポイント](#ba-endpoints-bac-users)
## エンドポイントに関連付けられたデータセット
次のエンドポイントを使用して、特定のデータセットを作成または管理します。
**Topics**
+ [データセットの作成](#ba-create-data-set)
+ [ファイルのアップロード](#ba-upload-file)
+ [データセットのロード (POST)](#ba-load-data-set-post)
+ [データセットのロード (GET)](#ba-load-data-set-get)
+ [Amazon S3 バケットからデータをロードする](#ba-load-data-set-s3)
+ [データセットを Amazon S3 バケットにエクスポートする](#ba-export-data-set-s3)
+ [データセットの消去](#ba-clear-data-set)
+ [データセットの削除](#ba-delete-data-set)
+ [データセットのレコード数のカウント](#ba-count-data-set-records)
### データセットの作成
このエンドポイントを使用すると、データセット定義を作成できます。
+ サポートされているメソッド: POST
+ 認証と ROLE\_ADMIN ロールが必要です。
+ パス: `/api/services/rest/bluesamservice/createDataSet`
+ 引数:
名前
(必須、文字列): データセットの名前。
型
(必須、文字列): データセットタイプ。可能な値は、`ESDS`、`KSDS`、`RRDS` です。
recordSize
(オプション、文字列): データセットの各レコードの最大サイズ。
fixedLength
(オプション、ブール値): レコード長が固定かどうかを示します。
compression
(オプション、ブール値): データセットが圧縮されているかどうかを示します。
cacheEnable
(オプション、ブール値): データセットのキャッシュが有効になっているかどうかを示します。
alternativeKeys
(オプション、キーのリスト):
+ offset (必須、数値)
+ length (必須、数値)
+ name (必須、数値)
+ 新規に作成されたデータセットを表す JSON ファイルを返します。
リクエスト例:
```
POST /api/services/rest/bluesamservice/createDataSet
{
"name": "DATASET",
"checked": false,
"records": [],
"primaryKey": {
"name": "PK"
},
"alternativeKeys": [
{
"offset": 10,
"length": 10,
"name": "ALTK_0"
}
],
"type": "ESDS",
"recordSize": 10,
"compression": true,
"cacheEnable": true
}
```
レスポンス例:
```
{
"dataSet": {
"name": "DATASET",
"checked": false,
"nbRecords": 0,
"keyLength": -1,
"recordSize": 10,
"compression": false,
"fixLength": true,
"type": "ESDS",
"cacheEnable": false,
"cacheWarmup": false,
"cacheEviction": "100ms",
"creationDate": 1686744961234,
"modificationDate": 1686744961234,
"records": [],
"primaryKey": {
"name": "PK",
"offset": null,
"length": null,
"columns": null,
"unique": true
},
"alternativeKeys": [
{
"offset": 10,
"length": 10,
"name": "ALTK_0"
}
],
"readLimit": 0,
"readEncoding": null,
"initCharacter": null,
"defaultCharacter": null,
"blankCharacter": null,
"strictZoned": null,
"decimalSeparator": null,
"currencySign": null,
"pictureCurrencySign": null
},
"message": null,
"result": true
}
```
### ファイルのアップロード
このエンドポイントを使用すると、サーバーにファイルをアップロードできます。ファイルは、特定の各ユーザーに対応する一時フォルダに保存されます。このエンドポイントは、ファイルをアップロードする必要が生じるたびに使用します。
+ サポートされているメソッド: POST
+ 認証と ROLE\_ADMIN ロールが必要です。
+ パス: `/api/services/rest/bluesamservice/upload`
+ 引数:
および
(必須、multipart/form-data): アップロードするファイル。
+ アップロードのステータスを反映するプール値を返します。
### データセットのロード (POST)
`createDataSet` を使用してデータセット定義を作成したら、アップロードされたファイルに関連付けられているレコードを特定のデータセットにロードできます。
+ サポートされているメソッド: POST
+ 認証と ROLE\_ADMIN ロールが必要です。
+ パス: `/api/services/rest/bluesamservice/loadDataSet`
+ 引数:
名前
(必須、文字列): データセットの名前。
+ 戻り値: リクエストのステータスと、ロードされたデータセット。
### データセットのロード (GET)
+ サポートされているメソッド: GET
+ 認証と ROLE\_ADMIN ロールが必要です。
+ パス: `/api/services/rest/bluesamservice/loadDataSet`
+ 引数:
listcatFileOrDatasetName
(必須、文字列): データセットの名前。
datasetFile
(必須、文字列): データセットファイルの名前。
+ 戻り値: リクエストのステータスと、ロードされたデータセット。
### Amazon S3 バケットからデータをロードする
listcat ファイルを使用して、Amazon S3 バケットからデータセットをロードします。
+ サポートされているメソッド: GET
+ 認証と ROLE\_ADMIN ロールが必要です。
+ パス: `/api/services/rest/bluesamservice/loadDataSetFromS3`
+ 引数:
listcatFileS3Location
(必須、文字列): listcat ファイルの Amazon S3 の場所。
datasetFileS3Location
(必須、文字列): データセットファイルの Amazon S3 の場所。
リージョン
(必須、文字列): ファイルが保存されている Amazon S3 AWS リージョン 。
+ 新規に作成されたデータセットを返します
リクエスト例:
```
/BAC/api/services/rest/bluesamservice/loadDataSetFromS3?region=us-east-1&listcatFileS3Location=s3://bucket-name/listcat.json&datasetFileS3Location=s3://bucket-name/dataset.DAT
```
### データセットを Amazon S3 バケットにエクスポートする
データセットを指定した Amazon S3 バケットにエクスポートします。
+ サポートされているメソッド: GET
+ 認証と ROLE\_ADMIN ロールが必要です。
+ パス: `/api/services/rest/bluesamservice/exportDataSetToS3`
+ 引数:
S3 の場所
(必須、文字列): データセットをエクスポートする Amazon S3 の場所。
datasetName
(必須、文字列): エクスポートするデータセットの名前。
リージョン
(必須、文字列): Amazon S3 バケット AWS リージョン の 。
kmsKeyId
(オプション、文字列): Amazon S3 バケットにエクスポートされたデータセットの暗号化に使用される AWS KMS ID。
+ エクスポートされたデータセットを返します。
リクエスト例:
```
/BAC/api/services/rest/bluesamservice/exportDataSetToS3?region=eu-west-1&s3Location=s3://bucket-name/dump&datasetName=dataset
```
### データセットの消去
データセットからすべてのレコードを消去します。
+ サポートされているメソッド: POST、GET
+ 認証と ROLE\_ADMIN ロールが必要です。
+ パス: `/api/services/rest/bluesamservice/clearDataSet`
+ 引数:
名前
(必須、文字列): 消去するデータセットの名前。GET メソッドを使用する場合、パラメータ名は です`datasetName`。
+ リクエストのステータスを返します。
### データセットの削除
データセット定義とレコードを削除します。
+ サポートされているメソッド: POST
+ 認証と ROLE\_ADMIN ロールが必要です。
+ パス: `/api/services/rest/bluesamservice/deleteDataSet`
+ 引数:
名前
(必須、文字列): 削除するデータセットの名前。
+ 戻り値: リクエストのステータスと、削除されたデータセット。
### データセットのレコード数のカウント
このエンドポイントは、データセットに関連付けられたレコード数を返します。
+ サポートされているメソッド: POST
+ 認証と ROLE\_USER ロールが必要です。
+ パス: `/api/services/rest/bluesamservice/countRecords`
+ 引数:
名前
(必須、文字列): データセットの名前。
+ 戻り値: レコード数
## エンドポイントに関連付けられたバルクデータセット
次のエンドポイントを使用して、一度に複数のデータセットを作成または管理します。
**Topics**
+ [データセットのエクスポート (GET)](#ba-export-data-sets-get)
+ [データセットのエクスポート (POST)](#ba-export-data-sets-post)
+ [複数のデータセットの作成](#ba-create-multiple-data-sets)
+ [すべてのデータセットのリスト](#ba-list-all-data-sets)
+ [すべてのデータセットの直接の一覧表示](#ba-direct-list-all-data-sets)
+ [すべてのデータセットの直接の一覧表示 (ページ単位)](#ba-direct-list-all-data-sets-by-page)
+ [データセットのストリーミング](#ba-stream-data-sets)
+ [すべてのデータセットの削除](#ba-delete-all-data-sets)
+ [listcat ファイルからデータセット定義を取得する](#ba-get-definitions-listcat)
+ [アップロードした listcat ファイルからデータセット定義を取得する](#ba-get-definitions-uploaded-listcat)
+ [データセットの取得](#ba-get-data-set)
+ [JSON ファイルから listcat をロードする](#ba-load-listcat)
### データセットのエクスポート (GET)
+ サポートされているメソッド: GET
+ 認証と ROLE\_ADMIN ロールが必要です。
+ パス: `/api/services/rest/bluesamservice/exportDataSet`
+ 引数:
datasetName
(必須、文字列): エクスポートするデータセットの名前。
datasetOutputFile
(必須、文字列): エクスポートされたデータセットを保存するサーバー上のフォルダのパス。
rdw
(必須、ブール値): レコード記述語 (RDW) をエクスポートされたレコードの一部にするかどうか。データセットに固定長レコードがある場合、このパラメータの値は無視されます。
+ リクエストのステータスと、エクスポートされたデータセット (ある場合) を含むファイルのパスを返します。レスポンスでデータセットが null の場合、指定された名前のデータセットをシステムが見つけることができなかったことを意味します。
### データセットのエクスポート (POST)
+ サポートされているメソッド: POST
+ 認証と ROLE\_USER ロールが必要です。
+ パス: `/api/services/rest/bluesamservice/exportDataSet`
+ 引数:
dumpParameters
(必須、BACReadParameters): Bluesam 読み取りパラメータ。
+ エクスポートされたデータセットのステータスを返します。
### 複数のデータセットの作成
+ サポートされているメソッド: POST
+ 認証と ROLE\_ADMIN ロールが必要です。
+ パス: `/api/services/rest/bluesamservice/createAllDataSets`
+ 引数:
+ データセットのリスト
名前
(必須、文字列): データセットの名前。
型
(必須、文字列): データセットタイプ。可能な値は、`ESDS`、`KSDS`、`RRDS` です。
recordSize
(オプション、文字列): データセットの各レコードの最大サイズ。
fixedLength
(オプション、ブール値): レコード長が固定かどうかを示します。
compression
(オプション、ブール値): データセットが圧縮されているかどうかを示します。
cacheEnable
(オプション、ブール値): データセットのキャッシュが有効になっているかどうかを示します。
+ 戻り値: リクエストのステータスと、新規に作成されたデータセット。
### すべてのデータセットのリスト
+ サポートされているメソッド: GET
+ 認証と ROLE\_USER ロールが必要です。
+ パス: `/api/services/rest/bluesamservice/listDataSet`
+ 引数: なし
+ 戻り値: リクエストのステータスと、データセットのリスト。
### すべてのデータセットの直接の一覧表示
+ サポートされているメソッド: GET
+ 認証と ROLE\_USER ロールが必要です。
+ パス: `/api/services/rest/bluesamservice/directListDataSet`
+ 引数: なし
+ 戻り値: リクエストのステータスと、データセットのリスト。
### すべてのデータセットの直接の一覧表示 (ページ単位)
+ サポートされているメソッド: GET
+ 認証と ROLE\_USER ロールが必要です。
+ パス: `/api/services/rest/bluesamservice/directListDataSetByPage`
+ 引数:
名前
(必須、文字列): データセットの名前。指定しない場合、デフォルトは `%` (すべてのデータセット) です。
page
(必須、int): ページ番号 (最小 0)。
pageSize
(必須、int): ページサイズ (最小 1、最大 500)。
+ 戻り値: リクエストのステータスと、データセットのリスト。
### データセットのストリーミング
+ サポートされているメソッド: GET
+ 認証と ROLE\_ADMIN ロールが必要です。
+ パス: `/api/services/rest/bluesamservice/streamDataset`
+ 引数:
datasetName
(必須、文字列): データセットの名前。
+ 戻り値: リクエストされたデータセットのストリーム。
### すべてのデータセットの削除
+ サポートされているメソッド: POST
+ 認証と ROLE\_ADMIN ロールが必要です。
+ パス: `/api/services/rest/bluesamservice/removeAll`
+ 引数: なし
+ 戻り値: リクエストのステータスを表すブール値。
### listcat ファイルからデータセット定義を取得する
+ サポートされているメソッド: POST
+ 認証と ROLE\_ADMIN ロールが必要です。
+ パス: `/api/services/rest/bluesamservice/getDataSetsDefinitionFromListcat`
+ 引数:
paramFilePath
(必須、文字列): listcat ファイルへのパス。
+ 戻り値: データセットのリスト
### アップロードした listcat ファイルからデータセット定義を取得する
+ サポートされているメソッド: POST
+ 認証と ROLE\_ADMIN ロールが必要です。
+ パス: `/api/services/rest/bluesamservice/getDataSetsDefinitionFromUploadedListcat`
+ 引数: なし
+ 戻り値: データセットのリスト
### データセットの取得
+ サポートされているメソッド: GET
+ 認証と ROLE\_USER ロールが必要です。
+ パス: `/api/services/rest/bluesamservice/getDataSet`
+ 引数:
名前
(必須、文字列): データセットの名前。
+ リクエストされたデータセットを返します。
### JSON ファイルから listcat をロードする
+ サポートされているメソッド: GET
+ 認証と ROLE\_ADMIN ロールが必要です。
+ パス: `/api/services/rest/bluesamservice/loadListcatFromJsonFile`
+ 引数:
filePath
(必須、文字列): listcat ファイルへのパス。
+ 戻り値: データセットのリスト
## レコード
次のエンドポイントを使用して、データセット内のレコードを作成または管理します。
**Topics**
+ [レコードを作成する](#ba-create-record)
+ [データセットの読み込み](#ba-read-data-set)
+ [レコードを削除する](#ba-delete-record)
+ [レコードの更新](#ba-update-record)
+ [レコードの保存](#ba-save-record)
+ [レコードの検証](#ba-validate-record)
+ [レコードツリーの取得](#ba-get-record-tree)
### レコードを作成する
このエンドポイントを使用すると、新しいレコードを作成できます。
+ サポートされているメソッド: POST
+ 認証と ROLE\_USER ロールが必要です。
+ パス: `/api/services/rest/crud/createRecord`
+ 引数:
データセット
(必須、データセット): データセットオブジェクト
マスク
(必須、マスク): マスクオブジェクト。
+ 戻り値: リクエストのステータスと、作成されたレコード。
### データセットの読み込み
このエンドポイントを使用すると、データセットを読み取ることができます。
+ サポートされているメソッド: POST
+ 認証と ROLE\_USER ロールが必要です。
+ パス: `/api/services/rest/crud/readDataSet`
+ 引数:
データセット
(必須、データセット): データセットオブジェクト
+ 戻り値: リクエストのステータスと、レコードを含むデータセット。
### レコードを削除する
このエンドポイントを使用すると、データセットからレコードを削除できます。
+ サポートされているメソッド: POST
+ 認証と ROLE\_USER ロールが必要です。
+ パス: `/api/services/rest/crud/deleteRecord`
+ 引数:
データセット
(必須、データセット): データセットオブジェクト
record
(必須、レコード): 削除するレコード
+ 削除のステータスを返します。
### レコードの更新
このエンドポイントを使用すると、データセットに関連付けられたレコードを更新できます。
+ サポートされているメソッド: POST
+ 認証と ROLE\_USER ロールが必要です。
+ パス: `/api/services/rest/crud/updateRecord`
+ 引数:
データセット
(必須、データセット): データセットオブジェクト
record
(必須、レコード): 更新するレコード
マスク
(オプション、マスク): 更新中に適用するマスクオブジェクト。
+ 戻り値: リクエストのステータスと、レコードを含むデータセット。
### レコードの保存
このエンドポイントを使用すると、マスクを使用してレコードをデータセットに保存できます。
+ サポートされているメソッド: POST
+ 認証と ROLE\_USER ロールが必要です。
+ パス: `/api/services/rest/crud/saveRecord`
+ 引数:
データセット
(必須、データセット): データセットオブジェクト
record
(必須、レコード): 保存するレコード
マスク
(オプション、マスク): 保存中に適用するマスクオブジェクト。
+ 戻り値: リクエストのステータスと、レコードを含むデータセット。
### レコードの検証
このエンドポイントは、レコードを検証するために使用します。
+ サポートされているメソッド: POST
+ 認証と ROLE\_USER ロールが必要です。
+ パス: `/api/services/rest/crud/validateRecord`
+ 引数:
データセット
(必須、データセット): データセットオブジェクト
record
(オプション、レコード): 検証するレコード。
マスク
(オプション、マスク): 検証中に適用するマスクオブジェクト。
+ 戻り値: リクエストのステータスと、レコードを含むデータセット。
### レコードツリーの取得
このエンドポイントは、レコードの階層ツリーを取得するために使用します。
+ サポートされているメソッド: POST
+ 認証と ROLE\_USER ロールが必要です。
+ パス: `/api/services/rest/crud/getRecordTree`
+ 引数:
データセット
(必須、データセット): データセットオブジェクト
record
(必須、レコード): 取得するレコード
マスク
(オプション、マスク): マスクオブジェクト。
+ リクエストのステータスと、リクエストされたレコードの階層ツリーを返します。
## マスク
次の以下のエンドポイントを使用して、データセットにマスクをロードまたは適用します。
**Topics**
+ [マスクのロード](#ba-load-mask)
+ [マスクの適用](#ba-apply-mask)
+ [マスクフィルタの適用](#ba-apply-mask-filter)
### マスクのロード
このエンドポイントを使用すると、特定のデータセットに関連するすべてのマスクを取得できます。
+ サポートされているメソッド: POST
+ 認証と ROLE\_USER ロールが必要です。
+ パス: `/api/services/rest/crud/loadMasks`
+ パス変数:
recordSize: .../loadMasks/{recordSize}
(オプション、数値): レコードサイズ。このレコードサイズに一致する、ロードされたマスクをフィルタリングします。
+ 引数:
データセット
(必須、データセット): データセットオブジェクト
+ 戻り値: リクエストのステータスと、マスクのリスト。
### マスクの適用
このエンドポイントを使用すると、特定のデータセットにマスクを適用できます。
+ サポートされているメソッド: POST
+ 認証と ROLE\_USER ロールが必要です。
+ パス: `/api/services/rest/crud/applyMask`
+ 引数:
データセット
(必須、データセット): データセットオブジェクト
マスク
(必須、マスク): データセットオブジェクト
+ 戻り値: リクエストのステータスと、適用したマスクを含むデータセット。
### マスクフィルタの適用
このエンドポイントを使用すると、特定のデータセットにマスクとフィルタを適用できます。
+ サポートされているメソッド: POST
+ 認証と ROLE\_USER ロールが必要です。
+ パス: `/api/services/rest/crud/applyMaskFilter`
+ 引数:
データセット
(必須、データセット): データセットオブジェクト
マスク
(必須、マスク): マスクオブジェクト
フィルター
(必須、フィルター): 適用するフィルターオブジェクト。
+ 戻り値: リクエストのステータスと、適用したマスクとフィルタを含むデータセット。
## その他
次のエンドポイントを使用して、データセットのキャッシュの管理や、データセットの特性の確認を行います。
**Topics**
+ [ウォームアップキャッシュの確認](#ba-check-warm-up-cache)
+ [チェックキャッシュの有効化](#ba-check-cache-enabled)
+ [キャッシュの有効化](#ba-enable-cache)
+ [割り当てられた RAM キャッシュの確認](#ba-check-allocated-ram-cache)
+ [永続性の確認](#ba-check-persistence)
+ [サポートされているデータセットタイプの確認](#ba-check-supported-data-set-types)
+ [サーバーヘルスの確認](#ba-check-server-health)
+ [PostgreSQL マルチスキーマ設定を確認する](#ba-check-postgres-multi-schema)
### ウォームアップキャッシュの確認
特定のデータセットに対して、ウォームアップキャッシュが有効になっているかどうかを確認します。
+ サポートされているメソッド: POST
+ 認証と ROLE\_ADMIN ロールが必要です。
+ パス: `/api/services/rest/bluesamservice/warmupCache`
+ 引数:
名前
(必須、文字列): データセットの名前。
+ 戻り値: ウォームアップキャッシュが有効になっている場合は「true」、それ以外の場合は「false」。
### チェックキャッシュの有効化
特定のデータセットに対して、キャッシュが有効になっているかどうかを確認します。
+ サポートされているメソッド: GET
+ 認証と ROLE\_USER ロールが必要です。
+ パス: `/api/services/rest/bluesamservice/isEnableCache`
+ 引数: なし
+ キャッシュが有効になっている場合は「true」を返します。
### キャッシュの有効化
+ サポートされているメソッド: POST
+ 認証と ROLE\_ADMIN ロールおよび ROLE\_SUPER\_ADMIN ロールが必要です。
+ パス: `/api/services/rest/bluesamservice/enableDisableCache/{enable}`
+ 引数:
enable
(必須、プール値): 「true」に設定すると、キャッシュが有効になります。
データセット
(必須、データセット): データセットオブジェクト
+ 戻り値: なし
### 割り当てられた RAM キャッシュの確認
このエンドポイントを使用すると、割り当てられた RAM キャッシュメモリを取得できます。
+ サポートされているメソッド: GET
+ 認証と ROLE\_USER ロールが必要です。
+ パス: `/api/services/rest/bluesamservice/allocatedRamCache`
+ 引数: なし
+ 戻り値: メモリのサイズ (文字列)
### 永続性の確認
+ サポートされているメソッド: GET
+ 認証と ROLE\_USER ロールが必要です。
+ パス: `/api/services/rest/bluesamservice/persistence`
+ 引数: なし
+ 戻り値: 文字列として使用される永続性
### サポートされているデータセットタイプの確認
+ サポートされているメソッド: GET
+ パス: `/api/services/rest/bluesamservice/getDataSetTypes`
+ 認証と ROLE\_USER ロールが必要です。
+ 引数: なし
+ 戻り値: サポートされているデータセットタイプのリスト (文字列のリスト)。
### サーバーヘルスの確認
+ サポートされているメソッド: GET
+ パス: `/api/services/rest/bluesamserver/serverIsUp`
+ 引数: なし
+ 戻り値: なし HTTP レスポンスステータスコード 200 は、サーバーが稼働中であることを示します。
### PostgreSQL マルチスキーマ設定を確認する
PostgreSQL マルチスキーマ設定が有効になっているかどうかを確認します。
+ サポートされているメソッド: GET
+ 認証と ROLE\_USER ロールが必要です。
+ パス: `/api/services/rest/bluesamservice/isPostgresMultiSchema`
+ 引数: なし
+ 戻り値: PostgreSQL マルチスキーマ設定が有効になっている場合は true、それ以外の場合は false。
## BAC ユーザー管理エンドポイント
次のエンドポイントを使用して、ユーザーインタラクションを管理します。
**Topics**
+ [ユーザーのログイン](#ba-log-user-in)
+ [システムに少なくとも 1 人のユーザーが存在するかどうかの確認](#ba-verify-at-least-one-user-exists)
+ [新規ユーザーの記録](#ba-record-new-user)
+ [ユーザー情報の取得](#ba-user-info)
+ [ユーザーの一覧表示](#ba-list-users)
+ [ユーザーの削除](#ba-delete-user)
+ [現在のユーザーのログアウト](#ba-log-user-out)
### ユーザーのログイン
+ サポートされているメソッド: POST
+ パス: `/api/services/security/servicelogin/login`
+ 引数: なし
+ 現在のリクエストで入力された認証情報を持つユーザーを表す、`com.netfective.bluage.bac.entities.SignOn` オブジェクトの JSON のシリアル化を返します。パスワードは、返されたオブジェクトの中では表示されません。ユーザーに割り当てられたロールが一覧表示されます。
レスポンス例:
```
{
"login": "some-admin",
"password": null,
"roles": [
{
"id": 0,
"roleName": "ROLE_ADMIN"
}
]
}
```
### システムに少なくとも 1 人のユーザーが存在するかどうかの確認
+ サポートされているメソッド: GET
+ パス: `/api/services/security/servicelogin/hasAccount`
+ 引数: なし
+ デフォルトのスーパー管理者ユーザー以外のユーザーが少なくとも 1 人作成されている場合は、ブール値 `true` を返します。それ以外の場合は `false` を返します。
### 新規ユーザーの記録
+ サポートされているメソッド: POST
+ 認証と ROLE\_ADMIN ロールが必要です。
+ パス: `/api/services/security/servicelogin/recorduser`
+ 引数: ストレージに追加されるユーザーを表す `com.netfective.bluage.bac.entities.SignOn` オブジェクトの JSON のシリアル化。ユーザーのロールを定義する必要があります。定義されていないと、ユーザーは BAC 機能やエンドポイントを使用できない可能性があります。
+ ユーザーが正常に作成された場合は、ブール値 `true` を返します。それ以外の場合は `false` を返します。
+ サンプルリクエスト JSON:
```
{
"login": "simpleuser",
"password": "simplepassword",
"roles": [
{
"id": 2,
"roleName": "ROLE_USER"
}
]
}
```
次に示すのは、`roleName` の 2 つの有効な値です。
+ `ROLE_ADMIN`: はBlusamリソースとユーザーを管理できます。
+ `ROLE_USER`: はBlusamリソースを管理できますが、ユーザーは管理できません。
### ユーザー情報の取得
+ サポートされているメソッド: GET
+ パス: `/api/services/security/servicelogin/userInfo`
+ 引数: なし
+ 現在接続されているユーザーのユーザー名とパスワードを返します。
### ユーザーの一覧表示
+ サポートされているメソッド: GET
+ 認証と ROLE\_ADMIN ロールが必要です。
+ パス: `/api/services/security/servicelogin/listusers`
+ 引数: なし
+ JSON としてシリアル化された `com.netfective.bluage.bac.entities.SignOn` の一覧を返します。
### ユーザーの削除
**重要**
このアクションを元に戻すことはできません。削除されたユーザーは、BAC アプリケーションに再度接続できなくなります。
+ サポートされているメソッド: POST
+ 認証と ROLE\_ADMIN ロールが必要です。
+ パス: `/api/services/security/servicelogin/deleteuser`
+ 引数: ストレージから削除するユーザーを表す `com.netfective.bluage.bac.entities.SignOn` オブジェクトの JSON のシリアル化。
+ ユーザーが正常に削除された場合は、ブール値 `true` を返します。
### 現在のユーザーのログアウト
+ サポートされているメソッド: GET
+ パス: `/api/services/security/servicelogout/logout`
+ 引数: なし
+ 現在のユーザーが正常にログアウトされた場合は、JSON メッセージ `{"success":true}` を返します。関連する HTTP セッションは無効になります。