io.enterpriseai.resources.AuthzClient
Source : sdks/java/enterprise-ai-java/src/main/java/io/enterpriseai/resources/AuthzClient.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 AuthzClient
Autorisation par relations. Contrôle d'accès fondé sur les relations (ReBAC) : vérifier et gérer les tuples d'autorisation du tenant. Le moteur est OpenFGA quand il est configuré, sinon la table de tuples intégrée, avec les mêmes règles.
Constructeur AuthzClient
AuthzClient(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. |
AuthzClient.check
JsonNode check(Object body)
Vérifier une relation. Indique si subject détient relation sur object, en suivant l'héritage. Jusqu'à 20 contextual_tuples sont tenus pour vrais pour cette seule vérification et jamais enregistrés (un tuple invalide répond 422 validation_error). Ouvert à tout membre du tenant. La réponse donne allowed, engine, subject, relation et object. Écrit l'événement d'audit authz.check avec la décision. Quand le moteur ne peut pas répondre, la décision est un refus, elle est auditée et l'API répond 502 authz_backend_error.
Route : /v1/authz/check (POST).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
body | Object | oui | Sujet, relation, objet et tuples contextuels facultatifs. |
Retour : JsonNode. Réponse JSON décodée de l'opération « Vérifier une relation ».
Erreurs levées : les erreurs typées du transport (Erreurs).
AuthzClient.check
JsonNode check(Object body, RequestOptions options)
Vérifier une relation. Indique si subject détient relation sur object, en suivant l'héritage. Jusqu'à 20 contextual_tuples sont tenus pour vrais pour cette seule vérification et jamais enregistrés (un tuple invalide répond 422 validation_error). Ouvert à tout membre du tenant. La réponse donne allowed, engine, subject, relation et object. Écrit l'événement d'audit authz.check avec la décision. Quand le moteur ne peut pas répondre, la décision est un refus, elle est auditée et l'API répond 502 authz_backend_error.
Route : /v1/authz/check (POST).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
body | Object | oui | Sujet, relation, objet et tuples contextuels facultatifs. | |
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 « Vérifier une relation ».
Erreurs levées : les erreurs typées du transport (Erreurs).
AuthzClient.deleteTuples
JsonNode deleteTuples(Object body)
Supprimer des tuples d'autorisation. Supprime un tuple ({subject, relation, object}) ou jusqu'à 100 ({"tuples": [...]}). Exige tenant_admin ou security_officer. Les tuples inexistants sont ignorés ; la réponse donne deleted (nombre supprimé) et engine. Écrit l'événement d'audit authz.delete. 502 authz_backend_error quand le moteur ne peut pas répondre.
Route : /v1/authz/tuples (DELETE).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
body | Object | oui | Un tuple, ou un objet tuples avec 1 à 100 tuples. |
Retour : JsonNode. Réponse JSON décodée de l'opération « Supprimer des tuples d'autorisation ».
Erreurs levées : les erreurs typées du transport (Erreurs).
AuthzClient.listTuples
io.enterpriseai.Page<JsonNode> listTuples()
Lister les tuples d'autorisation. Liste les tuples enregistrés du tenant, triés par objet, relation et sujet, 1000 au plus, éventuellement filtrés par objet et par sujet (égalité exacte). Ouvert à tout membre du tenant. next_cursor vaut toujours null.
Route : /v1/authz/tuples (GET).
Cet élément ne prend aucun paramètre.
Retour : io.enterpriseai.Page<JsonNode>. Réponse JSON décodée de l'opération « Lister les tuples d'autorisation ».
Erreurs levées : les erreurs typées du transport (Erreurs).
AuthzClient.listTuples
io.enterpriseai.Page<JsonNode> listTuples(java.util.Map<String, ?> query)
Lister les tuples d'autorisation. Liste les tuples enregistrés du tenant, triés par objet, relation et sujet, 1000 au plus, éventuellement filtrés par objet et par sujet (égalité exacte). Ouvert à tout membre du tenant. next_cursor vaut toujours null.
Route : /v1/authz/tuples (GET).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
query | java.util.Map<String, ?> | oui | Paramètres de la chaîne de requête de la route. |
Retour : io.enterpriseai.Page<JsonNode>. Réponse JSON décodée de l'opération « Lister les tuples d'autorisation ».
Erreurs levées : les erreurs typées du transport (Erreurs).
AuthzClient.writeTuples
JsonNode writeTuples(Object body)
Écrire des tuples d'autorisation. Accorde un tuple ({subject, relation, object}) ou jusqu'à 100 ({"tuples": [...]}) en une transaction. Exige tenant_admin ou security_officer. Un sujet générique (user:*) sur une relation réservée aux sujets nommés, comme can_assume, répond 422 authz_wildcard_not_allowed. La réponse (201) donne written et engine. Écrit l'événement d'audit authz.write. 502 authz_backend_error quand le moteur ne peut pas répondre.
Route : /v1/authz/tuples (POST).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
body | Object | oui | Un tuple, ou un objet tuples avec 1 à 100 tuples. |
Retour : JsonNode. Réponse JSON décodée de l'opération « Écrire des tuples d'autorisation ».
Erreurs levées : les erreurs typées du transport (Erreurs).
AuthzClient.writeTuples
JsonNode writeTuples(Object body, RequestOptions options)
Écrire des tuples d'autorisation. Accorde un tuple ({subject, relation, object}) ou jusqu'à 100 ({"tuples": [...]}) en une transaction. Exige tenant_admin ou security_officer. Un sujet générique (user:*) sur une relation réservée aux sujets nommés, comme can_assume, répond 422 authz_wildcard_not_allowed. La réponse (201) donne written et engine. Écrit l'événement d'audit authz.write. 502 authz_backend_error quand le moteur ne peut pas répondre.
Route : /v1/authz/tuples (POST).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
body | Object | oui | Un tuple, ou un objet tuples avec 1 à 100 tuples. | |
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 « Écrire des tuples d'autorisation ».
Erreurs levées : les erreurs typées du transport (Erreurs).