Project

Configuração do projeto pelo servidor: plataformas, chaves, métodos de login, variáveis globais e e-mails.

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

get

Obter projeto

SDK: só @owbase/node

Obtém um projeto.

Sem parâmetros.

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

@owbase/node

import { Client, Project } 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 project = new Project(client);

const result = await project.get();

delete

Excluir projeto

SDK: só @owbase/node

Exclui um projeto.

Sem parâmetros.

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

@owbase/node

import { Client, Project } 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 project = new Project(client);

const result = await project.delete();

updateAuthMethod

Atualizar status do método de autenticação do projeto

SDK: só @owbase/node

Atualiza as propriedades de um método de autenticação. Use este endpoint para ligar ou desligar um método no projeto.

Parâmetro	Tipo	Obrigatório	Descrição
methodId	ProjectAuthMethodId	sim	ID do método de autenticação. Valores possíveis: email-password,magic-url,email-otp,anonymous,invites,jwt,phone,passkey Valores: email-password, magic-url, email-otp, anonymous, invites, jwt, phone, passkey.
enabled	boolean	sim	Status do método de autenticação.

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

@owbase/node

import { Client, Project, ProjectAuthMethodId } 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 project = new Project(client);

const result = await project.updateAuthMethod({
    methodId: ProjectAuthMethodId.EmailPassword,
    enabled: false,
});

listKeys

Listar chaves do projeto

SDK: só @owbase/node

Obtém a lista de todas as chaves de API do projeto atual.

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: expire, accessedAt, name, scopes
total	boolean	não	Com false, o total não é calculado e volta como 0.

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

@owbase/node

import { Client, Project } 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 project = new Project(client);

const result = await project.listKeys({
    queries: [], // opcional
    total: false, // opcional
});

createEphemeralKey

Criar chave efêmera do projeto

SDK: só @owbase/node

Cria uma chave de API efêmera. O recomendado é ter várias chaves de API com escopos restritos, uma para cada função dentro do projeto.

Se precisar de uma chave de vida mais longa, você também pode criar uma chave de API comum.

Parâmetro	Tipo	Obrigatório	Descrição
scopes	ProjectKeyScopes[]	sim	Lista de escopos da chave. No máximo 200 escopos. Valores: project.read, project.write, usage.read, keys.read, keys.write, platforms.read, platforms.write, mocks.read, mocks.write, policies.read, policies.write, project.policies.read, project.policies.write, project.oauth2.read, project.oauth2.write, templates.read, templates.write, stages.read, stages.write, users.read, users.write, sessions.read, sessions.write, teams.read, teams.write, databases.read, databases.write, tables.read, tables.write, columns.read, columns.write, indexes.read, indexes.write, rows.read, rows.write, embeddings.write, collections.read, collections.write, attributes.read, attributes.write, documents.read, documents.write, documentsdb.read, documentsdb.write, documentsdb.collections.read, documentsdb.collections.write, documentsdb.documents.read, documentsdb.documents.write, documentsdb.indexes.read, documentsdb.indexes.write, vectorsdb.read, vectorsdb.write, vectorsdb.collections.read, vectorsdb.collections.write, vectorsdb.documents.read, vectorsdb.documents.write, vectorsdb.indexes.read, vectorsdb.indexes.write, buckets.read, buckets.write, files.read, files.write, tokens.read, tokens.write, functions.read, functions.write, executions.read, executions.write, execution.read, execution.write, sites.read, sites.write, log.read, log.write, providers.read, providers.write, topics.read, topics.write, subscribers.read, subscribers.write, targets.read, targets.write, messages.read, messages.write, rules.read, rules.write, webhooks.read, webhooks.write, locale.read, avatars.read, avatars.write, health.read, assistant.read, migrations.read, migrations.write, schedules.read, schedules.write, vcs.read, vcs.write, insights.read, insights.write, reports.read, reports.write, presences.read, presences.write.
duration	number	sim	Tempo em segundos até a chave efêmera expirar. A duração máxima é 3600 segundos.

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

@owbase/node

import { Client, Project, ProjectKeyScopes } 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 project = new Project(client);

const result = await project.createEphemeralKey({
    scopes: [ProjectKeyScopes.UsersRead],
    duration: 600,
});

getKey

Obter chave do projeto

SDK: só @owbase/node

Obtém uma chave pelo ID.

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

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

@owbase/node

import { Client, Project } 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 project = new Project(client);

const result = await project.getKey({
    keyId: '<KEY_ID>',
});

updateKey

Atualizar chave do projeto

SDK: só @owbase/node

Atualiza uma chave pelo ID. Use este endpoint para atualizar o nome, os escopos ou a validade de uma chave de API.

Parâmetro	Tipo	Obrigatório	Descrição
keyId	string	sim	ID da chave.
name	string	sim	Nome da chave. Tamanho máximo: 128 caracteres.
scopes	ProjectKeyScopes[]	sim	Lista de escopos da chave. No máximo 200 escopos. Valores: project.read, project.write, usage.read, keys.read, keys.write, platforms.read, platforms.write, mocks.read, mocks.write, policies.read, policies.write, project.policies.read, project.policies.write, project.oauth2.read, project.oauth2.write, templates.read, templates.write, stages.read, stages.write, users.read, users.write, sessions.read, sessions.write, teams.read, teams.write, databases.read, databases.write, tables.read, tables.write, columns.read, columns.write, indexes.read, indexes.write, rows.read, rows.write, embeddings.write, collections.read, collections.write, attributes.read, attributes.write, documents.read, documents.write, documentsdb.read, documentsdb.write, documentsdb.collections.read, documentsdb.collections.write, documentsdb.documents.read, documentsdb.documents.write, documentsdb.indexes.read, documentsdb.indexes.write, vectorsdb.read, vectorsdb.write, vectorsdb.collections.read, vectorsdb.collections.write, vectorsdb.documents.read, vectorsdb.documents.write, vectorsdb.indexes.read, vectorsdb.indexes.write, buckets.read, buckets.write, files.read, files.write, tokens.read, tokens.write, functions.read, functions.write, executions.read, executions.write, execution.read, execution.write, sites.read, sites.write, log.read, log.write, providers.read, providers.write, topics.read, topics.write, subscribers.read, subscribers.write, targets.read, targets.write, messages.read, messages.write, rules.read, rules.write, webhooks.read, webhooks.write, locale.read, avatars.read, avatars.write, health.read, assistant.read, migrations.read, migrations.write, schedules.read, schedules.write, vcs.read, vcs.write, insights.read, insights.write, reports.read, reports.write, presences.read, presences.write.
expire	string	não	Data de expiração no formato ISO 8601. Use null para não expirar.

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

@owbase/node

import { Client, Project, ProjectKeyScopes } 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 project = new Project(client);

const result = await project.updateKey({
    keyId: '<KEY_ID>',
    name: '<NAME>',
    scopes: [ProjectKeyScopes.UsersRead],
    expire: '2020-10-15T06:38:00.000+00:00', // opcional
});

deleteKey

Excluir chave do projeto

SDK: só @owbase/node

Exclui uma chave pelo ID. Depois de excluída, a chave não autentica mais chamadas à API.

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

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

@owbase/node

import { Client, Project } 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 project = new Project(client);

const result = await project.deleteKey({
    keyId: '<KEY_ID>',
});

updateLabels

Atualizar rótulos do projeto

SDK: só @owbase/node

Atualiza os rótulos do projeto. Rótulos facilitam filtrar os projetos de uma organização.

Parâmetro	Tipo	Obrigatório	Descrição
labels	string[]	sim	Lista de rótulos do projeto. 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 project.write.

@owbase/node

import { Client, Project } 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 project = new Project(client);

const result = await project.updateLabels({
    labels: ['production'],
});

listMockPhones

Listar telefones de teste do projeto

SDK: só @owbase/node

Obtém a lista de todos os telefones de teste do projeto. Este endpoint devolve uma lista com todos os telefones de teste e os OTPs deles.

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. Só os métodos limit e offset são aceitos
total	boolean	não	Com false, o total não é calculado e volta como 0.

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

@owbase/node

import { Client, Project } 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 project = new Project(client);

const result = await project.listMockPhones({
    queries: [], // opcional
    total: false, // opcional
});

createMockPhone

Criar telefone de teste do projeto

SDK: só @owbase/node

Cria um telefone de teste no projeto. Use este endpoint para cadastrar um número de telefone de teste e o OTP de login dele para quem testa o app.

Parâmetro	Tipo	Obrigatório	Descrição
number	string	sim	Número de telefone a associar ao telefone de teste. Precisa ser um número válido no formato E.164.
otp	string	sim	Senha de uso único (OTP) a associar ao telefone de teste. Precisa ser um código numérico de 6 dígitos.

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

@owbase/node

import { Client, Project } 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 project = new Project(client);

const result = await project.createMockPhone({
    number: '+12065550100',
    otp: '<OTP>',
});

getMockPhone

Obter telefone de teste do projeto

SDK: só @owbase/node

Obtém um telefone de teste pelo número. Este endpoint devolve o OTP do telefone de teste.

Parâmetro	Tipo	Obrigatório	Descrição
number	string	sim	Número de telefone associado ao telefone de teste. Precisa ser um número válido no formato E.164.

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

@owbase/node

import { Client, Project } 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 project = new Project(client);

const result = await project.getMockPhone({
    number: '+12065550100',
});

updateMockPhone

Atualizar telefone de teste do projeto

SDK: só @owbase/node

Atualiza um telefone de teste pelo número. Use este endpoint para atualizar o OTP do telefone de teste.

Parâmetro	Tipo	Obrigatório	Descrição
number	string	sim	Número de telefone associado ao telefone de teste. Precisa ser um número válido no formato E.164.
otp	string	sim	Senha de uso único (OTP) a associar ao telefone de teste. Precisa ser um código numérico de 6 dígitos.

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

@owbase/node

import { Client, Project } 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 project = new Project(client);

const result = await project.updateMockPhone({
    number: '+12065550100',
    otp: '<OTP>',
});

deleteMockPhone

Excluir telefone de teste do projeto

SDK: só @owbase/node

Exclui um telefone de teste pelo número. Este endpoint remove do projeto o telefone de teste e a configuração de OTP dele.

Parâmetro	Tipo	Obrigatório	Descrição
number	string	sim	Número de telefone associado ao telefone de teste. Precisa ser um número válido no formato E.164.

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

@owbase/node

import { Client, Project } 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 project = new Project(client);

const result = await project.deleteMockPhone({
    number: '+12065550100',
});

listOAuth2Providers

Listar provedores OAuth2 do projeto

SDK: só @owbase/node

Obtém a lista de todos os provedores OAuth2 que o servidor aceita, com a configuração do projeto para cada um. Os campos de credencial são só de escrita e sempre voltam vazios.

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. Só os métodos limit e offset são aceitos
total	boolean	não	Com false, o total não é calculado e volta como 0.

Acesso: chave de API com o escopo project.oauth2.read.

@owbase/node

import { Client, Project } 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 project = new Project(client);

const result = await project.listOAuth2Providers({
    queries: [], // opcional
    total: false, // opcional
});

updateOAuth2Amazon

Atualizar OAuth2 Amazon do projeto

SDK: só @owbase/node

Atualiza a configuração OAuth2 Amazon do projeto.

Parâmetro	Tipo	Obrigatório	Descrição
clientId	string	não	‘Client ID’ do app OAuth2 Amazon. Exemplo: amzn1.application-oa2-client.87400c00000000000000000000063d5b2
clientSecret	string	não	‘Client Secret’ do app OAuth2 Amazon. Exemplo: 79ffe4000000000000000000000000000000000000000000000000000002de55
enabled	boolean	não	Status do método de login OAuth2. Use true para permitir criar sessões novas. Com true, as credenciais são validadas de ponta a ponta, e a chamada falha com erro se forem inválidas.

Acesso: chave de API com o escopo project.oauth2.write.

@owbase/node

import { Client, Project } 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 project = new Project(client);

const result = await project.updateOAuth2Amazon({
    clientId: '<CLIENT_ID>', // opcional
    clientSecret: '<CLIENT_SECRET>', // opcional
    enabled: false, // opcional
});

updateOAuth2Apple

Atualizar OAuth2 Apple do projeto

SDK: só @owbase/node

Atualiza a configuração OAuth2 Apple do projeto.

Parâmetro	Tipo	Obrigatório	Descrição
serviceId	string	não	‘Service ID’ do app OAuth2 Apple. Exemplo: ip.owbase.app.web
keyId	string	não	‘Key ID’ do app OAuth2 Apple. Exemplo: P4000000N8
teamId	string	não	‘Team ID’ do app OAuth2 Apple. Exemplo: D4000000R6
p8File	string	não	Conteúdo do arquivo de chave privada .p8 do app OAuth2 da Apple. A chave secreta entre os marcadores PEM tem 200 caracteres. Por exemplo: —–BEGIN PRIVATE KEY—–MIGTAg…jy2Xbna—–END PRIVATE KEY—–
nativeClientIds	string[]	não	Bundle IDs de apps aceitos como público (audience) do ID token no Sign in with Apple nativo. Por exemplo: com.example.app. Junto com o Services ID, são os únicos client IDs cujos tokens são aceitos. Envie uma lista vazia para limpar a lista.
enabled	boolean	não	Status do login OAuth2 pelo navegador. Use true para permitir criar sessões novas pelo fluxo de redirecionamento. Com true, as credenciais são validadas de ponta a ponta, e a chamada falha com erro se forem inválidas. Não afeta o login nativo, que é controlado só pelo nativeEnabled.
nativeEnabled	boolean	não	Status do Sign in with Apple nativo. É a única chave que liga a criação de sessões a partir de ID tokens obtidos no aparelho, e independe do enabled. Precisa de um Services ID ou de pelo menos um client ID nativo para comparar com os tokens, mas não de ID de chave nem de time: este método confere uma assinatura em vez de trocar um código de autorização.

