Pular para o conteúdo
OwbaseOwbase

Users

Usuários do projeto pelo servidor: criar, buscar, bloquear, rótulos e sessões.

Classe Users: 48 métodos (0 no @owbase/web, 48 no @owbase/node). Os exemplos usam a forma de objeto dos parâmetros; troque os valores entre < e > pelos seus.

list

Seção intitulada “list”

Listar usuários

SDK: só @owbase/node

Obtém a lista de todos os usuários do projeto. Use os parâmetros de consulta para filtrar os resultados.

Parâmetro Tipo Obrigatório Descrição
queries string[] não Lista de consultas geradas com a classe Query do SDK. Saiba mais sobre consultas. No máximo 100 consultas, cada uma com até 4096 caracteres. É possível filtrar pelos atributos: name, email, phone, status, passwordUpdate, registration, emailVerification, phoneVerification, passwordPwned, labels, impersonator, accessedAt
search string não Termo de busca para filtrar a lista. Tamanho máximo: 256 caracteres.
total boolean não Com false, o total não é calculado e volta como 0.

Acesso: chave de API com o escopo users.read.

@owbase/node
import { Client, Users } from '@owbase/node';


const client = new Client()
    .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API
    .setProject('<YOUR_PROJECT_ID>') // ID do projeto
    .setKey('<YOUR_API_KEY>'); // chave de API (só no servidor)


const users = new Users(client);


const result = await users.list({
    queries: [], // opcional
    search: '<SEARCH>', // opcional
    total: false, // opcional
});

create

Seção intitulada “create”

Criar usuário

SDK: só @owbase/node

Cria um usuário.

Parâmetro Tipo Obrigatório Descrição
userId string sim ID do usuário. Escolha um ID próprio ou gere um ID aleatório com ID.unique(). Caracteres válidos: a-z, A-Z, 0-9, ponto, hífen e sublinhado. Não pode começar com caractere especial. Tamanho máximo: 36 caracteres.
email string não E-mail do usuário.
phone string não Número de telefone. Escreva o número com ‘+’ e o código do país na frente, por exemplo +16175551212.
password string não Senha do usuário em texto puro. Precisa ter pelo menos 8 caracteres.
name string não Nome do usuário. Tamanho máximo: 128 caracteres.

Acesso: chave de API com o escopo users.write.

@owbase/node
import { Client, Users } from '@owbase/node';


const client = new Client()
    .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API
    .setProject('<YOUR_PROJECT_ID>') // ID do projeto
    .setKey('<YOUR_API_KEY>'); // chave de API (só no servidor)


const users = new Users(client);


const result = await users.create({
    userId: '<USER_ID>',
    email: '[email protected]', // opcional
    phone: '+12065550100', // opcional
    password: 'password', // opcional
    name: '<NAME>', // opcional
});

createArgon2User

Seção intitulada “createArgon2User”

Criar usuário com senha Argon2

SDK: só @owbase/node

Cria um usuário. A senha informada precisa estar com hash do algoritmo Argon2. Use o endpoint POST /users para criar usuários com senha em texto puro.

Parâmetro Tipo Obrigatório Descrição
userId string sim ID do usuário. Escolha um ID próprio ou gere um ID aleatório com ID.unique(). Caracteres válidos: a-z, A-Z, 0-9, ponto, hífen e sublinhado. Não pode começar com caractere especial. Tamanho máximo: 36 caracteres.
email string sim E-mail do usuário.
password string sim Senha do usuário com hash Argon2.
name string não Nome do usuário. Tamanho máximo: 128 caracteres.

Acesso: chave de API com o escopo users.write.

@owbase/node
import { Client, Users } from '@owbase/node';


const client = new Client()
    .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API
    .setProject('<YOUR_PROJECT_ID>') // ID do projeto
    .setKey('<YOUR_API_KEY>'); // chave de API (só no servidor)


const users = new Users(client);


const result = await users.createArgon2User({
    userId: '<USER_ID>',
    email: '[email protected]',
    password: 'password',
    name: '<NAME>', // opcional
});

createBcryptUser

Seção intitulada “createBcryptUser”

Criar usuário com senha bcrypt

SDK: só @owbase/node

Cria um usuário. A senha informada precisa estar com hash do algoritmo Bcrypt. Use o endpoint POST /users para criar usuários com senha em texto puro.

Parâmetro Tipo Obrigatório Descrição
userId string sim ID do usuário. Escolha um ID próprio ou gere um ID aleatório com ID.unique(). Caracteres válidos: a-z, A-Z, 0-9, ponto, hífen e sublinhado. Não pode começar com caractere especial. Tamanho máximo: 36 caracteres.
email string sim E-mail do usuário.
password string sim Senha do usuário com hash Bcrypt.
name string não Nome do usuário. Tamanho máximo: 128 caracteres.

Acesso: chave de API com o escopo users.write.

@owbase/node
import { Client, Users } from '@owbase/node';


const client = new Client()
    .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API
    .setProject('<YOUR_PROJECT_ID>') // ID do projeto
    .setKey('<YOUR_API_KEY>'); // chave de API (só no servidor)


const users = new Users(client);


const result = await users.createBcryptUser({
    userId: '<USER_ID>',
    email: '[email protected]',
    password: 'password',
    name: '<NAME>', // opcional
});

listIdentities

Seção intitulada “listIdentities”

Listar identidades

SDK: só @owbase/node

Obtém as identidades de todos os usuários.

