Referência da API: organizações

As organizações agrupam vários ambientes em uma única entidade.

Consultar a organização do ambiente

É possível consultar com uma chave de API vinculada ao ambiente. Também é aceita uma chave vinculada à organização.

Endpoint: GET /v1/tenant/{tenantId}/organization

Autenticação: Chave de API vinculada ao ambiente ou à organização · escopo read

Parâmetros:

Nome	Tipo	Localização	Obrigatório	Descrição
tenantId	string	caminho	Sim	Formato: uuid

Resposta (200):

Detalhes da organização

{
	"id": "00000000-0000-0000-0000-000000000000",
	"displayName": "string",
	"createdAt": "2024-03-15T16:30:00Z",
	"contactEmail": "string",
	"isActive": true,
	"allowedLogins": {
		"Microsoft": true,
		"Google": true,
		"LinkedIn": true
	},
	"createdBy": "00000000-0000-0000-0000-000000000000"
}

Campo	Tipo	Obrigatório	Descrição
id	string	Sim	Formato: uuid
displayName	string	Sim	Padrão: "" Comprimento máximo: 128
createdAt	string	Sim	Formato: date-time
contactEmail	string	Sim	Formato: email
isActive	boolean	Sim	Padrão: true
allowedLogins	object	Sim
createdBy	string	Sim	Formato: uuid

Erros:

• 401 Chave de API ausente, inválida, desativada ou expirada
• 404 Recurso não encontrado

Consultar a capacidade de licenças da organização e a política de sincronização automática

Retorna, para toda a organização, o número de licenças compradas e em uso por nível (Fundamentos de processos, Arquitetura de processos, Inteligência de processos), a quantidade de licenças gratuitas para visualização, o destino da sincronização automática, uma explicação sobre diferenças nas licenças (o que o mecanismo fará e quando), o intervalo de cobrança e a política externalApiSeatPolicy. É possível consultar com uma chave de API vinculada ao ambiente. O parâmetro de caminho {tenantId} identifica o ambiente de contexto (a organização da chave vinculada à organização), não o alvo da operação.

Endpoint: GET /v1/tenant/{tenantId}/organization/billing/seats

Autenticação: Chave de API vinculada ao ambiente ou à organização · escopo read

Parâmetros:

Nome	Tipo	Localização	Obrigatório	Descrição
tenantId	string	caminho	Sim	Formato: uuid

Resposta (200):

Capacidade de licenças

{
	"contractType": "free",
	"isTrial": true,
	"purchased": {
		"foundation": 0,
		"architecture": 0,
		"intelligence": 0
	},
	"inUseBillable": {
		"foundation": 0,
		"architecture": 0,
		"intelligence": 0
	},
	"inUseFree": 0,
	"inUseDashboardViewers": 0,
	"totalBillable": 0,
	"freeViewerAllowance": 0,
	"freeViewerOverAllowance": 0,
	"dashboardViewerAllowance": 0,
	"dashboardViewerOverAllowance": 0,
	"fixedOverage": 0,
	"target": {
		"foundation": 0,
		"architecture": 0,
		"intelligence": 0
	},
	"drift": [
		{
			"rung": "foundation",
			"paid": 0,
			"actual": 0,
			"state": "equal",
			"buffer": 0
		}
	],
	"interval": "month",
	"nextBilledAt": "string",
	"externalApiSeatPolicy": "autoBill"
}

Campo	Tipo	Obrigatório	Descrição
contractType	free | selfServe | fixed | unlimited	Sim	Valores permitidos: free, selfServe, fixed, unlimited
isTrial	boolean	Sim
purchased	object	Sim
inUseBillable	object	Sim
inUseFree	number	Sim
inUseDashboardViewers	number	Sim
totalBillable	number	Sim
freeViewerAllowance	number	Sim
freeViewerOverAllowance	number	Sim
dashboardViewerAllowance	number	Sim
dashboardViewerOverAllowance	number	Sim
fixedOverage	number	Sim
target	object	Sim
drift	object[]	Sim
interval	month | year	Sim	Valores permitidos: month, year
nextBilledAt	string	Sim
externalApiSeatPolicy	autoBill | requireCapacity	Sim	Valores permitidos: autoBill, requireCapacity