Acesso: chave de API com o escopo project.oauth2.write.

@owbase/node

import { Client, Project } 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 project = new Project(client);

const result = await project.updateOAuth2Apple({
    serviceId: '<SERVICE_ID>', // opcional
    keyId: '<KEY_ID>', // opcional
    teamId: '<TEAM_ID>', // opcional
    p8File: '<P8_FILE>', // opcional
    nativeClientIds: [], // opcional
    enabled: false, // opcional
    nativeEnabled: false, // opcional
});

updateOAuth2Auth0

Atualizar OAuth2 Auth0 do projeto

SDK: só @owbase/node

Atualiza a configuração OAuth2 Auth0 do projeto.

Parâmetro	Tipo	Obrigatório	Descrição
clientId	string	não	‘Client ID’ do app OAuth2 Auth0. Exemplo: OaOkIA000000000000000000005KLSYq
clientSecret	string	não	‘Client Secret’ do app OAuth2 Auth0. Exemplo: zXz0000-00000000000000000000000000000-00000000000000000000PJafnF
endpoint	string	não	Domínio da instância Auth0. Exemplo: example.us.auth0.com
prompt	ProjectOAuth2Auth0Prompt[]	não	Lista de valores de prompt do OAuth2 do Auth0. Se “none” estiver na lista, precisa ser o único elemento. “none”: não mostra nenhuma tela de autenticação ou de consentimento. “login”: pede que o usuário se autentique de novo. “consent”: pede o consentimento do usuário. Envie uma lista vazia para usar o padrão do Auth0. Valores: none, login, consent.
enabled	boolean	não	Status do método de login OAuth2. Use true para permitir criar sessões novas. Com true, as credenciais são validadas de ponta a ponta, e a chamada falha com erro se forem inválidas.

Acesso: chave de API com o escopo project.oauth2.write.

@owbase/node

import { Client, Project, ProjectOAuth2Auth0Prompt } 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 project = new Project(client);

const result = await project.updateOAuth2Auth0({
    clientId: '<CLIENT_ID>', // opcional
    clientSecret: '<CLIENT_SECRET>', // opcional
    endpoint: '<ENDPOINT>', // opcional
    prompt: [ProjectOAuth2Auth0Prompt.None], // opcional
    enabled: false, // opcional
});

updateOAuth2Authentik

Atualizar OAuth2 Authentik do projeto

SDK: só @owbase/node

Atualiza a configuração OAuth2 Authentik do projeto.

Parâmetro	Tipo	Obrigatório	Descrição
clientId	string	não	‘Client ID’ do app OAuth2 Authentik. Exemplo: dTKOPa0000000000000000000000000000e7G8hv
clientSecret	string	não	‘Client Secret’ do app OAuth2 Authentik. Exemplo: ntQadq000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000Hp5WK
endpoint	string	não	Domínio da instância Authentik. Exemplo: example.authentik.com
enabled	boolean	não	Status do método de login OAuth2. Use true para permitir criar sessões novas. Com true, as credenciais são validadas de ponta a ponta, e a chamada falha com erro se forem inválidas.

Acesso: chave de API com o escopo project.oauth2.write.

@owbase/node

import { Client, Project } 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 project = new Project(client);

const result = await project.updateOAuth2Authentik({
    clientId: '<CLIENT_ID>', // opcional
    clientSecret: '<CLIENT_SECRET>', // opcional
    endpoint: '<ENDPOINT>', // opcional
    enabled: false, // opcional
});

updateOAuth2Autodesk

Atualizar OAuth2 Autodesk do projeto

SDK: só @owbase/node

Atualiza a configuração OAuth2 Autodesk do projeto.

Parâmetro	Tipo	Obrigatório	Descrição
clientId	string	não	‘Client ID’ do app OAuth2 Autodesk. Exemplo: 5zw90v00000000000000000000kVYXN7
clientSecret	string	não	‘Client Secret’ do app OAuth2 Autodesk. Exemplo: 7I000000000000MW
enabled	boolean	não	Status do método de login OAuth2. Use true para permitir criar sessões novas. Com true, as credenciais são validadas de ponta a ponta, e a chamada falha com erro se forem inválidas.

Acesso: chave de API com o escopo project.oauth2.write.

@owbase/node

import { Client, Project } 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 project = new Project(client);

const result = await project.updateOAuth2Autodesk({
    clientId: '<CLIENT_ID>', // opcional
    clientSecret: '<CLIENT_SECRET>', // opcional
    enabled: false, // opcional
});

updateOAuth2Bitbucket

Atualizar OAuth2 Bitbucket do projeto

SDK: só @owbase/node

Atualiza a configuração OAuth2 Bitbucket do projeto.

Parâmetro	Tipo	Obrigatório	Descrição
key	string	não	‘Key’ do app OAuth2 Bitbucket. Exemplo: Knt70000000000ByRc
secret	string	não	‘Secret’ do app OAuth2 Bitbucket. Exemplo: NMfLZJ00000000000000000000TLQdDx
enabled	boolean	não	Status do método de login OAuth2. Use true para permitir criar sessões novas. Com true, as credenciais são validadas de ponta a ponta, e a chamada falha com erro se forem inválidas.

Acesso: chave de API com o escopo project.oauth2.write.

@owbase/node

import { Client, Project } 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 project = new Project(client);

const result = await project.updateOAuth2Bitbucket({
    key: '<KEY>', // opcional
    secret: '<SECRET>', // opcional
    enabled: false, // opcional
});

updateOAuth2Bitly

Atualizar OAuth2 Bitly do projeto

SDK: só @owbase/node

Atualiza a configuração OAuth2 Bitly do projeto.

Parâmetro	Tipo	Obrigatório	Descrição
clientId	string	não	‘Client ID’ do app OAuth2 Bitly. Exemplo: d95151000000000000000000000000000067af9b
clientSecret	string	não	‘Client Secret’ do app OAuth2 Bitly. Exemplo: a13e250000000000000000000000000000d73095
enabled	boolean	não	Status do método de login OAuth2. Use true para permitir criar sessões novas. Com true, as credenciais são validadas de ponta a ponta, e a chamada falha com erro se forem inválidas.

Acesso: chave de API com o escopo project.oauth2.write.

@owbase/node

import { Client, Project } 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 project = new Project(client);

const result = await project.updateOAuth2Bitly({
    clientId: '<CLIENT_ID>', // opcional
    clientSecret: '<CLIENT_SECRET>', // opcional
    enabled: false, // opcional
});

updateOAuth2Box

Atualizar OAuth2 Box do projeto

SDK: só @owbase/node

Atualiza a configuração OAuth2 Box do projeto.

Parâmetro	Tipo	Obrigatório	Descrição
clientId	string	não	‘Client ID’ do app OAuth2 Box. Exemplo: deglcs00000000000000000000x2og6y
clientSecret	string	não	‘Client Secret’ do app OAuth2 Box. Exemplo: OKM1f100000000000000000000eshEif
enabled	boolean	não	Status do método de login OAuth2. Use true para permitir criar sessões novas. Com true, as credenciais são validadas de ponta a ponta, e a chamada falha com erro se forem inválidas.

Acesso: chave de API com o escopo project.oauth2.write.

@owbase/node

import { Client, Project } 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 project = new Project(client);

const result = await project.updateOAuth2Box({
    clientId: '<CLIENT_ID>', // opcional
    clientSecret: '<CLIENT_SECRET>', // opcional
    enabled: false, // opcional
});

updateOAuth2Cloudflare

Atualizar OAuth2 Cloudflare do projeto

SDK: só @owbase/node

Atualiza a configuração OAuth2 Cloudflare do projeto.

Parâmetro	Tipo	Obrigatório	Descrição
clientId	string	não	‘Client ID’ do app OAuth2 Cloudflare. Exemplo: 4b866000000000000000000000c9e4e2
clientSecret	string	não	‘Client Secret’ do app OAuth2 Cloudflare. Exemplo: cfoc_5Q6YRl0000000000000000000000000000000000003d214f
enabled	boolean	não	Status do método de login OAuth2. Use true para permitir criar sessões novas. Com true, as credenciais são validadas de ponta a ponta, e a chamada falha com erro se forem inválidas.

Acesso: chave de API com o escopo project.oauth2.write.

@owbase/node

import { Client, Project } 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 project = new Project(client);

const result = await project.updateOAuth2Cloudflare({
    clientId: '<CLIENT_ID>', // opcional
    clientSecret: '<CLIENT_SECRET>', // opcional
    enabled: false, // opcional
});

updateOAuth2Dailymotion

Atualizar OAuth2 Dailymotion do projeto

SDK: só @owbase/node

Atualiza a configuração OAuth2 Dailymotion do projeto.

Parâmetro	Tipo	Obrigatório	Descrição
apiKey	string	não	‘API Key’ do app OAuth2 Dailymotion. Exemplo: 07a9000000000000067f
apiSecret	string	não	‘API Secret’ do app OAuth2 Dailymotion. Exemplo: a399a90000000000000000000000000000d90639
enabled	boolean	não	Status do método de login OAuth2. Use true para permitir criar sessões novas. Com true, as credenciais são validadas de ponta a ponta, e a chamada falha com erro se forem inválidas.

Acesso: chave de API com o escopo project.oauth2.write.

@owbase/node

import { Client, Project } 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 project = new Project(client);

const result = await project.updateOAuth2Dailymotion({
    apiKey: '<API_KEY>', // opcional
    apiSecret: '<API_SECRET>', // opcional
    enabled: false, // opcional
});

updateOAuth2Discord

Atualizar OAuth2 Discord do projeto

SDK: só @owbase/node

Atualiza a configuração OAuth2 Discord do projeto.

Parâmetro	Tipo	Obrigatório	Descrição
clientId	string	não	‘Client ID’ do app OAuth2 Discord. Exemplo: 950722000000343754
clientSecret	string	não	‘Client Secret’ do app OAuth2 Discord. Exemplo: YmPXnM000000000000000000002zFg5D
prompt	ProjectOAuth2DiscordPrompt[]	não	Lista com no máximo um valor de prompt do OAuth2 do Discord. “none”: pula a tela de autorização para usuários que já autorizaram o app com os escopos pedidos. “consent”: pede que usuários que já autorizaram o app aprovem de novo. Envie uma lista vazia para usar o padrão do Discord. Valores: none, consent.
enabled	boolean	não	Status do método de login OAuth2. Use true para permitir criar sessões novas. Com true, as credenciais são validadas de ponta a ponta, e a chamada falha com erro se forem inválidas.

Acesso: chave de API com o escopo project.oauth2.write.

@owbase/node

import { Client, Project, ProjectOAuth2DiscordPrompt } 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 project = new Project(client);

const result = await project.updateOAuth2Discord({
    clientId: '<CLIENT_ID>', // opcional
    clientSecret: '<CLIENT_SECRET>', // opcional
    prompt: [ProjectOAuth2DiscordPrompt.None], // opcional
    enabled: false, // opcional
});

updateOAuth2Disqus

Atualizar OAuth2 Disqus do projeto

SDK: só @owbase/node

Atualiza a configuração OAuth2 Disqus do projeto.

Parâmetro	Tipo	Obrigatório	Descrição
publicKey	string	não	‘Public Key’ (também chamado de ‘API Key’) do app OAuth2 Disqus. Exemplo: cgegH70000000000000000000000000000000000000000000000000000Hr1nYX
secretKey	string	não	‘Secret Key’ (também chamado de ‘API Secret’) do app OAuth2 Disqus. Exemplo: W7Bykj00000000000000000000000000000000000000000000000000003o43w9
enabled	boolean	não	Status do método de login OAuth2. Use true para permitir criar sessões novas. Com true, as credenciais são validadas de ponta a ponta, e a chamada falha com erro se forem inválidas.

Acesso: chave de API com o escopo project.oauth2.write.

@owbase/node

import { Client, Project } 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 project = new Project(client);

const result = await project.updateOAuth2Disqus({
    publicKey: '<PUBLIC_KEY>', // opcional
    secretKey: '<SECRET_KEY>', // opcional
    enabled: false, // opcional
});

updateOAuth2Dropbox

Atualizar OAuth2 Dropbox do projeto

SDK: só @owbase/node

Atualiza a configuração OAuth2 Dropbox do projeto.

Parâmetro	Tipo	Obrigatório	Descrição
appKey	string	não	‘App Key’ do app OAuth2 Dropbox. Exemplo: jl000000000009t
appSecret	string	não	‘App Secret’ do app OAuth2 Dropbox. Exemplo: g200000000000vw
enabled	boolean	não	Status do método de login OAuth2. Use true para permitir criar sessões novas. Com true, as credenciais são validadas de ponta a ponta, e a chamada falha com erro se forem inválidas.

Acesso: chave de API com o escopo project.oauth2.write.

@owbase/node

import { Client, Project } 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 project = new Project(client);

const result = await project.updateOAuth2Dropbox({
    appKey: '<APP_KEY>', // opcional
    appSecret: '<APP_SECRET>', // opcional
    enabled: false, // opcional
});

updateOAuth2Etsy

Atualizar OAuth2 Etsy do projeto

SDK: só @owbase/node

Atualiza a configuração OAuth2 Etsy do projeto.

Parâmetro	Tipo	Obrigatório	Descrição
keyString	string	não	‘Keystring’ do app OAuth2 Etsy. Exemplo: nsgzxh0000000000008j85a2
sharedSecret	string	não	‘Shared Secret’ do app OAuth2 Etsy. Exemplo: tp000000ru
enabled	boolean	não	Status do método de login OAuth2. Use true para permitir criar sessões novas. Com true, as credenciais são validadas de ponta a ponta, e a chamada falha com erro se forem inválidas.

