enterprise_ai.tenant

Source : sdks/python/src/enterprise_ai/tenant/__init__.py. Retour à l'index de la référence du SDK Python.

remarque

Cette page est générée par tools/docs/gen_sdk_reference.py depuis les sources du SDK et les dossiers de textes OpenAPI. Ne la modifiez pas à la main : changez la source et régénérez.

Classe TenantsClient

Tenants et organisation. Les tenants, leur hiérarchie, les projets, les environnements et les membres.

Resource

TenantsClient.create

create(slug: str, name: str, **extra: Any) -> Any

Créer un tenant. Crée un tenant et fait de chaque sujet de admins son tenant_admin. Exige platform_admin. Un identifiant court déjà utilisé répond 409 conflict. Écrit l'événement d'audit tenant.create dans la chaîne du nouveau tenant.

Route : /v1/tenants (POST).

Nom	Type	Défaut	Requis	Description
slug	str		oui	Identifiant court du tenant, minuscules, chiffres et tirets, 2 à 63 caractères. Sert aussi dans la revendication tenant et dans les noms de groupes de l'annuaire.
name	str		oui	Nom affiché, 1 à 200 caractères.
**extra	Any		non	Champs supplémentaires fusionnés dans le corps de la requête.

Retour : Any. Réponse JSON décodée de l'opération « Créer un tenant ».

Erreurs levées : les erreurs typées du transport (Erreurs).

TenantsClient.get

get(tenant_id: str) -> Any

Lire un tenant. Renvoie un tenant : identifiant court, nom, statut, résidence des données et paramètres. Un tenant que l'appelant ne peut pas voir répond 404 not_found.

Route : /v1/tenants/{tenant_id} (GET).

Nom	Type	Défaut	Requis	Description
tenant_id	str		oui	Identifiant (UUID) du tenant.

Retour : Any. Réponse JSON décodée de l'opération « Lire un tenant ».

Erreurs levées : les erreurs typées du transport (Erreurs).

TenantsClient.list

list(**page: Any) -> Any

Lister les tenants. Liste les tenants visibles par l'appelant, triés par identifiant court, paginés : son propre tenant pour un identifiant de tenant, tous les tenants pour un administrateur de plateforme.

Route : /v1/tenants (GET).

