auth

Create an API key, optionally restricted, scoped to one workspace or one computer, or expiring

Changed on

A key never makes or changes a key into more than it has itself: every group at or under its own level, its scope inside its own (a workspace key makes keys only for that workspace, never one for every workspace), and an expiry no later than its own when it expires. It changes or revokes only keys already within its own access, and only narrows itself; anything past that is 403 key_escalation. A signed in session may do anything to its own keys. A computer’s own key manages no keys (403 computer_key), nor does a key for one computer (403 computer_scope). An expired key answers 401 key_expired. The value is returned once. Sending neither permissions nor an expiry makes a full access key that never expires, as before. computer_id makes a key for one Linux computer (where enabled): it calls only that computer’s control and lifecycle endpoints (start, stop, restart, suspend, resume; never delete, resize, clone, fork or move), its computer never changes, it is deleted with the computer and does not follow copies. Only a session or a key for the whole account makes one. Revoking one that could control the computer changes the computer’s VNC password.

post/api/keys

Request

  • Base URL
    https://www.orgo.ai
  • Auth
    HTTP bearer

Request body

namestring

Left out with computer_id: "Key for <computer>".

workspace_idstring uuid
computer_idstring

A key for this one Linux computer (its id, or its current or a past VM id). Not with workspace_id.

expires_in_daysinteger
expires_atstring date-time

In the future, a year out at most. Left out with expires_in_days: never expires.

Response

The new key: ApiKey plus apiKey (and key), its value, shown once. With computer_id: scope computer and computer: { id, name, os, workspace_id }.

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

    • info

      added optional request body

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status