Erros:

• 401 Chave de API ausente, inválida, desativada ou expirada
• 404 Recurso não encontrado

Consultar as estatísticas da organização

O parâmetro de caminho {tenantId} identifica o ambiente de contexto (a organização da chave vinculada à organização), não o alvo da operação.

Endpoint: GET /v1/tenant/{tenantId}/organization/statistics

Autenticação: Chave de API vinculada à organização · escopo read

Parâmetros:

Nome	Tipo	Localização	Obrigatório	Descrição
tenantId	string	caminho	Sim	Formato: uuid

Resposta (200):

Estatísticas da organização

{
	"userCount": 0,
	"tenantCount": 0,
	"tenantStatistics": [
		{
			"tenantId": "00000000-0000-0000-0000-000000000000",
			"uploadedDataSize": 0,
			"uploadedDataCount": 0,
			"modelCount": 0,
			"simulationCount": 0,
			"userCount": 0
		}
	]
}

Campo	Tipo	Obrigatório	Descrição
userCount	number	Sim
tenantCount	number	Sim
tenantStatistics	object[]	Sim

Erros:

• 401 Chave de API ausente, inválida, desativada ou expirada

Listar todos os ambientes da organização

O parâmetro de caminho {tenantId} identifica o ambiente de contexto (a organização da chave vinculada à organização), não o alvo da operação.

Endpoint: GET /v1/tenant/{tenantId}/organization/tenants

Autenticação: Chave de API vinculada à organização · escopo read

Parâmetros:

Nome	Tipo	Localização	Obrigatório	Descrição
tenantId	string	caminho	Sim	Formato: uuid
limit	integer	consulta	Não	Número máximo de itens a retornar
offset	integer	consulta	Não	Número de itens a ignorar

Resposta (200):

Lista de ambientes

[
	{
		"id": "00000000-0000-0000-0000-000000000000",
		"createdBy": "00000000-0000-0000-0000-000000000000",
		"createdAt": "2024-03-15T16:30:00Z",
		"displayName": "string",
		"contactEmail": "string",
		"isActive": true,
		"shortName": "string",
		"useOrganizationTheme": true,
		"description": "string",
		"organizationId": "00000000-0000-0000-0000-000000000000",
		"allowedLogins": {
			"Microsoft": true,
			"Google": true,
			"LinkedIn": true
		},
		"tenantType": "normal",
		"url": "string"
	}
]

Erros:

• 401 Chave de API ausente, inválida, desativada ou expirada

Criar um ambiente na organização (requer uma chave de API vinculada à organização)

O parâmetro de caminho {tenantId} identifica o ambiente de contexto (a organização da chave vinculada à organização), não o alvo da operação.

Endpoint: POST /v1/tenant/{tenantId}/organization/tenants

Autenticação: Chave de API com escopo da organização · escopo write

Parâmetros:

Nome	Tipo	Localização	Obrigatório	Descrição
tenantId	string	caminho	Sim	Formato: uuid

Corpo da solicitação:

{
	"displayName": "string",
	"shortName": "string",
	"description": "string",
	"timezone": "string",
	"tenantType": "normal"
}

Campo	Tipo	Obrigatório	Descrição
displayName	string	Não	Comprimento máximo: 128
shortName	string	Sim
description	string	Não	Comprimento máximo: 200
timezone	string	Não	Comprimento máximo: 64
tenantType	normal | sandbox | demo	Não	Valores permitidos: normal, sandbox, demo

Resposta (201):

Ambiente criado

