Backendless

Visão geral

Backendless é uma plataforma completa de backend-as-a-service (BaaS) que oferece funcionalidades escaláveis para aplicações móveis e web, incluindo autenticação de usuários, persistência de dados, armazenamento de arquivos e serviços de API personalizados. Com a integração no SquadOS, seus agentes podem criar e consultar objetos em banco de dados, gerenciar arquivos e diretórios, controlar sessões de usuários e publicar mensagens em canais em tempo real.

• Site oficial: https://backendless.com/
• Documentação na Composio: docs.composio.dev/toolkits/backendless

Autenticação

Esta ferramenta utiliza chave de API (API_KEY) para conectar.

Você vai precisar dos seguintes campos:

Campo	Obrigatório	Descrição
api_key	Sim	Chave de API da sua aplicação Backendless, disponível no Console em Manage → App Settings.

Como obter a credencial

1. Acesse backendless.com e faça login (ou crie uma conta gratuita).
2. Selecione a aplicação desejada no painel do Console.
3. Navegue até Manage → App Settings.
4. Copie o valor de API Key (REST API key) exibido na página.

Dica

Cada aplicação Backendless possui sua própria chave de API. Se você tiver múltiplas aplicações, certifique-se de usar a chave correta para o ambiente que deseja conectar ao SquadOS.

Como conectar no SquadOS

1. Acesse Ferramentas no menu lateral (/admin/tools).
2. Abra a aba Disponíveis e procure por Backendless.
3. Clique no card para abrir o modal de detalhes e em Conectar.
4. Você é levado para a página de conexão segura hospedada pela Composio, onde informa a chave de API obtida acima.
5. Ao concluir, você volta para o SquadOS com a conta conectada e a ferramenta disponível para os agentes. (Detalhes do fluxo em Ferramentas da Organização.)

Ações disponíveis

Copiar arquivo

BACKENDLESS_COPY_FILE

Copia um arquivo ou diretório dentro do armazenamento de arquivos do Backendless. Use quando precisar duplicar arquivos para um novo local após verificar os caminhos de origem e destino.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
source_path	string	Sim	Caminho absoluto do arquivo ou diretório a copiar. Deve começar com barra (/) e apontar para um recurso existente.
target_path	string	Sim	Caminho do diretório de destino onde a origem será copiada. Deve começar com barra (/). Será criado automaticamente se não existir.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Criar diretório

BACKENDLESS_CREATE_DIRECTORY

Cria um novo diretório no caminho especificado. Use quando precisar organizar arquivos em uma nova estrutura de pastas.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
user_token	string	Não	Token de autorização para o serviço de arquivos seguro. Necessário apenas se a segurança estiver habilitada.
directory_path	string	Sim	Caminho completo do diretório a criar, sem barra inicial. Diretórios em múltiplos níveis serão criados automaticamente se não existirem.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Criar Hive do Backendless

BACKENDLESS_CREATE_HIVE

Cria um novo Hive. Use quando precisar provisionar um novo recurso Hive antes de realizar operações de Hive. Exemplo: criar um hive chamado groceryStore.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
hive_name	string	Sim	Nome do hive a criar. Deve ser seguro para URL, sem barras. Caracteres permitidos: letras, números, underline e hífen.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Criar timer do Backendless

BACKENDLESS_CREATE_TIMER

Cria um novo timer com agendamento e código. Use quando precisar agendar tarefas recorrentes ou únicas para executar lógica server-side após confirmar os parâmetros.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
name	string	Sim	Nome único para o timer.
expire	integer	Não	Data/hora de expiração em milissegundos epoch Unix. O timer para após esse momento.
frequency	object	Sim	Configuração de agendamento e repetição do timer.
startDate	integer	Não	Data/hora de início em milissegundos epoch Unix. Padrão: agora, se omitido.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Excluir diretório

BACKENDLESS_DELETE_DIRECTORY

Exclui um diretório no caminho especificado no armazenamento de arquivos do Backendless. Use quando precisar remover pastas após confirmar o caminho.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
user_token	string	Não	Token de autenticação do usuário opcional. Se fornecido, a operação de exclusão será executada sob as políticas de segurança desse usuário.
directory_path	string	Sim	Caminho relativo do diretório a excluir no armazenamento de arquivos. Não incluir barra inicial.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Excluir arquivo

BACKENDLESS_DELETE_FILE

Exclui um arquivo do armazenamento de arquivos do Backendless no caminho especificado. Use quando precisar remover arquivos do armazenamento. A operação é permanente e não pode ser desfeita. Certifique-se de que o caminho do arquivo está correto antes de excluir.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
user_token	string	Não	Token de usuário opcional obtido no login. Quando fornecido, a operação de exclusão é executada com as permissões e políticas de segurança do usuário autenticado.
relative_path	string	Sim	Caminho do arquivo no armazenamento do Backendless. Pode ser fornecido com ou sem barra inicial. Exemplos: txtfiles/test.txt, /txtfiles/test.txt ou test.txt.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Excluir timer do Backendless