Parâmetro Tipo Obrigatório Descrição
queries string[] não Lista de consultas geradas com a classe Query do SDK. Saiba mais sobre consultas. No máximo 100 consultas, cada uma com até 4096 caracteres. É possível filtrar pelos atributos: userId, provider, providerUid, providerEmail, providerAccessTokenExpiry
search string não Termo de busca para filtrar a lista. Tamanho máximo: 256 caracteres.
total boolean não Com false, o total não é calculado e volta como 0.

Acesso: chave de API com o escopo users.read.

@owbase/node
import { Client, Users } from '@owbase/node';


const client = new Client()
    .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API
    .setProject('<YOUR_PROJECT_ID>') // ID do projeto
    .setKey('<YOUR_API_KEY>'); // chave de API (só no servidor)


const users = new Users(client);


const result = await users.listIdentities({
    queries: [], // opcional
    search: '<SEARCH>', // opcional
    total: false, // opcional
});

deleteIdentity

Seção intitulada “deleteIdentity”

Excluir identidade

SDK: só @owbase/node

Exclui uma identidade pelo ID.

Parâmetro Tipo Obrigatório Descrição
identityId string sim ID da identidade.

Acesso: chave de API com o escopo users.write.

@owbase/node
import { Client, Users } from '@owbase/node';


const client = new Client()
    .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API
    .setProject('<YOUR_PROJECT_ID>') // ID do projeto
    .setKey('<YOUR_API_KEY>'); // chave de API (só no servidor)


const users = new Users(client);


const result = await users.deleteIdentity({
    identityId: '<IDENTITY_ID>',
});

createMD5User

Seção intitulada “createMD5User”

Criar usuário com senha MD5

SDK: só @owbase/node

Cria um usuário. A senha informada precisa estar com hash do algoritmo MD5. Use o endpoint POST /users para criar usuários com senha em texto puro.

Parâmetro Tipo Obrigatório Descrição
userId string sim ID do usuário. Escolha um ID próprio ou gere um ID aleatório com ID.unique(). Caracteres válidos: a-z, A-Z, 0-9, ponto, hífen e sublinhado. Não pode começar com caractere especial. Tamanho máximo: 36 caracteres.
email string sim E-mail do usuário.
password string sim Senha do usuário com hash MD5.
name string não Nome do usuário. Tamanho máximo: 128 caracteres.

Acesso: chave de API com o escopo users.write.

@owbase/node
import { Client, Users } from '@owbase/node';


const client = new Client()
    .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API
    .setProject('<YOUR_PROJECT_ID>') // ID do projeto
    .setKey('<YOUR_API_KEY>'); // chave de API (só no servidor)


const users = new Users(client);


const result = await users.createMD5User({
    userId: '<USER_ID>',
    email: '[email protected]',
    password: 'password',
    name: '<NAME>', // opcional
});

createPHPassUser

Seção intitulada “createPHPassUser”

Criar usuário com senha PHPass

SDK: só @owbase/node

Cria um usuário. A senha informada precisa estar com hash do algoritmo PHPass. Use o endpoint POST /users para criar usuários com senha em texto puro.

Parâmetro Tipo Obrigatório Descrição
userId string sim ID do usuário. Escolha um ID próprio ou passe o texto ID.unique() para gerá-lo automaticamente. Caracteres válidos: a-z, A-Z, 0-9, ponto, hífen e sublinhado. Não pode começar com caractere especial. Tamanho máximo: 36 caracteres.
email string sim E-mail do usuário.
password string sim Senha do usuário com hash PHPass.
name string não Nome do usuário. Tamanho máximo: 128 caracteres.

Acesso: chave de API com o escopo users.write.

@owbase/node
import { Client, Users } from '@owbase/node';


const client = new Client()
    .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API
    .setProject('<YOUR_PROJECT_ID>') // ID do projeto
    .setKey('<YOUR_API_KEY>'); // chave de API (só no servidor)


const users = new Users(client);


const result = await users.createPHPassUser({
    userId: '<USER_ID>',
    email: '[email protected]',
    password: 'password',
    name: '<NAME>', // opcional
});

createScryptUser

Seção intitulada “createScryptUser”

Criar usuário com senha Scrypt

SDK: só @owbase/node

Cria um usuário. A senha informada precisa estar com hash do algoritmo Scrypt. Use o endpoint POST /users para criar usuários com senha em texto puro.

Parâmetro Tipo Obrigatório Descrição
userId string sim ID do usuário. Escolha um ID próprio ou gere um ID aleatório com ID.unique(). Caracteres válidos: a-z, A-Z, 0-9, ponto, hífen e sublinhado. Não pode começar com caractere especial. Tamanho máximo: 36 caracteres.
email string sim E-mail do usuário.
password string sim Senha do usuário com hash Scrypt.
passwordSalt string sim Salt opcional usado no hash da senha.
passwordCpu number sim Custo de CPU opcional usado no hash da senha.
passwordMemory number sim Custo de memória opcional usado no hash da senha.
passwordParallel number sim Custo de paralelismo opcional usado no hash da senha.
passwordLength number sim Tamanho opcional do hash da senha.
name string não Nome do usuário. Tamanho máximo: 128 caracteres.

Acesso: chave de API com o escopo users.write.

@owbase/node
import { Client, Users } from '@owbase/node';


const client = new Client()
    .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API
    .setProject('<YOUR_PROJECT_ID>') // ID do projeto
    .setKey('<YOUR_API_KEY>'); // chave de API (só no servidor)


const users = new Users(client);


