AWS O Mainframe Modernization Service (experiência em Managed Runtime Environment) não está mais aberto a novos clientes. Para recursos semelhantes ao AWS Mainframe Modernization Service (experiência em Managed Runtime Environment), explore o AWS Mainframe Modernization Service (experiência autogerenciada). Os clientes atuais podem continuar usando o serviço normalmente. Para obter mais informações, consulte Alteração na [disponibilidade AWS da modernização do mainframe](https://docs.aws.amazon.com/m2/latest/userguide/mainframe-modernization-availability-change.html). As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá. # Blusamendpoints REST do console de aplicativos Nesta seção, você pode aprender sobre o console do Blusam aplicativo, que é uma API projetada para simplificar o gerenciamento de conjuntos de dados VSAM modernizados. Os endpoints do aplicativo Blusam web usam o caminho `/bac` raiz. **Topics** + [Conjuntos de dados relacionados a endpoints](#ba-endpoints-bac-datasets) + [Conjuntos de dados em massa relacionados a endpoints](#ba-endpoints-bac-bulk) + [Registros](#ba-endpoints-bac-records) + [Máscaras](#ba-endpoints-bac-masks) + [Outros](#ba-endpoints-bac-other) + [Endpoints de gerenciamento de usuários do BAC](#ba-endpoints-bac-users) ## Conjuntos de dados relacionados a endpoints Use os seguintes endpoints para criar ou gerenciar um conjunto de dados específico. **Topics** + [Criar um conjunto de dados](#ba-create-data-set) + [Carregar um arquivo](#ba-upload-file) + [Carregar um conjunto de dados (POST)](#ba-load-data-set-post) + [Carregar um conjunto de dados (GET)](#ba-load-data-set-get) + [Carregar um conjunto de dados de um bucket do Amazon S3](#ba-load-data-set-s3) + [Exportar um conjunto de dados para um bucket do Amazon S3](#ba-export-data-set-s3) + [Limpar um conjunto de dados](#ba-clear-data-set) + [Excluir um conjunto de dados](#ba-delete-data-set) + [Contar registros do conjunto de dados](#ba-count-data-set-records) ### Criar um conjunto de dados É possível usar esse endpoint para criar uma definição de conjunto de dados. + Métodos compatíveis: POST + Requer autenticação e o perfil ROLE\_ADMIN. + Caminho: `/api/services/rest/bluesamservice/createDataSet` + Argumentos: name (obrigatório, string): o nome do conjunto de dados. type (obrigatório, string): o tipo de conjunto de dados. Os valores possíveis são: `ESDS`, `KSDS` `RRDS`. recordSize (opcional, string): tamanho máximo de cada registro do conjunto de dados. fixedLength (opcional, booleano): indica se o tamanho dos registros é fixo. compression (opcional, booleano): indica se o conjunto de dados está compactado. cacheEnable (opcional, booleano): indica se o armazenamento em cache está ativado para o conjunto de dados. alternativeKeys (opcional, lista de chaves): + deslocamento (obrigatório, número) + comprimento (obrigatório, número) + nome (obrigatório, número) + Exibe um arquivo JSON que representa o conjunto de dados recém-criado. Exemplo de solicitação: ``` 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 } ``` Resposta de exemplo: ``` { "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 } ``` ### Carregar um arquivo É possível usar esse endpoint para fazer upload de arquivos para o servidor. O arquivo é armazenado em uma pasta temporária que corresponde a cada usuário específico. Use esse endpoint sempre que precisar fazer upload de um arquivo. + Métodos compatíveis: POST + Requer autenticação e o perfil ROLE\_ADMIN. + Caminho: `/api/services/rest/bluesamservice/upload` + Argumentos: arquivo (obrigatório, multipartes/dados de formulário): o arquivo a ser carregado. + Retorna um booleano que reflete o status do carregamento ### Carregar um conjunto de dados (POST) Depois de usar `createDataSet` para criar a definição do conjunto de dados, você poderá carregar registros associados ao arquivo carregado em um conjunto de dados específico. + Métodos compatíveis: POST + Requer autenticação e o perfil ROLE\_ADMIN. + Caminho: `/api/services/rest/bluesamservice/loadDataSet` + Argumentos: name (obrigatório, string): o nome do conjunto de dados. + Retorna o status da solicitação e do conjunto de dados carregado. ### Carregar um conjunto de dados (GET) + Métodos compatíveis: GET + Requer autenticação e o perfil ROLE\_ADMIN. + Caminho: `/api/services/rest/bluesamservice/loadDataSet` + Argumentos: listcatFileOrDatasetName (obrigatório, string): o nome do conjunto de dados. Arquivo de conjunto de dados (obrigatório, string): o nome do arquivo do conjunto de dados. + Retorna o status da solicitação e do conjunto de dados carregado. ### Carregar um conjunto de dados de um bucket do Amazon S3 Carrega um conjunto de dados usando um arquivo listcat de um bucket do Amazon S3. + Métodos compatíveis: GET + Requer autenticação e o perfil ROLE\_ADMIN. + Caminho: `/api/services/rest/bluesamservice/loadDataSetFromS3` + Argumentos: listcatFileS3Location (obrigatório, string): a localização do arquivo listcat no Amazon S3. datasetFileS3Location (obrigatório, string): a localização do Amazon S3 do arquivo do conjunto de dados. region (obrigatório, string): o Amazon S3 Região da AWS onde os arquivos são armazenados. + Retorna o conjunto de dados recém-criado Exemplo de solicitação: ``` /BAC/api/services/rest/bluesamservice/loadDataSetFromS3?region=us-east-1&listcatFileS3Location=s3://bucket-name/listcat.json&datasetFileS3Location=s3://bucket-name/dataset.DAT ``` ### Exportar um conjunto de dados para um bucket do Amazon S3 Exporta um conjunto de dados para o bucket do Amazon S3 especificado. + Métodos compatíveis: GET + Requer autenticação e o perfil ROLE\_ADMIN. + Caminho: `/api/services/rest/bluesamservice/exportDataSetToS3` + Argumentos: s3Location (obrigatório, string): o local do Amazon S3 para o qual exportar o conjunto de dados. datasetName (obrigatório, string): o nome do conjunto de dados a ser exportado. region (obrigatório, string): o Região da AWS do bucket do Amazon S3. kmsKeyId (opcional, string): o AWS KMS ID a ser usado para criptografia do conjunto de dados exportado para o bucket do Amazon S3. + Retorna o conjunto de dados exportado Exemplo de solicitação: ``` /BAC/api/services/rest/bluesamservice/exportDataSetToS3?region=eu-west-1&s3Location=s3://bucket-name/dump&datasetName=dataset ``` ### Limpar um conjunto de dados Limpa todos os registros de um conjunto de dados. + Métodos compatíveis: GET, POST + Requer autenticação e o perfil ROLE\_ADMIN. + Caminho: `/api/services/rest/bluesamservice/clearDataSet` + Argumentos: name (obrigatório, string): o nome do conjunto de dados a ser limpo. Ao usar o método GET, o nome do parâmetro é`datasetName`. + Retorna o status da solicitação. ### Excluir um conjunto de dados Exclui a definição e os registros do conjunto de dados. + Métodos compatíveis: POST + Requer autenticação e o perfil ROLE\_ADMIN. + Caminho: `/api/services/rest/bluesamservice/deleteDataSet` + Argumentos: name (obrigatório, string): o nome do conjunto de dados a ser excluído. + Retorna o status da solicitação e do conjunto de dados excluído. ### Contar registros do conjunto de dados Esse endpoint exibe o número de registros associados a um conjunto de dados. + Métodos compatíveis: POST + Requer autenticação e o perfil ROLE\_USER. + Caminho: `/api/services/rest/bluesamservice/countRecords` + Argumentos: name (obrigatório, string): o nome do conjunto de dados. + Retornos: o número de registros ## Conjuntos de dados em massa relacionados a endpoints Use os seguintes endpoints para criar ou gerenciar vários conjuntos de dados ao mesmo tempo. **Topics** + [Exportar conjuntos de dados (GET)](#ba-export-data-sets-get) + [Exportar conjuntos de dados (POST)](#ba-export-data-sets-post) + [Criar vários conjuntos de dados](#ba-create-multiple-data-sets) + [Listar todos os conjuntos de dados](#ba-list-all-data-sets) + [Listar diretamente todos os conjuntos de dados](#ba-direct-list-all-data-sets) + [Listar diretamente todos os conjuntos de dados por página](#ba-direct-list-all-data-sets-by-page) + [Fazer o streaming de dados](#ba-stream-data-sets) + [Excluir todos os conjuntos de dados](#ba-delete-all-data-sets) + [Tenha as definições do conjunto de dados do arquivo listcat](#ba-get-definitions-listcat) + [Obtenha as definições do conjunto de dados do arquivo cat da lista carregado](#ba-get-definitions-uploaded-listcat) + [Receber um conjunto de dados](#ba-get-data-set) + [Carregar listcat do arquivo JSON](#ba-load-listcat) ### Exportar conjuntos de dados (GET) + Métodos compatíveis: GET + Requer autenticação e o perfil ROLE\_ADMIN. + Caminho: `/api/services/rest/bluesamservice/exportDataSet` + Argumentos: datasetName (obrigatório, string): o nome do conjunto de dados a ser exportado. datasetOutputFile (obrigatório, string): o caminho da pasta em que você deseja armazenar o conjunto de dados exportado no servidor. vermelho (obrigatório, booliano): se você deseja que a palavra descritora de registro (RDW) faça parte dos registros exportados. Se o conjunto de dados tiver registros de tamanho fixo, o valor desse parâmetro será ignorado. + Exibe o status da solicitação e o caminho do arquivo que contém o conjunto de dados exportado (se houver). Se o conjunto de dados for nulo na resposta, isso significa que o sistema não conseguiu localizar um conjunto de dados com o nome fornecido. ### Exportar conjuntos de dados (POST) + Métodos compatíveis: POST + Requer autenticação e o perfil ROLE\_USER. + Caminho: `/api/services/rest/bluesamservice/exportDataSet` + Argumentos: dumpParameters (obrigatório, BACRead Parâmetros): parâmetros de leitura do Bluesam. + Exibe o status do conjunto de dados exportado. ### Criar vários conjuntos de dados + Métodos compatíveis: POST + Requer autenticação e o perfil ROLE\_ADMIN. + Caminho: `/api/services/rest/bluesamservice/createAllDataSets` + Argumentos: + Lista de conjuntos de dados name (obrigatório, string): o nome do conjunto de dados. type (obrigatório, string): o tipo de conjunto de dados. Os valores possíveis são: `ESDS`, `KSDS` `RRDS`. recordSize (opcional, string): tamanho máximo de cada registro do conjunto de dados. fixedLength (opcional, booleano): indica se o tamanho dos registros é fixo. compression (opcional, booleano): indica se o conjunto de dados está compactado. cacheEnable (opcional, booleano): indica se o armazenamento em cache está ativado para o conjunto de dados. + Retornos: o status da solicitação e o conjunto de dados recém-criado. ### Listar todos os conjuntos de dados + Métodos compatíveis: GET + Requer autenticação e o perfil ROLE\_USER. + Caminho: `/api/services/rest/bluesamservice/listDataSet` + Argumentos: nenhum + Retornos: o status da solicitação e a lista dos conjuntos de dados. ### Listar diretamente todos os conjuntos de dados + Métodos compatíveis: GET + Requer autenticação e o perfil ROLE\_USER. + Caminho: `/api/services/rest/bluesamservice/directListDataSet` + Argumentos: nenhum + Retornos: o status da solicitação e a lista dos conjuntos de dados. ### Listar diretamente todos os conjuntos de dados por página + Métodos compatíveis: GET + Requer autenticação e o perfil ROLE\_USER. + Caminho: `/api/services/rest/bluesamservice/directListDataSetByPage` + Argumentos: name (obrigatório, string): o nome do conjunto de dados. O padrão é `%` (todos os conjuntos de dados) se não for especificado. page (obrigatório, int): o número da página (mínimo 0). pageSize (obrigatório, int): o tamanho da página (mínimo 1, máximo 500). + Retornos: o status da solicitação e a lista dos conjuntos de dados. ### Fazer o streaming de dados + Métodos compatíveis: GET + Requer autenticação e o perfil ROLE\_ADMIN. + Caminho: `/api/services/rest/bluesamservice/streamDataset` + Argumentos: datasetName (obrigatório, string): o nome do conjunto de dados. + Exibe: um fluxo dos conjuntos de dados solicitados. ### Excluir todos os conjuntos de dados + Métodos compatíveis: POST + Requer autenticação e o perfil ROLE\_ADMIN. + Caminho: `/api/services/rest/bluesamservice/removeAll` + Argumentos: nenhum + Exibe: um booliano que representa o status da solicitação. ### Tenha as definições do conjunto de dados do arquivo listcat + Métodos compatíveis: POST + Requer autenticação e o perfil ROLE\_ADMIN. + Caminho: `/api/services/rest/bluesamservice/getDataSetsDefinitionFromListcat` + Argumentos: paramFilePath (obrigatório, string): o caminho para o arquivo listcat. + Retornos: uma lista de conjuntos de dados ### Obtenha as definições do conjunto de dados do arquivo cat da lista carregado + Métodos compatíveis: POST + Requer autenticação e o perfil ROLE\_ADMIN. + Caminho: `/api/services/rest/bluesamservice/getDataSetsDefinitionFromUploadedListcat` + Argumentos: nenhum + Retornos: uma lista de conjuntos de dados ### Receber um conjunto de dados + Métodos compatíveis: GET + Requer autenticação e o perfil ROLE\_USER. + Caminho: `/api/services/rest/bluesamservice/getDataSet` + Argumentos: name (obrigatório, string): o nome do conjunto de dados. + Exibe o conjunto de dados solicitado. ### Carregar listcat do arquivo JSON + Métodos compatíveis: GET + Requer autenticação e o perfil ROLE\_ADMIN. + Caminho: `/api/services/rest/bluesamservice/loadListcatFromJsonFile` + Argumentos: filePath (obrigatório, string): o caminho para o arquivo listcat. + Retornos: uma lista de conjuntos de dados ## Registros Use os seguintes endpoints para criar ou gerenciar registros em um conjunto de dados. **Topics** + [Criar um registro](#ba-create-record) + [Leia um conjunto de dados](#ba-read-data-set) + [Excluir um registro](#ba-delete-record) + [Atualizar um registro](#ba-update-record) + [Salvar um registro](#ba-save-record) + [Validar um registro](#ba-validate-record) + [Receber uma árvore de registros](#ba-get-record-tree) ### Criar um registro É possível usar esse endpoint para criar um registro. + Métodos compatíveis: POST + Requer autenticação e o perfil ROLE\_USER. + Caminho: `/api/services/rest/crud/createRecord` + Argumentos: conjunto de dados (obrigatório, DataSet): o objeto do conjunto de dados máscara (obrigatório, máscara): o objeto da máscara. + Retorna o status da solicitação e o registro criado. ### Leia um conjunto de dados É possível usar esse endpoint para ler um conjunto de dados. + Métodos compatíveis: POST + Requer autenticação e o perfil ROLE\_USER. + Caminho: `/api/services/rest/crud/readDataSet` + Argumentos: conjunto de dados (obrigatório, DataSet): o objeto do conjunto de dados. + Retorna o status da solicitação e o conjunto de dados com os registros. ### Excluir um registro É possível usar esse endpoint para excluir um registro de um conjunto de dados. + Métodos compatíveis: POST + Requer autenticação e o perfil ROLE\_USER. + Caminho: `/api/services/rest/crud/deleteRecord` + Argumentos: conjunto de dados (obrigatório, DataSet): o objeto do conjunto de dados registro (obrigatório, Registro): o registro a ser excluído + Retorna o status da exclusão. ### Atualizar um registro É possível usar esse endpoint para atualizar um registro associado a um conjunto de dados. + Métodos compatíveis: POST + Requer autenticação e o perfil ROLE\_USER. + Caminho: `/api/services/rest/crud/updateRecord` + Argumentos: conjunto de dados (obrigatório, DataSet): o objeto do conjunto de dados registro (obrigatório, Registro): o registro a ser atualizado máscara (opcional, Máscara): o objeto de máscara a ser aplicado durante a atualização. + Retorna o status da solicitação e o conjunto de dados com os registros. ### Salvar um registro É possível usar esse endpoint para salvar um registro em um conjunto de dados e usar uma máscara. + Métodos compatíveis: POST + Requer autenticação e o perfil ROLE\_USER. + Caminho: `/api/services/rest/crud/saveRecord` + Argumentos: conjunto de dados (obrigatório, DataSet): o objeto do conjunto de dados registro (obrigatório, Registro): o registro a ser salvo máscara (opcional, Máscara): o objeto de máscara a ser aplicado durante o salvamento. + Retorna o status da solicitação e o conjunto de dados com os registros. ### Validar um registro Use esse endpoint para validar um registro. + Métodos compatíveis: POST + Requer autenticação e o perfil ROLE\_USER. + Caminho: `/api/services/rest/crud/validateRecord` + Argumentos: conjunto de dados (obrigatório, DataSet): o objeto do conjunto de dados registro (opcional, Registro): o registro a ser validado. máscara (opcional, Máscara): o objeto de máscara a ser aplicado durante a validação. + Retorna o status da solicitação e o conjunto de dados com os registros. ### Receber uma árvore de registros Use esse endpoint para receber a árvore hierárquica de um registro. + Métodos compatíveis: POST + Requer autenticação e o perfil ROLE\_USER. + Caminho: `/api/services/rest/crud/getRecordTree` + Argumentos: conjunto de dados (obrigatório, DataSet): o objeto do conjunto de dados registro (obrigatório, Registro): o registro a buscar máscara (opcional, Máscara): o objeto da máscara. + Exibe o status da solicitação e a árvore hierárquica do registro solicitado. ## Máscaras Use os seguintes endpoints para carregar ou aplicar máscaras a um conjunto de dados. **Topics** + [Carregue máscaras](#ba-load-mask) + [Aplicar máscara](#ba-apply-mask) + [Aplicar filtro de máscara](#ba-apply-mask-filter) ### Carregue máscaras É possível usar esse endpoint para recuperar todas as máscaras associadas a um conjunto de dados específico. + Métodos compatíveis: POST + Requer autenticação e o perfil ROLE\_USER. + Caminho: `/api/services/rest/crud/loadMasks` + Variáveis de caminho: recordSize: .../loadMasks/{recordSize} (opcional, numérico): o tamanho do registro, máscaras carregadas com filtro que correspondem a esse tamanho de registro + Argumentos: conjunto de dados (obrigatório, DataSet): o objeto do conjunto de dados + Retorna o status da solicitação e a lista das máscaras. ### Aplicar máscara É possível usar esse endpoint para aplicar uma máscara a um conjunto de dados específico. + Métodos compatíveis: POST + Requer autenticação e o perfil ROLE\_USER. + Caminho: `/api/services/rest/crud/applyMask` + Argumentos: conjunto de dados (obrigatório, DataSet): o objeto do conjunto de dados máscara (obrigatório, Máscara): o objeto do conjunto de dados + Retorna o status da solicitação e do conjunto de dados com a máscara aplicada. ### Aplicar filtro de máscara É possível usar esse endpoint para aplicar uma máscara e um filtro a um conjunto de dados específico. + Métodos compatíveis: POST + Requer autenticação e o perfil ROLE\_USER. + Caminho: `/api/services/rest/crud/applyMaskFilter` + Argumentos: conjunto de dados (obrigatório, DataSet): o objeto do conjunto de dados máscara (obrigatório, Máscara): o objeto de máscara filtrar (obrigatório, Filtro): o objeto de filtro a ser aplicado. + Retorna o status da solicitação e do conjunto de dados com a máscara e o filtro aplicados. ## Outros Use os seguintes endpoints para gerenciar o cache de um conjunto de dados ou verificar as características do conjunto de dados: **Topics** + [Verificar o cache de aquecimento](#ba-check-warm-up-cache) + [Verifique o cache ativado](#ba-check-cache-enabled) + [Habilitar cache](#ba-enable-cache) + [Conferir o cache de RAM alocado](#ba-check-allocated-ram-cache) + [Verificar a persistência](#ba-check-persistence) + [Verifique os tipos de conjuntos de dados compatíveis](#ba-check-supported-data-set-types) + [Verificar a integridade do servidor](#ba-check-server-health) + [Verifique a configuração de vários esquemas do PostgreSQL](#ba-check-postgres-multi-schema) ### Verificar o cache de aquecimento Verifica se o cache de aquecimento está ativado para um conjunto de dados específico. + Métodos compatíveis: POST + Requer autenticação e o perfil ROLE\_ADMIN. + Caminho: `/api/services/rest/bluesamservice/warmupCache` + Argumentos: name (obrigatório, string): o nome do conjunto de dados. + Retorna: verdadeiro se o cache de aquecimento estiver ativado e falso caso contrário. ### Verifique o cache ativado Verifica se o cache está habilitado para um conjunto de dados específico. + Métodos compatíveis: GET + Requer autenticação e o perfil ROLE\_USER. + Caminho: `/api/services/rest/bluesamservice/isEnableCache` + Argumentos: nenhum + Retorna verdadeiro se o armazenamento em cache estiver ativado. ### Habilitar cache + Métodos compatíveis: POST + Requer autenticação e os perfis ROLE\_ADMIN e ROLE\_SUPER\_ADMIN. + Caminho: `/api/services/rest/bluesamservice/enableDisableCache/{enable}` + Argumentos: habilitar (obrigatório, booliano): se definido como verdadeiro, ele habilitará o armazenamento em cache. conjunto de dados (obrigatório, DataSet): o objeto do conjunto de dados. + Retornos: nenhum ### Conferir o cache de RAM alocado É possível usar esse endpoint para recuperar a memória cache de RAM alocado. + Métodos compatíveis: GET + Requer autenticação e o perfil ROLE\_USER. + Caminho: `/api/services/rest/bluesamservice/allocatedRamCache` + Argumentos: nenhum + Retorna: o tamanho da memória como uma string ### Verificar a persistência + Métodos compatíveis: GET + Requer autenticação e o perfil ROLE\_USER. + Caminho: `/api/services/rest/bluesamservice/persistence` + Argumentos: nenhum + Retorna: a persistência usada como uma string ### Verifique os tipos de conjuntos de dados compatíveis + Métodos compatíveis: GET + Caminho: `/api/services/rest/bluesamservice/getDataSetTypes` + Requer autenticação e o perfil ROLE\_USER. + Argumentos: nenhum + Retorna: a lista de tipos de conjuntos de dados compatíveis como uma lista de cadeias de caracteres. ### Verificar a integridade do servidor + Métodos compatíveis: GET + Caminho: `/api/services/rest/bluesamserver/serverIsUp` + Argumentos: nenhum + Exibe: Nenhum. O código de status de resposta HTTP 200 indica que o servidor JICS está ativo e funcionando. ### Verifique a configuração de vários esquemas do PostgreSQL Verifica se a configuração de vários esquemas do PostgreSQL está habilitada. + Métodos compatíveis: GET + Requer autenticação e o perfil ROLE\_USER. + Caminho: `/api/services/rest/bluesamservice/isPostgresMultiSchema` + Argumentos: nenhum + Retorna: true se a configuração de vários esquemas do PostgreSQL estiver habilitada e false caso contrário. ## Endpoints de gerenciamento de usuários do BAC Use os seguintes endpoints para gerenciar as interações do usuário. **Topics** + [Fazer login como usuário em](#ba-log-user-in) + [Verificar se existe pelo menos um usuário no sistema](#ba-verify-at-least-one-user-exists) + [Gravar um novo usuário](#ba-record-new-user) + [Ter informações sobre o usuário](#ba-user-info) + [Listar usuários](#ba-list-users) + [Excluir um usuário](#ba-delete-user) + [Fazer logout do usuário atual](#ba-log-user-out) ### Fazer login como usuário em + Método compatível: POST + Caminho: `/api/services/security/servicelogin/login` + Argumentos: nenhum + Retorna a serialização JSON de um objeto `com.netfective.bluage.bac.entities.SignOn`, representando o usuário cujas credenciais são fornecidas na solicitação atual. A senha está oculta da exibição no objeto retornado. As funções atribuídas ao usuário estão sendo listadas. Resposta de exemplo: ``` { "login": "some-admin", "password": null, "roles": [ { "id": 0, "roleName": "ROLE_ADMIN" } ] } ``` ### Verificar se existe pelo menos um usuário no sistema + Método compatível: GET + Caminho: `/api/services/security/servicelogin/hasAccount` + Argumentos: nenhum + Exibe o valor booliano `true` se pelo menos um usuário diferente do usuário superadministrador padrão tiver sido criado. Caso contrário, exibe `false`. ### Gravar um novo usuário + Método compatível: POST + Requer autenticação e o perfil ROLE\_ADMIN. + Caminho: `/api/services/security/servicelogin/recorduser` + Argumentos: a serialização JSON de um objeto `com.netfective.bluage.bac.entities.SignOn`, que representa o usuário a ser adicionado ao armazenamento. Os perfis do usuário devem ser definidos, caso contrário, o usuário talvez não consiga usar o recurso e os endpoints do BAC. + Exibirá o valor booliano `true` se o usuário tiver sido criado com êxito. Caso contrário, exibe `false`. + Exemplo de solicitação JSON: ``` { "login": "simpleuser", "password": "simplepassword", "roles": [ { "id": 2, "roleName": "ROLE_USER" } ] } ``` Estes são os dois valores válidos para `roleName`: + `ROLE_ADMIN`: pode gerenciar Blusam recursos e usuários. + `ROLE_USER`: pode gerenciar Blusam recursos, mas não usuários. ### Ter informações sobre o usuário + Método compatível: GET + Caminho: `/api/services/security/servicelogin/userInfo` + Argumentos: nenhum + Exibe o nome de usuário e o perfil do usuário atualmente conectado ### Listar usuários + Método compatível: GET + Requer autenticação e o perfil ROLE\_ADMIN. + Caminho: `/api/services/security/servicelogin/listusers` + Argumentos: nenhum + Retorna uma lista de`com.netfective.bluage.bac.entities.SignOn`, serializada como JSON. ### Excluir um usuário **Importante** Esta ação não pode ser desfeita. O usuário excluído não poderá se conectar à aplicação BAC novamente. + Método compatível: POST + Requer autenticação e o perfil ROLE\_ADMIN. + Caminho: `/api/services/security/servicelogin/deleteuser` + Argumentos: a serialização JSON de um objeto `com.netfective.bluage.bac.entities.SignOn`, que representa o usuário a ser removido do armazenamento. + Exibirá o valor booliano `true` se o usuário tiver sido removido com êxito. ### Fazer logout do usuário atual + Método compatível: GET + Caminho: `/api/services/security/servicelogout/logout` + Argumentos: nenhum + Exibirá a mensagem JSON `{"success":true}` se o usuário atual tiver sido desconectado com êxito. A sessão HTTP relacionada será invalidada.