Aller au contenu principal

io.enterpriseai.resources.OrganizationsClient

Source : sdks/java/enterprise-ai-java/src/main/java/io/enterpriseai/resources/OrganizationsClient.java. Retour à l'index de la référence du SDK Java.

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 OrganizationsClient​

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

Constructeur OrganizationsClient​

OrganizationsClient(Transport transport)

Crée le client sur le transport partagé ; EnterpriseAIClient le construit, on y accède par l'accesseur du même nom.

NomTypeDéfautRequisDescription
transportTransportouiTransport partagé par les sous-clients d'un même client.

OrganizationsClient.create​

JsonNode create(Object body)

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).

NomTypeDéfautRequisDescription
bodyObjectouiIdentifiant court, nom, description et métadonnées de l'organisation.

Retour : JsonNode. 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.create​

JsonNode create(Object body, RequestOptions options)

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).

NomTypeDéfautRequisDescription
bodyObjectouiIdentifiant court, nom, description et métadonnées de l'organisation.
optionsRequestOptionsouiOptions 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 une organisation ».

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

OrganizationsClient.list​

Page<JsonNode> list()

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

Route : /v1/organizations (GET).

Cet élément ne prend aucun paramètre.

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

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

OrganizationsClient.list​

Page<JsonNode> list(Map<String, ?> query)

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

Route : /v1/organizations (GET).

NomTypeDéfautRequisDescription
queryMap<String, ?>ouiParamè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 organisations ».

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

OrganizationsClient.update​

JsonNode update(String organizationId, Object body)

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).

NomTypeDéfautRequisDescription
organizationIdStringouiIdentifiant (UUID) de l'organisation.
bodyObjectouiChamps à modifier ; les champs omis gardent leur valeur.

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

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

OrganizationsClient.update​

JsonNode update(String organizationId, Object body, RequestOptions options)

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).

NomTypeDéfautRequisDescription
organizationIdStringouiIdentifiant (UUID) de l'organisation.
bodyObjectouiChamps à modifier ; les champs omis gardent leur valeur.
optionsRequestOptionsouiOptions 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 une organisation ».

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