io.enterpriseai.resources.TenantsClient
Source : sdks/java/enterprise-ai-java/src/main/java/io/enterpriseai/resources/TenantsClient.java. Retour à l'index de la référence du SDK Java.
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.
Constructeur TenantsClient
TenantsClient(Transport transport)
Crée le client sur le transport partagé ; EnterpriseAIClient le construit, on y accède par l'accesseur du même nom.
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
transport | Transport | oui | Transport partagé par les sous-clients d'un même client. |
TenantsClient.create
JsonNode create(Object body)
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 |
|---|---|---|---|---|
body | Object | oui | Identifiant court, nom, résidence, paramètres et premiers administrateurs du tenant. |
Retour : JsonNode. 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.create
JsonNode create(Object body, RequestOptions options)
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 |
|---|---|---|---|---|
body | Object | oui | Identifiant court, nom, résidence, paramètres et premiers administrateurs du tenant. | |
options | RequestOptions | oui | Options de l'appel (clé d'idempotence, traceparent, en-têtes, signal d'annulation). |
Retour : JsonNode. 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
JsonNode get(String id)
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 |
|---|---|---|---|---|
id | String | oui | Identifiant (UUID) du tenant. |
Retour : JsonNode. 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
Page<JsonNode> list()
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).
Cet élément ne prend aucun paramètre.
Retour : Page<JsonNode>. Réponse JSON décodée de l'opération « Lister les tenants ».
Erreurs levées : les erreurs typées du transport (Erreurs).
TenantsClient.list
Page<JsonNode> list(Map<String, ?> query)
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 |
|---|---|---|---|---|
query | Map<String, ?> | oui | Paramètres de la chaîne de requête de la route. |
Retour : Page<JsonNode>. 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
JsonNode update(String id, Object body)
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 |
|---|---|---|---|---|
id | String | oui | Identifiant (UUID) du tenant. | |
body | Object | oui | Champs à modifier ; les champs omis gardent leur valeur. |
Retour : JsonNode. Réponse JSON décodée de l'opération « Modifier un tenant ».
Erreurs levées : les erreurs typées du transport (Erreurs).
TenantsClient.update
JsonNode update(String id, Object body, RequestOptions options)
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 |
|---|---|---|---|---|
id | String | oui | Identifiant (UUID) du tenant. | |
body | Object | oui | Champs à modifier ; les champs omis gardent leur valeur. | |
options | RequestOptions | oui | Options de l'appel (clé d'idempotence, traceparent, en-têtes, signal d'annulation). |
Retour : JsonNode. Réponse JSON décodée de l'opération « Modifier un tenant ».
Erreurs levées : les erreurs typées du transport (Erreurs).