Acesso: chave de API com o escopo project.oauth2.write.

@owbase/node

import { Client, Project } 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 project = new Project(client);

const result = await project.updateOAuth2Etsy({
    keyString: '<KEY_STRING>', // opcional
    sharedSecret: '<SHARED_SECRET>', // opcional
    enabled: false, // opcional
});

updateOAuth2Facebook

Atualizar OAuth2 Facebook do projeto

SDK: só @owbase/node

Atualiza a configuração OAuth2 Facebook do projeto.

Parâmetro	Tipo	Obrigatório	Descrição
appId	string	não	‘App ID’ do app OAuth2 Facebook. Exemplo: 260600000007694
appSecret	string	não	‘App Secret’ do app OAuth2 Facebook. Exemplo: 2d0b2800000000000000000000d38af4
enabled	boolean	não	Status do método de login OAuth2. Use true para permitir criar sessões novas. Com true, as credenciais são validadas de ponta a ponta, e a chamada falha com erro se forem inválidas.

Acesso: chave de API com o escopo project.oauth2.write.

@owbase/node

import { Client, Project } 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 project = new Project(client);

const result = await project.updateOAuth2Facebook({
    appId: '<APP_ID>', // opcional
    appSecret: '<APP_SECRET>', // opcional
    enabled: false, // opcional
});

updateOAuth2Figma

Atualizar OAuth2 Figma do projeto

SDK: só @owbase/node

Atualiza a configuração OAuth2 Figma do projeto.

Parâmetro	Tipo	Obrigatório	Descrição
clientId	string	não	‘Client ID’ do app OAuth2 Figma. Exemplo: byay5H0000000000VtiI40
clientSecret	string	não	‘Client Secret’ do app OAuth2 Figma. Exemplo: yEpOYn0000000000000000004iIsU5
enabled	boolean	não	Status do método de login OAuth2. Use true para permitir criar sessões novas. Com true, as credenciais são validadas de ponta a ponta, e a chamada falha com erro se forem inválidas.

Acesso: chave de API com o escopo project.oauth2.write.

@owbase/node

import { Client, Project } 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 project = new Project(client);

const result = await project.updateOAuth2Figma({
    clientId: '<CLIENT_ID>', // opcional
    clientSecret: '<CLIENT_SECRET>', // opcional
    enabled: false, // opcional
});

updateOAuth2FusionAuth

Atualizar OAuth2 FusionAuth do projeto

SDK: só @owbase/node

Atualiza a configuração OAuth2 FusionAuth do projeto.

Parâmetro	Tipo	Obrigatório	Descrição
clientId	string	não	‘Client ID’ do app OAuth2 FusionAuth. Exemplo: b2222c00-0000-0000-0000-000000862097
clientSecret	string	não	‘Client Secret’ do app OAuth2 FusionAuth. Exemplo: Jx4s0C0000000000000000000000000000000wGqLsc
endpoint	string	não	Domínio da instância FusionAuth. Exemplo: example.fusionauth.io
enabled	boolean	não	Status do método de login OAuth2. Use true para permitir criar sessões novas. Com true, as credenciais são validadas de ponta a ponta, e a chamada falha com erro se forem inválidas.

Acesso: chave de API com o escopo project.oauth2.write.

@owbase/node

import { Client, Project } 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 project = new Project(client);

const result = await project.updateOAuth2FusionAuth({
    clientId: '<CLIENT_ID>', // opcional
    clientSecret: '<CLIENT_SECRET>', // opcional
    endpoint: '<ENDPOINT>', // opcional
    enabled: false, // opcional
});

updateOAuth2GitHub

Atualizar OAuth2 GitHub do projeto

SDK: só @owbase/node

Atualiza a configuração OAuth2 GitHub do projeto.

Parâmetro	Tipo	Obrigatório	Descrição
clientId	string	não	‘OAuth2 app Client ID’ ou ‘App ID’ do app OAuth2 GitHub. Exemplo: e4d87900000000540733. Exemplo de valor errado: 370006
clientSecret	string	não	‘Client Secret’ do app OAuth2 GitHub. Exemplo: 5e07c00000000000000000000000000000198bcc
prompt	ProjectOAuth2GitHubPrompt[]	não	Lista de valores de prompt do OAuth2 do GitHub. “select_account”: pede que o usuário escolha uma conta. Envie uma lista vazia para usar o padrão do GitHub. Valores: select_account.
enabled	boolean	não	Status do método de login OAuth2. Use true para permitir criar sessões novas. Com true, as credenciais são validadas de ponta a ponta, e a chamada falha com erro se forem inválidas.

Acesso: chave de API com o escopo project.oauth2.write.

@owbase/node

import { Client, Project, ProjectOAuth2GitHubPrompt } 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 project = new Project(client);

const result = await project.updateOAuth2GitHub({
    clientId: '<CLIENT_ID>', // opcional
    clientSecret: '<CLIENT_SECRET>', // opcional
    prompt: [ProjectOAuth2GitHubPrompt.SelectAccount], // opcional
    enabled: false, // opcional
});

updateOAuth2Gitlab

Atualizar OAuth2 Gitlab do projeto

SDK: só @owbase/node

Atualiza a configuração OAuth2 Gitlab do projeto.

Parâmetro	Tipo	Obrigatório	Descrição
applicationId	string	não	‘Application ID’ do app OAuth2 Gitlab. Exemplo: d41ffe0000000000000000000000000000000000000000000000000000d5e252
secret	string	não	‘Secret’ do app OAuth2 Gitlab. Exemplo: gloas-838cfa0000000000000000000000000000000000000000000000000000ecbb38
endpoint	string	não	URL do endpoint da instância GitLab auto-hospedada. Exemplo: https://gitlab.com
enabled	boolean	não	Status do método de login OAuth2. Use true para permitir criar sessões novas. Com true, as credenciais são validadas de ponta a ponta, e a chamada falha com erro se forem inválidas.

Acesso: chave de API com o escopo project.oauth2.write.

@owbase/node

import { Client, Project } 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 project = new Project(client);

const result = await project.updateOAuth2Gitlab({
    applicationId: '<APPLICATION_ID>', // opcional
    secret: '<SECRET>', // opcional
    endpoint: 'https://example.com', // opcional
    enabled: false, // opcional
});

updateOAuth2Google

Atualizar OAuth2 Google do projeto

SDK: só @owbase/node

Atualiza a configuração OAuth2 Google do projeto.

Parâmetro	Tipo	Obrigatório	Descrição
clientId	string	não	‘Client ID’ do app OAuth2 Google. Exemplo: 120000000095-92ifjb00000000000000000000g7ijfb.apps.googleusercontent.com
clientSecret	string	não	‘Client Secret’ do app OAuth2 Google. Exemplo: GOCSPX-2k8gsR0000000000000000VNahJj
prompt	ProjectOAuth2GooglePrompt[]	não	Lista de valores de prompt do OAuth2 do Google. Se “none” estiver na lista, precisa ser o único elemento. “none”: não mostra nenhuma tela de autenticação ou de consentimento. Não pode vir com outros valores. “consent”: pede o consentimento do usuário. “select_account”: pede que o usuário escolha uma conta. Valores: none, consent, select_account.
nativeClientIds	string[]	não	Client IDs OAuth2 adicionais aceitos como público (audience) do ID token no login nativo (client IDs de Android e iOS). Junto com o client ID, que é sempre aceito, são os únicos client IDs cujos tokens são aceitos. Envie uma lista vazia para limpar a lista.
enabled	boolean	não	Status do login OAuth2 pelo navegador. Use true para permitir criar sessões novas pelo fluxo de redirecionamento. Com true, as credenciais são validadas de ponta a ponta, e a chamada falha com erro se forem inválidas. Não afeta o login nativo, que é controlado só pelo nativeEnabled.
nativeEnabled	boolean	não	Status do login nativo com Google. É a única chave que liga a criação de sessões a partir de ID tokens obtidos no aparelho, e independe do enabled. Precisa de um client ID ou de pelo menos um client ID nativo para comparar com os tokens, mas não do client secret: este método confere uma assinatura em vez de trocar um código de autorização.

Acesso: chave de API com o escopo project.oauth2.write.

@owbase/node

import { Client, Project, ProjectOAuth2GooglePrompt } 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 project = new Project(client);

const result = await project.updateOAuth2Google({
    clientId: '<CLIENT_ID>', // opcional
    clientSecret: '<CLIENT_SECRET>', // opcional
    prompt: [ProjectOAuth2GooglePrompt.None], // opcional
    nativeClientIds: [], // opcional
    enabled: false, // opcional
    nativeEnabled: false, // opcional
});

updateOAuth2HuggingFace

Atualizar OAuth2 Hugging Face do projeto

SDK: só @owbase/node

Atualiza a configuração OAuth2 Hugging Face do projeto.

Parâmetro	Tipo	Obrigatório	Descrição
clientId	string	não	‘Client ID’ do app OAuth2 Hugging Face. Exemplo: 2ab9cff9-d711-40ad-a91e-b08a49c42d24
clientSecret	string	não	‘Client Secret’ do app OAuth2 Hugging Face. Exemplo: oauth_app_secret_wcLhRtl000000000000000000000xbNdLt
enabled	boolean	não	Status do método de login OAuth2. Use true para permitir criar sessões novas. Com true, as credenciais são validadas de ponta a ponta, e a chamada falha com erro se forem inválidas.

Acesso: chave de API com o escopo project.oauth2.write.

@owbase/node

import { Client, Project } 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 project = new Project(client);

const result = await project.updateOAuth2HuggingFace({
    clientId: '<CLIENT_ID>', // opcional
    clientSecret: '<CLIENT_SECRET>', // opcional
    enabled: false, // opcional
});

updateOAuth2Kakao

Atualizar OAuth2 Kakao do projeto

SDK: só @owbase/node

Atualiza a configuração OAuth2 Kakao do projeto.

Parâmetro	Tipo	Obrigatório	Descrição
clientId	string	não	‘REST API key’ do app OAuth2 Kakao. Exemplo: 839ff5000000000000000000013206de
clientSecret	string	não	‘Client Secret’ do app OAuth2 Kakao. Exemplo: jLNVOK00000000000000000000yJebea. Gere em Kakao Login > Security e deixe o status como ativado
prompt	ProjectOAuth2KakaoPrompt[]	não	Lista de valores de prompt do OAuth2 do Kakao. Se “none” estiver na lista, precisa ser o único elemento. “none”: não mostra nenhuma tela de autenticação ou de consentimento. “login”: pede que o usuário se autentique de novo. “create”: pede que o usuário se cadastre. “select_account”: pede que o usuário escolha uma conta. Envie uma lista vazia para usar o padrão do Kakao. Valores: none, login, create, select_account.
enabled	boolean	não	Status do método de login OAuth2. Use true para permitir criar sessões novas. Com true, as credenciais são validadas de ponta a ponta, e a chamada falha com erro se forem inválidas.

Acesso: chave de API com o escopo project.oauth2.write.

@owbase/node

import { Client, Project, ProjectOAuth2KakaoPrompt } 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 project = new Project(client);

const result = await project.updateOAuth2Kakao({
    clientId: '<CLIENT_ID>', // opcional
    clientSecret: '<CLIENT_SECRET>', // opcional
    prompt: [ProjectOAuth2KakaoPrompt.None], // opcional
    enabled: false, // opcional
});

updateOAuth2Keycloak

Atualizar OAuth2 Keycloak do projeto

SDK: só @owbase/node

Atualiza a configuração OAuth2 Keycloak do projeto.

Parâmetro	Tipo	Obrigatório	Descrição
clientId	string	não	‘Client ID’ do app OAuth2 Keycloak. Exemplo: owbase-o0000000st-app
clientSecret	string	não	‘Client Secret’ do app OAuth2 Keycloak. Exemplo: jdjrJd00000000000000000000HUsaZO
endpoint	string	não	Domínio da instância Keycloak. Exemplo: keycloak.example.com
realmName	string	não	Nome do realm do Keycloak. Exemplo: owbase-realm
enabled	boolean	não	Status do método de login OAuth2. Use true para permitir criar sessões novas. Com true, as credenciais são validadas de ponta a ponta, e a chamada falha com erro se forem inválidas.

Acesso: chave de API com o escopo project.oauth2.write.

@owbase/node

import { Client, Project } 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 project = new Project(client);

const result = await project.updateOAuth2Keycloak({
    clientId: '<CLIENT_ID>', // opcional
    clientSecret: '<CLIENT_SECRET>', // opcional
    endpoint: '<ENDPOINT>', // opcional
    realmName: '<REALM_NAME>', // opcional
    enabled: false, // opcional
});

updateOAuth2Kick

Atualizar OAuth2 Kick do projeto

SDK: só @owbase/node

Atualiza a configuração OAuth2 Kick do projeto.

Parâmetro	Tipo	Obrigatório	Descrição
clientId	string	não	‘Client ID’ do app OAuth2 Kick. Exemplo: 01KQ7C00000000000001MFHS32
clientSecret	string	não	‘Client Secret’ do app OAuth2 Kick. Exemplo: 34ac5600000000000000000000000000000000000000000000000000e830c8b
enabled	boolean	não	Status do método de login OAuth2. Use true para permitir criar sessões novas. Com true, as credenciais são validadas de ponta a ponta, e a chamada falha com erro se forem inválidas.

Acesso: chave de API com o escopo project.oauth2.write.

@owbase/node

import { Client, Project } 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 project = new Project(client);

const result = await project.updateOAuth2Kick({
    clientId: '<CLIENT_ID>', // opcional
    clientSecret: '<CLIENT_SECRET>', // opcional
    enabled: false, // opcional
});

updateOAuth2Linkedin

Atualizar OAuth2 Linkedin do projeto

