Agent APIKeys6

Agent Task Tracker3

Agents9

API Keys6

Authentication1

Branch Events1

Branches10

Builds3

CLI Authentication2

Environments7

Events2

Filesystems10

Groups14

Logs3

Messages v22

Namespaces8

OAuth2

Organizations9

Projects8

Raw Events1

Registry1

Schedules7

Search1

Secrets5

States5

Tasks19

Version Events1

Versions5

API Keys

Update API Key Sharing Groups

Update default sharing groups for resources created by an API key.

patch/api_keys/{api_key_id}/sharing-groups

Request

Base URL
https://docs.terminaluse.com (the document declares no server; this is the origin it was published from)
Auth
none declared
TypeScript
https://skmtc.dev/terminaluse/apis/sb0-api/docs/api_keys/:api_key_id/sharing-groups/patch.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

api_key_idstring required

Request body

sharing_group_idsstring[] required

Replacement sharing groups (future creations only).

Response

Successful Response

created_atstring date-time nullable

When the key was created.

created_bystring required

member_id of the creator.

descriptionstring nullable

Optional description.

idstring required

The unique identifier of the API key.

key_prefixstring required

Display prefix (e.g., 'sk_tu_abc...').

last_used_atstring date-time nullable

When the key was last used.

namestring required

Human-readable name for the API key.

org_idstring required

WorkOS organization ID.

revoked_atstring date-time nullable

When the key was revoked (soft delete).

sharing_group_idsstring[]

Groups that receive default admin grants on resources created by this key.

Changes

No recorded changes to this operation across all 1 revision of this API.