Class SessionPermissionsApi

java.lang.Object

com.github.copilot.generated.rpc.SessionPermissionsApi

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

API methods for the permissions namespace.

Since:

1.0.0

Field Summary

Fields

Modifier and Type	Field	Description
final SessionPermissionsFolderTrustApi	folderTrust	API methods for the permissions.folderTrust sub-namespace.
final SessionPermissionsLocationsApi	locations	API methods for the permissions.locations sub-namespace.
final SessionPermissionsPathsApi	paths	API methods for the permissions.paths sub-namespace.
final SessionPermissionsUrlsApi	urls	API methods for the permissions.urls sub-namespace.

Method Summary

Modifier and Type	Method	Description
CompletableFuture<SessionPermissionsConfigureResult>	configure(SessionPermissionsConfigureParams params)	Replaces selected permission policy fields (rules, paths, URLs, exclusions, allow-all flags) on the session.
CompletableFuture<SessionPermissionsGetModeResult>	getMode()	Returns the current permission mode for the session.
CompletableFuture<SessionPermissionsHandlePendingPermissionRequestResult>	handlePendingPermissionRequest(SessionPermissionsHandlePendingPermissionRequestParams params)	Provides a decision for a pending tool permission request.
CompletableFuture<SessionPermissionsModifyRulesResult>	modifyRules(SessionPermissionsModifyRulesParams params)	Adds or removes session-scoped or location-scoped permission rules.
CompletableFuture<SessionPermissionsNotifyPromptShownResult>	notifyPromptShown(SessionPermissionsNotifyPromptShownParams params)	Notifies the runtime that a permission prompt UI has been shown to the user.
CompletableFuture<SessionPermissionsPendingRequestsResult>	pendingRequests()	Reconstructs the set of pending tool permission requests from the session's event history.
CompletableFuture<SessionPermissionsResetSessionApprovalsResult>	resetSessionApprovals(SessionPermissionsResetSessionApprovalsParams params)	Clears session-scoped tool approvals and, for full resets, exact session-approved paths.
CompletableFuture<SessionPermissionsSetApproveAllResult>	setApproveAll(SessionPermissionsSetApproveAllParams params)	Enables or disables automatic approval of tool permission requests for the session.
CompletableFuture<SessionPermissionsSetModeResult>	setMode(SessionPermissionsSetModeParams params)	Sets the permission mode for the session.
CompletableFuture<SessionPermissionsSetRequiredResult>	setRequired(SessionPermissionsSetRequiredParams params)	Sets whether the client wants permission prompts bridged into session events.

Methods inherited from class Object

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

Field Details

paths

public final SessionPermissionsPathsApi paths

API methods for the permissions.paths sub-namespace.

locations

public final SessionPermissionsLocationsApi locations

API methods for the permissions.locations sub-namespace.

folderTrust

public final SessionPermissionsFolderTrustApi folderTrust

API methods for the permissions.folderTrust sub-namespace.

urls

public final SessionPermissionsUrlsApi urls

API methods for the permissions.urls sub-namespace.

Method Details

configure

@CopilotExperimental
public CompletableFuture<SessionPermissionsConfigureResult> configure(SessionPermissionsConfigureParams params)

Replaces selected permission policy fields (rules, paths, URLs, exclusions, allow-all flags) on the session.

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

Since:

1.0.0

handlePendingPermissionRequest

@CopilotExperimental
public CompletableFuture<SessionPermissionsHandlePendingPermissionRequestResult> handlePendingPermissionRequest(SessionPermissionsHandlePendingPermissionRequestParams params)

Provides a decision for a pending tool permission request.

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

Since:

1.0.0

pendingRequests

@CopilotExperimental
public CompletableFuture<SessionPermissionsPendingRequestsResult> pendingRequests()

Reconstructs the set of pending tool permission requests from the session's event history.

Since:

1.0.0

setApproveAll

@CopilotExperimental
public CompletableFuture<SessionPermissionsSetApproveAllResult> setApproveAll(SessionPermissionsSetApproveAllParams params)

Enables or disables automatic approval of tool permission requests for the session.

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

Since:

1.0.0

setMode

@CopilotExperimental
public CompletableFuture<SessionPermissionsSetModeResult> setMode(SessionPermissionsSetModeParams params)

Sets the permission mode for the session. `manual` follows the normal approval flow, `assisted` attaches LLM safety recommendations, and `allow-all` automatically approves permission requests. The result returns the authoritative post-mutation mode so callers can update local state without racing the `session.permissions_changed` notification.

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

Since:

1.0.0

getMode

@CopilotExperimental
public CompletableFuture<SessionPermissionsGetModeResult> getMode()

Returns the current permission mode for the session.

Since:

1.0.0

modifyRules

@CopilotExperimental
public CompletableFuture<SessionPermissionsModifyRulesResult> modifyRules(SessionPermissionsModifyRulesParams params)

Adds or removes session-scoped or location-scoped permission rules.

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

Since:

1.0.0

setRequired

@CopilotExperimental
public CompletableFuture<SessionPermissionsSetRequiredResult> setRequired(SessionPermissionsSetRequiredParams params)

Sets whether the client wants permission prompts bridged into session events.

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

Since:

1.0.0

resetSessionApprovals

@CopilotExperimental
public CompletableFuture<SessionPermissionsResetSessionApprovalsResult> resetSessionApprovals(SessionPermissionsResetSessionApprovalsParams params)

Clears session-scoped tool approvals and, for full resets, exact session-approved paths.

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

Since:

1.0.0

notifyPromptShown

@CopilotExperimental
public CompletableFuture<SessionPermissionsNotifyPromptShownResult> notifyPromptShown(SessionPermissionsNotifyPromptShownParams params)

Notifies the runtime that a permission prompt UI has been shown to the user.

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

Since:

1.0.0