BACKENDLESS_DELETE_TIMER

Exclui um timer do Backendless pelo seu nome único. Use para remover permanentemente um timer agendado da sua aplicação Backendless. O timer deve existir e você deve fornecer o nome exato. Uma vez excluído, as execuções agendadas do timer param imediatamente e não podem ser recuperadas. Nota: requer acesso à Console Management API do Backendless (disponível nos planos Plus ou Enterprise).

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
name	string	Sim	Nome único do timer a excluir. Deve corresponder exatamente a um nome de timer existente.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Listar diretório

BACKENDLESS_DIRECTORY_LISTING

Recupera uma listagem de arquivos e diretórios em um determinado caminho. Use quando precisar navegar ou filtrar diretórios do armazenamento de arquivos.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
sub	boolean	Não	Se verdadeiro, lista diretórios recursivamente.
path	string	Sim	Caminho do diretório a listar. Deve começar com /.
offset	integer	Não	Índice do primeiro item a retornar para paginação.
pattern	string	Não	Padrão curinga para filtrar resultados; * corresponde a qualquer substring, ? corresponde a um único caractere.
pagesize	integer	Não	Número máximo de itens a retornar.
user_token	string	Não	Token de usuário para políticas de segurança. Se fornecido, a requisição é executada com as permissões do usuário.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Recuperação geral de objetos

BACKENDLESS_GENERAL_OBJECT_RETRIEVAL

Recupera objetos de uma tabela Backendless especificada com filtragem, ordenação e paginação. Use após confirmar o nome da tabela e as opções de consulta. Exemplo: “Obter Users onde age > 30 ordenado por created desc”.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
props	string	Não	Lista de propriedades a incluir, separadas por vírgula. Exemplo: name,email.
where	string	Não	Condição no estilo SQL para filtrar objetos. Exemplo: age > 25.
having	string	Não	Condição para filtrar grupos após agregação. Exemplo: COUNT(*) > 1.
offset	integer	Não	Número de objetos a pular antes de retornar os resultados. Padrão: 0.
sortBy	string	Não	Lista de propriedades para ordenação, separadas por vírgula (adicione desc para decrescente). Exemplo: created desc.
groupBy	string	Não	Lista de propriedades para agrupar, separadas por vírgula. Exemplo: department.
distinct	string	Não	Nome da coluna para retornar valores distintos. Exemplo: city.
pageSize	integer	Não	Número de objetos a retornar por página. Padrão: 10.
table_name	string	Sim	Nome da tabela de dados a consultar. Exemplo: Users.
user-token	string	Não	Token de autenticação do usuário para aplicar políticas de segurança no nível do usuário.
excludeProps	string	Não	Lista de propriedades a excluir, separadas por vírgula. Exemplo: password.
loadRelations	string	Não	Lista de propriedades relacionadas a incluir, separadas por vírgula. Exemplo: profile,address.
relationsDepth	integer	Não	Profundidade dos objetos relacionados a incluir. Padrão: 1.
relationsPageSize	integer	Não	Número de objetos relacionados a retornar por página. Padrão: 10.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Obter todos os valores

BACKENDLESS_GET_ALL_VALUES

Recupera todos os valores de um mapa em um Hive especificado. Use quando precisar buscar o conteúdo completo de um mapa Hive de uma só vez.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
map_name	string	Sim	Nome da chave que identifica o mapa.
hive_name	string	Sim	Nome do Hive onde o mapa está armazenado.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Obter valor do contador

BACKENDLESS_GET_COUNTER_VALUE

Recupera o valor atual de um contador do Backendless. Use quando precisar inspecionar o valor de um contador atômico.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
user_token	string	Não	Token de usuário opcional para aplicar políticas de segurança no nível do usuário.
counter_name	string	Sim	Nome do contador cujo valor deve ser recuperado.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Contar arquivos

BACKENDLESS_GET_FILE_COUNT

Obtém a contagem de arquivos em um diretório do Backendless. Use quando precisar determinar quantos itens correspondem a um filtro ou incluir subdiretórios.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
sub	boolean	Não	Se verdadeiro, inclui arquivos em subdiretórios recursivamente.
path	string	Sim	Caminho do diretório onde contar os arquivos. Deve começar com /.
pattern	string	Não	Padrão glob ou regex opcional para filtrar arquivos (prefixe com glob: ou regex:).
user_token	string	Não	Token de usuário opcional para operações autenticadas. Aplica políticas de segurança do usuário se fornecido.
count_directories	boolean	Não	Se verdadeiro, inclui diretórios na contagem também.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Obter itens de chave