SDK: só @owbase/node

Atualiza a configuração OAuth2 Linkedin do projeto.

Parâmetro	Tipo	Obrigatório	Descrição
clientId	string	não	‘Client ID’ do app OAuth2 Linkedin. Exemplo: 770000000000dv
primaryClientSecret	string	não	‘Primary Client Secret’ ou ‘Secondary Client Secret’ do app OAuth2 Linkedin. Exemplo: WPL_AP1.2Bf0000000000000./HtlYw==
enabled	boolean	não	Status do método de login OAuth2. Use true para permitir criar sessões novas. Com true, as credenciais são validadas de ponta a ponta, e a chamada falha com erro se forem inválidas.

Acesso: chave de API com o escopo project.oauth2.write.

@owbase/node

import { Client, Project } 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 project = new Project(client);

const result = await project.updateOAuth2Linkedin({
    clientId: '<CLIENT_ID>', // opcional
    primaryClientSecret: '<PRIMARY_CLIENT_SECRET>', // opcional
    enabled: false, // opcional
});

updateOAuth2Microsoft

Atualizar OAuth2 Microsoft do projeto

SDK: só @owbase/node

Atualiza a configuração OAuth2 Microsoft do projeto.

Parâmetro	Tipo	Obrigatório	Descrição
applicationId	string	não	‘Entra ID Application ID’ (também chamado de ‘Client ID’) do app OAuth2 Microsoft. Exemplo: 00001111-aaaa-2222-bbbb-3333cccc4444
applicationSecret	string	não	‘Entra ID Application Secret’ (também chamado de ‘Client Secret’) do app OAuth2 Microsoft. Exemplo: A1bC2dE3fH4iJ5kL6mN7oP8qR9sT0u
tenant	string	não	Identificador do tenant do Microsoft Entra ID. Use ‘common’, ‘organizations’, ‘consumers’ ou o ID de um tenant. Exemplo: common
prompt	ProjectOAuth2MicrosoftPrompt[]	não	Lista de valores de prompt do OAuth2 da Microsoft. “none”: não mostra nenhuma tela de autenticação ou de consentimento. “login”: pede que o usuário se autentique de novo. “consent”: pede o consentimento do usuário. “select_account”: pede que o usuário escolha uma conta. Envie uma lista vazia para usar o padrão da Microsoft. Valores: none, login, consent, select_account.
enabled	boolean	não	Status do método de login OAuth2. Use true para permitir criar sessões novas. Com true, as credenciais são validadas de ponta a ponta, e a chamada falha com erro se forem inválidas.

Acesso: chave de API com o escopo project.oauth2.write.

@owbase/node

import { Client, Project, ProjectOAuth2MicrosoftPrompt } 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 project = new Project(client);

const result = await project.updateOAuth2Microsoft({
    applicationId: '<APPLICATION_ID>', // opcional
    applicationSecret: '<APPLICATION_SECRET>', // opcional
    tenant: '<TENANT>', // opcional
    prompt: [ProjectOAuth2MicrosoftPrompt.None], // opcional
    enabled: false, // opcional
});

updateOAuth2Notion

Atualizar OAuth2 Notion do projeto

SDK: só @owbase/node

Atualiza a configuração OAuth2 Notion do projeto.

Parâmetro	Tipo	Obrigatório	Descrição
oauthClientId	string	não	‘OAuth Client ID’ do app OAuth2 Notion. Exemplo: 341d8700-0000-0000-0000-000000446ee3
oauthClientSecret	string	não	‘OAuth Client Secret’ do app OAuth2 Notion. Exemplo: secret_dLUr4b000000000000000000000000000000lFHAa9
enabled	boolean	não	Status do método de login OAuth2. Use true para permitir criar sessões novas. Com true, as credenciais são validadas de ponta a ponta, e a chamada falha com erro se forem inválidas.

Acesso: chave de API com o escopo project.oauth2.write.

@owbase/node

import { Client, Project } 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 project = new Project(client);

const result = await project.updateOAuth2Notion({
    oauthClientId: '<OAUTH_CLIENT_ID>', // opcional
    oauthClientSecret: '<OAUTH_CLIENT_SECRET>', // opcional
    enabled: false, // opcional
});

updateOAuth2Oidc

Atualizar OAuth2 Oidc do projeto

SDK: só @owbase/node

Atualiza a configuração OAuth2 Oidc do projeto.

Parâmetro	Tipo	Obrigatório	Descrição
clientId	string	não	‘Client ID’ do app OAuth2 Oidc. Exemplo: qibI2x0000000000000000000000000006L2YFoG
clientSecret	string	não	‘Client Secret’ do app OAuth2 Oidc. Exemplo: Ah68ed000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000003qpcHV
wellKnownURL	string	não	URL da configuração well-known do OpenID Connect. Quando informada, os endpoints de autorização, de token e de informações do usuário são descobertos automaticamente. Exemplo: https://myoauth.com/.well-known/openid-configuration
authorizationURL	string	não	URL do endpoint de autorização do OpenID Connect. Obrigatória quando o wellKnownURL não é informado. Exemplo: https://myoauth.com/oauth2/authorize
tokenURL	string	não	URL do endpoint de token do OpenID Connect. Obrigatória quando o wellKnownURL não é informado. Exemplo: https://myoauth.com/oauth2/token
userInfoURL	string	não	URL do endpoint de informações do usuário (user info) do OpenID Connect. Obrigatória quando o wellKnownURL não é informado. Exemplo: https://myoauth.com/oauth2/userinfo
prompt	ProjectOAuth2OidcPrompt[]	não	Lista de valores de prompt do OpenID Connect, que controlam as telas de autenticação e de consentimento. Se “none” estiver na lista, precisa ser o único elemento. “none”: não mostra nenhuma tela de autenticação ou de consentimento. “login”: pede que o usuário se autentique de novo. “consent”: pede o consentimento do usuário. “select_account”: pede que o usuário escolha uma conta. Valores: none, login, consent, select_account.
maxAge	number	não	Idade máxima da autenticação, em segundos. Quando definida, o usuário precisa ter se autenticado dentro desse número de segundos; senão, é pedido que se autentique de novo.
enabled	boolean	não	Status do método de login OAuth2. Use true para permitir criar sessões novas. Com true, as credenciais são validadas de ponta a ponta, e a chamada falha com erro se forem inválidas.

Acesso: chave de API com o escopo project.oauth2.write.

@owbase/node

import { Client, Project, ProjectOAuth2OidcPrompt } 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 project = new Project(client);

const result = await project.updateOAuth2Oidc({
    clientId: '<CLIENT_ID>', // opcional
    clientSecret: '<CLIENT_SECRET>', // opcional
    wellKnownURL: 'https://example.com', // opcional
    authorizationURL: 'https://example.com', // opcional
    tokenURL: 'https://example.com', // opcional
    userInfoURL: 'https://example.com', // opcional
    prompt: [ProjectOAuth2OidcPrompt.None], // opcional
    maxAge: 0, // opcional
    enabled: false, // opcional
});

updateOAuth2Okta

Atualizar OAuth2 Okta do projeto

SDK: só @owbase/node

Atualiza a configuração OAuth2 Okta do projeto.

Parâmetro	Tipo	Obrigatório	Descrição
clientId	string	não	‘Client ID’ do app OAuth2 Okta. Exemplo: 0oa00000000000000698
clientSecret	string	não	‘Client Secret’ do app OAuth2 Okta. Exemplo: Kiq0000000000000000000000000000000000000-00000000000H2L5-3SJ-vRV
domain	string	não	Domínio da empresa no Okta. Obrigatório para ligar o provedor. Exemplo: trial-6400025.okta.com. Exemplo de valor errado: trial-6400025-admin.okta.com, ou https://trial-6400025.okta.com/
authorizationServerId	string	não	Servidores de autorização próprios (Custom Authorization Servers). Opcional: pode ficar vazio ou sem configuração. Exemplo: aus000000000000000h7z
prompt	ProjectOAuth2OktaPrompt[]	não	Lista de valores de prompt do OAuth2 do Okta. Se “none” estiver na lista, precisa ser o único elemento. “none”: não mostra nenhuma tela de autenticação ou de consentimento. “login”: pede que o usuário se autentique de novo. “consent”: pede o consentimento do usuário. Envie uma lista vazia para usar o padrão do Okta. Valores: none, login, consent.
enabled	boolean	não	Status do método de login OAuth2. Use true para permitir criar sessões novas. Com true, as credenciais são validadas de ponta a ponta, e a chamada falha com erro se forem inválidas.

Acesso: chave de API com o escopo project.oauth2.write.

@owbase/node

import { Client, Project, ProjectOAuth2OktaPrompt } 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 project = new Project(client);

const result = await project.updateOAuth2Okta({
    clientId: '<CLIENT_ID>', // opcional
    clientSecret: '<CLIENT_SECRET>', // opcional
    domain: 'example.com', // opcional
    authorizationServerId: '<AUTHORIZATION_SERVER_ID>', // opcional
    prompt: [ProjectOAuth2OktaPrompt.None], // opcional
    enabled: false, // opcional
});

updateOAuth2Paypal

Atualizar OAuth2 Paypal do projeto

SDK: só @owbase/node

Atualiza a configuração OAuth2 Paypal do projeto.

Parâmetro	Tipo	Obrigatório	Descrição
clientId	string	não	‘Client ID’ do app OAuth2 Paypal. Exemplo: AdhIEG7-000000000000-0000000000000000000000000000000-0000000000000000000000-2pyB
secretKey	string	não	‘Secret Key 1’ ou ‘Secret Key 2’ do app OAuth2 Paypal. Exemplo: EH8KCXtew–000000000000000000000000000000000000000_C-1_5UP_000000000000000CB7KDp
enabled	boolean	não	Status do método de login OAuth2. Use true para permitir criar sessões novas. Com true, as credenciais são validadas de ponta a ponta, e a chamada falha com erro se forem inválidas.

Acesso: chave de API com o escopo project.oauth2.write.

@owbase/node

import { Client, Project } 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 project = new Project(client);

const result = await project.updateOAuth2Paypal({
    clientId: '<CLIENT_ID>', // opcional
    secretKey: '<SECRET_KEY>', // opcional
    enabled: false, // opcional
});

updateOAuth2PaypalSandbox

Atualizar OAuth2 PaypalSandbox do projeto

SDK: só @owbase/node

Atualiza a configuração OAuth2 PaypalSandbox do projeto.

Parâmetro	Tipo	Obrigatório	Descrição
clientId	string	não	‘Client ID’ do app OAuth2 PaypalSandbox. Exemplo: AdhIEG7-000000000000-0000000000000000000000000000000-0000000000000000000000-2pyB
secretKey	string	não	‘Secret Key 1’ ou ‘Secret Key 2’ do app OAuth2 PaypalSandbox. Exemplo: EH8KCXtew–000000000000000000000000000000000000000_C-1_5UP_000000000000000CB7KDp
enabled	boolean	não	Status do método de login OAuth2. Use true para permitir criar sessões novas. Com true, as credenciais são validadas de ponta a ponta, e a chamada falha com erro se forem inválidas.

Acesso: chave de API com o escopo project.oauth2.write.

@owbase/node

import { Client, Project } 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 project = new Project(client);

const result = await project.updateOAuth2PaypalSandbox({
    clientId: '<CLIENT_ID>', // opcional
    secretKey: '<SECRET_KEY>', // opcional
    enabled: false, // opcional
});

updateOAuth2Podio

Atualizar OAuth2 Podio do projeto

SDK: só @owbase/node

Atualiza a configuração OAuth2 Podio do projeto.

Parâmetro	Tipo	Obrigatório	Descrição
clientId	string	não	‘Client ID’ do app OAuth2 Podio. Exemplo: owbase-o0000000st-app
clientSecret	string	não	‘Client Secret’ do app OAuth2 Podio. Exemplo: Rn247T0000000000000000000000000000000000000000000000000000W2zWTN
enabled	boolean	não	Status do método de login OAuth2. Use true para permitir criar sessões novas. Com true, as credenciais são validadas de ponta a ponta, e a chamada falha com erro se forem inválidas.

Acesso: chave de API com o escopo project.oauth2.write.

@owbase/node

import { Client, Project } 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 project = new Project(client);

const result = await project.updateOAuth2Podio({
    clientId: '<CLIENT_ID>', // opcional
    clientSecret: '<CLIENT_SECRET>', // opcional
    enabled: false, // opcional
});

updateOAuth2Resend

Atualizar OAuth2 Resend do projeto

SDK: só @owbase/node

Atualiza a configuração OAuth2 Resend do projeto.

Parâmetro	Tipo	Obrigatório	Descrição
clientId	string	não	‘Client ID’ do app OAuth2 Resend. Exemplo: f47ac10b-58cc-4372-a567-0e02b2c3d479
clientSecret	string	não	‘Client Secret’ do app OAuth2 Resend. Exemplo: 9c1e4b00000000000000000000000000000000000000000000000000a72d5f4
enabled	boolean	não	Status do método de login OAuth2. Use true para permitir criar sessões novas. Com true, as credenciais são validadas de ponta a ponta, e a chamada falha com erro se forem inválidas.

Acesso: chave de API com o escopo project.oauth2.write.

@owbase/node

import { Client, Project } 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 project = new Project(client);

const result = await project.updateOAuth2Resend({
    clientId: '<CLIENT_ID>', // opcional
    clientSecret: '<CLIENT_SECRET>', // opcional
    enabled: false, // opcional
});

updateOAuth2Salesforce

Atualizar OAuth2 Salesforce do projeto

SDK: só @owbase/node

Atualiza a configuração OAuth2 Salesforce do projeto.

