Sign in
console

`PUT /api/console-auth` — bind a Lark app as the console's OAuth client. Saving this enforces sign-in on the next request, so the bound app must already carry working credentials in the registry (else the console would silently stay open).

put/api/console-auth

Request

  • The document declares no server URL.
  • Auth: API key in cookie lk_session

Request body

adminsstring[]

Admin email allowlist; empty = any tenant user may sign in.

lark_appstring required

Name of a registered [lark-apps.<name>] to sign users in with.

redirect_uristring nullable

Override the auto-derived <host>/auth/callback (must match what the Lark app registers).

scopestring nullable

Extra OAuth scopes, space-separated (usually none).

Response

Binding saved; sign-in now required

okboolean required

Changes

No recorded changes to this operation across all 1 revision of this API.