Module com.github.copilot.java

Package com.github.copilot.generated.rpc

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)	Patch of permission policy fields to apply (omit a field to leave it unchanged).
CompletableFuture<SessionPermissionsGetAllowAllResult>	getAllowAll()	No parameters.
CompletableFuture<SessionPermissionsHandlePendingPermissionRequestResult>	handlePendingPermissionRequest(SessionPermissionsHandlePendingPermissionRequestParams params)	Pending permission request ID and the decision to apply (approve/reject and scope).
CompletableFuture<SessionPermissionsModifyRulesResult>	modifyRules(SessionPermissionsModifyRulesParams params)	Scope and add/remove instructions for modifying session- or location-scoped permission rules.
CompletableFuture<SessionPermissionsNotifyPromptShownResult>	notifyPromptShown(SessionPermissionsNotifyPromptShownParams params)	Notification payload describing the permission prompt that the client just rendered.
CompletableFuture<SessionPermissionsPendingRequestsResult>	pendingRequests()	No parameters; returns currently-pending permission requests for the session.
CompletableFuture<SessionPermissionsResetSessionApprovalsResult>	resetSessionApprovals()	No parameters; clears all session-scoped tool permission approvals.
CompletableFuture<SessionPermissionsSetAllowAllResult>	setAllowAll(SessionPermissionsSetAllowAllParams params)	Whether to enable full allow-all permissions for the session.
CompletableFuture<SessionPermissionsSetApproveAllResult>	setApproveAll(SessionPermissionsSetApproveAllParams params)	Allow-all toggle for tool permission requests, with an optional telemetry source.
CompletableFuture<SessionPermissionsSetRequiredResult>	setRequired(SessionPermissionsSetRequiredParams params)	Toggles whether permission prompts should be bridged into session events for this client.

Methods inherited from class java.lang.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

public CompletableFuture<SessionPermissionsConfigureResult> configure(SessionPermissionsConfigureParams params)

Patch of permission policy fields to apply (omit a field to leave it unchanged).

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

public CompletableFuture<SessionPermissionsHandlePendingPermissionRequestResult> handlePendingPermissionRequest(SessionPermissionsHandlePendingPermissionRequestParams params)

Pending permission request ID and the decision to apply (approve/reject and scope).

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

public CompletableFuture<SessionPermissionsPendingRequestsResult> pendingRequests()

No parameters; returns currently-pending permission requests for the session.

Since:

1.0.0

setApproveAll

public CompletableFuture<SessionPermissionsSetApproveAllResult> setApproveAll(SessionPermissionsSetApproveAllParams params)

Allow-all toggle for tool permission requests, with an optional telemetry source.

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

Since:

1.0.0

setAllowAll

public CompletableFuture<SessionPermissionsSetAllowAllResult> setAllowAll(SessionPermissionsSetAllowAllParams params)

Whether to enable full allow-all permissions 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

getAllowAll

public CompletableFuture<SessionPermissionsGetAllowAllResult> getAllowAll()

No parameters.

Since:

1.0.0

modifyRules

public CompletableFuture<SessionPermissionsModifyRulesResult> modifyRules(SessionPermissionsModifyRulesParams params)

Scope and add/remove instructions for modifying session- 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

public CompletableFuture<SessionPermissionsSetRequiredResult> setRequired(SessionPermissionsSetRequiredParams params)

Toggles whether permission prompts should be bridged into session events for this client.

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

public CompletableFuture<SessionPermissionsResetSessionApprovalsResult> resetSessionApprovals()

No parameters; clears all session-scoped tool permission approvals.

Since:

1.0.0

notifyPromptShown

public CompletableFuture<SessionPermissionsNotifyPromptShownResult> notifyPromptShown(SessionPermissionsNotifyPromptShownParams params)

Notification payload describing the permission prompt that the client just rendered.

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

Since:

1.0.0