io.enterpriseai.resources.BreakGlassClient
Source: sdks/java/enterprise-ai-java/src/main/java/io/enterpriseai/resources/BreakGlassClient.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 BreakGlassClient
Break-glass emergency access grants.
Constructor BreakGlassClient
BreakGlassClient(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. |
BreakGlassClient.get
JsonNode get(String grantId)
Get a break glass grant. Returns one grant: requester, beneficiary, roles, scopes, reason, incident, duration, status, approval and dates. Visible to its requester and beneficiary and to tenant_admin, security_officer and auditor; anyone else gets 404 break_glass_not_found.
Route: /v1/break-glass/{grant_id} (GET).
| Name | Type | Default | Required | Description |
|---|---|---|---|---|
grantId | String | yes | Identifier (UUID) of the break glass grant. |
Returns: JsonNode. Decoded JSON answer of the operation "Get a break glass grant".
Raises: the typed errors of the transport (Errors).
BreakGlassClient.issueContext
JsonNode issueContext(String grantId, Object body)
Get an execution context for a break glass grant. Returns a signed ExecutionContext carrying the active elevation, whose lifetime never exceeds the grant expiry. Only the beneficiary may ask (403 forbidden); the grant must be active (409 break_glass_not_active); each audience must be known (400 context_wrong_audience). Downstream services verify it like any execution context.
Route: /v1/break-glass/{grant_id}/context (POST).
| Name | Type | Default | Required | Description |
|---|---|---|---|---|
grantId | String | yes | Identifier (UUID) of the break glass grant. | |
body | Object | yes | Optional audiences and lifetime of the context. |
Returns: JsonNode. Decoded JSON answer of the operation "Get an execution context for a break glass grant".
Raises: the typed errors of the transport (Errors).
BreakGlassClient.issueContext
JsonNode issueContext(String grantId, Object body, RequestOptions options)
Get an execution context for a break glass grant. Returns a signed ExecutionContext carrying the active elevation, whose lifetime never exceeds the grant expiry. Only the beneficiary may ask (403 forbidden); the grant must be active (409 break_glass_not_active); each audience must be known (400 context_wrong_audience). Downstream services verify it like any execution context.
Route: /v1/break-glass/{grant_id}/context (POST).
| Name | Type | Default | Required | Description |
|---|---|---|---|---|
grantId | String | yes | Identifier (UUID) of the break glass grant. | |
body | Object | yes | Optional audiences and lifetime of the context. | |
options | RequestOptions | yes | Per call options (idempotency key, traceparent, headers, abort signal). |
Returns: JsonNode. Decoded JSON answer of the operation "Get an execution context for a break glass grant".
Raises: the typed errors of the transport (Errors).
BreakGlassClient.list
JsonNode list()
List the break glass grants. Lists break glass grants, newest first: all of them for tenant_admin, security_officer and auditor, otherwise those the caller requested or benefits from. Active grants past their expiry are marked expired (audited once). An unknown status answers 400.
Route: /v1/break-glass (GET).
This element takes no parameter.
Returns: JsonNode. Decoded JSON answer of the operation "List the break glass grants".
Raises: the typed errors of the transport (Errors).
BreakGlassClient.list
JsonNode list(Map<String, ?> query)
List the break glass grants. Lists break glass grants, newest first: all of them for tenant_admin, security_officer and auditor, otherwise those the caller requested or benefits from. Active grants past their expiry are marked expired (audited once). An unknown status answers 400.
Route: /v1/break-glass (GET).
| Name | Type | Default | Required | Description |
|---|---|---|---|---|
query | Map<String, ?> | yes | Query string parameters of the route. |
Returns: JsonNode. Decoded JSON answer of the operation "List the break glass grants".
Raises: the typed errors of the transport (Errors).
BreakGlassClient.request
JsonNode request(Object body)
Request a break glass elevation. Requests an exceptional, time bound elevation for the beneficiary (the caller by default). Open to any member of the tenant.
Route: /v1/break-glass (POST).
| Name | Type | Default | Required | Description |
|---|---|---|---|---|
body | Object | yes | Roles, scopes, reason, duration, beneficiary and incident reference. |
Returns: JsonNode. Decoded JSON answer of the operation "Request a break glass elevation".
Raises: the typed errors of the transport (Errors).
BreakGlassClient.request
JsonNode request(Object body, RequestOptions options)
Request a break glass elevation. Requests an exceptional, time bound elevation for the beneficiary (the caller by default). Open to any member of the tenant.
Route: /v1/break-glass (POST).
| Name | Type | Default | Required | Description |
|---|---|---|---|---|
body | Object | yes | Roles, scopes, reason, duration, beneficiary and incident reference. | |
options | RequestOptions | yes | Per call options (idempotency key, traceparent, headers, abort signal). |
Returns: JsonNode. Decoded JSON answer of the operation "Request a break glass elevation".
Raises: the typed errors of the transport (Errors).
BreakGlassClient.revoke
JsonNode revoke(String grantId, Object body)
Revoke a break glass grant. Ends a pending or active grant and revokes the delegations created under it. Allowed to the requester, a tenant_admin or a security_officer (403 forbidden). A grant already closed answers 409 break_glass_closed. Writes the audit event break_glass.revoke.
Route: /v1/break-glass/{grant_id}/revoke (POST).
| Name | Type | Default | Required | Description |
|---|---|---|---|---|
grantId | String | yes | Identifier (UUID) of the break glass grant. | |
body | Object | yes | Optional reason. |
Returns: JsonNode. Decoded JSON answer of the operation "Revoke a break glass grant".
Raises: the typed errors of the transport (Errors).
BreakGlassClient.revoke
JsonNode revoke(String grantId, Object body, RequestOptions options)
Revoke a break glass grant. Ends a pending or active grant and revokes the delegations created under it. Allowed to the requester, a tenant_admin or a security_officer (403 forbidden). A grant already closed answers 409 break_glass_closed. Writes the audit event break_glass.revoke.
Route: /v1/break-glass/{grant_id}/revoke (POST).
| Name | Type | Default | Required | Description |
|---|---|---|---|---|
grantId | String | yes | Identifier (UUID) of the break glass grant. | |
body | Object | yes | Optional reason. | |
options | RequestOptions | yes | Per call options (idempotency key, traceparent, headers, abort signal). |
Returns: JsonNode. Decoded JSON answer of the operation "Revoke a break glass grant".
Raises: the typed errors of the transport (Errors).