ServiceKeyWithKey
Service key with the full key value (only returned on creation)
Extends
Section titled “Extends”Properties
Section titled “Properties”| Property | Type | Description | Inherited from |
|---|---|---|---|
allowed_namespaces? |
string[] |
Allowed table namespaces | ServiceKey.allowed_namespaces |
created_at |
string |
Creation timestamp | ServiceKey.created_at |
created_by? |
string |
User who created the key | ServiceKey.created_by |
deprecated_at? |
string |
Deprecation timestamp (for key rotation) | ServiceKey.deprecated_at |
description? |
string |
Description | ServiceKey.description |
enabled |
boolean |
Whether the key is enabled | ServiceKey.enabled |
expires_at? |
string |
Expiration timestamp | ServiceKey.expires_at |
grace_period_ends_at? |
string |
Grace period end for deprecated keys | ServiceKey.grace_period_ends_at |
id |
string |
Unique identifier | ServiceKey.id |
key |
string |
The full key value - only shown once at creation | - |
key_prefix |
string |
Key prefix (first 16 chars, for identification) | ServiceKey.key_prefix |
key_type |
"anon" | "service" | "publishable" | "tenant_service" | "global_service" |
Key type. - anon — anonymous access - publishable — publishable client key (browser-safe) - service — elevated privileges, bypasses RLS (legacy admin-API type) - tenant_service — elevated, tenant-scoped (RLS-enforced) - global_service — elevated, cross-tenant, bypasses RLS |
ServiceKey.key_type |
last_used_at? |
string |
Last usage timestamp | ServiceKey.last_used_at |
name |
string |
Display name | ServiceKey.name |
rate_limit_per_hour? |
number |
Rate limit per hour | ServiceKey.rate_limit_per_hour |
rate_limit_per_minute? |
number |
Rate limit per minute | ServiceKey.rate_limit_per_minute |
replaced_by? |
string |
ID of replacement key (after rotation) | ServiceKey.replaced_by |
revoked_at? |
string |
Revocation timestamp | ServiceKey.revoked_at |
scopes |
string[] |
Permission scopes | ServiceKey.scopes |