Account

Look up a pending device code by its 6-digit user code (session only)

Changed on

Shows the approval page what a pending device login is: the requesting device's name, the IP that started the flow and when. User sessions only. Approving or denying a CLI login is something only a signed-in person does, so an API key can never call this. Rate limited per user and per IP, the brute-force mitigation for a guessed 6-digit code.

Requires the self.update permission. See Permissions for the roles and API key permissions that include it.

get/v1/cli-auth/device/{userCode}

Request

  • Base URL
    https://api.openrelay.inc
  • URL
    https://api.openrelay.inc/v1/cli-auth/device/{userCode}
  • Auth
    HTTP bearer

Path parameters

userCodestring required

Response

The pending code's device details

clientIpstring
deviceNamestring required
requestedAtstring date-time required
statusstring required

pending, approved, or denied.

Changes

  • 7fe59d94a9f5Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • dc9750cb25b5Revision changes
    • info

      endpoint added