const result = await users.createScryptUser({
    userId: '<USER_ID>',
    email: '[email protected]',
    password: 'password',
    passwordSalt: '<PASSWORD_SALT>',
    passwordCpu: 8,
    passwordMemory: 65536,
    passwordParallel: 1,
    passwordLength: 64,
    name: '<NAME>', // opcional
});

createScryptModifiedUser

Seção intitulada “createScryptModifiedUser”

Criar usuário com senha Scrypt modificado

SDK: só @owbase/node

Cria um usuário. A senha informada precisa estar com hash do algoritmo Scrypt Modified. Use o endpoint POST /users para criar usuários com senha em texto puro.

Parâmetro Tipo Obrigatório Descrição
userId string sim ID do usuário. Escolha um ID próprio ou gere um ID aleatório com ID.unique(). Caracteres válidos: a-z, A-Z, 0-9, ponto, hífen e sublinhado. Não pode começar com caractere especial. Tamanho máximo: 36 caracteres.
email string sim E-mail do usuário.
password string sim Senha do usuário com hash Scrypt Modified.
passwordSalt string sim Salt usado no hash da senha.
passwordSaltSeparator string sim Separador do salt usado no hash da senha.
passwordSignerKey string sim Chave de assinatura usada no hash da senha.
name string não Nome do usuário. Tamanho máximo: 128 caracteres.

Acesso: chave de API com o escopo users.write.

@owbase/node
import { Client, Users } from '@owbase/node';


const client = new Client()
    .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API
    .setProject('<YOUR_PROJECT_ID>') // ID do projeto
    .setKey('<YOUR_API_KEY>'); // chave de API (só no servidor)


const users = new Users(client);


const result = await users.createScryptModifiedUser({
    userId: '<USER_ID>',
    email: '[email protected]',
    password: 'password',
    passwordSalt: '<PASSWORD_SALT>',
    passwordSaltSeparator: '<PASSWORD_SALT_SEPARATOR>',
    passwordSignerKey: '<PASSWORD_SIGNER_KEY>',
    name: '<NAME>', // opcional
});

createSHAUser

Seção intitulada “createSHAUser”

Criar usuário com senha SHA

SDK: só @owbase/node

Cria um usuário. A senha informada precisa estar com hash do algoritmo SHA. Use o endpoint POST /users para criar usuários com senha em texto puro.

Parâmetro Tipo Obrigatório Descrição
userId string sim ID do usuário. Escolha um ID próprio ou gere um ID aleatório com ID.unique(). Caracteres válidos: a-z, A-Z, 0-9, ponto, hífen e sublinhado. Não pode começar com caractere especial. Tamanho máximo: 36 caracteres.
email string sim E-mail do usuário.
password string sim Senha do usuário com hash SHA.
passwordVersion PasswordHash não Versão opcional do SHA usada no hash da senha. Valores aceitos: ‘sha1’, ‘sha224’, ‘sha256’, ‘sha384’, ‘sha512/224’, ‘sha512/256’, ‘sha512’, ‘sha3-224’, ‘sha3-256’, ‘sha3-384’, ‘sha3-512’ Valores: sha1, sha224, sha256, sha384, sha512/224, sha512/256, sha512, sha3-224, sha3-256, sha3-384, sha3-512.
name string não Nome do usuário. Tamanho máximo: 128 caracteres.

Acesso: chave de API com o escopo users.write.

@owbase/node
import { Client, Users, PasswordHash } from '@owbase/node';


const client = new Client()
    .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API
    .setProject('<YOUR_PROJECT_ID>') // ID do projeto
    .setKey('<YOUR_API_KEY>'); // chave de API (só no servidor)


const users = new Users(client);


const result = await users.createSHAUser({
    userId: '<USER_ID>',
    email: '[email protected]',
    password: 'password',
    passwordVersion: PasswordHash.Sha1, // opcional
    name: '<NAME>', // opcional
});

get

Seção intitulada “get”

Obter usuário

SDK: só @owbase/node

Obtém um usuário pelo ID.

Parâmetro Tipo Obrigatório Descrição
userId string sim ID do usuário.

Acesso: chave de API com o escopo users.read.

@owbase/node
import { Client, Users } from '@owbase/node';


const client = new Client()
    .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API
    .setProject('<YOUR_PROJECT_ID>') // ID do projeto
    .setKey('<YOUR_API_KEY>'); // chave de API (só no servidor)


const users = new Users(client);


const result = await users.get({
    userId: '<USER_ID>',
});

delete

Seção intitulada “delete”

Excluir usuário

SDK: só @owbase/node

Exclui um usuário pelo ID, o que libera o ID dele. Como o ID fica livre para ser reutilizado, todos os recursos ligados ao usuário, como documentos ou arquivos do storage, devem ser excluídos antes do usuário. Para manter o ID reservado, use o endpoint updateStatus.

Parâmetro Tipo Obrigatório Descrição
userId string sim ID do usuário.

Acesso: chave de API com o escopo users.write.

@owbase/node
import { Client, Users } from '@owbase/node';


const client = new Client()
    .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API
    .setProject('<YOUR_PROJECT_ID>') // ID do projeto
    .setKey('<YOUR_API_KEY>'); // chave de API (só no servidor)


const users = new Users(client);


const result = await users.delete({
    userId: '<USER_ID>',
});

updateEmail

Seção intitulada “updateEmail”

Atualizar e-mail

SDK: só @owbase/node

Atualiza o e-mail do usuário pelo ID.

Parâmetro Tipo Obrigatório Descrição
userId string sim ID do usuário.
email string sim E-mail do usuário.

Acesso: chave de API com o escopo users.write.

@owbase/node
import { Client, Users } from '@owbase/node';


