Sign in
CLI

Start CLI browser login

Changed on

Starts a browser-assisted CLI login session. The response includes a device code for polling and a user code that the user approves in the browser. This endpoint does not require an API key.

post/cli/login/start

Request

  • Base URL: https://api.primitive.dev/v1
  • URL: https://api.primitive.dev/v1/cli/login/start
  • Auth: none required

Request body

device_namestring

Human-readable device name shown during browser approval

metadataobject

Optional client metadata stored with the login session; serialized JSON must be 2048 bytes or fewer

Response

CLI login session created

successboolean required

Changes

  • 52138fa51360Revision changes
    • info

      removed the invalid_signup_code enum value from the / response property for the response status

    • info

      removed the invalid_signup_code enum value from the / response property for the response status

  • 22d1dfc68434Revision changes
    • warning

      added the new not_a_repeating_send enum value to the / response property for the response status

    • warning

      added the new not_a_repeating_send enum value to the / response property for the response status

    • warning

      added the new repeat_idle_requires_internal_recipient enum value to the / response property for the response status

    • warning

      added the new repeat_idle_requires_internal_recipient enum value to the / response property for the response status

    • warning

      added the new repeat_recipient_external enum value to the / response property for the response status

    • warning

      added the new repeat_recipient_external enum value to the / response property for the response status

    • warning

      added the new repeat_stop_not_allowed enum value to the / response property for the response status

    • warning

      added the new repeat_stop_not_allowed enum value to the / response property for the response status

    • warning

      added the new repeat_unsupported enum value to the / response property for the response status

    • warning

      added the new repeat_unsupported enum value to the / response property for the response status