enterprise_ai.authz
Source : sdks/python/src/enterprise_ai/authz/__init__.py. Retour à l'index de la référence du SDK Python.
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
/v1/authz/check (OpenFGA, contrôles de relations) et /v1/policies/evaluate (OPA, décision expliquée).
Resource
AuthzClient.check
check(subject: str, relation: str, object: str, contextual_tuples: list[dict[str, str]] | None = None) -> Any
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 |
|---|---|---|---|---|
subject | str | oui | Sujet vérifié, <type>:<id> : user:alice, group:fin#member ou user:*. | |
relation | str | oui | Nom de la relation, minuscules, chiffres et tirets bas, par exemple viewer. | |
object | str | oui | Objet vérifié, <type>:<id>, par exemple project:42. | |
contextual_tuples | list[dict[str, str]] | None | None | non | Jusqu'à 20 tuples {subject, relation, object} tenus pour vrais pour cette seule vérification, jamais enregistrés. |
Retour : Any. 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_batch
check_batch(checks: Iterable[dict[str, Any]]) -> Any
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 |
|---|---|---|---|---|
checks | Iterable[dict[str, Any]] | oui | Contrôles à exécuter dans l'ordre, chacun {subject, relation, object, contextual_tuples?}. |
Retour : Any. 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.explain
explain(action: str, resource: dict[str, Any], context: dict[str, Any] | None = None, subject: dict[str, Any] | None = None) -> Any
Évaluer une demande de politique. Renvoie la décision pour une demande du Policy Contract. Le corps est un Policy Contract ({schema_version, request}) ou seulement son objet request (subject, action, resource, context) ; il est validé avec le contrat policy-contract (422 validation_error).
Route : /v1/policies/evaluate (POST).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
action | str | oui | Action à évaluer, par exemple tool.invoke. | |
resource | dict[str, Any] | oui | Uniquement cette ressource : <type> ou <type>:<id>, par exemple project:42. | |
context | dict[str, Any] | None | None | non | Entrée supplémentaire fournie à la politique (environnement, attributs de la requête). |
subject | dict[str, Any] | None | None | non | Uniquement les tuples de ce sujet, comme user:alice ou group:fin#member. |
Retour : Any. Réponse JSON décodée de l'opération « Évaluer une demande de politique ».
Erreurs levées : les erreurs typées du transport (Erreurs).
Fonctions
confirm_check
confirm_check(response: Any) -> Any
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 |
|---|---|---|---|---|
response | Any | oui | Réponse de POST /v1/authz/check à contrôler. |
Retour : Any. Réponse JSON décodée de l'opération « Vérifier une relation ».
Erreurs levées : AuthzUnconfirmed, les erreurs typées du transport (Erreurs).
confirm_decision
confirm_decision(response: Any) -> Any
Évaluer une demande de politique. Renvoie la décision pour une demande du Policy Contract. Le corps est un Policy Contract ({schema_version, request}) ou seulement son objet request (subject, action, resource, context) ; il est validé avec le contrat policy-contract (422 validation_error).
Route : /v1/policies/evaluate (POST).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
response | Any | oui | Réponse de POST /v1/policies/evaluate à contrôler. |
Retour : Any. Réponse JSON décodée de l'opération « Évaluer une demande de politique ».
Erreurs levées : AuthzUnconfirmed, les erreurs typées du transport (Erreurs).