BACKENDLESS_GET_KEY_ITEMS

Recupera valores para uma chave especificada em uma lista (todos, único ou intervalo). Use quando precisar de elementos específicos ou da lista completa de uma chave Hive. Suporta recuperação por índice único, por intervalo ou lista completa.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
key	string	Sim	Nome da chave que identifica a lista a recuperar.
index	integer	Não	Índice base zero para recuperar um único elemento. Mutuamente exclusivo com from_index e to_index.
to_index	integer	Não	Índice final base zero para recuperação por intervalo. Deve ser fornecido junto com from_index.
hive_name	string	Sim	Nome do Hive onde a lista está armazenada.
from_index	integer	Não	Índice inicial base zero para recuperação por intervalo. Deve ser fornecido junto com to_index.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Obter timer do Backendless

BACKENDLESS_GET_TIMER

Recupera informações sobre um timer específico. Use quando precisar inspecionar o agendamento e os detalhes da próxima execução de um timer pelo nome.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
name	string	Sim	Nome do timer a recuperar.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Inserir valores no mapa

BACKENDLESS_MAP_PUT

Define ou atualiza pares chave-valor em um mapa Hive. Use quando precisar adicionar ou atualizar múltiplas entradas em um mapa Hive.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
entries	object	Sim	Pares chave-valor a definir no mapa.
map_name	string	Sim	Nome da chave que identifica o mapa.
hive_name	string	Sim	Nome do Hive onde o mapa está armazenado.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Mover arquivo

BACKENDLESS_MOVE_FILE

Move um arquivo ou diretório dentro do armazenamento de arquivos do Backendless. Use quando precisar realocar recursos para um novo caminho após verificar origem e destino.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
source_path	string	Sim	Caminho absoluto do arquivo ou diretório a mover. Deve começar com barra (/) e apontar para um recurso existente.
target_path	string	Sim	Caminho do diretório de destino onde a origem será movida. Deve começar com barra (/). Será criado automaticamente se não existir.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Publicar mensagem

BACKENDLESS_PUBLISH_MESSAGE

Publica uma mensagem em um canal de mensagens especificado. Use quando precisar enviar notificações ou eventos para assinantes após confirmar o canal e o payload.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
headers	object	Não	Cabeçalhos adicionais de mensagem para filtragem de entrega.
message	string	Sim	Conteúdo da mensagem a publicar; deve ser um tipo JSON válido.
publishAt	integer	Não	Timestamp Unix em milissegundos indicando quando a mensagem deve ser entregue.
user_token	string	Não	Token de usuário opcional para contexto de segurança; enviado como cabeçalho user-token.
publisherId	string	Não	Identificador único do publicador da mensagem; opcional.
repeatEvery	integer	Não	Frequência em segundos para entrega repetida.
channel_name	string	Sim	Nome do canal onde publicar a mensagem.
repeatExpiresAt	integer	Não	Timestamp Unix em milissegundos indicando quando a repetição deve parar.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Redefinir contador

BACKENDLESS_RESET_COUNTER

Redefine um contador do Backendless de volta a zero. Use quando precisar reinicializar um contador antes de iniciar uma nova sequência.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
user_token	string	Não	Token de usuário opcional para aplicar políticas de segurança no nível do usuário.
counter_name	string	Sim	Nome do contador a redefinir para zero.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Definir valor do contador

BACKENDLESS_SET_COUNTER_VALUE

Define um contador do Backendless para um valor específico de forma condicional. Use quando precisar garantir que o contador só seja atualizado se corresponder a um valor esperado.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
expected	integer	Sim	O valor atual esperado do contador.
user_token	string	Não	Token de usuário opcional para aplicar políticas de segurança no nível do usuário.
counter_name	string	Sim	Nome do contador a atualizar.
updatedvalue	integer	Sim	O novo valor a definir se o contador atual for igual ao valor esperado.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Atualizar timer do Backendless

BACKENDLESS_UPDATE_TIMER

Atualiza o agendamento ou o código de um timer existente. Use quando precisar modificar a configuração de um timer após recuperá-lo.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
code	string	Não	Código atualizado a executar quando o timer disparar.
name	string	Sim	Nome do timer a atualizar.
expire	integer	Não	Nova data/hora de expiração em milissegundos epoch Unix.
frequency	object	Não	Configuração atualizada de agendamento e repetição do timer.
startDate	integer	Não	Nova data/hora de início em milissegundos epoch Unix.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Excluir usuário

BACKENDLESS_USER_DELETE

Exclui um usuário pelo ID. Use quando precisar remover uma conta de usuário após confirmar as permissões.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
user_id	string	Sim	O ID único (objectId) do usuário a excluir.
user_token	string	Não	Token de autenticação de usuário opcional. Se fornecido, a operação usa o contexto de segurança do usuário.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Encontrar usuário por ID

