io.enterpriseai.resources.SecurityClient
Source: sdks/java/enterprise-ai-java/src/main/java/io/enterpriseai/resources/SecurityClient.java. Back to the Java SDK reference index.
This page is generated by tools/docs/gen_sdk_reference.py from the SDK sources and the OpenAPI text folders. Do not edit it by hand: change the source and regenerate.
Class SecurityClient
Platform security posture and tenant security settings.
Constructor SecurityClient
SecurityClient(Transport transport)
Creates the client on the shared transport; EnterpriseAIClient builds it and exposes it through the accessor of the same name.
| Name | Type | Default | Required | Description |
|---|---|---|---|---|
transport | Transport | yes | Transport shared by the sub-clients of one client. |
SecurityClient.getSettings
JsonNode getSettings()
Get the security settings. Returns tenant_id and settings: the security settings of the tenant, defaults included. Needs tenant_admin or security_officer and a tenant (403 tenant_required).
Route: /v1/security/settings (GET).
This element takes no parameter.
Returns: JsonNode. Decoded JSON answer of the operation "Get the security settings".
Raises: the typed errors of the transport (Errors).
SecurityClient.posture
JsonNode posture()
Get the security posture. Returns environment, generated_at, protections (authentication methods and other protections in force), checks (each with its status pass, warn or fail, severity and message) and summary (number of checks per status). For a caller with a tenant, also tenant with the security settings of the tenant, which some checks take into account. Needs security_officer or tenant_admin. Read only.
Route: /v1/security/posture (GET).
This element takes no parameter.
Returns: JsonNode. Decoded JSON answer of the operation "Get the security posture".
Raises: the typed errors of the transport (Errors).
SecurityClient.updateSettings
JsonNode updateSettings(Object body)
Update the security settings. Partial update: only the settings sent change, the others keep their value. Needs tenant_admin or security_officer and a tenant.
Route: /v1/security/settings (PUT).
| Name | Type | Default | Required | Description |
|---|---|---|---|---|
body | Object | yes | JSON object with the settings to change, for example {"prompt_injection_mode": "block"}. |
Returns: JsonNode. Decoded JSON answer of the operation "Update the security settings".
Raises: the typed errors of the transport (Errors).
SecurityClient.updateSettings
JsonNode updateSettings(Object body, RequestOptions options)
Update the security settings. Partial update: only the settings sent change, the others keep their value. Needs tenant_admin or security_officer and a tenant.
Route: /v1/security/settings (PUT).
| Name | Type | Default | Required | Description |
|---|---|---|---|---|
body | Object | yes | JSON object with the settings to change, for example {"prompt_injection_mode": "block"}. | |
options | RequestOptions | yes | Per call options (idempotency key, traceparent, headers, abort signal). |
Returns: JsonNode. Decoded JSON answer of the operation "Update the security settings".
Raises: the typed errors of the transport (Errors).