Parâmetro	Tipo	Obrigatório	Descrição
customerKey	string	não	‘Consumer Key’ do app OAuth2 Salesforce. Exemplo: 3MVG9I0000000000000000000000000000000000000000000000000000000000000000000000000C5Aejq
customerSecret	string	não	‘Consumer Secret’ do app OAuth2 Salesforce. Exemplo: 3w000000000000e2
prompt	ProjectOAuth2SalesforcePrompt[]	não	Lista de valores de prompt do OAuth2 do Salesforce. “login”: pede que o usuário se autentique de novo. “consent”: pede o consentimento do usuário. Envie uma lista vazia para usar o padrão do Salesforce. Valores: login, consent.
enabled	boolean	não	Status do método de login OAuth2. Use true para permitir criar sessões novas. Com true, as credenciais são validadas de ponta a ponta, e a chamada falha com erro se forem inválidas.

Acesso: chave de API com o escopo project.oauth2.write.

@owbase/node

import { Client, Project, ProjectOAuth2SalesforcePrompt } 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 project = new Project(client);

const result = await project.updateOAuth2Salesforce({
    customerKey: '<CUSTOMER_KEY>', // opcional
    customerSecret: '<CUSTOMER_SECRET>', // opcional
    prompt: [ProjectOAuth2SalesforcePrompt.Login], // opcional
    enabled: false, // opcional
});

updateOAuth2Slack

Atualizar OAuth2 Slack do projeto

SDK: só @owbase/node

Atualiza a configuração OAuth2 Slack do projeto.

Parâmetro	Tipo	Obrigatório	Descrição
clientId	string	não	‘Client ID’ do app OAuth2 Slack. Exemplo: 23000000089.15000000000023
clientSecret	string	não	‘Client Secret’ do app OAuth2 Slack. Exemplo: 81656000000000000000000000f3d2fd
enabled	boolean	não	Status do método de login OAuth2. Use true para permitir criar sessões novas. Com true, as credenciais são validadas de ponta a ponta, e a chamada falha com erro se forem inválidas.

Acesso: chave de API com o escopo project.oauth2.write.

@owbase/node

import { Client, Project } 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 project = new Project(client);

const result = await project.updateOAuth2Slack({
    clientId: '<CLIENT_ID>', // opcional
    clientSecret: '<CLIENT_SECRET>', // opcional
    enabled: false, // opcional
});

updateOAuth2Spotify

Atualizar OAuth2 Spotify do projeto

SDK: só @owbase/node

Atualiza a configuração OAuth2 Spotify do projeto.

Parâmetro	Tipo	Obrigatório	Descrição
clientId	string	não	‘Client ID’ do app OAuth2 Spotify. Exemplo: 6ec271000000000000000000009beace
clientSecret	string	não	‘Client Secret’ do app OAuth2 Spotify. Exemplo: db068a000000000000000000008b5b9f
enabled	boolean	não	Status do método de login OAuth2. Use true para permitir criar sessões novas. Com true, as credenciais são validadas de ponta a ponta, e a chamada falha com erro se forem inválidas.

Acesso: chave de API com o escopo project.oauth2.write.

@owbase/node

import { Client, Project } 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 project = new Project(client);

const result = await project.updateOAuth2Spotify({
    clientId: '<CLIENT_ID>', // opcional
    clientSecret: '<CLIENT_SECRET>', // opcional
    enabled: false, // opcional
});

updateOAuth2Stripe

Atualizar OAuth2 Stripe do projeto

SDK: só @owbase/node

Atualiza a configuração OAuth2 Stripe do projeto.

Parâmetro	Tipo	Obrigatório	Descrição
clientId	string	não	‘Client ID’ do app OAuth2 Stripe. Exemplo: ca_UKibXX0000000000000000000006byvR
apiSecretKey	string	não	‘API Secret Key’ do app OAuth2 Stripe. Exemplo: sk_51SfOd000000000000000000000000000000000000000000000000000000000000000000000000000000000000000QGWYfp
enabled	boolean	não	Status do método de login OAuth2. Use true para permitir criar sessões novas. Com true, as credenciais são validadas de ponta a ponta, e a chamada falha com erro se forem inválidas.

Acesso: chave de API com o escopo project.oauth2.write.

@owbase/node

import { Client, Project } 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 project = new Project(client);

const result = await project.updateOAuth2Stripe({
    clientId: '<CLIENT_ID>', // opcional
    apiSecretKey: '<API_SECRET_KEY>', // opcional
    enabled: false, // opcional
});

updateOAuth2TikTok

Atualizar OAuth2 TikTok do projeto

SDK: só @owbase/node

Atualiza a configuração OAuth2 TikTok do projeto.

Parâmetro	Tipo	Obrigatório	Descrição
clientId	string	não	‘Client key’ do app OAuth2 TikTok. Exemplo: awz000000000tyw0
clientSecret	string	não	‘Client secret’ do app OAuth2 TikTok. Exemplo: 6wXewM00000000000000000000yXnite
enabled	boolean	não	Status do método de login OAuth2. Use true para permitir criar sessões novas. Com true, as credenciais são validadas de ponta a ponta, e a chamada falha com erro se forem inválidas.

Acesso: chave de API com o escopo project.oauth2.write.

@owbase/node

import { Client, Project } 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 project = new Project(client);

const result = await project.updateOAuth2TikTok({
    clientId: '<CLIENT_ID>', // opcional
    clientSecret: '<CLIENT_SECRET>', // opcional
    enabled: false, // opcional
});

updateOAuth2Tradeshift

Atualizar OAuth2 Tradeshift do projeto

SDK: só @owbase/node

Atualiza a configuração OAuth2 Tradeshift do projeto.

Parâmetro	Tipo	Obrigatório	Descrição
oauth2ClientId	string	não	‘OAuth2 Client ID’ do app OAuth2 Tradeshift. Exemplo: owbase-tes00000.0000000000est-app
oauth2ClientSecret	string	não	‘OAuth2 Client Secret’ do app OAuth2 Tradeshift. Exemplo: 7cb52700-0000-0000-0000-000000ca5b83
enabled	boolean	não	Status do método de login OAuth2. Use true para permitir criar sessões novas. Com true, as credenciais são validadas de ponta a ponta, e a chamada falha com erro se forem inválidas.

Acesso: chave de API com o escopo project.oauth2.write.

@owbase/node

import { Client, Project } 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 project = new Project(client);

const result = await project.updateOAuth2Tradeshift({
    oauth2ClientId: '<OAUTH2_CLIENT_ID>', // opcional
    oauth2ClientSecret: '<OAUTH2_CLIENT_SECRET>', // opcional
    enabled: false, // opcional
});

updateOAuth2TradeshiftSandbox

Atualizar OAuth2 Tradeshift Sandbox do projeto

SDK: só @owbase/node

Atualiza a configuração OAuth2 Tradeshift Sandbox do projeto.

Parâmetro	Tipo	Obrigatório	Descrição
oauth2ClientId	string	não	‘OAuth2 Client ID’ do app OAuth2 Tradeshift Sandbox. Exemplo: owbase-tes00000.0000000000est-app
oauth2ClientSecret	string	não	‘OAuth2 Client Secret’ do app OAuth2 Tradeshift Sandbox. Exemplo: 7cb52700-0000-0000-0000-000000ca5b83
enabled	boolean	não	Status do método de login OAuth2. Use true para permitir criar sessões novas. Com true, as credenciais são validadas de ponta a ponta, e a chamada falha com erro se forem inválidas.

Acesso: chave de API com o escopo project.oauth2.write.

@owbase/node

import { Client, Project } 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 project = new Project(client);

const result = await project.updateOAuth2TradeshiftSandbox({
    oauth2ClientId: '<OAUTH2_CLIENT_ID>', // opcional
    oauth2ClientSecret: '<OAUTH2_CLIENT_SECRET>', // opcional
    enabled: false, // opcional
});

updateOAuth2Twitch

Atualizar OAuth2 Twitch do projeto

SDK: só @owbase/node

Atualiza a configuração OAuth2 Twitch do projeto.

Parâmetro	Tipo	Obrigatório	Descrição
clientId	string	não	‘Client ID’ do app OAuth2 Twitch. Exemplo: vvi0in000000000000000000ikmt9p
clientSecret	string	não	‘Client Secret’ do app OAuth2 Twitch. Exemplo: pmapue000000000000000000zylw3v
enabled	boolean	não	Status do método de login OAuth2. Use true para permitir criar sessões novas. Com true, as credenciais são validadas de ponta a ponta, e a chamada falha com erro se forem inválidas.

Acesso: chave de API com o escopo project.oauth2.write.

@owbase/node

import { Client, Project } 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 project = new Project(client);

const result = await project.updateOAuth2Twitch({
    clientId: '<CLIENT_ID>', // opcional
    clientSecret: '<CLIENT_SECRET>', // opcional
    enabled: false, // opcional
});

updateOAuth2Webflow

Atualizar OAuth2 Webflow do projeto

SDK: só @owbase/node

Atualiza a configuração OAuth2 Webflow do projeto.

Parâmetro	Tipo	Obrigatório	Descrição
clientId	string	não	‘Client ID’ do app OAuth2 Webflow. Exemplo: 8bb20000000000000000000000000000000000000000000000000000000040dd
clientSecret	string	não	‘Client Secret’ do app OAuth2 Webflow. Exemplo: 59bf00000000000000000000000000000000000000000000000000000000fe59
enabled	boolean	não	Status do método de login OAuth2. Use true para permitir criar sessões novas. Com true, as credenciais são validadas de ponta a ponta, e a chamada falha com erro se forem inválidas.

Acesso: chave de API com o escopo project.oauth2.write.

@owbase/node

import { Client, Project } 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 project = new Project(client);

const result = await project.updateOAuth2Webflow({
    clientId: '<CLIENT_ID>', // opcional
    clientSecret: '<CLIENT_SECRET>', // opcional
    enabled: false, // opcional
});

updateOAuth2WordPress

Atualizar OAuth2 WordPress do projeto

SDK: só @owbase/node

Atualiza a configuração OAuth2 WordPress do projeto.

Parâmetro	Tipo	Obrigatório	Descrição
clientId	string	não	‘Client ID’ do app OAuth2 WordPress. Exemplo: 130005
clientSecret	string	não	‘Client Secret’ do app OAuth2 WordPress. Exemplo: PlBfJS0000000000000000000000000000000000000000000000000000EdUZJk
enabled	boolean	não	Status do método de login OAuth2. Use true para permitir criar sessões novas. Com true, as credenciais são validadas de ponta a ponta, e a chamada falha com erro se forem inválidas.

Acesso: chave de API com o escopo project.oauth2.write.

@owbase/node

import { Client, Project } 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 project = new Project(client);

const result = await project.updateOAuth2WordPress({
    clientId: '<CLIENT_ID>', // opcional
    clientSecret: '<CLIENT_SECRET>', // opcional
    enabled: false, // opcional
});

updateOAuth2X

Atualizar OAuth2 X do projeto

SDK: só @owbase/node

Atualiza a configuração OAuth2 X do projeto.

Parâmetro	Tipo	Obrigatório	Descrição
customerKey	string	não	‘Customer Key’ do app OAuth2 X. Exemplo: slzZV0000000000000NFLaWT
secretKey	string	não	‘Secret Key’ do app OAuth2 X. Exemplo: tkEPkp00000000000000000000000000000000000000FTxbI9
enabled	boolean	não	Status do método de login OAuth2. Use true para permitir criar sessões novas. Com true, as credenciais são validadas de ponta a ponta, e a chamada falha com erro se forem inválidas.

Acesso: chave de API com o escopo project.oauth2.write.

@owbase/node

import { Client, Project } 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 project = new Project(client);

const result = await project.updateOAuth2X({
    customerKey: '<CUSTOMER_KEY>', // opcional
    secretKey: '<SECRET_KEY>', // opcional
    enabled: false, // opcional
});

updateOAuth2Yahoo

Atualizar OAuth2 Yahoo do projeto

SDK: só @owbase/node

Atualiza a configuração OAuth2 Yahoo do projeto.

Parâmetro	Tipo	Obrigatório	Descrição
clientId	string	não	‘Client ID’ (também chamado de ‘Customer Key’) do app OAuth2 Yahoo. Exemplo: dj0yJm000000000000000000000000000000000000000000000000000000000000000000000000000000000000Z4PWRm
clientSecret	string	não	‘Client Secret’ (também chamado de ‘Customer Secret’) do app OAuth2 Yahoo. Exemplo: cf978f0000000000000000000000000000c5e2e9
enabled	boolean	não	Status do método de login OAuth2. Use true para permitir criar sessões novas. Com true, as credenciais são validadas de ponta a ponta, e a chamada falha com erro se forem inválidas.

Acesso: chave de API com o escopo project.oauth2.write.

@owbase/node

import { Client, Project } 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 project = new Project(client);

const result = await project.updateOAuth2Yahoo({
    clientId: '<CLIENT_ID>', // opcional
    clientSecret: '<CLIENT_SECRET>', // opcional
    enabled: false, // opcional
});

updateOAuth2Yandex

Atualizar OAuth2 Yandex do projeto

SDK: só @owbase/node

Atualiza a configuração OAuth2 Yandex do projeto.

Parâmetro	Tipo	Obrigatório	Descrição
clientId	string	não	‘Client ID’ do app OAuth2 Yandex. Exemplo: 6a8a6a0000000000000000000091483c
clientSecret	string	não	‘Client Secret’ do app OAuth2 Yandex. Exemplo: bbf98500000000000000000000c75a63
enabled	boolean	não	Status do método de login OAuth2. Use true para permitir criar sessões novas. Com true, as credenciais são validadas de ponta a ponta, e a chamada falha com erro se forem inválidas.

Acesso: chave de API com o escopo project.oauth2.write.

@owbase/node

import { Client, Project } 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 project = new Project(client);