const client = new Client()
    .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API
    .setProject('<YOUR_PROJECT_ID>') // ID do projeto
    .setKey('<YOUR_API_KEY>'); // chave de API (só no servidor)


const users = new Users(client);


const result = await users.updateEmail({
    userId: '<USER_ID>',
    email: '[email protected]',
});

updateImpersonator

Seção intitulada “updateImpersonator”

Atualizar permissão de impersonation do usuário

SDK: só @owbase/node

Define se um usuário pode ou não se passar por outros usuários (impersonation). Quando os headers de impersonation são usados, o pedido roda como o usuário-alvo no comportamento da API, enquanto os logs de auditoria internos continuam atribuindo a ação a quem se passou pelo alvo e guardam os dados do alvo só no conteúdo interno da auditoria. Os endpoints de Account ficam só de leitura durante a impersonation: eles mostram a conta do alvo, e tudo o que a alteraria é recusado, então quem se passa pelo alvo não consegue mudar as credenciais dele nem excluir a conta dele.

Parâmetro Tipo Obrigatório Descrição
userId string sim ID do usuário.
impersonator boolean sim Se o usuário pode se passar por outros usuários. Com true, o usuário pode navegar pelos usuários do projeto para escolher um alvo e enviar os headers de impersonation para agir como esse usuário. Os logs de auditoria internos continuam atribuindo as ações feitas no lugar do alvo a quem se passou por ele e guardam os dados do usuário-alvo só no conteúdo interno da auditoria.

Acesso: chave de API com o escopo users.write.

@owbase/node
import { Client, Users } from '@owbase/node';


const client = new Client()
    .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API
    .setProject('<YOUR_PROJECT_ID>') // ID do projeto
    .setKey('<YOUR_API_KEY>'); // chave de API (só no servidor)


const users = new Users(client);


const result = await users.updateImpersonator({
    userId: '<USER_ID>',
    impersonator: false,
});

createJWT

Seção intitulada “createJWT”

Criar JWT do usuário

SDK: só @owbase/node

Cria um JSON Web Token para o usuário, pelo ID dele. Use o JWT gerado para se autenticar em nome do usuário. O segredo do JWT deixa de valer se a sessão que ele usa for excluída.

Parâmetro Tipo Obrigatório Descrição
userId string sim ID do usuário.
sessionId string não ID da sessão. Use o texto ‘recent()’ para usar a sessão mais recente, que também é o padrão.
duration number não Tempo em segundos até o JWT expirar. O padrão é 900 segundos, e o máximo, 3600 segundos.

Acesso: chave de API com o escopo users.write.

@owbase/node
import { Client, Users } from '@owbase/node';


const client = new Client()
    .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API
    .setProject('<YOUR_PROJECT_ID>') // ID do projeto
    .setKey('<YOUR_API_KEY>'); // chave de API (só no servidor)


const users = new Users(client);


const result = await users.createJWT({
    userId: '<USER_ID>',
    sessionId: 'recent()', // opcional
    duration: 0, // opcional
});

updateLabels

Seção intitulada “updateLabels”

Atualizar rótulos do usuário

SDK: só @owbase/node

Atualiza os rótulos do usuário pelo ID.

Rótulos servem para dar acesso a recursos. Enquanto os times são uma forma de os usuários compartilharem acesso a um recurso, os rótulos são definidos pelo desenvolvedor para dar acesso sem convite. Veja mais na documentação de permissões.

Parâmetro Tipo Obrigatório Descrição
userId string sim ID do usuário.
labels string[] sim Lista de rótulos do usuário. Substitui os rótulos anteriores. No máximo 1000 rótulos, cada um com até 36 caracteres alfanuméricos.

Acesso: chave de API com o escopo users.write.

@owbase/node
import { Client, Users } from '@owbase/node';


const client = new Client()
    .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API
    .setProject('<YOUR_PROJECT_ID>') // ID do projeto
    .setKey('<YOUR_API_KEY>'); // chave de API (só no servidor)


const users = new Users(client);


const result = await users.updateLabels({
    userId: '<USER_ID>',
    labels: ['subscriber'],
});

listMemberships

Seção intitulada “listMemberships”

Listar participações do usuário

SDK: só @owbase/node

Obtém a lista de participações do usuário pelo ID.

Parâmetro Tipo Obrigatório Descrição
userId string sim ID do usuário.
queries string[] não Lista de consultas geradas com a classe Query do SDK. Saiba mais sobre consultas. No máximo 100 consultas, cada uma com até 4096 caracteres. É possível filtrar pelos atributos: userId, teamId, invited, joined, confirm, roles
search string não Termo de busca para filtrar a lista. Tamanho máximo: 256 caracteres.
total boolean não Com false, o total não é calculado e volta como 0.

Acesso: chave de API com o escopo users.read.

@owbase/node
import { Client, Users } from '@owbase/node';


const client = new Client()
    .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API
    .setProject('<YOUR_PROJECT_ID>') // ID do projeto
    .setKey('<YOUR_API_KEY>'); // chave de API (só no servidor)


const users = new Users(client);


const result = await users.listMemberships({
    userId: '<USER_ID>',
    queries: [], // opcional
    search: '<SEARCH>', // opcional
    total: false, // opcional
});

updateMFA

Seção intitulada “updateMFA”

Atualizar MFA

SDK: só @owbase/node

Liga ou desliga o MFA na conta de um usuário.

Parâmetro Tipo Obrigatório Descrição
userId string sim ID do usuário.
mfa boolean sim Liga ou desliga o MFA.