{
	"id": "00000000-0000-0000-0000-000000000000",
	"createdBy": "00000000-0000-0000-0000-000000000000",
	"createdAt": "2024-03-15T16:30:00Z",
	"displayName": "string",
	"contactEmail": "string",
	"isActive": true,
	"shortName": "string",
	"useOrganizationTheme": true,
	"description": "string",
	"organizationId": "00000000-0000-0000-0000-000000000000",
	"allowedLogins": {
		"Microsoft": true,
		"Google": true,
		"LinkedIn": true
	},
	"tenantType": "normal",
	"url": "string"
}

Campo	Tipo	Obrigatório	Descrição
id	string	Sim	Formato: uuid
createdBy	string	Sim	Formato: uuid
createdAt	string	Sim	Formato: date-time
displayName	string	Sim	Padrão: "" Comprimento máximo: 128
contactEmail	string	Sim	Formato: email
isActive	boolean	Sim	Padrão: true
shortName	string	Sim
useOrganizationTheme	boolean	Sim	Padrão: true
description	string	Sim	Comprimento máximo: 200
organizationId	string	Sim	Formato: uuid
allowedLogins	object	Sim
tenantType	normal | sandbox | demo	Sim	Valores permitidos: normal, sandbox, demo Padrão: normal
url	string	Sim	Formato: uri

Erros:

• 400 Solicitação inválida: por exemplo, uma expressão de filtro inválida, um processo sem modelo, um tipo de arquivo não compatível ou um campo obrigatório ausente
• 401 Chave de API ausente, inválida, desativada ou expirada
• 403 A chave de API não tem o escopo ou o acesso à organização necessários, o ambiente está inativo ou o plano não permite esse tipo de arquivo
• 406 O valor não pode ser aceito (por exemplo, um nome curto reservado ou duplicado)

Excluir logicamente um ambiente da organização (requer uma chave de API com escopo da organização)

O acesso à API para o ambiente é interrompido imediatamente. O ambiente e seus dados são mantidos durante o período de segurança para exclusão e removidos depois pela exclusão completa automatizada. Não é possível excluir o ambiente que você está usando no momento (o ambiente de contexto).

Endpoint: DELETE /v1/tenant/{tenantId}/organization/tenants/{targetId}

Autenticação: Chave de API com escopo da organização · escopo write

Parâmetros:

Nome	Tipo	Localização	Obrigatório	Descrição
tenantId	string	caminho	Sim	Formato: uuid
targetId	string	caminho	Sim	Formato: uuid

Resposta (200):

Ambiente excluído

{
	"success": true,
	"message": "string"
}

Campo	Tipo	Obrigatório	Descrição
success	boolean	Sim
message	string	Sim

Erros:

• 400 Solicitação inválida: por exemplo, uma expressão de filtro inválida, um processo sem modelo, um tipo de arquivo não compatível ou um campo obrigatório ausente
• 401 Chave de API ausente, inválida, desativada ou expirada
• 403 A chave de API não tem o escopo ou o acesso à organização necessários, o ambiente está inativo ou o plano não permite esse tipo de arquivo
• 404 Recurso não encontrado

Restaurar um ambiente excluído logicamente na organização (requer uma chave de API com escopo da organização)

Desfaça uma exclusão lógica durante o período de segurança: o ambiente e seus dados voltam exatamente ao estado anterior, e o acesso à API é retomado. O parâmetro de caminho {tenantId} corresponde ao ambiente de contexto (a organização da chave com escopo da organização), não ao alvo da operação.

Endpoint: POST /v1/tenant/{tenantId}/organization/tenants/{targetId}/restore

Autenticação: Chave de API com escopo da organização · escopo write

Parâmetros:

Nome	Tipo	Localização	Obrigatório	Descrição
tenantId	string	caminho	Sim	Formato: uuid
targetId	string	caminho	Sim	Formato: uuid

Resposta (200):

Ambiente restaurado

{
	"success": true,
	"message": "string"
}

Campo	Tipo	Obrigatório	Descrição
success	boolean	Sim
message	string	Sim

Erros:

