io.enterpriseai.resources.MembersClient

Source : sdks/java/enterprise-ai-java/src/main/java/io/enterpriseai/resources/MembersClient.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 MembersClient

Membres du tenant et attribution des rôles.

Constructeur MembersClient

MembersClient(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.

MembersClient.create

JsonNode create(Object body)

Ajouter un membre. Donne à un utilisateur (sujet OIDC) un rôle et une habilitation dans le tenant, ou dans un projet avec project_id. La fiche utilisateur est créée si elle est inconnue ; une appartenance existante pour le même utilisateur et le même projet est mise à jour. Exige tenant_admin ; accorder platform_admin exige un administrateur de plateforme (403 forbidden). Écrit l'événement d'audit member.assign.

Route : /v1/members (POST).

Nom	Type	Défaut	Requis	Description
body	Object		oui	Utilisateur, rôle, habilitation et projet facultatif de l'appartenance.

Retour : JsonNode. Réponse JSON décodée de l'opération « Ajouter un membre ».

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

MembersClient.create

JsonNode create(Object body, RequestOptions options)

Ajouter un membre. Donne à un utilisateur (sujet OIDC) un rôle et une habilitation dans le tenant, ou dans un projet avec project_id. La fiche utilisateur est créée si elle est inconnue ; une appartenance existante pour le même utilisateur et le même projet est mise à jour. Exige tenant_admin ; accorder platform_admin exige un administrateur de plateforme (403 forbidden). Écrit l'événement d'audit member.assign.

Route : /v1/members (POST).

Nom	Type	Défaut	Requis	Description
body	Object		oui	Utilisateur, rôle, habilitation et projet facultatif de l'appartenance.
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 « Ajouter un membre ».

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

MembersClient.createGroupMapping

JsonNode createGroupMapping(Object body)

Créer une correspondance de groupe. Associe un groupe de l'annuaire à un rôle dans un projet et, en option, à un profil de quota. Exige tenant_admin.

Route : /v1/identity/group-mappings (POST).

Nom	Type	Défaut	Requis	Description
body	Object		oui	Groupe, projet, rôle et profil de quota facultatif de la correspondance.

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

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

MembersClient.createGroupMapping

JsonNode createGroupMapping(Object body, RequestOptions options)

Créer une correspondance de groupe. Associe un groupe de l'annuaire à un rôle dans un projet et, en option, à un profil de quota. Exige tenant_admin.

Route : /v1/identity/group-mappings (POST).

Nom	Type	Défaut	Requis	Description
body	Object		oui	Groupe, projet, rôle et profil de quota facultatif de la correspondance.
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 une correspondance de groupe ».

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

MembersClient.createQuotaProfile

JsonNode createQuotaProfile(Object body)

Créer un profil de quota. Crée un profil de quota réutilisable par les correspondances de groupes. Exige tenant_admin. Au moins un des champs limit_cost et limit_tokens est obligatoire (422 validation_error). Un nom déjà utilisé répond 409 conflict. Écrit l'événement d'audit identity.quota_profile.create.

Route : /v1/identity/quota-profiles (POST).

Nom	Type	Défaut	Requis	Description
body	Object		oui	Nom, période, mode d'application et plafonds du profil.

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

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

MembersClient.createQuotaProfile

JsonNode createQuotaProfile(Object body, RequestOptions options)

Créer un profil de quota. Crée un profil de quota réutilisable par les correspondances de groupes. Exige tenant_admin. Au moins un des champs limit_cost et limit_tokens est obligatoire (422 validation_error). Un nom déjà utilisé répond 409 conflict. Écrit l'événement d'audit identity.quota_profile.create.

Route : /v1/identity/quota-profiles (POST).

Nom	Type	Défaut	Requis	Description
body	Object		oui	Nom, période, mode d'application et plafonds du profil.
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 profil de quota ».

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

MembersClient.delete

void delete(String id)

Retirer un membre. Supprime l'appartenance : l'utilisateur perd le rôle qu'elle donnait dès la requête suivante. Exige tenant_admin. Écrit l'événement d'audit member.remove. Répond 204, ou 404 not_found.

Route : /v1/members/{member_id} (DELETE).

Nom	Type	Défaut	Requis	Description
id	String		oui	Identifiant (UUID) de l'appartenance.

Retour : void.

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

MembersClient.deleteGroupMapping

void deleteGroupMapping(String id)

Supprimer une correspondance de groupe. Supprime la correspondance et retire ce qu'elle avait accordé (appartenances aux projets et quotas enregistrés comme accordés par elle) ; les appartenances accordées à la main restent. Exige tenant_admin. Écrit l'événement d'audit identity.group_mapping.delete. Répond 204, ou 404 not_found pour une correspondance inconnue.

Route : /v1/identity/group-mappings/{mapping_id} (DELETE).

Nom	Type	Défaut	Requis	Description
id	String		oui	Identifiant (UUID) de la correspondance de groupe.

Retour : void.

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

MembersClient.deleteQuotaProfile

void deleteQuotaProfile(String id)

Supprimer un profil de quota. Supprime un profil de quota. Exige tenant_admin. Un profil encore utilisé par une correspondance de groupe ne peut pas être supprimé (409 conflict) : détachez-le d'abord des correspondances. Écrit l'événement d'audit identity.quota_profile.delete. Répond 204, ou 404 not_found.

Route : /v1/identity/quota-profiles/{profile_id} (DELETE).

Nom	Type	Défaut	Requis	Description
id	String		oui	Identifiant (UUID) du profil de quota.

Retour : void.

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

MembersClient.getGroupMapping

JsonNode getGroupMapping(String id)

Lire une correspondance de groupe. Renvoie une correspondance de groupe. Exige tenant_admin, security_officer ou auditor. Répond 404 not_found pour une correspondance inconnue.

Route : /v1/identity/group-mappings/{mapping_id} (GET).

Nom	Type	Défaut	Requis	Description
id	String		oui	Identifiant (UUID) de la correspondance de groupe.

Retour : JsonNode. Réponse JSON décodée de l'opération « Lire une correspondance de groupe ».

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

MembersClient.list

Page<JsonNode> list()

Lister les membres. Liste les appartenances du tenant, paginées : sujet de l'utilisateur, e-mail, nom affiché, rôle, habilitation, projet et date de création. Ouvert à tout membre du tenant.

Route : /v1/members (GET).

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

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

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

MembersClient.list

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

Lister les membres. Liste les appartenances du tenant, paginées : sujet de l'utilisateur, e-mail, nom affiché, rôle, habilitation, projet et date de création. Ouvert à tout membre du tenant.

Route : /v1/members (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 membres ».

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

MembersClient.listGroupMappings

JsonNode listGroupMappings()

Lister les correspondances de groupes. Liste toutes les correspondances de groupes de l'annuaire du tenant avec leur groupe, projet, rôle et profil de quota. Exige tenant_admin, security_officer ou auditor (403 forbidden sinon). Non paginé : next_cursor vaut toujours null.

Route : /v1/identity/group-mappings (GET).

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

Retour : JsonNode. Réponse JSON décodée de l'opération « Lister les correspondances de groupes ».

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

MembersClient.listQuotaProfiles

JsonNode listQuotaProfiles()

Lister les profils de quota. Liste les profils de quota du tenant (nom, période, mode d'application, plafonds de coût et de jetons, devise). Exige tenant_admin, security_officer ou auditor.

Route : /v1/identity/quota-profiles (GET).

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

Retour : JsonNode. Réponse JSON décodée de l'opération « Lister les profils de quota ».

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

MembersClient.update

JsonNode update(String id, Object body)

Modifier un membre. Modifie le rôle ou l'habilitation d'une appartenance. Exige tenant_admin ; accorder platform_admin exige un administrateur de plateforme (403 forbidden). Écrit l'événement d'audit member.update. Répond 404 not_found pour une appartenance inconnue.

Route : /v1/members/{member_id} (PATCH).

Nom	Type	Défaut	Requis	Description
id	String		oui	Identifiant (UUID) de l'appartenance.
body	Object		oui	Nouveau rôle et/ou nouvelle habilitation.

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

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

MembersClient.update

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

Modifier un membre. Modifie le rôle ou l'habilitation d'une appartenance. Exige tenant_admin ; accorder platform_admin exige un administrateur de plateforme (403 forbidden). Écrit l'événement d'audit member.update. Répond 404 not_found pour une appartenance inconnue.

Route : /v1/members/{member_id} (PATCH).

Nom	Type	Défaut	Requis	Description
id	String		oui	Identifiant (UUID) de l'appartenance.
body	Object		oui	Nouveau rôle et/ou nouvelle habilitation.
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 membre ».

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

MembersClient.updateGroupMapping

JsonNode updateGroupMapping(String id, Object body)

Modifier une correspondance de groupe. Modifie le groupe, le projet, le rôle ou le profil de quota d'une correspondance ; seuls les champs envoyés changent. clear_quota_profile: true détache le profil. Les nouvelles valeurs s'appliquent à la prochaine connexion de chaque membre. Exige tenant_admin. Une modification qui dupliquerait une autre correspondance répond 409 conflict ; un projet ou un profil inconnu répond 404. Écrit l'événement d'audit identity.group_mapping.update.

Route : /v1/identity/group-mappings/{mapping_id} (PATCH).

Nom	Type	Défaut	Requis	Description
id	String		oui	Identifiant (UUID) de la correspondance de groupe.
body	Object		oui	Champs à modifier ; les champs omis gardent leur valeur.

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

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

MembersClient.updateQuotaProfile

JsonNode updateQuotaProfile(String id, Object body)

Modifier un profil de quota. Modifie la période, le mode d'application ou les plafonds d'un profil, ainsi que les quotas d'utilisateurs déjà créés à partir de lui par les correspondances de groupes, dans la même transaction. Exige tenant_admin. Écrit l'événement d'audit identity.quota_profile.update avec le nombre de quotas modifiés. Répond 404 not_found pour un profil inconnu.

Route : /v1/identity/quota-profiles/{profile_id} (PATCH).

Nom	Type	Défaut	Requis	Description
id	String		oui	Identifiant (UUID) du profil de quota.
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 profil de quota ».

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