const result = await project.updateOAuth2Yandex({
    clientId: '<CLIENT_ID>', // opcional
    clientSecret: '<CLIENT_SECRET>', // opcional
    enabled: false, // opcional
});

updateOAuth2Zoho

Atualizar OAuth2 Zoho do projeto

SDK: só @owbase/node

Atualiza a configuração OAuth2 Zoho do projeto.

Parâmetro	Tipo	Obrigatório	Descrição
clientId	string	não	‘Client ID’ do app OAuth2 Zoho. Exemplo: 1000.83C178000000000000000000RPNX0B
clientSecret	string	não	‘Client Secret’ do app OAuth2 Zoho. Exemplo: fb5cac000000000000000000000000000000a68f6e
prompt	ProjectOAuth2ZohoPrompt[]	não	Lista de valores de prompt do OAuth2 do Zoho. “consent”: pede o consentimento do usuário. Envie uma lista vazia para usar o padrão do Zoho. Valores: consent.
enabled	boolean	não	Status do método de login OAuth2. Use true para permitir criar sessões novas. Com true, as credenciais são validadas de ponta a ponta, e a chamada falha com erro se forem inválidas.

Acesso: chave de API com o escopo project.oauth2.write.

@owbase/node

import { Client, Project, ProjectOAuth2ZohoPrompt } 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 project = new Project(client);

const result = await project.updateOAuth2Zoho({
    clientId: '<CLIENT_ID>', // opcional
    clientSecret: '<CLIENT_SECRET>', // opcional
    prompt: [ProjectOAuth2ZohoPrompt.Consent], // opcional
    enabled: false, // opcional
});

updateOAuth2Zoom

Atualizar OAuth2 Zoom do projeto

SDK: só @owbase/node

Atualiza a configuração OAuth2 Zoom do projeto.

Parâmetro	Tipo	Obrigatório	Descrição
clientId	string	não	‘Client ID’ do app OAuth2 Zoom. Exemplo: QMAC00000000000000w0AQ
clientSecret	string	não	‘Client Secret’ do app OAuth2 Zoom. Exemplo: GAWsG4000000000000000000007U01ON
enabled	boolean	não	Status do método de login OAuth2. Use true para permitir criar sessões novas. Com true, as credenciais são validadas de ponta a ponta, e a chamada falha com erro se forem inválidas.

Acesso: chave de API com o escopo project.oauth2.write.

@owbase/node

import { Client, Project } 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 project = new Project(client);

const result = await project.updateOAuth2Zoom({
    clientId: '<CLIENT_ID>', // opcional
    clientSecret: '<CLIENT_SECRET>', // opcional
    enabled: false, // opcional
});

getOAuth2Provider

Obter provedor OAuth2 do projeto

SDK: só @owbase/node

Obtém a configuração de um provedor OAuth2. Os campos de credencial (client secret, arquivo p8, IDs de chave e de time) são só de escrita e sempre voltam vazios.

Parâmetro	Tipo	Obrigatório	Descrição
providerId	ProjectOAuthProviderId	sim	Chave do provedor OAuth2. Por exemplo: github, google, apple. Valores: amazon, apple, auth0, authentik, autodesk, bitbucket, bitly, box, cloudflare, dailymotion, discord, disqus, dropbox, etsy, facebook, figma, fusionauth, github, gitlab, google, huggingface, kakao, keycloak, kick, linkedin, microsoft, notion, oidc, okta, paypal, paypalSandbox, podio, resend, salesforce, slack, spotify, stripe, tiktok, tradeshift, tradeshiftBox, twitch, webflow, wordpress, x, yahoo, yammer, yandex, zoho, zoom.

Acesso: chave de API com o escopo project.oauth2.read.

@owbase/node

import { Client, Project, ProjectOAuthProviderId } 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 project = new Project(client);

const result = await project.getOAuth2Provider({
    providerId: ProjectOAuthProviderId.Amazon,
});

listPlatforms

Listar plataformas do projeto

SDK: só @owbase/node

Obtém a lista de todas as plataformas do projeto. Este endpoint devolve uma lista com todas as plataformas e as configurações delas.

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: type, name, hostname, bundleIdentifier, applicationId, packageIdentifierName, packageName
total	boolean	não	Com false, o total não é calculado e volta como 0.

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

@owbase/node

import { Client, Project } 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 project = new Project(client);

const result = await project.listPlatforms({
    queries: [], // opcional
    total: false, // opcional
});

createAndroidPlatform

Criar plataforma Android do projeto

SDK: só @owbase/node

Cria uma plataforma Android no projeto. Use este endpoint para cadastrar uma plataforma Android onde os seus usuários vão rodar o app que fala com a API do Owbase.

Parâmetro	Tipo	Obrigatório	Descrição
platformId	string	sim	ID da plataforma. 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.
name	string	sim	Nome da plataforma. Tamanho máximo: 128 caracteres.
applicationId	string	sim	ID do app Android. Tamanho máximo: 256 caracteres.

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

@owbase/node

import { Client, Project } 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 project = new Project(client);

const result = await project.createAndroidPlatform({
    platformId: '<PLATFORM_ID>',
    name: '<NAME>',
    applicationId: '<APPLICATION_ID>',
});

updateAndroidPlatform

Atualizar plataforma Android do projeto

SDK: só @owbase/node

Atualiza uma plataforma Android pelo ID. Use este endpoint para atualizar o nome ou o ID do app da plataforma.

Parâmetro	Tipo	Obrigatório	Descrição
platformId	string	sim	ID da plataforma.
name	string	sim	Nome da plataforma. Tamanho máximo: 128 caracteres.
applicationId	string	sim	ID do app Android. Tamanho máximo: 256 caracteres.

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

@owbase/node

import { Client, Project } 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 project = new Project(client);

const result = await project.updateAndroidPlatform({
    platformId: '<PLATFORM_ID>',
    name: '<NAME>',
    applicationId: '<APPLICATION_ID>',
});

createApplePlatform

Criar plataforma Apple do projeto

SDK: só @owbase/node

Cria uma plataforma Apple no projeto. Use este endpoint para cadastrar uma plataforma Apple onde os seus usuários vão rodar o app que fala com a API do Owbase.

Parâmetro	Tipo	Obrigatório	Descrição
platformId	string	sim	ID da plataforma. 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.
name	string	sim	Nome da plataforma. Tamanho máximo: 128 caracteres.
bundleIdentifier	string	sim	Bundle identifier da Apple. Tamanho máximo: 256 caracteres.

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

@owbase/node

import { Client, Project } 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 project = new Project(client);

const result = await project.createApplePlatform({
    platformId: '<PLATFORM_ID>',
    name: '<NAME>',
    bundleIdentifier: '<BUNDLE_IDENTIFIER>',
});

updateApplePlatform

Atualizar plataforma Apple do projeto

SDK: só @owbase/node

Atualiza uma plataforma Apple pelo ID. Use este endpoint para atualizar o nome ou o bundle identifier da plataforma.

Parâmetro	Tipo	Obrigatório	Descrição
platformId	string	sim	ID da plataforma.
name	string	sim	Nome da plataforma. Tamanho máximo: 128 caracteres.
bundleIdentifier	string	sim	Bundle identifier da Apple. Tamanho máximo: 256 caracteres.

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

@owbase/node

import { Client, Project } 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 project = new Project(client);

const result = await project.updateApplePlatform({
    platformId: '<PLATFORM_ID>',
    name: '<NAME>',
    bundleIdentifier: '<BUNDLE_IDENTIFIER>',
});

createLinuxPlatform

Criar plataforma Linux do projeto

SDK: só @owbase/node

Cria uma plataforma Linux no projeto. Use este endpoint para cadastrar uma plataforma Linux onde os seus usuários vão rodar o app que fala com a API do Owbase.

Parâmetro	Tipo	Obrigatório	Descrição
platformId	string	sim	ID da plataforma. 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.
name	string	sim	Nome da plataforma. Tamanho máximo: 128 caracteres.
packageName	string	sim	Nome do pacote Linux. Tamanho máximo: 256 caracteres.

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

@owbase/node

import { Client, Project } 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 project = new Project(client);

const result = await project.createLinuxPlatform({
    platformId: '<PLATFORM_ID>',
    name: '<NAME>',
    packageName: '<PACKAGE_NAME>',
});

updateLinuxPlatform

Atualizar plataforma Linux do projeto

SDK: só @owbase/node

Atualiza uma plataforma Linux pelo ID. Use este endpoint para atualizar o nome ou o nome do pacote da plataforma.

Parâmetro	Tipo	Obrigatório	Descrição
platformId	string	sim	ID da plataforma.
name	string	sim	Nome da plataforma. Tamanho máximo: 128 caracteres.
packageName	string	sim	Nome do pacote Linux. Tamanho máximo: 256 caracteres.

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

@owbase/node

import { Client, Project } 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 project = new Project(client);

const result = await project.updateLinuxPlatform({
    platformId: '<PLATFORM_ID>',
    name: '<NAME>',
    packageName: '<PACKAGE_NAME>',
});

createWebPlatform

Criar plataforma web do projeto

SDK: só @owbase/node

Cria uma plataforma web no projeto. Use este endpoint para cadastrar uma plataforma onde os seus usuários vão rodar o app que fala com a API do Owbase.

Parâmetro	Tipo	Obrigatório	Descrição
platformId	string	sim	ID da plataforma. 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.
name	string	sim	Nome da plataforma. Tamanho máximo: 128 caracteres.
hostname	string	sim	Hostname web da plataforma. Tamanho máximo: 256 caracteres.

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

@owbase/node

import { Client, Project } 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 project = new Project(client);

const result = await project.createWebPlatform({
    platformId: '<PLATFORM_ID>',
    name: '<NAME>',
    hostname: 'app.example.com',
});

updateWebPlatform

Atualizar plataforma web do projeto

SDK: só @owbase/node

Atualiza uma plataforma web pelo ID. Use este endpoint para atualizar o nome ou o hostname da plataforma.

Parâmetro	Tipo	Obrigatório	Descrição
platformId	string	sim	ID da plataforma.
name	string	sim	Nome da plataforma. Tamanho máximo: 128 caracteres.
hostname	string	sim	Hostname web da plataforma. Tamanho máximo: 256 caracteres.

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

@owbase/node

import { Client, Project } 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 project = new Project(client);

const result = await project.updateWebPlatform({
    platformId: '<PLATFORM_ID>',
    name: '<NAME>',
    hostname: 'app.example.com',
});

createWindowsPlatform

Criar plataforma Windows do projeto

SDK: só @owbase/node

Cria uma plataforma Windows no projeto. Use este endpoint para cadastrar uma plataforma Windows onde os seus usuários vão rodar o app que fala com a API do Owbase.

Parâmetro	Tipo	Obrigatório	Descrição
platformId	string	sim	ID da plataforma. 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.
name	string	sim	Nome da plataforma. Tamanho máximo: 128 caracteres.
packageIdentifierName	string	sim	Nome do identificador de pacote do Windows. Tamanho máximo: 256 caracteres.

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

@owbase/node

import { Client, Project } 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 project = new Project(client);

const result = await project.createWindowsPlatform({
    platformId: '<PLATFORM_ID>',
    name: '<NAME>',
    packageIdentifierName: '<PACKAGE_IDENTIFIER_NAME>',
});

updateWindowsPlatform

Atualizar plataforma Windows do projeto

SDK: só @owbase/node

Atualiza uma plataforma Windows pelo ID. Use este endpoint para atualizar o nome ou o nome do identificador de pacote da plataforma.

Parâmetro	Tipo	Obrigatório	Descrição
platformId	string	sim	ID da plataforma.
name	string	sim	Nome da plataforma. Tamanho máximo: 128 caracteres.
packageIdentifierName	string	sim	Nome do identificador de pacote do Windows. Tamanho máximo: 256 caracteres.

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

@owbase/node

import { Client, Project } 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 project = new Project(client);

const result = await project.updateWindowsPlatform({
    platformId: '<PLATFORM_ID>',
    name: '<NAME>',
    packageIdentifierName: '<PACKAGE_IDENTIFIER_NAME>',
});

getPlatform

Obter plataforma do projeto

SDK: só @owbase/node

Obtém uma plataforma pelo ID. Este endpoint devolve os detalhes da plataforma, como nome, tipo e as principais configurações.

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

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

@owbase/node

import { Client, Project } 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 project = new Project(client);

const result = await project.getPlatform({
    platformId: '<PLATFORM_ID>',
});

deletePlatform

Excluir plataforma do projeto

SDK: só @owbase/node

Exclui uma plataforma pelo ID. Este endpoint remove do projeto a plataforma e todas as configurações dela.

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

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

@owbase/node

import { Client, Project } 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 project = new Project(client);

const result = await project.deletePlatform({
    platformId: '<PLATFORM_ID>',
});

listPolicies

Listar políticas do projeto

SDK: só @owbase/node

Obtém a lista de todas as políticas do projeto e a configuração atual delas.

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. Só os métodos limit e offset são aceitos
total	boolean	não	Com false, o total não é calculado e volta como 0.

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

@owbase/node

import { Client, Project } 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 project = new Project(client);

const result = await project.listPolicies({
    queries: [], // opcional
    total: false, // opcional
});

updateDenyAliasedEmailPolicy

Atualizar política de recusa de e-mail com alias

SDK: só @owbase/node

Define se e-mails com alias, como subendereços e e-mails com sufixo, são recusados no cadastro de novos usuários e na troca de e-mail.

Parâmetro	Tipo	Obrigatório	Descrição
enabled	boolean	sim	Define se e-mails com alias são bloqueados no cadastro e na troca de e-mail.

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

@owbase/node

import { Client, Project } 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 project = new Project(client);

const result = await project.updateDenyAliasedEmailPolicy({
    enabled: false,
});

updateDenyCorporateEmailPolicy

