orgs

Update Org Service Key

Changed on

Update an API key's role(s) in place without rotating the key.

Organization Operators cannot assign the Organization Admin role or change a key that already holds it, and no key can change its own roles. Workspace-scoped keys also require key-management permission in every workspace they cover. Applies to both org-scoped and workspace-scoped keys.

patch/api/v1/orgs/current/service-keys/{api_key_id}

Request

  • Base URL
    https://api.smith.langchain.com
  • URL
    https://api.smith.langchain.com/api/v1/orgs/current/service-keys/{api_key_id}
  • Auth
    • API key in header X-API-Key
    • or API key in header X-Organization-Id
    • or HTTP bearer

Path parameters

api_key_idstring uuid required

Request body

role_idstring uuid nullable
org_role_idstring uuid nullable

Response

Successful Response

created_atstring date-time nullable
idstring uuid required
short_keystring required
descriptionstring required
read_onlyboolean
last_used_atstring date-time nullable
expires_atstring date-time nullable
revoked_atstring date-time nullable
workspace_namesstring[] nullable
default_workspace_namestring nullable
role_idstring uuid nullable
org_role_idstring uuid nullable
access_scope'organization' | 'workspace'
created_bystring nullable
is_tracing_keyboolean
workspace_idsstring[]
can_deleteboolean

Whether tracing-key deletion authority has been confirmed. Legacy key responses do not evaluate this capability.

Changes