v1

latestOpenAPI 3.1.02026-08-04151221521.2 KB

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

api_key_idstring required

sharing_group_idsstring[] required

Replacement sharing groups (future creations only).

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.