Sign in
Auth

Create WorkOS AuthKit login URL

Builds the WorkOS AuthKit authorize URL for the desktop. The desktop opens the returned URL in the browser, preserving state and optional PKCE challenge.

get/v1/auth/workos/login-url

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /v1/auth/workos/login-url
  • Auth: none declared

Query parameters

redirect_uristring required

Redirect URI.

Example:http://localhost:8080/oauth/callback

Desktop loopback or custom redirect URI registered with the provider.

statestring required

OAuth state.

Example:kind-smoke

Opaque state generated by the desktop and echoed through the login flow.

code_challengestring

PKCE challenge.

Example:kind-smoke-challenge

Optional S256 PKCE code challenge.

Response

Authorize URL.

urlstring required

Fully-qualified WorkOS AuthKit authorize URL with PKCE and state query parameters.

Example response

{
  "url": "http://localhost:18090/user_management/authorize?client_id=solomon-desktop-kind&response_type=code&state=abc"
}

Changes

No recorded changes to this operation across all 50 revisions of this API.