Acesso: chave de API com o escopo users.write.

@owbase/node
import { Client, Users } from '@owbase/node';


const client = new Client()
    .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API
    .setProject('<YOUR_PROJECT_ID>') // ID do projeto
    .setKey('<YOUR_API_KEY>'); // chave de API (só no servidor)


const users = new Users(client);


const result = await users.updateMFA({
    userId: '<USER_ID>',
    mfa: false,
});

updateMfa

Seção intitulada “updateMfa”

Atualizar MFA

SDK: só @owbase/node

Liga ou desliga o MFA na conta de um usuário.

Parâmetro Tipo Obrigatório Descrição
userId string sim ID do usuário.
mfa boolean sim Liga ou desliga o MFA.

Acesso: chave de API com o escopo users.write.

Sem exemplo próprio: veja o do método que o substitui.

deleteMFAAuthenticator

Seção intitulada “deleteMFAAuthenticator”

Excluir autenticador

SDK: só @owbase/node

Exclui um app autenticador.

Parâmetro Tipo Obrigatório Descrição
userId string sim ID do usuário.
type AuthenticatorType sim Tipo de autenticador. Valores: totp.

Acesso: chave de API com o escopo users.write.

@owbase/node
import { Client, Users, AuthenticatorType } from '@owbase/node';


const client = new Client()
    .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API
    .setProject('<YOUR_PROJECT_ID>') // ID do projeto
    .setKey('<YOUR_API_KEY>'); // chave de API (só no servidor)


const users = new Users(client);


const result = await users.deleteMFAAuthenticator({
    userId: '<USER_ID>',
    type: AuthenticatorType.Totp,
});

deleteMfaAuthenticator

Seção intitulada “deleteMfaAuthenticator”

Excluir autenticador

SDK: só @owbase/node

Exclui um app autenticador.

Parâmetro Tipo Obrigatório Descrição
userId string sim ID do usuário.
type AuthenticatorType sim Tipo de autenticador. Valores: totp.

Acesso: chave de API com o escopo users.write.

Sem exemplo próprio: veja o do método que o substitui.

getMFAChallenge

Seção intitulada “getMFAChallenge”

Obter desafio de MFA

SDK: só @owbase/node

Obtém um desafio de MFA personalizado de um usuário, com o código a entregar pelo seu próprio canal.

Parâmetro Tipo Obrigatório Descrição
userId string sim ID do usuário.
challengeId string sim ID do desafio.

Acesso: chave de API com o escopo users.read.

@owbase/node
import { Client, Users } from '@owbase/node';


const client = new Client()
    .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API
    .setProject('<YOUR_PROJECT_ID>') // ID do projeto
    .setKey('<YOUR_API_KEY>'); // chave de API (só no servidor)


const users = new Users(client);


const result = await users.getMFAChallenge({
    userId: '<USER_ID>',
    challengeId: '<CHALLENGE_ID>',
});

listMFAFactors

Seção intitulada “listMFAFactors”

Listar fatores

SDK: só @owbase/node

Lista os fatores disponíveis na conta para usar num desafio de MFA.

Parâmetro Tipo Obrigatório Descrição
userId string sim ID do usuário.

Acesso: chave de API com o escopo users.read.

@owbase/node
import { Client, Users } from '@owbase/node';


const client = new Client()
    .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API
    .setProject('<YOUR_PROJECT_ID>') // ID do projeto
    .setKey('<YOUR_API_KEY>'); // chave de API (só no servidor)


const users = new Users(client);


const result = await users.listMFAFactors({
    userId: '<USER_ID>',
});

listMfaFactors

Seção intitulada “listMfaFactors”

Listar fatores

SDK: só @owbase/node

Lista os fatores disponíveis na conta para usar num desafio de MFA.

Parâmetro Tipo Obrigatório Descrição
userId string sim ID do usuário.

Acesso: chave de API com o escopo users.read.

Sem exemplo próprio: veja o do método que o substitui.

getMFARecoveryCodes

Seção intitulada “getMFARecoveryCodes”

Obter códigos de recuperação de MFA

SDK: só @owbase/node

Obtém, pelo ID do usuário, os códigos de recuperação que servem de reserva no fluxo de MFA. Antes, os códigos precisam ter sido gerados com o método createMfaRecoveryCodes.

Parâmetro Tipo Obrigatório Descrição
userId string sim ID do usuário.

Acesso: chave de API com o escopo users.read.

@owbase/node
import { Client, Users } from '@owbase/node';


const client = new Client()
    .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API
    .setProject('<YOUR_PROJECT_ID>') // ID do projeto
    .setKey('<YOUR_API_KEY>'); // chave de API (só no servidor)


const users = new Users(client);


const result = await users.getMFARecoveryCodes({
    userId: '<USER_ID>',
});

getMfaRecoveryCodes

Seção intitulada “getMfaRecoveryCodes”

Obter códigos de recuperação de MFA

SDK: só @owbase/node

Obtém, pelo ID do usuário, os códigos de recuperação que servem de reserva no fluxo de MFA. Antes, os códigos precisam ter sido gerados com o método createMfaRecoveryCodes.

Parâmetro Tipo Obrigatório Descrição
userId string sim ID do usuário.

Acesso: chave de API com o escopo users.read.

Sem exemplo próprio: veja o do método que o substitui.

updateMFARecoveryCodes

Seção intitulada “updateMFARecoveryCodes”

Atualizar códigos de recuperação de MFA (gerar de novo)

SDK: só @owbase/node

