Nesta página
> recursos > documentação > api > Referência da API: organizações

Referência da API: organizações

warning

Excluir um ambiente removerá permanentemente todos os seus processos, conjuntos de dados e atribuições de usuários. Essa ação não pode ser desfeita. Você não pode excluir o ambiente usado para autenticação.

warning

Remover um usuário da organização revogará o acesso dele a todos os ambientes da organização.

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

Obter a organização do ambiente

A leitura é permitida com uma chave de API com escopo de ambiente; uma chave com escopo de organização também é aceita.

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

Autenticação: Chave de API com escopo de 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

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

Retorna as licenças compradas e em uso em toda a organização por nível (Process Foundation, Process Architecture, Process Intelligence), a quantidade permitida de visualizadores gratuitos, o destino da sincronização automática, a explicação do desvio de licenças (o que o mecanismo fará e quando), o intervalo de cobrança e a externalApiSeatPolicy. A leitura é permitida com uma chave de API com escopo de ambiente. O parâmetro de caminho {tenantId} é o ambiente de contexto (a organização da chave com escopo de organização), não o alvo da operação.

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

Autenticação: Chave de API com escopo de 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,
	"totalBillable": 0,
	"freeViewerAllowance": 0,
	"freeViewerOverAllowance": 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
totalBillable number Sim
freeViewerAllowance number Sim
freeViewerOverAllowance 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

Obter estatísticas de toda a organização

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

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

Autenticação: Chave de API com escopo de 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} é o ambiente de contexto (a organização da chave com escopo de organização), não o alvo da operação.

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

Autenticação: Chave de API com escopo de 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
		},
		"url": "string"
	}
]

Erros:

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

Criar um novo ambiente na organização (exige uma chave de API com escopo de organização)

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

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

Autenticação: Chave de API com escopo de 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"
}
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

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
	},
	"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
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 upload 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 necessário ou acesso à organização, o ambiente está inativo ou o plano bloqueia o tipo de arquivo
  • 406 O valor não pode ser aceito (por exemplo, um short name reservado ou duplicado)

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

O acesso à API do ambiente é interrompido imediatamente. O ambiente e seus dados são mantidos durante a janela de segurança da exclusão e removidos depois pela exclusão completa automatizada. O ambiente que você está usando no momento (o ambiente de contexto) não pode ser excluído.

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

Autenticação: Chave de API com escopo de 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 upload 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 necessário ou acesso à organização, o ambiente está inativo ou o plano bloqueia o tipo de arquivo
  • 404 Recurso não encontrado

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

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

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

Autenticação: Chave de API com escopo de 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 upload 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 necessário ou acesso à organização, o ambiente está inativo ou o plano bloqueia o tipo de arquivo
  • 404 Recurso não encontrado

Listar todos os usuários da organização

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

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

Autenticação: Chave de API com escopo de 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 (exige uma chave de API com escopo de organização)

Os sinalizadores de função no corpo (isAdminInOrganization, isActiveInOrganization) são respeitados literalmente; emita chaves com escopo de organização somente para administradores da organização. O parâmetro de caminho {tenantId} é o ambiente de contexto (a organização da chave com escopo de organização), não o alvo da operação.

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

Autenticação: Chave de API com escopo de 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 (respeitados literalmente: emita chaves com escopo de 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 necessário ou acesso à organização, o ambiente está inativo ou o plano bloqueia o tipo de arquivo
  • 404 Recurso não encontrado

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

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

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

Autenticação: Chave de API com escopo de 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 necessário ou acesso à organização, o ambiente está inativo ou o plano bloqueia o tipo de arquivo
  • 404 Recurso não encontrado

Documentação relacionada