Class SessionSandboxApi

java.lang.Object

com.github.copilot.generated.rpc.SessionSandboxApi

@Generated("copilot-sdk-codegen")
public final class SessionSandboxApi
extends Object

API methods for the sandbox namespace.

Since:

1.0.0

Method Summary

Modifier and Type	Method	Description
CompletableFuture<SessionSandboxDisableForSessionResult>	disableForSession(SessionSandboxDisableForSessionParams params)	Disables sandboxing for the remainder of the current session and approves the referenced pending sandbox-bypass permission request.
CompletableFuture<SessionSandboxGetCredentialSuggestionsResult>	getCredentialSuggestions()	Lists possible secret-bearing environment variables available to new sandboxed shells that are not already covered by credential masking.
CompletableFuture<SessionSandboxGetEnforcementStatusResult>	getEnforcementStatus()	Returns whether managed policy requires sandbox enforcement and whether an enforcement failure has permanently blocked the session.
CompletableFuture<SessionSandboxGrantPathForRequestResult>	grantPathForRequest(SessionSandboxGrantPathForRequestParams params)	Adds the path offered by a pending sandbox escalation permission request's sandboxPathGrant to the session's sandbox policy and approves the request, so the blocked operation re-runs inside the sandbox rather than outside it.

Methods inherited from class Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

getEnforcementStatus

@CopilotExperimental
public CompletableFuture<SessionSandboxGetEnforcementStatusResult> getEnforcementStatus()

Returns whether managed policy requires sandbox enforcement and whether an enforcement failure has permanently blocked the session.

Since:

1.0.0

getCredentialSuggestions

@CopilotExperimental
public CompletableFuture<SessionSandboxGetCredentialSuggestionsResult> getCredentialSuggestions()

Lists possible secret-bearing environment variables available to new sandboxed shells that are not already covered by credential masking. Uses local name rules and known-provider host suggestions, never returns secret values, and changes no settings or network permissions. Returns no suggestions while the session is not sandboxed.

Since:

1.0.0

disableForSession

@CopilotExperimental
public CompletableFuture<SessionSandboxDisableForSessionResult> disableForSession(SessionSandboxDisableForSessionParams params)

Disables sandboxing for the remainder of the current session and approves the referenced pending sandbox-bypass permission request. The request is rejected unless the exact request is still pending and the effective sandbox policy permits bypass.

Note: the sessionId field in the params record is overridden by the session-scoped wrapper; any value provided is ignored.

Since:

1.0.0

grantPathForRequest

@CopilotExperimental
public CompletableFuture<SessionSandboxGrantPathForRequestResult> grantPathForRequest(SessionSandboxGrantPathForRequestParams params)

Adds the path offered by a pending sandbox escalation permission request's sandboxPathGrant to the session's sandbox policy and approves the request, so the blocked operation re-runs inside the sandbox rather than outside it. The request is rejected unless the exact request is still pending, carries a sandboxPathGrant, and the grant still takes effect under the current managed policy. Does not persist the path; hosts that store sandbox settings save it themselves.

Note: the sessionId field in the params record is overridden by the session-scoped wrapper; any value provided is ignored.

Since:

1.0.0