auth

Change a key’s name, permissions, expiry or scope; its value never changes

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. Send only what changes. permissions: "full", "read_only" or an object of group to level. expires_in_days (1 to 365) or expires_at (a date within a year; null removes the expiry). workspace_id: a workspace, or null for every workspace. A computer’s own key is Orgo’s: 409 managed_key. A key for one computer keeps its computer: workspace_id or computer_id is 400 computer_scope_fixed.

patch/api/keys/{id}

Request

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

Request body

namestring nullable
expires_in_daysinteger
expires_atstring date-time nullable

null removes the expiry.

workspace_idstring uuid nullable

Response

The key as it is now.

idstring uuid
namestring nullable
scope'account' | 'workspace' | 'computer'

Where it reaches.

workspace_idstring uuid nullable

The one workspace it reaches (a key for one computer: that computer’s); null for every workspace.

key_prefixstring nullable
created_atstring date-time
last_usedstring date-time nullable
access'full' | 'read_only' | 'custom'
expires_atstring date-time nullable

null: never.

expiredboolean

Past expires_at: listed until deleted, signs in nowhere (401 key_expired).

computer_keyboolean

A computer’s own key, made and rotated by Orgo.

rotated_atstring date-time nullable

A computer’s own key: when its secret last changed.

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

      endpoint added