You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .speakeasy/in.openapi.yaml
+20-3Lines changed: 20 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -34290,7 +34290,7 @@ paths:
34290
34290
- 'API Keys'
34291
34291
x-speakeasy-name-override: 'list'
34292
34292
post:
34293
-
description: 'Create a new API key for the authenticated user. The plaintext `key` is returned only in this response. Treat it as a write-only, sensitive value; it cannot be retrieved later. Authenticate with a [management key](/docs/guides/overview/auth/management-api-keys), or with a Connect client secret.'
34293
+
description: 'Create a new API key for the authenticated user. The plaintext `key` is returned only in this response. Treat it as a write-only, sensitive value; it cannot be retrieved later. Authenticate with a [management key](/docs/guides/overview/auth/management-api-keys). The optional `external` object associates the key with a partner-defined user and lookup key.'
34294
34294
operationId: 'createKeys'
34295
34295
requestBody:
34296
34296
content:
@@ -34323,6 +34323,23 @@ paths:
34323
34323
type:
34324
34324
- 'string'
34325
34325
- 'null'
34326
+
external:
34327
+
description: 'Optional partner-defined identity associated with the created API key.'
34328
+
properties:
34329
+
api_key:
34330
+
description: 'Optional partner-supplied API key with a minimum length of 32 characters and sufficient entropy. Stored as a SHA-256 hash and never returned.'
34331
+
maxLength: 512
34332
+
minLength: 32
34333
+
type: 'string'
34334
+
user:
34335
+
description: 'Partner''s end-user identifier for attribution.'
34336
+
example: 'partner-user-123'
34337
+
maxLength: 512
34338
+
minLength: 1
34339
+
type: 'string'
34340
+
required:
34341
+
- 'user'
34342
+
type: 'object'
34326
34343
include_byok_in_limit:
34327
34344
description: 'Whether to include BYOK usage in the limit'
34328
34345
example: true
@@ -34642,7 +34659,7 @@ paths:
34642
34659
x-speakeasy-name-override: 'create'
34643
34660
/keys/{hash}:
34644
34661
delete:
34645
-
description: 'Delete an existing API key. Authenticate with a [management key](/docs/guides/overview/auth/management-api-keys), or with a Connect client secret. A client secret reaches only the keys that same client created; any other key responds as if it does not exist.'
34662
+
description: 'Delete an existing API key. Authenticate with a [management key](/docs/guides/overview/auth/management-api-keys).'
34646
34663
operationId: 'deleteKeys'
34647
34664
parameters:
34648
34665
- description: 'The hash identifier of the API key to delete'
@@ -34992,7 +35009,7 @@ paths:
34992
35009
- 'API Keys'
34993
35010
x-speakeasy-name-override: 'get'
34994
35011
patch:
34995
-
description: 'Update an existing API key. Authenticate with a [management key](/docs/guides/overview/auth/management-api-keys), or with a Connect client secret. A client secret reaches only the keys that same client created; any other key responds as if it does not exist.'
35012
+
description: 'Update an existing API key. Authenticate with a [management key](/docs/guides/overview/auth/management-api-keys).'
34996
35013
operationId: 'updateKeys'
34997
35014
parameters:
34998
35015
- description: 'The hash identifier of the API key to update'
0 commit comments