Gera de novo, pelo ID do usuário, os códigos de recuperação que servem de reserva no fluxo de MFA. Antes, os códigos precisam ter sido gerados com o método createMfaRecoveryCodes.

Parâmetro Tipo Obrigatório Descrição
userId string sim ID do usuário.

Acesso: chave de API com o escopo users.write.

@owbase/node
import { Client, Users } from '@owbase/node';


const client = new Client()
    .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API
    .setProject('<YOUR_PROJECT_ID>') // ID do projeto
    .setKey('<YOUR_API_KEY>'); // chave de API (só no servidor)


const users = new Users(client);


const result = await users.updateMFARecoveryCodes({
    userId: '<USER_ID>',
});

updateMfaRecoveryCodes

Seção intitulada “updateMfaRecoveryCodes”

Atualizar códigos de recuperação de MFA (gerar de novo)

SDK: só @owbase/node

Gera de novo, pelo ID do usuário, os códigos de recuperação que servem de reserva no fluxo de MFA. Antes, os códigos precisam ter sido gerados com o método createMfaRecoveryCodes.

Parâmetro Tipo Obrigatório Descrição
userId string sim ID do usuário.

Acesso: chave de API com o escopo users.write.

Sem exemplo próprio: veja o do método que o substitui.

createMFARecoveryCodes

Seção intitulada “createMFARecoveryCodes”

Criar códigos de recuperação de MFA

SDK: só @owbase/node

Gera códigos de recuperação, como reserva do fluxo de MFA, para o ID do usuário. Os códigos de recuperação podem ser usados como tipo de verificação de MFA no método createMfaChallenge do SDK de cliente.

Parâmetro Tipo Obrigatório Descrição
userId string sim ID do usuário.

Acesso: chave de API com o escopo users.write.

@owbase/node
import { Client, Users } from '@owbase/node';


const client = new Client()
    .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API
    .setProject('<YOUR_PROJECT_ID>') // ID do projeto
    .setKey('<YOUR_API_KEY>'); // chave de API (só no servidor)


const users = new Users(client);


const result = await users.createMFARecoveryCodes({
    userId: '<USER_ID>',
});

createMfaRecoveryCodes

Seção intitulada “createMfaRecoveryCodes”

Criar códigos de recuperação de MFA

SDK: só @owbase/node

Gera códigos de recuperação, como reserva do fluxo de MFA, para o ID do usuário. Os códigos de recuperação podem ser usados como tipo de verificação de MFA no método createMfaChallenge do SDK de cliente.

Parâmetro Tipo Obrigatório Descrição
userId string sim ID do usuário.

Acesso: chave de API com o escopo users.write.

Sem exemplo próprio: veja o do método que o substitui.

updateName

Seção intitulada “updateName”

Atualizar nome

SDK: só @owbase/node

Atualiza o nome do usuário pelo ID.

Parâmetro Tipo Obrigatório Descrição
userId string sim ID do usuário.
name string sim Nome do usuário. Tamanho máximo: 128 caracteres.

Acesso: chave de API com o escopo users.write.

@owbase/node
import { Client, Users } from '@owbase/node';


const client = new Client()
    .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API
    .setProject('<YOUR_PROJECT_ID>') // ID do projeto
    .setKey('<YOUR_API_KEY>'); // chave de API (só no servidor)


const users = new Users(client);


const result = await users.updateName({
    userId: '<USER_ID>',
    name: '<NAME>',
});

listPasskeys

Seção intitulada “listPasskeys”

Listar passkeys do usuário

SDK: só @owbase/node

Obtém a lista de passkeys verificadas que um usuário cadastrou.

Parâmetro Tipo Obrigatório Descrição
userId string sim ID do usuário.
queries string[] não Lista de consultas geradas com a classe Query do SDK. Saiba mais sobre consultas. No máximo 100 consultas, cada uma com até 4096 caracteres. É possível filtrar e ordenar pelos atributos: $id, $createdAt, $updatedAt, name, accessedAt
total boolean não Com false, o total não é calculado e volta como 0.

Acesso: chave de API com o escopo users.read.

@owbase/node
import { Client, Users } from '@owbase/node';


const client = new Client()
    .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API
    .setProject('<YOUR_PROJECT_ID>') // ID do projeto
    .setKey('<YOUR_API_KEY>'); // chave de API (só no servidor)


const users = new Users(client);


const result = await users.listPasskeys({
    userId: '<USER_ID>',
    queries: [], // opcional
    total: false, // opcional
});

getPasskey

Seção intitulada “getPasskey”

Obter passkey do usuário

SDK: só @owbase/node

Obtém uma passkey verificada de um usuário pelo ID.

Parâmetro Tipo Obrigatório Descrição
userId string sim ID do usuário.
passkeyId string sim ID da passkey.

Acesso: chave de API com o escopo users.read.

@owbase/node
import { Client, Users } from '@owbase/node';


const client = new Client()
    .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API
    .setProject('<YOUR_PROJECT_ID>') // ID do projeto
    .setKey('<YOUR_API_KEY>'); // chave de API (só no servidor)


const users = new Users(client);


const result = await users.getPasskey({
    userId: '<USER_ID>',
    passkeyId: '<PASSKEY_ID>',
});

updatePasskey

Seção intitulada “updatePasskey”

Atualizar passkey do usuário

SDK: só @owbase/node

Renomeia uma passkey de um usuário.

Parâmetro Tipo Obrigatório Descrição
userId string sim ID do usuário.
passkeyId string sim ID da passkey.
name string sim Nome da passkey. Tamanho máximo: 128 caracteres.

