KyPanelDocs
/

API reference

Oauth

Connected apps: the consent screen of the OAuth sign-in used by the /mcp endpoint (ChatGPT, Claude and other MCP clients).

Sign in and allow (or deny) a connected app

POST/api/v1/oauth/approve

Signs the person in (without opening a panel session) and sends the app back with a code.

Who
public
API tokens
not needed
Operation
oauthApprove · ky call oauthApprove

Parameters

NameIn
client_idquery
code_challengequery
code_challenge_methodquery
redirect_uriquery
resourcequery
response_typequery
scopequery
statequery

Request body

FieldType
asstring
codestring
denyboolean
passwordstring
querystring
read_onlyboolean
usernamestring

Responses

  • 200 OK
    Body
    FieldType
    mfa_requiredboolean
  • 400 Bad Request: invalid-request, validation
  • 401 Unauthorized: invalid-code, invalid-credentials
  • 500 Internal Server Error: internal

Describe a connected app's authorization request (consent screen)

GET/api/v1/oauth/request

Tells the consent screen (the SPA at /oauth/authorize) who asks, or why the request is invalid.

Who
public
API tokens
not needed
Operation
oauthRequestInfo · ky call oauthRequestInfo

Parameters

NameIn
client_idquery
code_challengequery
code_challenge_methodquery
redirect_uriquery
resourcequery
response_typequery
scopequery
statequery

Responses

  • 200 OK
    Body
    FieldType
    client_hoststring
    client_namestring
    panel_namestring
    read_onlyboolean
    serverstring