Atualizar política de recusa de e-mail não corporativo

SDK: só @owbase/node

Define se só e-mails corporativos (de domínios que não são gratuitos nem descartáveis) são aceitos no cadastro de novos usuários e na troca de e-mail.

Parâmetro	Tipo	Obrigatório	Descrição
enabled	boolean	sim	Define se o cadastro e a troca de e-mail ficam restritos a e-mails corporativos.

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

@owbase/node

import { Client, Project } 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 project = new Project(client);

const result = await project.updateDenyCorporateEmailPolicy({
    enabled: false,
});

updateDenyDisposableEmailPolicy

Atualizar política de recusa de e-mail descartável

SDK: só @owbase/node

Define se e-mails descartáveis, de domínios temporários conhecidos, são recusados no cadastro de novos usuários e na troca de e-mail.

Parâmetro	Tipo	Obrigatório	Descrição
enabled	boolean	sim	Define se e-mails descartáveis são bloqueados no cadastro e na troca de e-mail.

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

@owbase/node

import { Client, Project } 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 project = new Project(client);

const result = await project.updateDenyDisposableEmailPolicy({
    enabled: false,
});

updateDenyFreeEmailPolicy

Atualizar política de recusa de e-mail gratuito

SDK: só @owbase/node

Define se e-mails de provedores gratuitos, como Gmail ou Yahoo, são recusados no cadastro de novos usuários e na troca de e-mail.

Parâmetro	Tipo	Obrigatório	Descrição
enabled	boolean	sim	Define se e-mails de provedores gratuitos são bloqueados no cadastro e na troca de e-mail.

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

@owbase/node

import { Client, Project } 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 project = new Project(client);

const result = await project.updateDenyFreeEmailPolicy({
    enabled: false,
});

updateMembershipPrivacyPolicy

Atualizar política de privacidade das participações

SDK: só @owbase/node

Esta política controla se os membros de um time podem ver as informações dos outros membros. Quando ligada, todos os membros do time veem o ID, o nome, o e-mail, o telefone e o status de MFA dos outros membros.

Parâmetro	Tipo	Obrigatório	Descrição
userId	boolean	não	Use true para mostrar a todos os membros do time o ID do usuário, ou false para escondê-lo.
userEmail	boolean	não	Use true para mostrar a todos os membros do time o e-mail do usuário, ou false para escondê-lo.
userPhone	boolean	não	Use true para mostrar a todos os membros do time o telefone do usuário, ou false para escondê-lo.
userName	boolean	não	Use true para mostrar a todos os membros do time o nome do usuário, ou false para escondê-lo.
userMFA	boolean	não	Use true para mostrar a todos os membros do time o status de MFA do usuário, ou false para escondê-lo.
userAccessedAt	boolean	não	Use true para mostrar a todos os membros do time a data do último acesso do usuário, ou false para escondê-la.

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

@owbase/node

import { Client, Project } 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 project = new Project(client);

const result = await project.updateMembershipPrivacyPolicy({
    userId: false, // opcional
    userEmail: false, // opcional
    userPhone: false, // opcional
    userName: false, // opcional
    userMFA: false, // opcional
    userAccessedAt: false, // opcional
});

updateMFAFactorsPolicy

Atualizar política de fatores de MFA

SDK: só @owbase/node

Esta política controla quais fatores os usuários podem usar para concluir um desafio de MFA. Fatores desligados não servem para criar um desafio e aparecem como indisponíveis ao listar os fatores. O fator custom vem desligado por padrão; ligue-o para entregar os códigos de desafio pelo seu próprio canal. Os códigos de recuperação continuam sempre disponíveis como alternativa.

Parâmetro	Tipo	Obrigatório	Descrição
totp	boolean	não	Use true para permitir o TOTP num desafio de MFA, ou false para desligá-lo.
email	boolean	não	Use true para permitir o e-mail num desafio de MFA, ou false para desligá-lo.
phone	boolean	não	Use true para permitir o telefone (SMS) num desafio de MFA, ou false para desligá-lo.
custom	boolean	não	Use true para permitir o fator custom num desafio de MFA, ou false para desligá-lo.

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

@owbase/node

import { Client, Project } 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 project = new Project(client);

const result = await project.updateMFAFactorsPolicy({
    totp: false, // opcional
    email: false, // opcional
    phone: false, // opcional
    custom: false, // opcional
});

updatePasskeyPolicy

Atualizar política de passkeys

SDK: só @owbase/node

Configura a relying party a que as passkeys ficam ligadas. O ID da relying party é o domínio do seu app, e as origens são as origens web exatas que podem cadastrar passkeys e fazer login com elas. As passkeys ficam indisponíveis até os dois estarem definidos e o método de autenticação passkey estar ligado. O ID da relying party não pode mudar enquanto houver usuários com passkeys, e qualquer mudança invalida as cerimônias em andamento.

Parâmetro	Tipo	Obrigatório	Descrição
rpId	string	não	ID da relying party: o domínio do seu app, como example.com. Use localhost no desenvolvimento local.
origins	string[]	não	Origens web que podem usar passkeys, como https://example.com ou https://app.example.com. Cada uma precisa ser HTTPS no ID da relying party ou num subdomínio dele, sem caminho. HTTP só é aceito em localhost. No máximo 10 origens.

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

@owbase/node

import { Client, Project } 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 project = new Project(client);

const result = await project.updatePasskeyPolicy({
    rpId: '<RP_ID>', // opcional
    origins: [], // opcional
});

updatePasswordDictionaryPolicy

Atualizar política de dicionário de senhas

SDK: só @owbase/node

Esta política controla se as senhas novas são comparadas com um dicionário das senhas mais comuns. Quando ligada, a senha que o usuário escolhe ao trocá-la não pode estar no dicionário.

Parâmetro	Tipo	Obrigatório	Descrição
enabled	boolean	sim	Liga ou desliga a política de dicionário de senhas. Use true para que a troca de senha bloqueie senhas do dicionário, ou false para permiti-las. Ao mudar esta política, as senhas que já existem continuam válidas.

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

@owbase/node

import { Client, Project } 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 project = new Project(client);

const result = await project.updatePasswordDictionaryPolicy({
    enabled: false,
});

updatePasswordHistoryPolicy

Atualizar política de histórico de senhas

SDK: só @owbase/node

Atualiza uma das políticas de força de senha. Conforme o tamanho total configurado, os hashes das senhas anteriores ficam guardados, e o usuário não pode escolher uma senha nova que já esteja no histórico de senhas, ao atualizar a senha ou ao definir uma nova pela recuperação de senha.

Atenção: enquanto a política de histórico de senhas está desligada, o histórico não é guardado. Ligar a política não traz histórico dos usuários existentes; ela só começa a guardar e a aplicar a regra nas trocas de senha feitas depois de ligada.

Parâmetro	Tipo	Obrigatório	Descrição
total	number	não	Tamanho do histórico de senhas por usuário. O valor pode ser de 1 a 20, ou null para desligar o limite.

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

@owbase/node

import { Client, Project } 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 project = new Project(client);

const result = await project.updatePasswordHistoryPolicy({
    total: 1,
});

updatePasswordPersonalDataPolicy

Atualizar política de dados pessoais na senha

SDK: só @owbase/node

Esta política controla se a força da senha é conferida com os dados pessoais. Quando ligada, a senha que o usuário define ou troca não pode conter o ID, o nome, o e-mail ou o telefone dele.

Parâmetro	Tipo	Obrigatório	Descrição
enabled	boolean	sim	Liga ou desliga a política de dados pessoais na senha. Use true para bloquear senhas que contenham dados pessoais do usuário, ou false para permiti-las. Ao mudar esta política, as senhas que já existem continuam válidas.

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

@owbase/node

import { Client, Project } 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 project = new Project(client);

const result = await project.updatePasswordPersonalDataPolicy({
    enabled: false,
});

updatePasswordPwnedPolicy

Atualizar política de senhas vazadas

SDK: só @owbase/node

Esta política controla se as senhas são conferidas na base de vazamentos do Have I Been Pwned. Quando ligada, toda senha usada no cadastro, no login ou na redefinição é conferida, e o resultado fica registrado no usuário como passwordPwned. Sozinha, a política só registra. Ligue users para recusar uma senha vazada no cadastro ou ao definir uma senha nova, e sessions para recusar o login com senha vazada até ela ser redefinida. Só os cinco primeiros caracteres do hash da senha são enviados ao serviço. As opções que não forem enviadas mantêm o valor atual.

Parâmetro	Tipo	Obrigatório	Descrição
enabled	boolean	não	Liga ou desliga a política de senhas vazadas. Use true para conferir as senhas em vazamentos de dados conhecidos e registrar o resultado no usuário, ou false para nunca conferir. O padrão é true. Sozinha, ela só registra; use users e sessions para bloquear. Ao mudar esta política, as senhas que já existem continuam válidas.
sessions	boolean	não	Se o login com senha vazada é recusado até a senha ser redefinida. O padrão é false, que permite o login e só registra o resultado.
users	boolean	não	Se uma senha vazada é recusada quando o usuário se cadastra ou define uma senha nova. O padrão é false, que permite a senha e só registra o resultado.

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

@owbase/node

import { Client, Project } 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 project = new Project(client);

const result = await project.updatePasswordPwnedPolicy({
    enabled: false, // opcional
    sessions: false, // opcional
    users: false, // opcional
});

updatePasswordStrengthPolicy

Atualizar política de força de senha

SDK: só @owbase/node

Atualiza os requisitos de força de senha dos usuários do projeto.

Parâmetro	Tipo	Obrigatório	Descrição
min	number	não	Tamanho mínimo da senha. O valor precisa estar entre 8 e 256. O padrão é 8.
uppercase	boolean	não	Se as senhas precisam ter pelo menos uma letra maiúscula.
lowercase	boolean	não	Se as senhas precisam ter pelo menos uma letra minúscula.
number	boolean	não	Se as senhas precisam ter pelo menos um número.
symbols	boolean	não	Se as senhas precisam ter pelo menos um símbolo.

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

@owbase/node

import { Client, Project } 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 project = new Project(client);

const result = await project.updatePasswordStrengthPolicy({
    min: 8, // opcional
    uppercase: false, // opcional
    lowercase: false, // opcional
    number: false, // opcional
    symbols: false, // opcional
});

updateSessionAlertPolicy

Atualizar política de alerta de sessão

SDK: só @owbase/node

Esta política controla se um alerta por e-mail é enviado quando uma sessão é criada. Quando ligada, o usuário recebe uma notificação por e-mail ao entrar na conta. Exceção: a primeira sessão depois do cadastro não dispara alerta, mesmo com a política ligada.

Parâmetro	Tipo	Obrigatório	Descrição
enabled	boolean	sim	Liga ou desliga a política de alerta de sessão. Use true para que os usuários recebam notificações por e-mail quando forem criadas sessões para eles, ou false para não enviar alertas por e-mail.

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

@owbase/node

import { Client, Project } 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 project = new Project(client);

const result = await project.updateSessionAlertPolicy({
    enabled: false,
});

updateSessionDurationPolicy

Atualizar política de duração de sessão

SDK: só @owbase/node

Atualiza a duração máxima das sessões criadas no projeto.

Parâmetro	Tipo	Obrigatório	Descrição
duration	number	sim	Duração máxima da sessão, em segundos. O valor mínimo é 60 segundos, e o máximo, 1 ano, ou seja, 31536000 segundos.

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

@owbase/node

import { Client, Project } 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 project = new Project(client);

const result = await project.updateSessionDurationPolicy({
    duration: 60,
});

updateSessionInvalidationPolicy

Atualizar política de invalidação de sessões

SDK: só @owbase/node

Esta política controla se as sessões existentes são invalidadas quando a senha do usuário muda. Quando ligada, o usuário que troca a senha é desconectado de todos os aparelhos.

Parâmetro	Tipo	Obrigatório	Descrição
enabled	boolean	sim	Liga ou desliga a política de invalidação de sessões. Use true para que a troca de senha invalide todas as sessões do usuário, ou false para manter as sessões ativas.

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

@owbase/node

import { Client, Project } 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 project = new Project(client);

const result = await project.updateSessionInvalidationPolicy({
    enabled: false,
});

updateSessionLimitPolicy

Atualizar política de limite de sessões

SDK: só @owbase/node

Atualiza o número máximo de sessões por usuário. Quando o limite é atingido, a sessão mais antiga é excluída para dar lugar à nova.

Parâmetro	Tipo	Obrigatório	Descrição
total	number	sim	Número máximo de sessões por usuário. O valor pode ser de 1 a 100.

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

@owbase/node

import { Client, Project } 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 project = new Project(client);

const result = await project.updateSessionLimitPolicy({
    total: 1,
});

updateUserLimitPolicy

Atualizar política de limite de usuários

SDK: só @owbase/node

Atualiza o número máximo de usuários do projeto. Quando o limite é atingido, ou se os usuários existentes já passam dele, todos continuam ativos, mas novos cadastros ficam bloqueados.

Parâmetro	Tipo	Obrigatório	Descrição
total	number	não	Número máximo de usuários do projeto. O valor pode ser de 0 a 10000. Use 0 ou null para desligar o limite.

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

@owbase/node

import { Client, Project } 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 project = new Project(client);

const result = await project.updateUserLimitPolicy({
    total: 0,
});

getPolicy

Obter política do projeto

SDK: só @owbase/node

Obtém uma política pelo ID. Este endpoint devolve a configuração atual da política do projeto pedida.