BACKENDLESS_USER_FIND

Recupera informações de um usuário pelo ID. Use quando precisar buscar detalhes de um usuário específico após ter o objectId.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
user_id	string	Sim	O objectId único do usuário a recuperar.
user_token	string	Não	Token de autenticação de usuário opcional. Se fornecido, a requisição usa o contexto de segurança do usuário.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Conceder permissão ao usuário

BACKENDLESS_USER_GRANT_PERMISSION

Concede uma permissão a um usuário em um objeto de dados específico. Use quando precisar atribuir direitos de acesso precisos após verificar os IDs da tabela e do objeto. Exemplo: “Conceder permissão FIND a um usuário para um registro Person”.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
user	string	Sim	ID do objeto do usuário ao qual a permissão está sendo concedida.
object_id	string	Sim	Identificador único do objeto de dados cujas permissões serão modificadas.
permission	string	Sim	Tipo de permissão a conceder. Valores: UPDATE, FIND, REMOVE, DESCRIBE, PERMISSION, LOAD_RELATIONS, ADD_RELATION, DELETE_RELATION, UPSERT, *. Use * para conceder todas as permissões.
table_name	string	Sim	Nome da tabela de dados que contém o objeto.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Login do usuário

BACKENDLESS_USER_LOGIN

Faz login de um usuário registrado com identidade e senha. Use quando precisar autenticar um usuário antes de fazer requisições subsequentes. Exemplo: “Login de alice@wonderland.com com senha wonderland”.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
login	string	Sim	Valor da propriedade marcada como identidade (ex.: e-mail).
password	string	Sim	Senha do usuário (diferencia maiúsculas de minúsculas).

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Logout do usuário

BACKENDLESS_USER_LOGOUT

Faz logout do usuário atualmente autenticado. Use quando precisar encerrar a sessão do usuário após as operações.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
user-token	string	Sim	Token de sessão do usuário. Use como cabeçalho user-token para autenticar a requisição.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Recuperação de senha do usuário

BACKENDLESS_USER_PASSWORD_RECOVERY

Inicia a recuperação de senha para um usuário. Use quando um usuário solicitar uma redefinição de senha após esquecê-la. Dispara um e-mail com instruções de recuperação.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
user_identity	string	Sim	Valor da propriedade marcada como identidade na tabela Users (por padrão, é o e-mail). Deve ser codificada em URL no caminho da requisição.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Registro de usuário

BACKENDLESS_USER_REGISTRATION

Registra um novo usuário com e-mail e senha. Use quando precisar criar uma conta de usuário ou converter uma conta de convidado em conta registrada após coletar as credenciais. Exemplo: registrar alice@wonderland.com com senha wonderland.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
email	string	Sim	Endereço de e-mail do usuário usado como identidade no Backendless.
objectId	string	Não	objectId opcional de um usuário convidado a converter em usuário registrado.
password	string	Sim	Senha para o novo usuário (diferencia maiúsculas de minúsculas).

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Revogar permissão do usuário

BACKENDLESS_USER_REVOKE_PERMISSION

Revoga uma permissão de um usuário ou papel especificado em um objeto de dados específico. Use quando precisar negar uma operação concedida anteriormente para um usuário ou papel em um objeto de dados após verificar os IDs da tabela e do objeto.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
role	string	Não	Nome do papel para o qual revogar a permissão. Ignorado se user for fornecido.
user	string	Não	ObjectId do usuário na tabela Users. Forneça para revogar para um usuário específico.
object_id	string	Sim	Identificador único do objeto de dados cujas permissões serão modificadas.
permission	string	Sim	Tipo de permissão a revogar. Valores: UPDATE, FIND, REMOVE, DESCRIBE, PERMISSION, LOAD_RELATIONS, ADD_RELATION, DELETE_RELATION, UPSERT, *. Use * para revogar todas as permissões.
table_name	string	Sim	Nome da tabela de dados que contém o objeto.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Atualizar usuário

BACKENDLESS_USER_UPDATE

Atualiza propriedades de um usuário Backendless existente. Use quando precisar modificar campos do perfil do usuário após o login. Exemplo: atualizar phoneNumber para 5551212.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
user_id	string	Sim	ObjectId do usuário a atualizar.
properties	object	Sim	Pares chave-valor das propriedades do usuário a atualizar.
user_token	string	Não	Token de sessão obtido em um login bem-sucedido. Se fornecido, a atualização será realizada sob a política de proprietário do usuário.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Validar token do usuário

BACKENDLESS_VALIDATE_USER_TOKEN

Valida um token de sessão de usuário. Use após obter um token no login para confirmar que a sessão está ativa.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
userToken	string	Sim	O token de sessão a validar, retornado pelo login do usuário.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.