Class SessionMcpOauthApi

java.lang.Object

com.github.copilot.generated.rpc.SessionMcpOauthApi

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

API methods for the mcp.oauth namespace.

Since:

1.0.0

Method Summary

Modifier and Type	Method	Description
CompletableFuture<Void>	authenticationStateChanged(SessionMcpOauthAuthenticationStateChangedParams params)	Identifies the MCP server whose persisted OAuth credentials were updated.
CompletableFuture<SessionMcpOauthCancelLoginResult>	cancelLogin(SessionMcpOauthCancelLoginParams params)	Targets only the original prepared/applying owned login on this exact session requester.
CompletableFuture<SessionMcpOauthHandlePendingRequestResult>	handlePendingRequest(SessionMcpOauthHandlePendingRequestParams params)	Pending MCP OAuth request ID and host-provided token or cancellation response.
CompletableFuture<SessionMcpOauthLoginResult>	login(SessionMcpOauthLoginParams params)	Remote MCP server name and optional overrides controlling reauthentication, OAuth client display name, callback success-page copy, and static OAuth client selection.
CompletableFuture<SessionMcpOauthLoginResult>	login(SessionMcpOauthLoginRequest request)	Remote MCP server name and optional overrides controlling reauthentication, OAuth client display name, callback success-page copy, and static OAuth client selection.
CompletableFuture<SessionMcpOauthPrepareLoginResult>	prepareLogin(SessionMcpOauthPrepareLoginParams params)	Effect-free preparation bound to the existing local session, requester and installation, with frozen options.
CompletableFuture<McpOauthProbeResult>	probe(SessionMcpOauthProbeParams params)	Remote MCP server name for a passive OAuth status probe.
CompletableFuture<McpOauthProbeResult>	probe(SessionMcpOauthProbeRequest request)	Remote MCP server name for a passive OAuth status probe.
CompletableFuture<SessionMcpOauthRespondResult>	respond(SessionMcpOauthRespondParams params)	Pending MCP OAuth request id to respond to.

Methods inherited from class Object

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

Method Details

handlePendingRequest

@CopilotExperimental
public CompletableFuture<SessionMcpOauthHandlePendingRequestResult> handlePendingRequest(SessionMcpOauthHandlePendingRequestParams params)

Pending MCP OAuth request ID and host-provided token or cancellation response.

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

Since:

1.0.0

authenticationStateChanged

@CopilotExperimental
public CompletableFuture<Void> authenticationStateChanged(SessionMcpOauthAuthenticationStateChangedParams params)

Identifies the MCP server whose persisted OAuth credentials were updated.

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

Since:

1.0.0

prepareLogin

@CopilotExperimental
public CompletableFuture<SessionMcpOauthPrepareLoginResult> prepareLogin(SessionMcpOauthPrepareLoginParams params)

Effect-free preparation bound to the existing local session, requester and installation, with frozen options.

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

Since:

1.0.0

login

@CopilotExperimental
public CompletableFuture<SessionMcpOauthLoginResult> login(SessionMcpOauthLoginParams params)

Remote MCP server name and optional overrides controlling reauthentication, OAuth client display name, callback success-page copy, and static OAuth client selection.

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

Since:

1.0.0

login

@CopilotExperimental
public CompletableFuture<SessionMcpOauthLoginResult> login(SessionMcpOauthLoginRequest request)

Remote MCP server name and optional overrides controlling reauthentication, OAuth client display name, callback success-page copy, and static OAuth client selection.

Accepts the extensible request, including inputs added after the params record.

Since:

1.0.0

probe

@CopilotExperimental
public CompletableFuture<McpOauthProbeResult> probe(SessionMcpOauthProbeParams params)

Remote MCP server name for a passive OAuth status probe.

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

Since:

1.0.0

probe

@CopilotExperimental
public CompletableFuture<McpOauthProbeResult> probe(SessionMcpOauthProbeRequest request)

Remote MCP server name for a passive OAuth status probe.

Accepts the extensible request, including inputs added after the params record.

Since:

1.0.0

cancelLogin

@CopilotExperimental
public CompletableFuture<SessionMcpOauthCancelLoginResult> cancelLogin(SessionMcpOauthCancelLoginParams params)

Targets only the original prepared/applying owned login on this exact session requester.

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

Since:

1.0.0

respond

@CopilotExperimental
public CompletableFuture<SessionMcpOauthRespondResult> respond(SessionMcpOauthRespondParams params)

Pending MCP OAuth request id to respond to.

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

Since:

1.0.0