Parâmetro	Tipo	Obrigatório	Descrição
policyId	ProjectPolicyId	sim	ID da política. Pode ser: password-dictionary, password-history, password-strength, password-personal-data, password-pwned, session-alert, session-duration, session-invalidation, session-limit, user-limit, membership-privacy, mfa-factors, deny-aliased-email, deny-disposable-email, deny-free-email, deny-corporate-email, passkey. Valores: password-dictionary, password-history, password-strength, password-personal-data, password-pwned, session-alert, session-duration, session-invalidation, session-limit, user-limit, membership-privacy, mfa-factors, deny-aliased-email, deny-disposable-email, deny-free-email, deny-corporate-email, passkey.

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

@owbase/node

import { Client, Project, ProjectPolicyId } 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 project = new Project(client);

const result = await project.getPolicy({
    policyId: ProjectPolicyId.PasswordDictionary,
});

updateProtocol

Atualizar protocolo do projeto

SDK: só @owbase/node

Atualiza as propriedades de um protocolo. Use este endpoint para ligar ou desligar um protocolo no projeto.

Parâmetro	Tipo	Obrigatório	Descrição
protocolId	ProjectProtocolId	sim	Nome do protocolo. Pode ser: rest, graphql, websocket Valores: rest, graphql, websocket.
enabled	boolean	sim	Status do protocolo.

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

@owbase/node

import { Client, Project, ProjectProtocolId } 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 project = new Project(client);

const result = await project.updateProtocol({
    protocolId: ProjectProtocolId.Rest,
    enabled: false,
});

updateService

Atualizar serviço do projeto

SDK: só @owbase/node

Atualiza as propriedades de um serviço. Use este endpoint para ligar ou desligar um serviço no projeto.

Parâmetro	Tipo	Obrigatório	Descrição
serviceId	ProjectServiceId	sim	Nome do serviço. Pode ser: account, avatars, databases, tablesdb, locale, health, project, storage, teams, users, vcs, sites, functions, proxy, graphql, migrations, messaging, advisor Valores: account, avatars, databases, tablesdb, locale, health, project, storage, teams, users, vcs, sites, functions, proxy, graphql, migrations, messaging, advisor.
enabled	boolean	sim	Status do serviço.

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

@owbase/node

import { Client, Project, ProjectServiceId } 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 project = new Project(client);

const result = await project.updateService({
    serviceId: ProjectServiceId.Account,
    enabled: false,
});

updateSMTP

Atualizar configuração de SMTP do projeto

SDK: só @owbase/node

Atualiza a configuração de SMTP do projeto. Use este endpoint para configurar o provedor SMTP do projeto com as suas próprias configurações para enviar e-mails transacionais.

Parâmetro	Tipo	Obrigatório	Descrição
host	string	não	Hostname (domínio) do servidor SMTP
port	number	não	Porta do servidor SMTP
username	string	não	Usuário do servidor SMTP. Envie um texto vazio para apagar um valor definido antes.
password	string	não	Senha do servidor SMTP. Envie um texto vazio para apagar um valor definido antes. Este valor fica guardado de forma segura e não pode ser lido depois (só escrita).
senderEmail	string	não	Endereço de e-mail que aparece na caixa de entrada como remetente. Envie um texto vazio para apagar um valor definido antes.
senderName	string	não	Nome que aparece na caixa de entrada como remetente. Envie um texto vazio para apagar um valor definido antes.
replyToEmail	string	não	E-mail usado quando o usuário responde ao e-mail. Envie um texto vazio para apagar um valor definido antes.
replyToName	string	não	Nome usado quando o usuário responde ao e-mail. Envie um texto vazio para apagar um valor definido antes.
secure	ProjectSMTPSecure	não	Define se a comunicação com o servidor SMTP é criptografada. Valores aceitos: tls, ssl. Deixe vazio para não criptografar. Valores: tls, ssl.
enabled	boolean	não	Liga ou desliga o SMTP próprio. O SMTP próprio é útil para usar a sua marca e também permite usar modelos de e-mail personalizados.

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

@owbase/node

import { Client, Project, ProjectSMTPSecure } 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 project = new Project(client);

const result = await project.updateSMTP({
    host: 'example.com', // opcional
    port: 587, // opcional
    username: '<USERNAME>', // opcional
    password: 'password', // opcional
    senderEmail: '[email protected]', // opcional
    senderName: '<SENDER_NAME>', // opcional
    replyToEmail: '[email protected]', // opcional
    replyToName: '<REPLY_TO_NAME>', // opcional
    secure: ProjectSMTPSecure.Tls, // opcional
    enabled: false, // opcional
});

createSMTPTest

Criar teste de SMTP do projeto

SDK: só @owbase/node

Envia um e-mail de teste para verificar a configuração de SMTP.

Parâmetro	Tipo	Obrigatório	Descrição
emails	string[]	sim	Lista de e-mails que recebem o e-mail de teste. No máximo 10 e-mails.

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

@owbase/node

import { Client, Project } 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 project = new Project(client);

const result = await project.createSMTPTest({
    emails: ['[email protected]'],
});

listEmailTemplates

Listar modelos de e-mail do projeto

SDK: só @owbase/node

Obtém a lista de todos os modelos de e-mail personalizados configurados no projeto. Este endpoint devolve uma lista com todos os modelos de e-mail configurados e as localidades deles.

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. Só os métodos limit e offset são aceitos
total	boolean	não	Com false, o total não é calculado e volta como 0.

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

@owbase/node

import { Client, Project } 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 project = new Project(client);

const result = await project.listEmailTemplates({
    queries: [], // opcional
    total: false, // opcional
});

updateEmailTemplate

Atualizar modelo de e-mail do projeto

SDK: só @owbase/node

Atualiza um modelo de e-mail personalizado para a localidade e o tipo informados. Use este endpoint para alterar o conteúdo dos seus modelos de e-mail.

Parâmetro	Tipo	Obrigatório	Descrição
templateId	ProjectEmailTemplateId	sim	Tipo do modelo de e-mail personalizado. Pode ser: verification, magicSession, recovery, invitation, mfaChallenge, sessionAlert, otpSession, otpVerification, otpRecovery Valores: verification, magicSession, recovery, invitation, mfaChallenge, sessionAlert, otpSession, otpVerification, otpRecovery.
locale	ProjectEmailTemplateLocale	não	Localidade do modelo de e-mail personalizado. Se ficar vazia, vale a localidade padrão (en). Valores: af, ar-ae, ar-bh, ar-dz, ar-eg, ar-iq, ar-jo, ar-kw, ar-lb, ar-ly, ar-ma, ar-om, ar-qa, ar-sa, ar-sy, ar-tn, ar-ye, as, az, be, bg, bh, bn, bs, ca, cs, cy, da, de, de-at, de-ch, de-li, de-lu, el, en, en-au, en-bz, en-ca, en-gb, en-ie, en-jm, en-nz, en-tt, en-us, en-za, eo, es, es-ar, es-bo, es-cl, es-co, es-cr, es-do, es-ec, es-gt, es-hn, es-mx, es-ni, es-pa, es-pe, es-pr, es-py, es-sv, es-uy, es-ve, et, eu, fa, fi, fo, fr, fr-be, fr-ca, fr-ch, fr-lu, ga, gd, he, hi, hr, hu, id, is, it, it-ch, ja, ji, ko, ku, lt, lv, mk, ml, ms, mt, nb, ne, nl, nl-be, nn, no, pa, pl, pt, pt-br, rm, ro, ro-md, ru, ru-md, sb, sk, sl, sq, sr, sv, sv-fi, th, tn, tr, ts, ua, ur, ve, vi, xh, zh-cn, zh-hk, zh-sg, zh-tw, zu.
subject	string	não	Assunto do modelo de e-mail. Pode ter até 255 caracteres.
message	string	não	Corpo da mensagem do modelo de e-mail, em texto puro ou HTML. Pode ter até 10MB de conteúdo.
senderName	string	não	Nome do remetente do e-mail.
senderEmail	string	não	E-mail do remetente. Envie um texto vazio para apagar um valor definido antes.
replyToEmail	string	não	E-mail de resposta (reply-to). Envie um texto vazio para apagar um valor definido antes.
replyToName	string	não	Nome de resposta (reply-to).

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

@owbase/node

import { Client, Project, ProjectEmailTemplateId, ProjectEmailTemplateLocale } 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 project = new Project(client);

const result = await project.updateEmailTemplate({
    templateId: ProjectEmailTemplateId.Verification,
    locale: ProjectEmailTemplateLocale.Af, // opcional
    subject: '<SUBJECT>', // opcional
    message: '<MESSAGE>', // opcional
    senderName: '<SENDER_NAME>', // opcional
    senderEmail: '[email protected]', // opcional
    replyToEmail: '[email protected]', // opcional
    replyToName: '<REPLY_TO_NAME>', // opcional
});

getEmailTemplate

Obter modelo de e-mail do projeto

SDK: só @owbase/node

Obtém um modelo de e-mail personalizado para a localidade e o tipo informados. Este endpoint devolve o conteúdo do modelo, o assunto e os demais detalhes da configuração.

Parâmetro	Tipo	Obrigatório	Descrição
templateId	ProjectEmailTemplateId	sim	Tipo do modelo de e-mail personalizado. Pode ser: verification, magicSession, recovery, invitation, mfaChallenge, sessionAlert, otpSession, otpVerification, otpRecovery Valores: verification, magicSession, recovery, invitation, mfaChallenge, sessionAlert, otpSession, otpVerification, otpRecovery.
locale	ProjectEmailTemplateLocale	não	Localidade do modelo de e-mail personalizado. Se ficar vazia, vale a localidade padrão (en). Valores: af, ar-ae, ar-bh, ar-dz, ar-eg, ar-iq, ar-jo, ar-kw, ar-lb, ar-ly, ar-ma, ar-om, ar-qa, ar-sa, ar-sy, ar-tn, ar-ye, as, az, be, bg, bh, bn, bs, ca, cs, cy, da, de, de-at, de-ch, de-li, de-lu, el, en, en-au, en-bz, en-ca, en-gb, en-ie, en-jm, en-nz, en-tt, en-us, en-za, eo, es, es-ar, es-bo, es-cl, es-co, es-cr, es-do, es-ec, es-gt, es-hn, es-mx, es-ni, es-pa, es-pe, es-pr, es-py, es-sv, es-uy, es-ve, et, eu, fa, fi, fo, fr, fr-be, fr-ca, fr-ch, fr-lu, ga, gd, he, hi, hr, hu, id, is, it, it-ch, ja, ji, ko, ku, lt, lv, mk, ml, ms, mt, nb, ne, nl, nl-be, nn, no, pa, pl, pt, pt-br, rm, ro, ro-md, ru, ru-md, sb, sk, sl, sq, sr, sv, sv-fi, th, tn, tr, ts, ua, ur, ve, vi, xh, zh-cn, zh-hk, zh-sg, zh-tw, zu.

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

@owbase/node

import { Client, Project, ProjectEmailTemplateId, ProjectEmailTemplateLocale } 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 project = new Project(client);

const result = await project.getEmailTemplate({
    templateId: ProjectEmailTemplateId.Verification,
    locale: ProjectEmailTemplateLocale.Af, // opcional
});

listVariables

Listar variáveis do projeto

SDK: só @owbase/node

Obtém a lista de todas as variáveis de ambiente do projeto.

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: key, resourceType, resourceId, secret
total	boolean	não	Com false, o total não é calculado e volta como 0.

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

@owbase/node

import { Client, Project } 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 project = new Project(client);

const result = await project.listVariables({
    queries: [], // opcional
    total: false, // opcional
});

createVariable

Criar variável do projeto

SDK: só @owbase/node

Cria uma variável de ambiente do projeto. Todas as functions e sites do projeto acessam essas variáveis.

Parâmetro	Tipo	Obrigatório	Descrição
variableId	string	sim	ID único da variável. 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.
key	string	sim	Chave da variável. Só letras, dígitos e sublinhado, sem começar por dígito. Tamanho máximo: 255 caracteres.
value	string	sim	Valor da variável. Tamanho máximo: 8192 caracteres.
secret	boolean	não	Variáveis secretas podem ser atualizadas ou excluídas, mas só os projetos conseguem lê-las, durante o build e a execução.

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

@owbase/node

import { Client, Project } 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 project = new Project(client);

const result = await project.createVariable({
    variableId: '<VARIABLE_ID>',
    key: '<KEY>',
    value: '<VALUE>',
    secret: false, // opcional
});

getVariable

Obter variável do projeto

SDK: só @owbase/node

Obtém uma variável pelo ID.

Parâmetro	Tipo	Obrigatório	Descrição
variableId	string	sim	ID único da variável.

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

@owbase/node

import { Client, Project } 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 project = new Project(client);

const result = await project.getVariable({
    variableId: '<VARIABLE_ID>',
});

updateVariable

Atualizar variável do projeto

SDK: só @owbase/node

Atualiza uma variável pelo ID.

Parâmetro	Tipo	Obrigatório	Descrição
variableId	string	sim	ID único da variável.
key	string	não	Chave da variável. Só letras, dígitos e sublinhado, sem começar por dígito. Tamanho máximo: 255 caracteres.
value	string	não	Valor da variável. Tamanho máximo: 8192 caracteres.
secret	boolean	não	Variáveis secretas podem ser atualizadas ou excluídas, mas só os projetos conseguem lê-las, durante o build e a execução.

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

@owbase/node

import { Client, Project } 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 project = new Project(client);

const result = await project.updateVariable({
    variableId: '<VARIABLE_ID>',
    key: '<KEY>', // opcional
    value: '<VALUE>', // opcional
    secret: false, // opcional
});

deleteVariable

Excluir variável do projeto

SDK: só @owbase/node

Exclui uma variável pelo ID.

Parâmetro	Tipo	Obrigatório	Descrição
variableId	string	sim	ID único da variável.

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

@owbase/node

import { Client, Project } 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 project = new Project(client);

const result = await project.deleteVariable({
    variableId: '<VARIABLE_ID>',
});

---

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.