Organization

Recursos da organização, com chave de API de organização.

Nota

Estes métodos pedem uma chave de API de organização, e o console do Owbase não cria esse tipo de chave.

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

listProjects

Listar projetos da organização

SDK: só @owbase/node

Obtém a lista de todos os projetos. Use os parâmetros de consulta para filtrar os resultados.

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

Acesso: chave de API da organização com o escopo projects.read.

@owbase/node

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

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

createProject

Criar projeto da organização

SDK: só @owbase/node

Cria um projeto.

Parâmetro	Tipo	Obrigatório	Descrição
projectId	string	sim	ID único. Escolha um ID próprio ou gere um ID aleatório com ID.unique(). Caracteres válidos: a-z e hífen. Não pode começar com caractere especial. Tamanho máximo: 36 caracteres.
name	string	sim	Nome do projeto. Tamanho máximo: 128 caracteres.
region	Region	não	Região do projeto. Valores: default.

Acesso: chave de API da organização com o escopo projects.write.

@owbase/node

import { Client, Organization, Region } 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 organization = new Organization(client);

const result = await organization.createProject({
    projectId: '<PROJECT_ID>',
    name: '<NAME>',
    region: Region.Default, // opcional
});

getProject

Obter projeto da organização

SDK: só @owbase/node

Obtém um projeto.

Parâmetro	Tipo	Obrigatório	Descrição
projectId	string	sim	ID único do projeto.

Acesso: chave de API da organização com o escopo projects.read.

@owbase/node

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

const result = await organization.getProject({
    projectId: '<PROJECT_ID>',
});

updateProject

Atualizar projeto da organização

SDK: só @owbase/node

Atualiza um projeto pelo ID.

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

Acesso: chave de API da organização com o escopo projects.write.

@owbase/node

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

const result = await organization.updateProject({
    projectId: '<PROJECT_ID>',
    name: '<NAME>',
});

deleteProject

Excluir projeto da organização

SDK: só @owbase/node

Exclui um projeto pelo ID.

Parâmetro	Tipo	Obrigatório	Descrição
projectId	string	sim	ID único do projeto.

Acesso: chave de API da organização com o escopo projects.write.

@owbase/node

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

const result = await organization.deleteProject({
    projectId: '<PROJECT_ID>',
});

listProjectKeys

Listar chaves do projeto

SDK: só @owbase/node

Obtém a lista de todas as chaves de API de um projeto da sua organização.

Parâmetro	Tipo	Obrigatório	Descrição
projectId	string	sim	ID único do projeto.
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 da organização com o escopo organization.projects.keys.read (também aceita keys.read).

@owbase/node

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

const result = await organization.listProjectKeys({
    projectId: '<PROJECT_ID>',
    queries: [], // opcional
    total: false, // opcional
});

createEphemeralProjectKey

Criar chave efêmera do projeto

SDK: só @owbase/node

Cria uma chave de API efêmera para um projeto da sua organização. 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
projectId	string	sim	ID único do projeto.
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 da organização com o escopo organization.projects.keys.write (também aceita keys.write).

@owbase/node

import { Client, Organization, 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 organization = new Organization(client);

const result = await organization.createEphemeralProjectKey({
    projectId: '<PROJECT_ID>',
    scopes: [ProjectKeyScopes.UsersRead],
    duration: 600,
});

getProjectKey

Obter chave do projeto

SDK: só @owbase/node

Obtém uma chave de projeto pelo ID.

Parâmetro	Tipo	Obrigatório	Descrição
projectId	string	sim	ID único do projeto.
keyId	string	sim	ID da chave.

Acesso: chave de API da organização com o escopo organization.projects.keys.read (também aceita keys.read).

@owbase/node

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

const result = await organization.getProjectKey({
    projectId: '<PROJECT_ID>',
    keyId: '<KEY_ID>',
});

updateProjectKey

Atualizar chave do projeto

SDK: só @owbase/node

Atualiza uma chave de projeto 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
projectId	string	sim	ID único do projeto.
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 da organização com o escopo organization.projects.keys.write (também aceita keys.write).

@owbase/node

import { Client, Organization, 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 organization = new Organization(client);

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

deleteProjectKey

Excluir chave do projeto

SDK: só @owbase/node

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

Parâmetro	Tipo	Obrigatório	Descrição
projectId	string	sim	ID único do projeto.
keyId	string	sim	ID da chave.

Acesso: chave de API da organização com o escopo organization.projects.keys.write (também aceita keys.write).

@owbase/node

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

const result = await organization.deleteProjectKey({
    projectId: '<PROJECT_ID>',
    keyId: '<KEY_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.