Acesso: chave de API com o escopo users.write.

@owbase/node
import { Client, Users } from '@owbase/node';


const client = new Client()
    .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API
    .setProject('<YOUR_PROJECT_ID>') // ID do projeto
    .setKey('<YOUR_API_KEY>'); // chave de API (só no servidor)


const users = new Users(client);


const result = await users.updatePasskey({
    userId: '<USER_ID>',
    passkeyId: '<PASSKEY_ID>',
    name: '<NAME>',
});

deletePasskey

Seção intitulada “deletePasskey”

Excluir passkey do usuário

SDK: só @owbase/node

Exclui uma passkey de um usuário, por exemplo quando um aparelho é perdido. A passkey deixa de servir para login.

Parâmetro Tipo Obrigatório Descrição
userId string sim ID do usuário.
passkeyId string sim ID da passkey.

Acesso: chave de API com o escopo users.write.

@owbase/node
import { Client, Users } from '@owbase/node';


const client = new Client()
    .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API
    .setProject('<YOUR_PROJECT_ID>') // ID do projeto
    .setKey('<YOUR_API_KEY>'); // chave de API (só no servidor)


const users = new Users(client);


const result = await users.deletePasskey({
    userId: '<USER_ID>',
    passkeyId: '<PASSKEY_ID>',
});

updatePassword

Seção intitulada “updatePassword”

Atualizar senha

SDK: só @owbase/node

Atualiza a senha do usuário pelo ID.

Parâmetro Tipo Obrigatório Descrição
userId string sim ID do usuário.
password string sim Nova senha do usuário. Precisa ter pelo menos 8 caracteres.

Acesso: chave de API com o escopo users.write.

@owbase/node
import { Client, Users } from '@owbase/node';


const client = new Client()
    .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API
    .setProject('<YOUR_PROJECT_ID>') // ID do projeto
    .setKey('<YOUR_API_KEY>'); // chave de API (só no servidor)


const users = new Users(client);


const result = await users.updatePassword({
    userId: '<USER_ID>',
    password: 'password',
});

updatePhone

Seção intitulada “updatePhone”

Atualizar telefone

SDK: só @owbase/node

Atualiza o telefone do usuário pelo ID.

Parâmetro Tipo Obrigatório Descrição
userId string sim ID do usuário.
number string sim Telefone do usuário.

Acesso: chave de API com o escopo users.write.

@owbase/node
import { Client, Users } from '@owbase/node';


const client = new Client()
    .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API
    .setProject('<YOUR_PROJECT_ID>') // ID do projeto
    .setKey('<YOUR_API_KEY>'); // chave de API (só no servidor)


const users = new Users(client);


const result = await users.updatePhone({
    userId: '<USER_ID>',
    number: '+12065550100',
});

getPrefs

Seção intitulada “getPrefs”

Obter preferências do usuário

SDK: só @owbase/node

Obtém as preferências do usuário pelo ID.

Parâmetro Tipo Obrigatório Descrição
userId string sim ID do usuário.

Acesso: chave de API com o escopo users.read.

@owbase/node
import { Client, Users } from '@owbase/node';


const client = new Client()
    .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API
    .setProject('<YOUR_PROJECT_ID>') // ID do projeto
    .setKey('<YOUR_API_KEY>'); // chave de API (só no servidor)


const users = new Users(client);


const result = await users.getPrefs({
    userId: '<USER_ID>',
});

updatePrefs

Seção intitulada “updatePrefs”

Atualizar preferências do usuário

SDK: só @owbase/node

Atualiza as preferências do usuário pelo ID. O objeto enviado é guardado como está e substitui o valor anterior. O tamanho máximo das preferências é 64kB; acima disso, a chamada falha com erro.

Parâmetro Tipo Obrigatório Descrição
userId string sim ID do usuário.
prefs object sim Objeto JSON chave-valor com as preferências.

Acesso: chave de API com o escopo users.write.

@owbase/node
import { Client, Users } from '@owbase/node';


const client = new Client()
    .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API
    .setProject('<YOUR_PROJECT_ID>') // ID do projeto
    .setKey('<YOUR_API_KEY>'); // chave de API (só no servidor)


const users = new Users(client);


const result = await users.updatePrefs({
    userId: '<USER_ID>',
    prefs: {},
});

listSessions

Seção intitulada “listSessions”

Listar sessões do usuário

SDK: só @owbase/node

Obtém a lista de sessões do usuário pelo ID.

Parâmetro Tipo Obrigatório Descrição
userId string sim ID do usuário.
total boolean não Com false, o total não é calculado e volta como 0.

Acesso: chave de API com o escopo users.read (também aceita sessions.read).

@owbase/node
import { Client, Users } from '@owbase/node';


const client = new Client()
    .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API
    .setProject('<YOUR_PROJECT_ID>') // ID do projeto
    .setKey('<YOUR_API_KEY>'); // chave de API (só no servidor)


const users = new Users(client);


const result = await users.listSessions({
    userId: '<USER_ID>',
    total: false, // opcional
});

createSession

Seção intitulada “createSession”

Criar sessão

SDK: só @owbase/node

Cria uma sessão para um usuário. Devolve um objeto de sessão pronto para uso.

Para gerar um token para um fluxo de autenticação próprio, use o endpoint POST /users/{userId}/tokens.

Parâmetro Tipo Obrigatório Descrição
userId string sim ID do usuário. Escolha um ID próprio ou gere um ID aleatório com ID.unique(). Caracteres válidos: a-z, A-Z, 0-9, ponto, hífen e sublinhado. Não pode começar com caractere especial. Tamanho máximo: 36 caracteres.