• 400 Solicitação inválida: por exemplo, uma expressão de filtro inválida, um processo sem modelo, um tipo de arquivo não compatível ou um campo obrigatório ausente
• 401 Chave de API ausente, inválida, desativada ou expirada
• 403 A chave de API não tem o escopo ou o acesso à organização necessários, o ambiente está inativo ou o plano não permite esse tipo de arquivo
• 404 Recurso não encontrado

Listar todos os usuários da organização

O parâmetro de caminho {tenantId} corresponde ao ambiente de contexto (a organização da chave com escopo da organização), não ao alvo da operação.

Endpoint: GET /v1/tenant/{tenantId}/organization/users

Autenticação: Chave de API com escopo da organização · escopo read

Parâmetros:

Nome	Tipo	Localização	Obrigatório	Descrição
tenantId	string	caminho	Sim	Formato: uuid
limit	integer	consulta	Não	Número máximo de itens a retornar
offset	integer	consulta	Não	Número de itens a ignorar

Resposta (200):

Lista de usuários da organização

[
	{
		"id": "00000000-0000-0000-0000-000000000000",
		"email": "string",
		"firstName": "string",
		"lastName": "string",
		"createdAt": "2024-03-15T16:30:00Z",
		"lastLoginAt": "2024-03-15T16:30:00Z",
		"organizationId": "00000000-0000-0000-0000-000000000000",
		"isActiveInOrganization": true,
		"isAdminInOrganization": true
	}
]

Erros:

• 401 Chave de API ausente, inválida, desativada ou expirada

Atualizar as configurações de um usuário da organização (requer uma chave de API com escopo da organização)

Os indicadores de função no corpo da solicitação (isAdminInOrganization, isActiveInOrganization) são aplicados exatamente como enviados. Emita chaves com escopo da organização somente para administradores da organização. O parâmetro de caminho {tenantId} corresponde ao ambiente de contexto (a organização da chave com escopo da organização), não ao alvo da operação.

Endpoint: PUT /v1/tenant/{tenantId}/organization/users/{userId}

Autenticação: Chave de API com escopo da organização · escopo write

Parâmetros:

Nome	Tipo	Localização	Obrigatório	Descrição
tenantId	string	caminho	Sim	Formato: uuid
userId	string	caminho	Sim	Formato: uuid

Corpo da solicitação:

{
	"isActiveInOrganization": true,
	"isAdminInOrganization": true
}

Campo	Tipo	Obrigatório	Descrição
isActiveInOrganization	boolean	Não	Indica se o usuário está ativo na organização
isAdminInOrganization	boolean	Não	Direitos de administrador da organização (aplicados exatamente como enviados: emita chaves com escopo da organização somente para administradores da organização)

Resposta (200):

Atualizado

{
	"message": "string"
}

Campo	Tipo	Obrigatório	Descrição
message	string	Sim

Erros:

• 401 Chave de API ausente, inválida, desativada ou expirada
• 403 A chave de API não tem o escopo ou o acesso à organização necessários, o ambiente está inativo ou o plano não permite esse tipo de arquivo
• 404 Recurso não encontrado

Remover um usuário da organização (requer uma chave de API com escopo da organização)

O parâmetro de caminho {tenantId} corresponde ao ambiente de contexto (a organização da chave com escopo da organização), não ao alvo da operação.

Endpoint: DELETE /v1/tenant/{tenantId}/organization/users/{userId}

Autenticação: Chave de API com escopo da organização · escopo write

Parâmetros:

Nome	Tipo	Localização	Obrigatório	Descrição
tenantId	string	caminho	Sim	Formato: uuid
userId	string	caminho	Sim	Formato: uuid

Resposta (200):

Usuário removido

{
	"message": "string"
}

Campo	Tipo	Obrigatório	Descrição
message	string	Sim

Erros:

• 401 Chave de API ausente, inválida, desativada ou expirada
• 403 A chave de API não tem o escopo ou o acesso à organização necessários, o ambiente está inativo ou o plano não permite esse tipo de arquivo
• 404 Recurso não encontrado