v2

latestOpenAPI 3.1.0UNLICENSED2026-07-26210239.8 KB

Initiate device login flow via WorkOS CLI auth

post/device-auth/initiate

Request body

object required

Response

OK

deviceCodestring required

Device code for polling

userCodestring required

User code displayed to the user

verificationUristring required

URI the user should visit to authenticate

verificationUriCompletestring required

URI with the user code pre-filled for one-click authentication

expiresInnumber required

Seconds until the codes expire

intervalnumber required

Polling interval in seconds