Acesso: chave de API com o escopo users.write (também aceita sessions.write).

@owbase/node
import { Client, Users } from '@owbase/node';


const client = new Client()
    .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API
    .setProject('<YOUR_PROJECT_ID>') // ID do projeto
    .setKey('<YOUR_API_KEY>'); // chave de API (só no servidor)


const users = new Users(client);


const result = await users.createSession({
    userId: '<USER_ID>',
});

deleteSessions

Seção intitulada “deleteSessions”

Excluir sessões do usuário

SDK: só @owbase/node

Exclui todas as sessões do usuário, pelo ID do usuário.

Parâmetro Tipo Obrigatório Descrição
userId string sim ID do usuário.

Acesso: chave de API com o escopo users.write (também aceita sessions.write).

@owbase/node
import { Client, Users } from '@owbase/node';


const client = new Client()
    .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API
    .setProject('<YOUR_PROJECT_ID>') // ID do projeto
    .setKey('<YOUR_API_KEY>'); // chave de API (só no servidor)


const users = new Users(client);


const result = await users.deleteSessions({
    userId: '<USER_ID>',
});

deleteSession

Seção intitulada “deleteSession”

Excluir sessão do usuário

SDK: só @owbase/node

Exclui uma sessão do usuário pelo ID.

Parâmetro Tipo Obrigatório Descrição
userId string sim ID do usuário.
sessionId string sim ID da sessão.

Acesso: chave de API com o escopo users.write (também aceita sessions.write).

@owbase/node
import { Client, Users } from '@owbase/node';


const client = new Client()
    .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API
    .setProject('<YOUR_PROJECT_ID>') // ID do projeto
    .setKey('<YOUR_API_KEY>'); // chave de API (só no servidor)


const users = new Users(client);


const result = await users.deleteSession({
    userId: '<USER_ID>',
    sessionId: '<SESSION_ID>',
});

updateStatus

Seção intitulada “updateStatus”

Atualizar status do usuário

SDK: só @owbase/node

Atualiza o status do usuário pelo ID. Use este endpoint como alternativa à exclusão do usuário, quando quiser manter o ID dele reservado.

Parâmetro Tipo Obrigatório Descrição
userId string sim ID do usuário.
status boolean sim Status do usuário. Para ativar o usuário, passe true; para bloquear, passe false.

Acesso: chave de API com o escopo users.write.

@owbase/node
import { Client, Users } from '@owbase/node';


const client = new Client()
    .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API
    .setProject('<YOUR_PROJECT_ID>') // ID do projeto
    .setKey('<YOUR_API_KEY>'); // chave de API (só no servidor)


const users = new Users(client);


const result = await users.updateStatus({
    userId: '<USER_ID>',
    status: false,
});

createToken

Seção intitulada “createToken”

Criar token

SDK: só @owbase/node

Devolve um token com uma chave secreta para criar uma sessão. Use o ID do usuário e o segredo para fazer um pedido ao endpoint PUT /account/sessions/token e concluir o login.

Parâmetro Tipo Obrigatório Descrição
userId string sim ID do usuário.
length number não Tamanho do token, em caracteres. O padrão é 6 caracteres
expire number não Validade do token, em segundos. O padrão é 15 minutos.

Acesso: chave de API com o escopo users.write.

@owbase/node
import { Client, Users } from '@owbase/node';


const client = new Client()
    .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API
    .setProject('<YOUR_PROJECT_ID>') // ID do projeto
    .setKey('<YOUR_API_KEY>'); // chave de API (só no servidor)


const users = new Users(client);


const result = await users.createToken({
    userId: '<USER_ID>',
    length: 4, // opcional
    expire: 60, // opcional
});

updateEmailVerification

Seção intitulada “updateEmailVerification”

Atualizar verificação de e-mail

SDK: só @owbase/node

Atualiza o status de verificação do e-mail do usuário pelo ID.

Parâmetro Tipo Obrigatório Descrição
userId string sim ID do usuário.
emailVerification boolean sim Status de verificação do e-mail do usuário.

Acesso: chave de API com o escopo users.write.

@owbase/node
import { Client, Users } from '@owbase/node';


const client = new Client()
    .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API
    .setProject('<YOUR_PROJECT_ID>') // ID do projeto
    .setKey('<YOUR_API_KEY>'); // chave de API (só no servidor)


const users = new Users(client);


const result = await users.updateEmailVerification({
    userId: '<USER_ID>',
    emailVerification: false,
});

updatePhoneVerification

Seção intitulada “updatePhoneVerification”

Atualizar verificação de telefone

SDK: só @owbase/node

Atualiza o status de verificação do telefone do usuário pelo ID.

Parâmetro Tipo Obrigatório Descrição
userId string sim ID do usuário.
phoneVerification boolean sim Status de verificação do telefone do usuário.

Acesso: chave de API com o escopo users.write.

@owbase/node
import { Client, Users } from '@owbase/node';


const client = new Client()
    .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API
    .setProject('<YOUR_PROJECT_ID>') // ID do projeto
    .setKey('<YOUR_API_KEY>'); // chave de API (só no servidor)


const users = new Users(client);


const result = await users.updatePhoneVerification({
    userId: '<USER_ID>',
    phoneVerification: false,
});

As descrições desta página são traduções das que vêm da especificação da API do servidor (licença BSD-3-Clause), e os exemplos vêm do gerador de SDKs (licença MIT). Os avisos completos estão no arquivo NOTICE dos pacotes @owbase/web e @owbase/node.