AWS Il servizio di modernizzazione del mainframe (esperienza Managed Runtime Environment) non è più aperto a nuovi clienti. Per funzionalità simili a AWS Mainframe Modernization Service (esperienza Managed Runtime Environment), esplora AWS Mainframe Modernization Service (Self-Managed Experience). I clienti esistenti possono continuare a utilizzare il servizio normalmente. [Per ulteriori informazioni, consulta AWS Modifica della disponibilità di Mainframe Modernization.](https://docs.aws.amazon.com/m2/latest/userguide/mainframe-modernization-availability-change.html) Le traduzioni sono generate tramite traduzione automatica. In caso di conflitto tra il contenuto di una traduzione e la versione originale in Inglese, quest'ultima prevarrà. # Blusamendpoint REST della console delle applicazioni In questa sezione, puoi conoscere la console delle Blusam applicazioni, un'API progettata per semplificare la gestione dei set di dati VSAM modernizzati. Gli endpoint per l'applicazione Blusam Web utilizzano il percorso principale. `/bac` **Topics** + [Set di dati (endpoint correlati)](#ba-endpoints-bac-datasets) + [Set di dati in blocco: endpoint correlati](#ba-endpoints-bac-bulk) + [Registri](#ba-endpoints-bac-records) + [Maschere](#ba-endpoints-bac-masks) + [Altro](#ba-endpoints-bac-other) + [Endpoint BAC per la gestione degli utenti](#ba-endpoints-bac-users) ## Set di dati (endpoint correlati) Utilizza i seguenti endpoint per creare o gestire un set di dati specifico. **Topics** + [Crea un set di dati](#ba-create-data-set) + [Caricamento di un file](#ba-upload-file) + [Carica un set di dati (POST)](#ba-load-data-set-post) + [Carica un set di dati (GET)](#ba-load-data-set-get) + [Caricare un set di dati da un bucket Amazon S3](#ba-load-data-set-s3) + [Esportazione di un set di dati in un bucket Amazon S3](#ba-export-data-set-s3) + [Cancellare un set di dati](#ba-clear-data-set) + [Eliminare un set di dati](#ba-delete-data-set) + [Conta i record del set di dati](#ba-count-data-set-records) ### Crea un set di dati È possibile utilizzare questo endpoint per creare una definizione di set di dati. + Metodi supportati: POST + Richiede l'autenticazione e il ruolo ROLE\_ADMIN. + Percorso: `/api/services/rest/bluesamservice/createDataSet` + Argomenti: nome (obbligatorio, stringa): il nome del set di dati. tipo (obbligatorio, stringa): il tipo di set di dati. I valori possibili sono:`ESDS`,`KSDS`,`RRDS`. Dimensione del record (opzionale, stringa): dimensione massima di ogni record del set di dati. Lunghezza fissa (opzionale, booleano): indica se la lunghezza dei record è fissa. compressione (opzionale, booleano): indica se il set di dati è compresso. CacheEnable (opzionale, booleano): indica se la memorizzazione nella cache è abilitata per il set di dati. Tasti alternativi (opzionale, elenco di chiavi): + offset (obbligatorio, numero) + lunghezza (richiesto, numero) + nome (richiesto, numero) + Restituisce un file JSON che rappresenta il set di dati appena creato. Richiesta di esempio: ``` 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 } ``` Risposta di esempio: ``` { "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 } ``` ### Caricamento di un file È possibile utilizzare questo endpoint per caricare file sul server. Il file viene archiviato in una cartella temporanea che corrisponde a ciascun utente specifico. Usa questo endpoint ogni volta che devi caricare un file. + Metodi supportati: POST + Richiede l'autenticazione e il ruolo ROLE\_ADMIN. + Percorso: `/api/services/rest/bluesamservice/upload` + Argomenti: file (obbligatorio, multipart/form-data): il file da caricare. + Restituisce un valore booleano che riflette lo stato del caricamento ### Carica un set di dati (POST) Dopo aver creato `createDataSet` la definizione del set di dati, è possibile caricare i record associati al file caricato in un set di dati specifico. + Metodi supportati: POST + Richiede l'autenticazione e il ruolo ROLE\_ADMIN. + Percorso: `/api/services/rest/bluesamservice/loadDataSet` + Argomenti: nome (obbligatorio, stringa): il nome del set di dati. + Restituisce lo stato della richiesta e del set di dati caricato. ### Carica un set di dati (GET) + Metodi supportati: GET + Richiede l'autenticazione e il ruolo ROLE\_ADMIN. + Percorso: `/api/services/rest/bluesamservice/loadDataSet` + Argomenti: listcatFileOrDatasetName (obbligatorio, stringa): il nome del set di dati. DataSetFile (obbligatorio, stringa): il nome del file del set di dati. + Restituisce lo stato della richiesta e del set di dati caricato. ### Caricare un set di dati da un bucket Amazon S3 Carica un set di dati utilizzando un file listcat da un bucket Amazon S3. + Metodi supportati: GET + Richiede l'autenticazione e il ruolo ROLE\_ADMIN. + Percorso: `/api/services/rest/bluesamservice/loadDataSetFromS3` + Argomenti: Elenca la posizione dei file CAT 3 (obbligatorio, stringa): la posizione Amazon S3 del file listcat. Posizione di DataSetFiles3 (obbligatorio, stringa): la posizione Amazon S3 del file del set di dati. region (obbligatorio, stringa): l'Amazon S3 Regione AWS in cui sono archiviati i file. + Restituisce il set di dati appena creato Richiesta di esempio: ``` /BAC/api/services/rest/bluesamservice/loadDataSetFromS3?region=us-east-1&listcatFileS3Location=s3://bucket-name/listcat.json&datasetFileS3Location=s3://bucket-name/dataset.DAT ``` ### Esportazione di un set di dati in un bucket Amazon S3 Esporta un set di dati nel bucket Amazon S3 specificato. + Metodi supportati: GET + Richiede l'autenticazione e il ruolo ROLE\_ADMIN. + Percorso: `/api/services/rest/bluesamservice/exportDataSetToS3` + Argomenti: s3Location (obbligatorio, stringa): la posizione Amazon S3 in cui esportare il set di dati. datasetName (obbligatorio, stringa): il nome del set di dati da esportare. region (obbligatorio, stringa): il Regione AWS bucket Amazon S3. kmsKeyId (opzionale, stringa): l' AWS KMS ID da utilizzare per la crittografia del set di dati esportato nel bucket Amazon S3. + Restituisce il set di dati esportato Richiesta di esempio: ``` /BAC/api/services/rest/bluesamservice/exportDataSetToS3?region=eu-west-1&s3Location=s3://bucket-name/dump&datasetName=dataset ``` ### Cancellare un set di dati Cancella tutti i record da un set di dati. + Metodi supportati: POST, GET + Richiede l'autenticazione e il ruolo ROLE\_ADMIN. + Percorso: `/api/services/rest/bluesamservice/clearDataSet` + Argomenti: nome (obbligatorio, stringa): il nome del set di dati da cancellare. Quando si utilizza il metodo GET, il nome del parametro è`datasetName`. + Restituisce lo stato della richiesta. ### Eliminare un set di dati Elimina la definizione e i record del set di dati. + Metodi supportati: POST + Richiede l'autenticazione e il ruolo ROLE\_ADMIN. + Percorso: `/api/services/rest/bluesamservice/deleteDataSet` + Argomenti: nome (obbligatorio, stringa): il nome del set di dati da eliminare. + Restituisce lo stato della richiesta e del set di dati eliminato. ### Conta i record del set di dati Questo endpoint restituisce il numero di record associati a un set di dati. + Metodi supportati: POST + Richiede l'autenticazione e il ruolo ROLE\_USER. + Percorso: `/api/services/rest/bluesamservice/countRecords` + Argomenti: nome (obbligatorio, stringa): il nome del set di dati. + Restituisce: il numero di record ## Set di dati in blocco: endpoint correlati Utilizza i seguenti endpoint per creare o gestire più set di dati contemporaneamente. **Topics** + [Esporta set di dati (GET)](#ba-export-data-sets-get) + [Esporta set di dati (POST)](#ba-export-data-sets-post) + [Crea più set di dati](#ba-create-multiple-data-sets) + [Elenca tutti i set di dati](#ba-list-all-data-sets) + [Elenca direttamente tutti i set di dati](#ba-direct-list-all-data-sets) + [Elenca direttamente tutti i set di dati per pagina](#ba-direct-list-all-data-sets-by-page) + [Set di dati di streaming](#ba-stream-data-sets) + [Elimina tutti i set di dati](#ba-delete-all-data-sets) + [Ottieni le definizioni dei set di dati dal file listcat](#ba-get-definitions-listcat) + [Ottieni le definizioni dei set di dati dal file cat dell'elenco caricato](#ba-get-definitions-uploaded-listcat) + [Ottieni un set di dati](#ba-get-data-set) + [Carica listcat dal file JSON](#ba-load-listcat) ### Esporta set di dati (GET) + Metodi supportati: GET + Richiede l'autenticazione e il ruolo ROLE\_ADMIN. + Percorso: `/api/services/rest/bluesamservice/exportDataSet` + Argomenti: datasetName (obbligatorio, stringa): il nome del set di dati da esportare. datasetOutputFile (obbligatorio, stringa): il percorso della cartella in cui si desidera archiviare il set di dati esportato sul server. rdw (obbligatorio, booleano): se si desidera che la parola descrittiva del record (RDW) faccia parte dei record esportati. Se il set di dati contiene record a lunghezza fissa, il valore di questo parametro viene ignorato. + Restituisce lo stato della richiesta e il percorso del file contenente il set di dati esportato (se presente). Se il set di dati è nullo nella risposta, significa che il sistema non è stato in grado di individuare un set di dati con il nome specificato. ### Esporta set di dati (POST) + Metodi supportati: POST + Richiede l'autenticazione e il ruolo ROLE\_USER. + Percorso: `/api/services/rest/bluesamservice/exportDataSet` + Argomenti: Parametri di dump (obbligatorio, BACRead Parametri): parametri di lettura Bluesam. + Restituisce lo stato del set di dati esportato. ### Crea più set di dati + Metodi supportati: POST + Richiede l'autenticazione e il ruolo ROLE\_ADMIN. + Percorso: `/api/services/rest/bluesamservice/createAllDataSets` + Argomenti: + Elenco dei set di dati nome (obbligatorio, stringa): il nome del set di dati. tipo (obbligatorio, stringa): il tipo di set di dati. I valori possibili sono:`ESDS`,`KSDS`,`RRDS`. Dimensione del record (opzionale, stringa): dimensione massima di ogni record del set di dati. Lunghezza fissa (opzionale, booleano): indica se la lunghezza dei record è fissa. compressione (opzionale, booleano): indica se il set di dati è compresso. CacheEnable (opzionale, booleano): indica se la memorizzazione nella cache è abilitata per il set di dati. + Restituisce: lo stato della richiesta e il set di dati appena creato. ### Elenca tutti i set di dati + Metodi supportati: GET + Richiede l'autenticazione e il ruolo ROLE\_USER. + Percorso: `/api/services/rest/bluesamservice/listDataSet` + Argomenti: Nessuno + Restituisce: lo stato della richiesta e l'elenco dei set di dati. ### Elenca direttamente tutti i set di dati + Metodi supportati: GET + Richiede l'autenticazione e il ruolo ROLE\_USER. + Percorso: `/api/services/rest/bluesamservice/directListDataSet` + Argomenti: Nessuno + Restituisce: lo stato della richiesta e l'elenco dei set di dati. ### Elenca direttamente tutti i set di dati per pagina + Metodi supportati: GET + Richiede l'autenticazione e il ruolo ROLE\_USER. + Percorso: `/api/services/rest/bluesamservice/directListDataSetByPage` + Argomenti: nome (obbligatorio, stringa): il nome del set di dati. Il valore predefinito è `%` (tutti i set di dati) se non specificato. page (obbligatorio, int): il numero di pagina (minimo 0). pageSize (obbligatorio, int): la dimensione della pagina (minimo 1, massimo 500). + Restituisce: lo stato della richiesta e l'elenco dei set di dati. ### Set di dati di streaming + Metodi supportati: GET + Richiede l'autenticazione e il ruolo ROLE\_ADMIN. + Percorso: `/api/services/rest/bluesamservice/streamDataset` + Argomenti: datasetName (obbligatorio, stringa): il nome del set di dati. + Restituisce: un flusso dei set di dati richiesti. ### Elimina tutti i set di dati + Metodi supportati: POST + Richiede l'autenticazione e il ruolo ROLE\_ADMIN. + Percorso: `/api/services/rest/bluesamservice/removeAll` + Argomenti: Nessuno + Restituisce: un valore booleano che rappresenta lo stato della richiesta. ### Ottieni le definizioni dei set di dati dal file listcat + Metodi supportati: POST + Richiede l'autenticazione e il ruolo ROLE\_ADMIN. + Percorso: `/api/services/rest/bluesamservice/getDataSetsDefinitionFromListcat` + Argomenti: paramFilePath (obbligatorio, stringa): il percorso del file listcat. + Restituisce: un elenco di set di dati ### Ottieni le definizioni dei set di dati dal file cat dell'elenco caricato + Metodi supportati: POST + Richiede l'autenticazione e il ruolo ROLE\_ADMIN. + Percorso: `/api/services/rest/bluesamservice/getDataSetsDefinitionFromUploadedListcat` + Argomenti: Nessuno + Restituisce: un elenco di set di dati ### Ottieni un set di dati + Metodi supportati: GET + Richiede l'autenticazione e il ruolo ROLE\_USER. + Percorso: `/api/services/rest/bluesamservice/getDataSet` + Argomenti: nome (obbligatorio, stringa): il nome del set di dati. + Restituisce il set di dati richiesto. ### Carica listcat dal file JSON + Metodi supportati: GET + Richiede l'autenticazione e il ruolo ROLE\_ADMIN. + Percorso: `/api/services/rest/bluesamservice/loadListcatFromJsonFile` + Argomenti: filePath (obbligatorio, stringa): il percorso del file listcat. + Restituisce: un elenco di set di dati ## Registri Utilizza i seguenti endpoint per creare o gestire i record all'interno di un set di dati. **Topics** + [Creazione di un record](#ba-create-record) + [Leggi un set di dati](#ba-read-data-set) + [Eliminazione di un registro](#ba-delete-record) + [Aggiornare un record](#ba-update-record) + [Salva un record](#ba-save-record) + [Convalida un record](#ba-validate-record) + [Ottieni un albero dei record](#ba-get-record-tree) ### Creazione di un record È possibile utilizzare questo endpoint per creare un nuovo record. + Metodi supportati: POST + Richiede l'autenticazione e il ruolo ROLE\_USER. + Percorso: `/api/services/rest/crud/createRecord` + Argomenti: set di dati (obbligatorio, DataSet): l'oggetto del set di dati maschera (obbligatorio, maschera): l'oggetto maschera. + Restituisce lo stato della richiesta e il record creato. ### Leggi un set di dati È possibile utilizzare questo endpoint per leggere un set di dati. + Metodi supportati: POST + Richiede l'autenticazione e il ruolo ROLE\_USER. + Percorso: `/api/services/rest/crud/readDataSet` + Argomenti: set di dati (obbligatorio, DataSet): l'oggetto del set di dati. + Restituisce lo stato della richiesta e il set di dati con i record. ### Eliminazione di un registro È possibile utilizzare questo endpoint per eliminare un record da un set di dati. + Metodi supportati: POST + Richiede l'autenticazione e il ruolo ROLE\_USER. + Percorso: `/api/services/rest/crud/deleteRecord` + Argomenti: set di dati (obbligatorio, DataSet): l'oggetto del set di dati record (obbligatorio, Record): il record da eliminare + Restituisce lo stato dell'eliminazione. ### Aggiornare un record È possibile utilizzare questo endpoint per aggiornare un record associato a un set di dati. + Metodi supportati: POST + Richiede l'autenticazione e il ruolo ROLE\_USER. + Percorso: `/api/services/rest/crud/updateRecord` + Argomenti: set di dati (obbligatorio, DataSet): l'oggetto del set di dati record (obbligatorio, Record): il record da aggiornare maschera (opzionale, Maschera): l'oggetto maschera da applicare durante l'aggiornamento. + Restituisce lo stato della richiesta e il set di dati con i record. ### Salva un record È possibile utilizzare questo endpoint per salvare un record in un set di dati e utilizzare una maschera. + Metodi supportati: POST + Richiede l'autenticazione e il ruolo ROLE\_USER. + Percorso: `/api/services/rest/crud/saveRecord` + Argomenti: set di dati (obbligatorio, DataSet): l'oggetto del set di dati record (richiesto, Record): il record da salvare maschera (opzionale, Maschera): l'oggetto maschera da applicare durante il salvataggio. + Restituisce lo stato della richiesta e il set di dati con i record. ### Convalida un record Usa questo endpoint per convalidare un record. + Metodi supportati: POST + Richiede l'autenticazione e il ruolo ROLE\_USER. + Percorso: `/api/services/rest/crud/validateRecord` + Argomenti: set di dati (obbligatorio, DataSet): l'oggetto del set di dati record (opzionale, Record): il record da convalidare. maschera (opzionale, Mask): l'oggetto maschera da applicare durante la convalida. + Restituisce lo stato della richiesta e il set di dati con i record. ### Ottieni un albero dei record Usa questo endpoint per ottenere l'albero gerarchico di un record. + Metodi supportati: POST + Richiede l'autenticazione e il ruolo ROLE\_USER. + Percorso: `/api/services/rest/crud/getRecordTree` + Argomenti: set di dati (obbligatorio, DataSet): l'oggetto del set di dati record (richiesto, Record): il record da recuperare maschera (opzionale, Maschera): l'oggetto maschera. + Restituisce lo stato della richiesta e l'albero gerarchico del record richiesto. ## Maschere Utilizza i seguenti endpoint per caricare o applicare maschere a un set di dati. **Topics** + [Caricare le maschere](#ba-load-mask) + [Applica la maschera](#ba-apply-mask) + [Applica il filtro maschera](#ba-apply-mask-filter) ### Caricare le maschere È possibile utilizzare questo endpoint per recuperare tutte le maschere associate a un set di dati specifico. + Metodi supportati: POST + Richiede l'autenticazione e il ruolo ROLE\_USER. + Percorso: `/api/services/rest/crud/loadMasks` + Variabili del percorso: RecordSize:... /loadMasks/ {recordSize} (opzionale, numerico): la dimensione del record, filtra le maschere caricate che corrispondono a questa dimensione del record + Argomenti: set di dati (obbligatorio, DataSet): l'oggetto del set di dati + Restituisce lo stato della richiesta e l'elenco delle maschere. ### Applica la maschera È possibile utilizzare questo endpoint per applicare una maschera a un set di dati specifico. + Metodi supportati: POST + Richiede l'autenticazione e il ruolo ROLE\_USER. + Percorso: `/api/services/rest/crud/applyMask` + Argomenti: set di dati (obbligatorio, DataSet): l'oggetto del set di dati maschera (richiesto, Mask): l'oggetto del set di dati + Restituisce lo stato della richiesta e il set di dati con la maschera applicata. ### Applica il filtro maschera È possibile utilizzare questo endpoint per applicare una maschera e un filtro a un set di dati specifico. + Metodi supportati: POST + Richiede l'autenticazione e il ruolo ROLE\_USER. + Percorso: `/api/services/rest/crud/applyMaskFilter` + Argomenti: set di dati (obbligatorio, DataSet): l'oggetto del set di dati maschera (obbligatorio, Maschera): l'oggetto maschera filter (obbligatorio, Filter): l'oggetto filtro da applicare. + Restituisce lo stato della richiesta e il set di dati con la maschera e il filtro applicati. ## Altro Utilizza i seguenti endpoint per gestire la cache di un set di dati o controllare le caratteristiche del set di dati **Topics** + [Controlla la cache di riscaldamento](#ba-check-warm-up-cache) + [Verifica che la cache sia abilitata](#ba-check-cache-enabled) + [Abilita la cache](#ba-enable-cache) + [Controlla la cache RAM allocata](#ba-check-allocated-ram-cache) + [Controlla la persistenza](#ba-check-persistence) + [Controlla i tipi di set di dati supportati](#ba-check-supported-data-set-types) + [Controlla lo stato del server](#ba-check-server-health) + [Controlla la configurazione multi-schema di PostgreSQL](#ba-check-postgres-multi-schema) ### Controlla la cache di riscaldamento Verifica se la cache di riscaldamento è abilitata per un set di dati specifico. + Metodi supportati: POST + Richiede l'autenticazione e il ruolo ROLE\_ADMIN. + Percorso: `/api/services/rest/bluesamservice/warmupCache` + Argomenti: nome (obbligatorio, stringa): il nome del set di dati. + Restituisce: true se la cache di riscaldamento è abilitata e false in caso contrario. ### Verifica che la cache sia abilitata Verifica se la cache è abilitata per un set di dati specifico. + Metodi supportati: GET + Richiede l'autenticazione e il ruolo ROLE\_USER. + Percorso: `/api/services/rest/bluesamservice/isEnableCache` + Argomenti: Nessuno + Restituisce true se la memorizzazione nella cache è abilitata. ### Abilita la cache + Metodi supportati: POST + Richiede l'autenticazione e i ruoli ROLE\_ADMIN e ROLE\_SUPER\_ADMIN. + Percorso: `/api/services/rest/bluesamservice/enableDisableCache/{enable}` + Argomenti: abilita (obbligatorio, booleano): se impostato su true, abiliterà la memorizzazione nella cache. set di dati (obbligatorio, DataSet): l'oggetto del set di dati. + Restituisce Nessuno ### Controlla la cache RAM allocata È possibile utilizzare questo endpoint per recuperare la memoria cache RAM allocata. + Metodi supportati: GET + Richiede l'autenticazione e il ruolo ROLE\_USER. + Percorso: `/api/services/rest/bluesamservice/allocatedRamCache` + Argomenti: Nessuno + Restituisce: la dimensione della memoria come stringa ### Controlla la persistenza + Metodi supportati: GET + Richiede l'autenticazione e il ruolo ROLE\_USER. + Percorso: `/api/services/rest/bluesamservice/persistence` + Argomenti: Nessuno + Restituisce: la persistenza usata come stringa ### Controlla i tipi di set di dati supportati + Metodi supportati: GET + Percorso: `/api/services/rest/bluesamservice/getDataSetTypes` + Richiede l'autenticazione e il ruolo ROLE\_USER. + Argomenti: nessuno + Restituisce: l'elenco dei tipi di set di dati supportati come elenco di stringhe. ### Controlla lo stato del server + Metodi supportati: GET + Percorso: `/api/services/rest/bluesamserver/serverIsUp` + Argomenti: Nessuno + Restituzioni: nessuna. Il codice di stato della risposta HTTP 200 indica che il server è attivo e funzionante. ### Controlla la configurazione multi-schema di PostgreSQL Verifica se la configurazione multi-schema di PostgreSQL è abilitata. + Metodi supportati: GET + Richiede l'autenticazione e il ruolo ROLE\_USER. + Percorso: `/api/services/rest/bluesamservice/isPostgresMultiSchema` + Argomenti: Nessuno + Restituisce: true se la configurazione multi-schema di PostgreSQL è abilitata e false in caso contrario. ## Endpoint BAC per la gestione degli utenti Utilizza i seguenti endpoint per gestire le interazioni con gli utenti. **Topics** + [Effettua il login di un utente](#ba-log-user-in) + [Verifica se nel sistema esiste almeno un utente](#ba-verify-at-least-one-user-exists) + [Registra un nuovo utente](#ba-record-new-user) + [Ottieni informazioni sull'utente](#ba-user-info) + [Elencare gli utenti](#ba-list-users) + [Eliminazione di un utente](#ba-delete-user) + [Disconnette l'utente corrente](#ba-log-user-out) ### Effettua il login di un utente + Metodo supportato: POST + Percorso: `/api/services/security/servicelogin/login` + Argomenti: Nessuno + Restituisce la serializzazione JSON di un `com.netfective.bluage.bac.entities.SignOn` oggetto, che rappresenta l'utente le cui credenziali sono fornite nella richiesta corrente. La password è nascosta alla vista nell'oggetto restituito. I ruoli assegnati all'utente vengono elencati. Risposta di esempio: ``` { "login": "some-admin", "password": null, "roles": [ { "id": 0, "roleName": "ROLE_ADMIN" } ] } ``` ### Verifica se nel sistema esiste almeno un utente + Metodo supportato: GET + Percorso: `/api/services/security/servicelogin/hasAccount` + Argomenti: Nessuno + Restituisce il valore booleano `true` se è stato creato almeno un utente diverso dall'utente super amministratore predefinito. Restituisce altrimenti`false`. ### Registra un nuovo utente + Metodo supportato: POST + Richiede l'autenticazione e il ruolo ROLE\_ADMIN. + Percorso: `/api/services/security/servicelogin/recorduser` + Argomenti: la serializzazione JSON di un `com.netfective.bluage.bac.entities.SignOn` oggetto che rappresenta l'utente da aggiungere allo storage. I ruoli per l'utente devono essere definiti, altrimenti l'utente potrebbe non essere in grado di utilizzare la struttura e gli endpoint BAC. + Restituisce il valore booleano `true` se l'utente è stato creato con successo. Restituisce altrimenti`false`. + Esempio di richiesta JSON: ``` { "login": "simpleuser", "password": "simplepassword", "roles": [ { "id": 2, "roleName": "ROLE_USER" } ] } ``` Di seguito sono riportati i due valori validi per`roleName`: + `ROLE_ADMIN`: può gestire Blusam risorse e utenti. + `ROLE_USER`: può gestire Blusam le risorse ma non gli utenti. ### Ottieni informazioni sull'utente + Metodo supportato: GET + Percorso: `/api/services/security/servicelogin/userInfo` + Argomenti: Nessuno + Restituisce il nome utente e il ruolo dell'utente attualmente connesso ### Elencare gli utenti + Metodo supportato: GET + Richiede l'autenticazione e il ruolo ROLE\_ADMIN. + Percorso: `/api/services/security/servicelogin/listusers` + Argomenti: Nessuno + Restituisce un elenco di`com.netfective.bluage.bac.entities.SignOn`, serializzato come JSON. ### Eliminazione di un utente **Importante** Questa operazione non può essere annullata. L'utente eliminato non sarà più in grado di connettersi all'applicazione BAC. + Metodo supportato: POST + Richiede l'autenticazione e il ruolo ROLE\_ADMIN. + Percorso: `/api/services/security/servicelogin/deleteuser` + Argomenti: la serializzazione JSON di un `com.netfective.bluage.bac.entities.SignOn` oggetto che rappresenta l'utente da rimuovere dall'archivio. + Restituisce il valore booleano `true` se l'utente è stato rimosso con successo. ### Disconnette l'utente corrente + Metodo supportato: GET + Percorso: `/api/services/security/servicelogout/logout` + Argomenti: Nessuno + Restituisce il messaggio JSON `{"success":true}` se l'utente corrente è stato disconnesso con successo. La sessione HTTP correlata verrà invalidata.