Nom	Type	Défaut	Requis	Description
**page	Any		non	Options de pagination transmises à la liste : limit (nombre maximal d'éléments par page) et cursor (le next_cursor de la page précédente). Itérer sur la page renvoyée suit tous les curseurs.

Retour : Any. Réponse JSON décodée de l'opération « Lister les tenants ».

Erreurs levées : les erreurs typées du transport (Erreurs).

TenantsClient.update

update(tenant_id: str, **changes: Any) -> Any

Modifier un tenant. Modifie le nom, la résidence des données, les paramètres ou le statut d'un tenant. Exige tenant_admin ; changer status (active ou suspended) exige un administrateur de plateforme (403 forbidden). Un tenant suspendu répond 403 tenant_suspended à tout identifiant. Écrit l'événement d'audit tenant.update.

Route : /v1/tenants/{tenant_id} (PATCH).

Nom	Type	Défaut	Requis	Description
tenant_id	str		oui	Identifiant (UUID) du tenant.
**changes	Any		non	Champs du tenant à modifier, envoyés comme corps du PATCH.

Retour : Any. Réponse JSON décodée de l'opération « Modifier un tenant ».

Erreurs levées : les erreurs typées du transport (Erreurs).

Classe ProjectsClient

Tenants et organisation. Les tenants, leur hiérarchie, les projets, les environnements et les membres.

Resource

ProjectsClient.create

create(slug: str, name: str, **extra: Any) -> Any

Créer un projet. Crée un projet dans le tenant de l'appelant. Exige tenant_admin.

Route : /v1/projects (POST).

Nom	Type	Défaut	Requis	Description
slug	str		oui	Identifiant court du projet, minuscules, chiffres et tirets, 63 caractères au plus, unique dans le tenant. Utilisé dans l'en-tête X-Project.
name	str		oui	Nom affiché, 1 à 200 caractères.
**extra	Any		non	Champs supplémentaires fusionnés dans le corps de la requête.

Retour : Any. Réponse JSON décodée de l'opération « Créer un projet ».

Erreurs levées : les erreurs typées du transport (Erreurs).

ProjectsClient.create_environment

create_environment(project_id: str, name: str, **extra: Any) -> Any

Créer un environnement. Ajoute un environnement (dev, test, staging ou prod) au projet. Exige tenant_admin et la relation editor sur le projet. Un environnement qui existe déjà répond 409 conflict. Écrit l'événement d'audit environment.create.

Route : /v1/projects/{project_id}/environments (POST).

Nom	Type	Défaut	Requis	Description
project_id	str		oui	Identifiant (UUID) du projet.
name	str		oui	dev, test, staging ou prod.
**extra	Any		non	Champs supplémentaires fusionnés dans le corps de la requête.

Retour : Any. Réponse JSON décodée de l'opération « Créer un environnement ».

Erreurs levées : les erreurs typées du transport (Erreurs).

ProjectsClient.delete

delete(project_id: str) -> Any

Supprimer un projet. Supprime le projet et ses environnements. Exige tenant_admin et la relation owner sur le projet (403 relation_required). Des objets qui référencent encore le projet peuvent bloquer la suppression (409 conflict). Écrit l'événement d'audit project.delete. Répond 204.

Route : /v1/projects/{project_id} (DELETE).

Nom	Type	Défaut	Requis	Description
project_id	str		oui	Identifiant (UUID) du projet.

Retour : Any. Réponse JSON décodée de l'opération « Supprimer un projet ».

Erreurs levées : les erreurs typées du transport (Erreurs).

ProjectsClient.get

get(project_id: str) -> Any

Lire un projet. Renvoie le projet avec ses environnements. Exige la relation viewer sur le projet (403 relation_required, audité). Répond 404 not_found pour un projet inconnu.

Route : /v1/projects/{project_id} (GET).

Nom	Type	Défaut	Requis	Description
project_id	str		oui	Identifiant (UUID) du projet.

Retour : Any. Réponse JSON décodée de l'opération « Lire un projet ».

Erreurs levées : les erreurs typées du transport (Erreurs).

ProjectsClient.list

list(**page: Any) -> Any

Lister les projets. Liste les projets du tenant triés par identifiant court, paginés, éventuellement filtrés par organisation ou unité métier. Ouvert à tout membre du tenant.

Route : /v1/projects (GET).

Nom	Type	Défaut	Requis	Description
**page	Any		non	Options de pagination transmises à la liste : limit (nombre maximal d'éléments par page) et cursor (le next_cursor de la page précédente). Itérer sur la page renvoyée suit tous les curseurs.

Retour : Any. Réponse JSON décodée de l'opération « Lister les projets ».

Erreurs levées : les erreurs typées du transport (Erreurs).

ProjectsClient.list_environments

list_environments(project_id: str) -> Any

Lister les environnements d'un projet. Liste les environnements du projet, triés par nom. Exige la relation viewer sur le projet. Non paginé : next_cursor vaut toujours null.

Route : /v1/projects/{project_id}/environments (GET).

Nom	Type	Défaut	Requis	Description
project_id	str		oui	Identifiant (UUID) du projet.

Retour : Any. Réponse JSON décodée de l'opération « Lister les environnements d'un projet ».

Erreurs levées : les erreurs typées du transport (Erreurs).

ProjectsClient.update

update(project_id: str, **changes: Any) -> Any

Modifier un projet. Modifie le nom, la description, les paramètres, les métadonnées ou le rattachement d'un projet. Envoyer organization_id ou business_unit_id à null détache le projet. L'unité doit appartenir à l'organisation (422 invalid_hierarchy). Exige tenant_admin et la relation editor sur le projet. Envoyez expected_version pour détecter une modification concurrente (409 version_conflict). Écrit l'événement d'audit project.update.

Route : /v1/projects/{project_id} (PATCH).

Nom	Type	Défaut	Requis	Description
project_id	str		oui	Identifiant (UUID) du projet.
**changes	Any		non	Champs du projet à modifier, envoyés comme corps du PATCH.

Retour : Any. Réponse JSON décodée de l'opération « Modifier un projet ».

Erreurs levées : les erreurs typées du transport (Erreurs).

Classe OrganizationsClient

Tenants et organisation. Les tenants, leur hiérarchie, les projets, les environnements et les membres.

Resource

OrganizationsClient.create

create(slug: str, name: str, description: str | None = None, metadata: dict[str, Any] | None = None) -> Any

Créer une organisation. Crée une organisation dans le tenant. Exige tenant_admin. Un identifiant court déjà utilisé répond 409 conflict. Écrit l'événement d'audit organization.create.

Route : /v1/organizations (POST).

Nom	Type	Défaut	Requis	Description
slug	str		oui	Identifiant court en minuscules, chiffres et tirets, commençant par une lettre ou un chiffre, 63 caractères au plus. Unique, il ne peut plus être modifié.
name	str		oui	Nom affiché, 1 à 200 caractères.
description	str | None	None	non	Description, 2000 caractères au plus (vide par défaut).
metadata	dict[str, Any] | None	None	non	Paires clé-valeur libres enregistrées avec l'objet. Contrôlées par la base : un objet refusé répond 422 invalid_metadata.

Retour : Any. Réponse JSON décodée de l'opération « Créer une organisation ».

Erreurs levées : les erreurs typées du transport (Erreurs).

OrganizationsClient.list

list(**page: Any) -> Any

Lister les organisations. Liste les organisations du tenant, paginées. Ouvert à tout membre du tenant.

Route : /v1/organizations (GET).

Nom	Type	Défaut	Requis	Description
**page	Any		non	Options de pagination transmises à la liste : limit (nombre maximal d'éléments par page) et cursor (le next_cursor de la page précédente). Itérer sur la page renvoyée suit tous les curseurs.

Retour : Any. Réponse JSON décodée de l'opération « Lister les organisations ».

Erreurs levées : les erreurs typées du transport (Erreurs).

OrganizationsClient.update

update(organization_id: str, expected_version: int | None = None, **changes: Any) -> Any

Modifier une organisation. Modifie le nom, la description, le statut (active ou archived) ou les métadonnées d'une organisation. Exige tenant_admin. Envoyez expected_version pour détecter une modification concurrente (409 version_conflict). Écrit l'événement d'audit organization.update.

Route : /v1/organizations/{organization_id} (PATCH).

Nom	Type	Défaut	Requis	Description
organization_id	str		oui	Identifiant (UUID) de l'organisation.
expected_version	int | None	None	non	Version lue en dernier par l'appelant. Une version périmée répond 409 version_conflict (concurrence optimiste).
**changes	Any		non	Champs de l'organisation à modifier, envoyés comme corps du PATCH.

Retour : Any. Réponse JSON décodée de l'opération « Modifier une organisation ».

Erreurs levées : les erreurs typées du transport (Erreurs).

Classe BusinessUnitsClient

Tenants et organisation. Les tenants, leur hiérarchie, les projets, les environnements et les membres.

Resource

BusinessUnitsClient.create

create(organization_id: str, slug: str, name: str, parent_id: str | None = None, description: str | None = None, metadata: dict[str, Any] | None = None) -> Any

Créer une unité métier. Crée une unité métier dans une organisation, éventuellement sous une unité parente de la même organisation (422 invalid_hierarchy sinon). Exige tenant_admin. Un identifiant court déjà utilisé répond 409 conflict. Écrit l'événement d'audit business_unit.create.

Route : /v1/business-units (POST).

Nom	Type	Défaut	Requis	Description
organization_id	str		oui	Organisation qui contient l'unité. Obligatoire.
slug	str		oui	Identifiant court en minuscules, chiffres et tirets, commençant par une lettre ou un chiffre, 63 caractères au plus. Unique, il ne peut plus être modifié.
name	str		oui	Nom affiché, 1 à 200 caractères.
parent_id	str | None	None	non	Unité parente dans la même organisation ; null pour une unité de premier niveau. Ne peut plus être modifiée.
description	str | None	None	non	Description, 2000 caractères au plus (vide par défaut).
metadata	dict[str, Any] | None	None	non	Paires clé-valeur libres enregistrées avec l'objet. Contrôlées par la base : un objet refusé répond 422 invalid_metadata.

Retour : Any. Réponse JSON décodée de l'opération « Créer une unité métier ».

Erreurs levées : les erreurs typées du transport (Erreurs).

BusinessUnitsClient.list

list(organization_id: str | None = None, parent_id: str | None = None, **page: Any) -> Any

Lister les unités métier. Liste les unités métier du tenant, paginées, éventuellement filtrées par organisation ou par unité parente. Ouvert à tout membre du tenant.

Route : /v1/business-units (GET).

Nom	Type	Défaut	Requis	Description
organization_id	str | None	None	non	Uniquement les unités de cette organisation.
parent_id	str | None	None	non	Uniquement les enfants directs de cette unité métier.
**page	Any		non	Options de pagination transmises à la liste : limit (nombre maximal d'éléments par page) et cursor (le next_cursor de la page précédente). Itérer sur la page renvoyée suit tous les curseurs.

Retour : Any. Réponse JSON décodée de l'opération « Lister les unités métier ».

Erreurs levées : les erreurs typées du transport (Erreurs).

BusinessUnitsClient.update

update(business_unit_id: str, expected_version: int | None = None, **changes: Any) -> Any

Modifier une unité métier. Modifie le nom, la description, le statut (active ou archived) ou les métadonnées d'une unité métier. Son organisation et son parent ne peuvent pas changer. Exige tenant_admin. Envoyez expected_version pour détecter une modification concurrente (409 version_conflict). Écrit l'événement d'audit business_unit.update.

Route : /v1/business-units/{business_unit_id} (PATCH).

Nom	Type	Défaut	Requis	Description
business_unit_id	str		oui	Identifiant (UUID) de l'unité métier.
expected_version	int | None	None	non	Version lue en dernier par l'appelant. Une version périmée répond 409 version_conflict (concurrence optimiste).
**changes	Any		non	Champs de l'unité métier à modifier, envoyés comme corps du PATCH.

Retour : Any. Réponse JSON décodée de l'opération « Modifier une unité métier ».

Erreurs levées : les erreurs typées du transport (Erreurs).