@workos/openapi-spec 0.15.0 → 0.16.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/open-api-spec.yaml +1830 -608
- package/dist/services.d.mts +1 -1
- package/dist/services.mjs +30 -0
- package/dist/types.d.ts +1292 -259
- package/package.json +2 -2
package/dist/open-api-spec.yaml
CHANGED
|
@@ -1,5 +1,117 @@
|
|
|
1
1
|
openapi: 3.1.1
|
|
2
2
|
paths:
|
|
3
|
+
/agents/credentials/validate:
|
|
4
|
+
post:
|
|
5
|
+
description: >-
|
|
6
|
+
Validate an agent credential — an API key or access token — against the
|
|
7
|
+
environment of the API key used to authenticate the request. This is a
|
|
8
|
+
read-only check: it never consumes or mutates the credential.
|
|
9
|
+
operationId: AgentAdminController_validateCredential
|
|
10
|
+
parameters: []
|
|
11
|
+
requestBody:
|
|
12
|
+
required: true
|
|
13
|
+
content:
|
|
14
|
+
application/json:
|
|
15
|
+
schema:
|
|
16
|
+
type: object
|
|
17
|
+
properties:
|
|
18
|
+
type:
|
|
19
|
+
type: string
|
|
20
|
+
enum:
|
|
21
|
+
- api_key
|
|
22
|
+
- access_token
|
|
23
|
+
description: >-
|
|
24
|
+
The kind of credential being validated — an agent API key or
|
|
25
|
+
an agent access token.
|
|
26
|
+
example: access_token
|
|
27
|
+
credential:
|
|
28
|
+
type: string
|
|
29
|
+
minLength: 1
|
|
30
|
+
description: >-
|
|
31
|
+
The credential value to validate: the API key value for
|
|
32
|
+
`api_key`, or the access token (JWT) for `access_token`.
|
|
33
|
+
example: sk_agent_example_1234567890
|
|
34
|
+
audience:
|
|
35
|
+
type: string
|
|
36
|
+
minLength: 1
|
|
37
|
+
description: >-
|
|
38
|
+
Only applies to `access_token` credentials. When provided,
|
|
39
|
+
the access token's `aud` claim is verified against this
|
|
40
|
+
value — tokens issued for a different resource are rejected.
|
|
41
|
+
Not permitted for `api_key` credentials.
|
|
42
|
+
example: https://api.example.com
|
|
43
|
+
required:
|
|
44
|
+
- type
|
|
45
|
+
- credential
|
|
46
|
+
responses:
|
|
47
|
+
'200':
|
|
48
|
+
description: OK
|
|
49
|
+
content:
|
|
50
|
+
application/json:
|
|
51
|
+
schema:
|
|
52
|
+
$ref: '#/components/schemas/AgentCredentialValidation'
|
|
53
|
+
'400':
|
|
54
|
+
description: Bad Request
|
|
55
|
+
content:
|
|
56
|
+
application/json:
|
|
57
|
+
schema:
|
|
58
|
+
type: object
|
|
59
|
+
properties:
|
|
60
|
+
code:
|
|
61
|
+
type: string
|
|
62
|
+
description: The error code identifying the type of error.
|
|
63
|
+
example: invalid_request
|
|
64
|
+
const: invalid_request
|
|
65
|
+
message:
|
|
66
|
+
type: string
|
|
67
|
+
description: A human-readable description of the error.
|
|
68
|
+
example: Request could not be processed.
|
|
69
|
+
required:
|
|
70
|
+
- code
|
|
71
|
+
- message
|
|
72
|
+
summary: Validate an agent credential
|
|
73
|
+
tags:
|
|
74
|
+
- agents
|
|
75
|
+
x-feature-flag: agent-auth-public-api
|
|
76
|
+
/agents/registrations/{id}:
|
|
77
|
+
get:
|
|
78
|
+
description: >-
|
|
79
|
+
Retrieve the details of an agent registration by ID. The registration is
|
|
80
|
+
scoped to the environment of the API key used to authenticate the
|
|
81
|
+
request.
|
|
82
|
+
operationId: AgentAdminController_getRegistration
|
|
83
|
+
parameters:
|
|
84
|
+
- name: id
|
|
85
|
+
required: true
|
|
86
|
+
in: path
|
|
87
|
+
description: The unique ID of the agent registration.
|
|
88
|
+
schema:
|
|
89
|
+
type: string
|
|
90
|
+
example: agent_reg_01EHWNCE74X7JSDV0X3SZ3KJNY
|
|
91
|
+
responses:
|
|
92
|
+
'200':
|
|
93
|
+
description: OK
|
|
94
|
+
content:
|
|
95
|
+
application/json:
|
|
96
|
+
schema:
|
|
97
|
+
$ref: '#/components/schemas/AgentRegistration'
|
|
98
|
+
'404':
|
|
99
|
+
description: Not Found
|
|
100
|
+
content:
|
|
101
|
+
application/json:
|
|
102
|
+
schema:
|
|
103
|
+
type: object
|
|
104
|
+
properties:
|
|
105
|
+
message:
|
|
106
|
+
type: string
|
|
107
|
+
description: A human-readable description of the error.
|
|
108
|
+
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
109
|
+
required:
|
|
110
|
+
- message
|
|
111
|
+
summary: Get an agent registration
|
|
112
|
+
tags:
|
|
113
|
+
- agents
|
|
114
|
+
x-feature-flag: agent-auth-public-api
|
|
3
115
|
/api_keys/validations:
|
|
4
116
|
post:
|
|
5
117
|
description: Validate an API key value and return the API key object if valid.
|
|
@@ -2253,6 +2365,9 @@ paths:
|
|
|
2253
2365
|
id: authz_resource_01HXYZ123456789ABCDEFGH
|
|
2254
2366
|
external_id: project-ext-456
|
|
2255
2367
|
resource_type_slug: project
|
|
2368
|
+
source:
|
|
2369
|
+
type: direct
|
|
2370
|
+
group_role_assignment_id: null
|
|
2256
2371
|
created_at: '2026-01-15T12:00:00.000Z'
|
|
2257
2372
|
updated_at: '2026-01-15T12:00:00.000Z'
|
|
2258
2373
|
description: Created
|
|
@@ -6204,6 +6319,25 @@ paths:
|
|
|
6204
6319
|
`after` fetches newer records).
|
|
6205
6320
|
schema:
|
|
6206
6321
|
$ref: '#/components/schemas/PaginationOrder'
|
|
6322
|
+
- name: registration_types
|
|
6323
|
+
required: false
|
|
6324
|
+
in: query
|
|
6325
|
+
description: >-
|
|
6326
|
+
Filter Connect Applications by registration type. Specify multiple
|
|
6327
|
+
as a comma-separated list (e.g.
|
|
6328
|
+
`registration_types=dynamic,authenticated`). Defaults to
|
|
6329
|
+
`authenticated` only when not specified.
|
|
6330
|
+
style: form
|
|
6331
|
+
explode: false
|
|
6332
|
+
schema:
|
|
6333
|
+
type: array
|
|
6334
|
+
items:
|
|
6335
|
+
type: string
|
|
6336
|
+
enum:
|
|
6337
|
+
- dynamic
|
|
6338
|
+
- authenticated
|
|
6339
|
+
example:
|
|
6340
|
+
- authenticated
|
|
6207
6341
|
- name: organization_id
|
|
6208
6342
|
required: false
|
|
6209
6343
|
in: query
|
|
@@ -6816,6 +6950,118 @@ paths:
|
|
|
6816
6950
|
summary: Delete a Connection
|
|
6817
6951
|
tags:
|
|
6818
6952
|
- connections
|
|
6953
|
+
/data-integrations/{slug}/api-key:
|
|
6954
|
+
put:
|
|
6955
|
+
description: >-
|
|
6956
|
+
Creates or updates an API-key-based installation for the specified
|
|
6957
|
+
integration and user. If an installation already exists, the stored API
|
|
6958
|
+
key is rotated to the new value.
|
|
6959
|
+
operationId: DataIntegrationsController_upsertApiKey
|
|
6960
|
+
parameters:
|
|
6961
|
+
- name: slug
|
|
6962
|
+
required: true
|
|
6963
|
+
in: path
|
|
6964
|
+
description: The identifier of the integration.
|
|
6965
|
+
schema:
|
|
6966
|
+
example: github
|
|
6967
|
+
type: string
|
|
6968
|
+
requestBody:
|
|
6969
|
+
required: true
|
|
6970
|
+
content:
|
|
6971
|
+
application/json:
|
|
6972
|
+
schema:
|
|
6973
|
+
type: object
|
|
6974
|
+
properties:
|
|
6975
|
+
user_id:
|
|
6976
|
+
type: string
|
|
6977
|
+
description: A [User](/reference/authkit/user) identifier.
|
|
6978
|
+
example: user_01EHZNVPK3SFK441A1RGBFSHRT
|
|
6979
|
+
organization_id:
|
|
6980
|
+
type: string
|
|
6981
|
+
description: >-
|
|
6982
|
+
An [Organization](/reference/organization) identifier.
|
|
6983
|
+
Optional parameter to scope the connection to a specific
|
|
6984
|
+
organization.
|
|
6985
|
+
example: org_01EHZNVPK3SFK441A1RGBFSHRT
|
|
6986
|
+
secret:
|
|
6987
|
+
type: string
|
|
6988
|
+
minLength: 1
|
|
6989
|
+
description: The API key secret to store for this integration.
|
|
6990
|
+
example: sk-1234567890abcdef
|
|
6991
|
+
required:
|
|
6992
|
+
- user_id
|
|
6993
|
+
- secret
|
|
6994
|
+
responses:
|
|
6995
|
+
'200':
|
|
6996
|
+
description: The resulting connected account after the upsert.
|
|
6997
|
+
content:
|
|
6998
|
+
application/json:
|
|
6999
|
+
schema:
|
|
7000
|
+
$ref: '#/components/schemas/ConnectedAccount'
|
|
7001
|
+
example:
|
|
7002
|
+
object: connected_account
|
|
7003
|
+
id: data_installation_01EHZNVPK3SFK441A1RGBFSHRT
|
|
7004
|
+
user_id: user_01EHZNVPK3SFK441A1RGBFSHRT
|
|
7005
|
+
organization_id: org_01EHZNVPK3SFK441A1RGBFSHRT
|
|
7006
|
+
scopes: []
|
|
7007
|
+
auth_method: api_key
|
|
7008
|
+
api_key_last_4: cdef
|
|
7009
|
+
state: connected
|
|
7010
|
+
created_at: '2024-01-16T14:20:00.000Z'
|
|
7011
|
+
updated_at: '2024-01-16T14:20:00.000Z'
|
|
7012
|
+
'400':
|
|
7013
|
+
description: Bad Request
|
|
7014
|
+
content:
|
|
7015
|
+
application/json:
|
|
7016
|
+
schema:
|
|
7017
|
+
type: object
|
|
7018
|
+
properties:
|
|
7019
|
+
message:
|
|
7020
|
+
type: string
|
|
7021
|
+
description: A human-readable description of the error.
|
|
7022
|
+
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
7023
|
+
required:
|
|
7024
|
+
- message
|
|
7025
|
+
'401':
|
|
7026
|
+
description: Unauthorized
|
|
7027
|
+
'403':
|
|
7028
|
+
description: Forbidden
|
|
7029
|
+
content:
|
|
7030
|
+
application/json:
|
|
7031
|
+
schema:
|
|
7032
|
+
type: object
|
|
7033
|
+
properties:
|
|
7034
|
+
message:
|
|
7035
|
+
type: string
|
|
7036
|
+
description: A human-readable description of the error.
|
|
7037
|
+
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
7038
|
+
required:
|
|
7039
|
+
- message
|
|
7040
|
+
'404':
|
|
7041
|
+
description: Data integration not found for the given provider slug.
|
|
7042
|
+
content:
|
|
7043
|
+
application/json:
|
|
7044
|
+
schema:
|
|
7045
|
+
type: object
|
|
7046
|
+
properties:
|
|
7047
|
+
message:
|
|
7048
|
+
type: string
|
|
7049
|
+
description: A human-readable description of the error.
|
|
7050
|
+
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
7051
|
+
required:
|
|
7052
|
+
- message
|
|
7053
|
+
'422':
|
|
7054
|
+
description: >-
|
|
7055
|
+
The matched installation uses a different auth method than this
|
|
7056
|
+
endpoint expects.
|
|
7057
|
+
content:
|
|
7058
|
+
application/json:
|
|
7059
|
+
schema:
|
|
7060
|
+
$ref: '#/components/schemas/AuthMethodMismatchError'
|
|
7061
|
+
summary: Upsert an API key for a connected account
|
|
7062
|
+
tags:
|
|
7063
|
+
- pipes
|
|
7064
|
+
x-feature-flag: pipes-api-keys
|
|
6819
7065
|
/data-integrations/{slug}/authorize:
|
|
6820
7066
|
post:
|
|
6821
7067
|
description: >-
|
|
@@ -6908,6 +7154,91 @@ paths:
|
|
|
6908
7154
|
summary: Get authorization URL
|
|
6909
7155
|
tags:
|
|
6910
7156
|
- pipes
|
|
7157
|
+
/data-integrations/{slug}/credentials:
|
|
7158
|
+
post:
|
|
7159
|
+
description: >-
|
|
7160
|
+
Returns credentials for a user's connected account. Branches on the
|
|
7161
|
+
installation's `auth_method`: OAuth installations return an access token
|
|
7162
|
+
(refreshed if needed); API-key installations return the stored secret.
|
|
7163
|
+
operationId: DataIntegrationsController_vendCredentials
|
|
7164
|
+
parameters:
|
|
7165
|
+
- name: slug
|
|
7166
|
+
required: true
|
|
7167
|
+
in: path
|
|
7168
|
+
description: The identifier of the integration.
|
|
7169
|
+
schema:
|
|
7170
|
+
example: github
|
|
7171
|
+
type: string
|
|
7172
|
+
requestBody:
|
|
7173
|
+
required: true
|
|
7174
|
+
content:
|
|
7175
|
+
application/json:
|
|
7176
|
+
schema:
|
|
7177
|
+
type: object
|
|
7178
|
+
properties:
|
|
7179
|
+
user_id:
|
|
7180
|
+
type: string
|
|
7181
|
+
description: A [User](/reference/authkit/user) identifier.
|
|
7182
|
+
example: user_01EHZNVPK3SFK441A1RGBFSHRT
|
|
7183
|
+
organization_id:
|
|
7184
|
+
type: string
|
|
7185
|
+
description: >-
|
|
7186
|
+
An [Organization](/reference/organization) identifier.
|
|
7187
|
+
Optional parameter to scope the connection to a specific
|
|
7188
|
+
organization.
|
|
7189
|
+
example: org_01EHZNVPK3SFK441A1RGBFSHRT
|
|
7190
|
+
required:
|
|
7191
|
+
- user_id
|
|
7192
|
+
responses:
|
|
7193
|
+
'200':
|
|
7194
|
+
description: OK
|
|
7195
|
+
content:
|
|
7196
|
+
application/json:
|
|
7197
|
+
schema:
|
|
7198
|
+
$ref: '#/components/schemas/DataIntegrationCredentialsResponse'
|
|
7199
|
+
example:
|
|
7200
|
+
active: true
|
|
7201
|
+
credential:
|
|
7202
|
+
object: credential
|
|
7203
|
+
auth_method: oauth
|
|
7204
|
+
value: gho_16C7e42F292c6912E7710c838347Ae178B4a
|
|
7205
|
+
expires_at: '2025-12-31T23:59:59.000Z'
|
|
7206
|
+
scopes:
|
|
7207
|
+
- repo
|
|
7208
|
+
- user:email
|
|
7209
|
+
missing_scopes: []
|
|
7210
|
+
'400':
|
|
7211
|
+
description: Bad Request
|
|
7212
|
+
content:
|
|
7213
|
+
application/json:
|
|
7214
|
+
schema:
|
|
7215
|
+
type: object
|
|
7216
|
+
properties:
|
|
7217
|
+
message:
|
|
7218
|
+
type: string
|
|
7219
|
+
description: A human-readable description of the error.
|
|
7220
|
+
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
7221
|
+
required:
|
|
7222
|
+
- message
|
|
7223
|
+
'401':
|
|
7224
|
+
description: Unauthorized
|
|
7225
|
+
'404':
|
|
7226
|
+
description: Data integration not found for the given provider slug.
|
|
7227
|
+
content:
|
|
7228
|
+
application/json:
|
|
7229
|
+
schema:
|
|
7230
|
+
type: object
|
|
7231
|
+
properties:
|
|
7232
|
+
message:
|
|
7233
|
+
type: string
|
|
7234
|
+
description: A human-readable description of the error.
|
|
7235
|
+
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
7236
|
+
required:
|
|
7237
|
+
- message
|
|
7238
|
+
summary: Vend credentials for a connected account
|
|
7239
|
+
tags:
|
|
7240
|
+
- pipes
|
|
7241
|
+
x-feature-flag: pipes-api-keys
|
|
6911
7242
|
/data-integrations/{slug}/token:
|
|
6912
7243
|
post:
|
|
6913
7244
|
description: >-
|
|
@@ -10102,6 +10433,10 @@ paths:
|
|
|
10102
10433
|
enum:
|
|
10103
10434
|
- sign-up
|
|
10104
10435
|
- sign-in
|
|
10436
|
+
signals_id:
|
|
10437
|
+
type: string
|
|
10438
|
+
description: An optional Radar signals ID for the request.
|
|
10439
|
+
example: 01JBS0GN92GC2RJQS4X9DBPQ2A
|
|
10105
10440
|
required:
|
|
10106
10441
|
- ip_address
|
|
10107
10442
|
- user_agent
|
|
@@ -12021,6 +12356,19 @@ paths:
|
|
|
12021
12356
|
description: >-
|
|
12022
12357
|
A token representing a user invitation to redeem during
|
|
12023
12358
|
authentication.
|
|
12359
|
+
- name: max_age
|
|
12360
|
+
required: false
|
|
12361
|
+
in: query
|
|
12362
|
+
schema:
|
|
12363
|
+
type: integer
|
|
12364
|
+
minimum: 0
|
|
12365
|
+
example: 3600
|
|
12366
|
+
description: >-
|
|
12367
|
+
Maximum allowable elapsed time, in seconds, since the user last
|
|
12368
|
+
actively authenticated. If the last authentication is older than
|
|
12369
|
+
this value, the user is prompted to re-authenticate; a value of `0`
|
|
12370
|
+
forces re-authentication. Only supported when the provider is
|
|
12371
|
+
`authkit`.
|
|
12024
12372
|
- name: screen_hint
|
|
12025
12373
|
required: false
|
|
12026
12374
|
in: query
|
|
@@ -12265,47 +12613,160 @@ paths:
|
|
|
12265
12613
|
summary: Create a CORS origin
|
|
12266
12614
|
tags:
|
|
12267
12615
|
- user-management.cors-origins
|
|
12268
|
-
/user_management/email_verification/{id}:
|
|
12269
|
-
get:
|
|
12270
|
-
description: >-
|
|
12271
|
-
Get the details of an existing email verification code that can be used
|
|
12272
|
-
to send an email to a user for verification.
|
|
12273
|
-
operationId: UserlandUsersController_getEmailVerification
|
|
12274
|
-
parameters:
|
|
12275
|
-
- name: id
|
|
12276
|
-
required: true
|
|
12277
|
-
in: path
|
|
12278
|
-
description: The ID of the email verification code.
|
|
12279
|
-
schema:
|
|
12280
|
-
type: string
|
|
12281
|
-
example: email_verification_01E4ZCR3C56J083X43JQXF3JK5
|
|
12282
|
-
responses:
|
|
12283
|
-
'200':
|
|
12284
|
-
description: OK
|
|
12285
|
-
content:
|
|
12286
|
-
application/json:
|
|
12287
|
-
schema:
|
|
12288
|
-
$ref: '#/components/schemas/EmailVerification'
|
|
12289
|
-
'404':
|
|
12290
|
-
description: Not Found
|
|
12291
|
-
content:
|
|
12292
|
-
application/json:
|
|
12293
|
-
schema:
|
|
12294
|
-
type: object
|
|
12295
|
-
properties:
|
|
12296
|
-
message:
|
|
12297
|
-
type: string
|
|
12298
|
-
description: A human-readable description of the error.
|
|
12299
|
-
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
12300
|
-
required:
|
|
12301
|
-
- message
|
|
12302
|
-
summary: Get an email verification code
|
|
12303
|
-
tags:
|
|
12304
|
-
- user-management.users
|
|
12305
|
-
/user_management/invitations:
|
|
12306
12616
|
get:
|
|
12307
|
-
description:
|
|
12308
|
-
operationId:
|
|
12617
|
+
description: Lists the CORS origins for the current environment.
|
|
12618
|
+
operationId: CorsOriginsController_list
|
|
12619
|
+
parameters:
|
|
12620
|
+
- name: before
|
|
12621
|
+
required: false
|
|
12622
|
+
in: query
|
|
12623
|
+
description: >-
|
|
12624
|
+
An object ID that defines your place in the list. When the ID is not
|
|
12625
|
+
present, you are at the end of the list. For example, if you make a
|
|
12626
|
+
list request and receive 100 objects, ending with `"obj_123"`, your
|
|
12627
|
+
subsequent call can include `before="obj_123"` to fetch a new batch
|
|
12628
|
+
of objects before `"obj_123"`.
|
|
12629
|
+
schema:
|
|
12630
|
+
example: xxx_01HXYZ123456789ABCDEFGHIJ
|
|
12631
|
+
type: string
|
|
12632
|
+
- name: after
|
|
12633
|
+
required: false
|
|
12634
|
+
in: query
|
|
12635
|
+
description: >-
|
|
12636
|
+
An object ID that defines your place in the list. When the ID is not
|
|
12637
|
+
present, you are at the end of the list. For example, if you make a
|
|
12638
|
+
list request and receive 100 objects, ending with `"obj_123"`, your
|
|
12639
|
+
subsequent call can include `after="obj_123"` to fetch a new batch
|
|
12640
|
+
of objects after `"obj_123"`.
|
|
12641
|
+
schema:
|
|
12642
|
+
example: xxx_01HXYZ987654321KJIHGFEDCBA
|
|
12643
|
+
type: string
|
|
12644
|
+
- name: limit
|
|
12645
|
+
required: false
|
|
12646
|
+
in: query
|
|
12647
|
+
description: >-
|
|
12648
|
+
Upper limit on the number of objects to return, between `1` and
|
|
12649
|
+
`100`.
|
|
12650
|
+
schema:
|
|
12651
|
+
minimum: 1
|
|
12652
|
+
maximum: 100
|
|
12653
|
+
default: 10
|
|
12654
|
+
example: 10
|
|
12655
|
+
type: integer
|
|
12656
|
+
- name: order
|
|
12657
|
+
required: false
|
|
12658
|
+
in: query
|
|
12659
|
+
description: >-
|
|
12660
|
+
Order the results by the creation time. Supported values are `"asc"`
|
|
12661
|
+
(ascending), `"desc"` (descending), and `"normal"` (descending with
|
|
12662
|
+
reversed cursor semantics where `before` fetches older records and
|
|
12663
|
+
`after` fetches newer records).
|
|
12664
|
+
schema:
|
|
12665
|
+
$ref: '#/components/schemas/PaginationOrder'
|
|
12666
|
+
responses:
|
|
12667
|
+
'200':
|
|
12668
|
+
description: CORS origins listed successfully.
|
|
12669
|
+
content:
|
|
12670
|
+
application/json:
|
|
12671
|
+
schema:
|
|
12672
|
+
allOf:
|
|
12673
|
+
- type: object
|
|
12674
|
+
properties:
|
|
12675
|
+
object:
|
|
12676
|
+
type: string
|
|
12677
|
+
description: Indicates this is a list response.
|
|
12678
|
+
const: list
|
|
12679
|
+
list_metadata:
|
|
12680
|
+
type: object
|
|
12681
|
+
properties:
|
|
12682
|
+
before:
|
|
12683
|
+
type:
|
|
12684
|
+
- string
|
|
12685
|
+
- 'null'
|
|
12686
|
+
description: >-
|
|
12687
|
+
An object ID that defines your place in the list.
|
|
12688
|
+
When the ID is not present, you are at the start
|
|
12689
|
+
of the list.
|
|
12690
|
+
example: cors_origin_01HXYZ123456789ABCDEFGHIJ
|
|
12691
|
+
after:
|
|
12692
|
+
type:
|
|
12693
|
+
- string
|
|
12694
|
+
- 'null'
|
|
12695
|
+
description: >-
|
|
12696
|
+
An object ID that defines your place in the list.
|
|
12697
|
+
When the ID is not present, you are at the end of
|
|
12698
|
+
the list.
|
|
12699
|
+
example: cors_origin_01HXYZ987654321KJIHGFEDCBA
|
|
12700
|
+
required:
|
|
12701
|
+
- before
|
|
12702
|
+
- after
|
|
12703
|
+
description: >-
|
|
12704
|
+
Pagination cursors for navigating between pages of
|
|
12705
|
+
results.
|
|
12706
|
+
- type: object
|
|
12707
|
+
properties:
|
|
12708
|
+
data:
|
|
12709
|
+
type: array
|
|
12710
|
+
description: The list of records for the current page.
|
|
12711
|
+
items:
|
|
12712
|
+
$ref: '#/components/schemas/CorsOriginResponse'
|
|
12713
|
+
'401':
|
|
12714
|
+
description: Unauthorized
|
|
12715
|
+
content:
|
|
12716
|
+
application/json:
|
|
12717
|
+
schema:
|
|
12718
|
+
type: object
|
|
12719
|
+
properties:
|
|
12720
|
+
message:
|
|
12721
|
+
type: string
|
|
12722
|
+
description: A human-readable description of the error.
|
|
12723
|
+
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
12724
|
+
required:
|
|
12725
|
+
- message
|
|
12726
|
+
summary: List CORS origins
|
|
12727
|
+
tags:
|
|
12728
|
+
- user-management.cors-origins
|
|
12729
|
+
/user_management/email_verification/{id}:
|
|
12730
|
+
get:
|
|
12731
|
+
description: >-
|
|
12732
|
+
Get the details of an existing email verification code that can be used
|
|
12733
|
+
to send an email to a user for verification.
|
|
12734
|
+
operationId: UserlandUsersController_getEmailVerification
|
|
12735
|
+
parameters:
|
|
12736
|
+
- name: id
|
|
12737
|
+
required: true
|
|
12738
|
+
in: path
|
|
12739
|
+
description: The ID of the email verification code.
|
|
12740
|
+
schema:
|
|
12741
|
+
type: string
|
|
12742
|
+
example: email_verification_01E4ZCR3C56J083X43JQXF3JK5
|
|
12743
|
+
responses:
|
|
12744
|
+
'200':
|
|
12745
|
+
description: OK
|
|
12746
|
+
content:
|
|
12747
|
+
application/json:
|
|
12748
|
+
schema:
|
|
12749
|
+
$ref: '#/components/schemas/EmailVerification'
|
|
12750
|
+
'404':
|
|
12751
|
+
description: Not Found
|
|
12752
|
+
content:
|
|
12753
|
+
application/json:
|
|
12754
|
+
schema:
|
|
12755
|
+
type: object
|
|
12756
|
+
properties:
|
|
12757
|
+
message:
|
|
12758
|
+
type: string
|
|
12759
|
+
description: A human-readable description of the error.
|
|
12760
|
+
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
12761
|
+
required:
|
|
12762
|
+
- message
|
|
12763
|
+
summary: Get an email verification code
|
|
12764
|
+
tags:
|
|
12765
|
+
- user-management.users
|
|
12766
|
+
/user_management/invitations:
|
|
12767
|
+
get:
|
|
12768
|
+
description: Get a list of all of invitations matching the criteria specified.
|
|
12769
|
+
operationId: UserlandUserInvitesController_list
|
|
12309
12770
|
parameters:
|
|
12310
12771
|
- name: before
|
|
12311
12772
|
required: false
|
|
@@ -14524,6 +14985,121 @@ paths:
|
|
|
14524
14985
|
summary: Create a redirect URI
|
|
14525
14986
|
tags:
|
|
14526
14987
|
- user-management.redirect-uris
|
|
14988
|
+
get:
|
|
14989
|
+
description: Lists the redirect URIs for an environment.
|
|
14990
|
+
operationId: RedirectUrisController_list
|
|
14991
|
+
parameters:
|
|
14992
|
+
- name: before
|
|
14993
|
+
required: false
|
|
14994
|
+
in: query
|
|
14995
|
+
description: >-
|
|
14996
|
+
An object ID that defines your place in the list. When the ID is not
|
|
14997
|
+
present, you are at the end of the list. For example, if you make a
|
|
14998
|
+
list request and receive 100 objects, ending with `"obj_123"`, your
|
|
14999
|
+
subsequent call can include `before="obj_123"` to fetch a new batch
|
|
15000
|
+
of objects before `"obj_123"`.
|
|
15001
|
+
schema:
|
|
15002
|
+
example: xxx_01HXYZ123456789ABCDEFGHIJ
|
|
15003
|
+
type: string
|
|
15004
|
+
- name: after
|
|
15005
|
+
required: false
|
|
15006
|
+
in: query
|
|
15007
|
+
description: >-
|
|
15008
|
+
An object ID that defines your place in the list. When the ID is not
|
|
15009
|
+
present, you are at the end of the list. For example, if you make a
|
|
15010
|
+
list request and receive 100 objects, ending with `"obj_123"`, your
|
|
15011
|
+
subsequent call can include `after="obj_123"` to fetch a new batch
|
|
15012
|
+
of objects after `"obj_123"`.
|
|
15013
|
+
schema:
|
|
15014
|
+
example: xxx_01HXYZ987654321KJIHGFEDCBA
|
|
15015
|
+
type: string
|
|
15016
|
+
- name: limit
|
|
15017
|
+
required: false
|
|
15018
|
+
in: query
|
|
15019
|
+
description: >-
|
|
15020
|
+
Upper limit on the number of objects to return, between `1` and
|
|
15021
|
+
`100`.
|
|
15022
|
+
schema:
|
|
15023
|
+
minimum: 1
|
|
15024
|
+
maximum: 100
|
|
15025
|
+
default: 10
|
|
15026
|
+
example: 10
|
|
15027
|
+
type: integer
|
|
15028
|
+
- name: order
|
|
15029
|
+
required: false
|
|
15030
|
+
in: query
|
|
15031
|
+
description: >-
|
|
15032
|
+
Order the results by the creation time. Supported values are `"asc"`
|
|
15033
|
+
(ascending), `"desc"` (descending), and `"normal"` (descending with
|
|
15034
|
+
reversed cursor semantics where `before` fetches older records and
|
|
15035
|
+
`after` fetches newer records).
|
|
15036
|
+
schema:
|
|
15037
|
+
$ref: '#/components/schemas/PaginationOrder'
|
|
15038
|
+
responses:
|
|
15039
|
+
'200':
|
|
15040
|
+
description: Redirect URIs listed successfully.
|
|
15041
|
+
content:
|
|
15042
|
+
application/json:
|
|
15043
|
+
schema:
|
|
15044
|
+
allOf:
|
|
15045
|
+
- type: object
|
|
15046
|
+
properties:
|
|
15047
|
+
object:
|
|
15048
|
+
type: string
|
|
15049
|
+
description: Indicates this is a list response.
|
|
15050
|
+
const: list
|
|
15051
|
+
list_metadata:
|
|
15052
|
+
type: object
|
|
15053
|
+
properties:
|
|
15054
|
+
before:
|
|
15055
|
+
type:
|
|
15056
|
+
- string
|
|
15057
|
+
- 'null'
|
|
15058
|
+
description: >-
|
|
15059
|
+
An object ID that defines your place in the list.
|
|
15060
|
+
When the ID is not present, you are at the start
|
|
15061
|
+
of the list.
|
|
15062
|
+
example: ruri_01HXYZ123456789ABCDEFGHIJ
|
|
15063
|
+
after:
|
|
15064
|
+
type:
|
|
15065
|
+
- string
|
|
15066
|
+
- 'null'
|
|
15067
|
+
description: >-
|
|
15068
|
+
An object ID that defines your place in the list.
|
|
15069
|
+
When the ID is not present, you are at the end of
|
|
15070
|
+
the list.
|
|
15071
|
+
example: ruri_01HXYZ987654321KJIHGFEDCBA
|
|
15072
|
+
required:
|
|
15073
|
+
- before
|
|
15074
|
+
- after
|
|
15075
|
+
description: >-
|
|
15076
|
+
Pagination cursors for navigating between pages of
|
|
15077
|
+
results.
|
|
15078
|
+
- type: object
|
|
15079
|
+
properties:
|
|
15080
|
+
data:
|
|
15081
|
+
type: array
|
|
15082
|
+
description: The list of records for the current page.
|
|
15083
|
+
items:
|
|
15084
|
+
$ref: '#/components/schemas/RedirectUri'
|
|
15085
|
+
'401':
|
|
15086
|
+
description: Unauthorized
|
|
15087
|
+
content:
|
|
15088
|
+
application/json:
|
|
15089
|
+
schema:
|
|
15090
|
+
type: object
|
|
15091
|
+
properties:
|
|
15092
|
+
message:
|
|
15093
|
+
type: string
|
|
15094
|
+
description: A human-readable description of the error.
|
|
15095
|
+
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
15096
|
+
required:
|
|
15097
|
+
- message
|
|
15098
|
+
example:
|
|
15099
|
+
message: Unauthorized
|
|
15100
|
+
summary: List redirect URIs
|
|
15101
|
+
tags:
|
|
15102
|
+
- user-management.redirect-uris
|
|
14527
15103
|
/user_management/sessions/logout:
|
|
14528
15104
|
get:
|
|
14529
15105
|
description: Logout a user from the current [session](/reference/authkit/session).
|
|
@@ -17698,6 +18274,8 @@ info:
|
|
|
17698
18274
|
tags:
|
|
17699
18275
|
- name: admin-portal
|
|
17700
18276
|
description: Endpoints for the Admin Portal API.
|
|
18277
|
+
- name: agents
|
|
18278
|
+
description: Manage agents for environments.
|
|
17701
18279
|
- name: api_keys
|
|
17702
18280
|
description: Manage API keys for environments.
|
|
17703
18281
|
- name: application.client-secrets
|
|
@@ -19167,37 +19745,6 @@ components:
|
|
|
19167
19745
|
pattern: ^[\x00-\x7F]+$
|
|
19168
19746
|
example: 2fe01467-f7ea-4dd2-8b79-c2b4f56d0191
|
|
19169
19747
|
description: An external identifier for the Organization.
|
|
19170
|
-
SsoIntentOptions:
|
|
19171
|
-
type: object
|
|
19172
|
-
properties:
|
|
19173
|
-
bookmark_slug:
|
|
19174
|
-
type: string
|
|
19175
|
-
description: The bookmark slug to use for SSO.
|
|
19176
|
-
example: chatgpt
|
|
19177
|
-
provider_type:
|
|
19178
|
-
type: string
|
|
19179
|
-
description: The SSO provider type to configure.
|
|
19180
|
-
example: GoogleSAML
|
|
19181
|
-
const: GoogleSAML
|
|
19182
|
-
DomainVerificationIntentOptions:
|
|
19183
|
-
type: object
|
|
19184
|
-
properties:
|
|
19185
|
-
domain_name:
|
|
19186
|
-
type: string
|
|
19187
|
-
description: >-
|
|
19188
|
-
The domain name to verify. When provided, the domain verification
|
|
19189
|
-
flow will skip the domain entry form and go directly to the
|
|
19190
|
-
verification step.
|
|
19191
|
-
example: example.com
|
|
19192
|
-
IntentOptions:
|
|
19193
|
-
type: object
|
|
19194
|
-
properties:
|
|
19195
|
-
sso:
|
|
19196
|
-
description: SSO-specific options for the Admin Portal.
|
|
19197
|
-
$ref: '#/components/schemas/SsoIntentOptions'
|
|
19198
|
-
domain_verification:
|
|
19199
|
-
description: Domain verification-specific options for the Admin Portal.
|
|
19200
|
-
$ref: '#/components/schemas/DomainVerificationIntentOptions'
|
|
19201
19748
|
GenerateLinkDto:
|
|
19202
19749
|
type: object
|
|
19203
19750
|
properties:
|
|
@@ -19242,9 +19789,6 @@ components:
|
|
|
19242
19789
|
- domain_verification
|
|
19243
19790
|
- certificate_renewal
|
|
19244
19791
|
- bring_your_own_key
|
|
19245
|
-
intent_options:
|
|
19246
|
-
description: Options to configure the Admin Portal based on the intent.
|
|
19247
|
-
$ref: '#/components/schemas/IntentOptions'
|
|
19248
19792
|
it_contact_emails:
|
|
19249
19793
|
description: >-
|
|
19250
19794
|
The email addresses of the IT contacts to grant access to the Admin
|
|
@@ -20023,6 +20567,11 @@ components:
|
|
|
20023
20567
|
items:
|
|
20024
20568
|
type: string
|
|
20025
20569
|
enum: &ref_15
|
|
20570
|
+
- agent.registration.created
|
|
20571
|
+
- agent.registration.claim.attempt.created
|
|
20572
|
+
- agent.registration.claim.completed
|
|
20573
|
+
- agent.registration.credential.issued
|
|
20574
|
+
- agent.registration.organization.switched
|
|
20026
20575
|
- authentication.email_verification_succeeded
|
|
20027
20576
|
- authentication.magic_auth_failed
|
|
20028
20577
|
- authentication.magic_auth_succeeded
|
|
@@ -20038,6 +20587,7 @@ components:
|
|
|
20038
20587
|
- authentication.sso_succeeded
|
|
20039
20588
|
- authentication.sso_timed_out
|
|
20040
20589
|
- authentication.radar_risk_detected
|
|
20590
|
+
- authentication.reauthentication_succeeded
|
|
20041
20591
|
- api_key.created
|
|
20042
20592
|
- api_key.revoked
|
|
20043
20593
|
- api_key.updated
|
|
@@ -20101,7 +20651,6 @@ components:
|
|
|
20101
20651
|
- pipes.connected_account.disconnected
|
|
20102
20652
|
- pipes.connected_account.reauthorization_needed
|
|
20103
20653
|
- session.created
|
|
20104
|
-
- session.reauthenticated
|
|
20105
20654
|
- session.revoked
|
|
20106
20655
|
- waitlist_user.approved
|
|
20107
20656
|
- waitlist_user.created
|
|
@@ -20574,6 +21123,185 @@ components:
|
|
|
20574
21123
|
https://your-authkit-domain.workos.com/oauth/authorize/complete?state=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdGF0ZSI6InJhbmRvbV9zdGF0ZV9zdHJpbmciLCJpYXQiOjE3NDI2MDQ4NTN9.abc123def456ghi789
|
|
20575
21124
|
required:
|
|
20576
21125
|
- redirect_uri
|
|
21126
|
+
AgentRegistration:
|
|
21127
|
+
type: object
|
|
21128
|
+
properties:
|
|
21129
|
+
id:
|
|
21130
|
+
type: string
|
|
21131
|
+
description: Unique identifier of the agent registration.
|
|
21132
|
+
example: agent_reg_01EHWNCE74X7JSDV0X3SZ3KJNY
|
|
21133
|
+
agent_identity:
|
|
21134
|
+
type: object
|
|
21135
|
+
properties:
|
|
21136
|
+
id:
|
|
21137
|
+
type: string
|
|
21138
|
+
description: Unique identifier of the agent identity.
|
|
21139
|
+
example: agent_identity_01EHWNCE74X7JSDV0X3SZ3KJNY
|
|
21140
|
+
userland_user_id:
|
|
21141
|
+
type:
|
|
21142
|
+
- string
|
|
21143
|
+
- 'null'
|
|
21144
|
+
description: >-
|
|
21145
|
+
Identifier of the AuthKit user the agent identity is bound to,
|
|
21146
|
+
or `null` when the agent is not associated with a user.
|
|
21147
|
+
example: user_01E4ZCR3C56J083X43JQXF3JK5
|
|
21148
|
+
created_at:
|
|
21149
|
+
type: string
|
|
21150
|
+
format: date-time
|
|
21151
|
+
description: The timestamp when the agent identity was created.
|
|
21152
|
+
example: '2026-01-15T12:00:00.000Z'
|
|
21153
|
+
updated_at:
|
|
21154
|
+
type: string
|
|
21155
|
+
format: date-time
|
|
21156
|
+
description: The timestamp when the agent identity was last updated.
|
|
21157
|
+
example: '2026-01-15T12:00:00.000Z'
|
|
21158
|
+
required:
|
|
21159
|
+
- id
|
|
21160
|
+
- userland_user_id
|
|
21161
|
+
- created_at
|
|
21162
|
+
- updated_at
|
|
21163
|
+
description: The agent identity associated with this registration.
|
|
21164
|
+
organization_id:
|
|
21165
|
+
type: string
|
|
21166
|
+
description: Identifier of the organization the agent is registered to.
|
|
21167
|
+
example: org_01EHQMYV6MBK39QC5PZXHY59C3
|
|
21168
|
+
status:
|
|
21169
|
+
type: string
|
|
21170
|
+
enum:
|
|
21171
|
+
- unverified
|
|
21172
|
+
- verified
|
|
21173
|
+
- expired
|
|
21174
|
+
- revoked
|
|
21175
|
+
description: The current verification status of the registration.
|
|
21176
|
+
example: verified
|
|
21177
|
+
kind:
|
|
21178
|
+
type: string
|
|
21179
|
+
enum:
|
|
21180
|
+
- anonymous
|
|
21181
|
+
- service_auth
|
|
21182
|
+
- identity_assertion
|
|
21183
|
+
description: The kind of agent registration.
|
|
21184
|
+
example: service_auth
|
|
21185
|
+
claim:
|
|
21186
|
+
description: >-
|
|
21187
|
+
The claim associated with this registration, or `null` if the
|
|
21188
|
+
registration has no claim.
|
|
21189
|
+
oneOf:
|
|
21190
|
+
- type: object
|
|
21191
|
+
properties:
|
|
21192
|
+
id:
|
|
21193
|
+
type: string
|
|
21194
|
+
description: Unique identifier of the claim.
|
|
21195
|
+
example: agent_reg_claim_01EHWNCE74X7JSDV0X3SZ3KJNY
|
|
21196
|
+
claim_completion:
|
|
21197
|
+
description: >-
|
|
21198
|
+
The completion record for the claim, or `null` if the claim
|
|
21199
|
+
has not been completed.
|
|
21200
|
+
oneOf:
|
|
21201
|
+
- type: object
|
|
21202
|
+
properties:
|
|
21203
|
+
id:
|
|
21204
|
+
type: string
|
|
21205
|
+
description: Unique identifier of the claim completion.
|
|
21206
|
+
example: agent_reg_claim_attempt_01EHWNCE74X7JSDV0X3SZ3KJNY
|
|
21207
|
+
created_at:
|
|
21208
|
+
type: string
|
|
21209
|
+
format: date-time
|
|
21210
|
+
description: The timestamp when the claim completion was created.
|
|
21211
|
+
example: '2026-01-15T12:00:00.000Z'
|
|
21212
|
+
updated_at:
|
|
21213
|
+
type: string
|
|
21214
|
+
format: date-time
|
|
21215
|
+
description: >-
|
|
21216
|
+
The timestamp when the claim completion was last
|
|
21217
|
+
updated.
|
|
21218
|
+
example: '2026-01-15T12:00:00.000Z'
|
|
21219
|
+
expires_at:
|
|
21220
|
+
type: string
|
|
21221
|
+
format: date-time
|
|
21222
|
+
description: The timestamp when the claim completion expires.
|
|
21223
|
+
example: '2026-01-15T12:00:00.000Z'
|
|
21224
|
+
claimed_at:
|
|
21225
|
+
type: string
|
|
21226
|
+
format: date-time
|
|
21227
|
+
description: The timestamp when the claim was completed.
|
|
21228
|
+
example: '2026-01-15T12:00:00.000Z'
|
|
21229
|
+
required:
|
|
21230
|
+
- id
|
|
21231
|
+
- created_at
|
|
21232
|
+
- updated_at
|
|
21233
|
+
- expires_at
|
|
21234
|
+
- claimed_at
|
|
21235
|
+
- type: 'null'
|
|
21236
|
+
created_at:
|
|
21237
|
+
type: string
|
|
21238
|
+
format: date-time
|
|
21239
|
+
description: The timestamp when the claim was created.
|
|
21240
|
+
example: '2026-01-15T12:00:00.000Z'
|
|
21241
|
+
updated_at:
|
|
21242
|
+
type: string
|
|
21243
|
+
format: date-time
|
|
21244
|
+
description: The timestamp when the claim was last updated.
|
|
21245
|
+
example: '2026-01-15T12:00:00.000Z'
|
|
21246
|
+
expires_at:
|
|
21247
|
+
type: string
|
|
21248
|
+
format: date-time
|
|
21249
|
+
description: The timestamp when the claim expires.
|
|
21250
|
+
example: '2026-01-15T12:00:00.000Z'
|
|
21251
|
+
required:
|
|
21252
|
+
- id
|
|
21253
|
+
- claim_completion
|
|
21254
|
+
- created_at
|
|
21255
|
+
- updated_at
|
|
21256
|
+
- expires_at
|
|
21257
|
+
- type: 'null'
|
|
21258
|
+
created_at:
|
|
21259
|
+
type: string
|
|
21260
|
+
format: date-time
|
|
21261
|
+
description: The timestamp when the registration was created.
|
|
21262
|
+
example: '2026-01-15T12:00:00.000Z'
|
|
21263
|
+
updated_at:
|
|
21264
|
+
type: string
|
|
21265
|
+
format: date-time
|
|
21266
|
+
description: The timestamp when the registration was last updated.
|
|
21267
|
+
example: '2026-01-15T12:00:00.000Z'
|
|
21268
|
+
required:
|
|
21269
|
+
- id
|
|
21270
|
+
- agent_identity
|
|
21271
|
+
- organization_id
|
|
21272
|
+
- status
|
|
21273
|
+
- kind
|
|
21274
|
+
- claim
|
|
21275
|
+
- created_at
|
|
21276
|
+
- updated_at
|
|
21277
|
+
AgentCredentialValidation:
|
|
21278
|
+
type: object
|
|
21279
|
+
properties:
|
|
21280
|
+
valid:
|
|
21281
|
+
type: boolean
|
|
21282
|
+
description: Whether the presented credential is valid.
|
|
21283
|
+
example: true
|
|
21284
|
+
registration_id:
|
|
21285
|
+
type:
|
|
21286
|
+
- string
|
|
21287
|
+
- 'null'
|
|
21288
|
+
description: >-
|
|
21289
|
+
Identifier of the agent registration the credential belongs to, or
|
|
21290
|
+
`null` when the credential is invalid.
|
|
21291
|
+
example: agent_reg_01EHWNCE74X7JSDV0X3SZ3KJNY
|
|
21292
|
+
expires_at:
|
|
21293
|
+
type:
|
|
21294
|
+
- string
|
|
21295
|
+
- 'null'
|
|
21296
|
+
format: date-time
|
|
21297
|
+
description: >-
|
|
21298
|
+
The timestamp when the credential expires, or `null` when the
|
|
21299
|
+
credential is invalid.
|
|
21300
|
+
example: '2026-01-15T12:00:00.000Z'
|
|
21301
|
+
required:
|
|
21302
|
+
- valid
|
|
21303
|
+
- registration_id
|
|
21304
|
+
- expires_at
|
|
20577
21305
|
ApiKey:
|
|
20578
21306
|
type: object
|
|
20579
21307
|
properties:
|
|
@@ -20688,6 +21416,12 @@ components:
|
|
|
20688
21416
|
oneOf:
|
|
20689
21417
|
- $ref: '#/components/schemas/ApiKey'
|
|
20690
21418
|
- type: 'null'
|
|
21419
|
+
agent_registration_id:
|
|
21420
|
+
type: string
|
|
21421
|
+
description: >-
|
|
21422
|
+
The ID of the agent registration this API Key was issued for.
|
|
21423
|
+
Present only when the API Key is assigned to an agent registration.
|
|
21424
|
+
example: agent_reg_01EHZNVPK3SFK441A1RGBFSHRT
|
|
20691
21425
|
required:
|
|
20692
21426
|
- api_key
|
|
20693
21427
|
ConnectApplication:
|
|
@@ -21745,6 +22479,27 @@ components:
|
|
|
21745
22479
|
- external_id
|
|
21746
22480
|
- resource_type_slug
|
|
21747
22481
|
description: The resource the role is assigned on.
|
|
22482
|
+
source:
|
|
22483
|
+
type: object
|
|
22484
|
+
properties:
|
|
22485
|
+
type:
|
|
22486
|
+
type: string
|
|
22487
|
+
enum:
|
|
22488
|
+
- direct
|
|
22489
|
+
- group
|
|
22490
|
+
description: Whether the role was assigned directly or derived from a group.
|
|
22491
|
+
group_role_assignment_id:
|
|
22492
|
+
type:
|
|
22493
|
+
- string
|
|
22494
|
+
- 'null'
|
|
22495
|
+
description: >-
|
|
22496
|
+
The ID of the group role assignment the role was derived from,
|
|
22497
|
+
or null if direct.
|
|
22498
|
+
example: null
|
|
22499
|
+
required:
|
|
22500
|
+
- type
|
|
22501
|
+
- group_role_assignment_id
|
|
22502
|
+
description: The origin of the role assignment.
|
|
21748
22503
|
created_at:
|
|
21749
22504
|
format: date-time
|
|
21750
22505
|
type: string
|
|
@@ -21761,6 +22516,7 @@ components:
|
|
|
21761
22516
|
- organization_membership_id
|
|
21762
22517
|
- role
|
|
21763
22518
|
- resource
|
|
22519
|
+
- source
|
|
21764
22520
|
- created_at
|
|
21765
22521
|
- updated_at
|
|
21766
22522
|
UserRoleAssignmentList:
|
|
@@ -23509,104 +24265,53 @@ components:
|
|
|
23509
24265
|
example: event_01EHZNVPK3SFK441A1RGBFSHRT
|
|
23510
24266
|
event:
|
|
23511
24267
|
type: string
|
|
23512
|
-
const:
|
|
24268
|
+
const: agent.registration.claim.attempt.created
|
|
23513
24269
|
data:
|
|
23514
24270
|
type: object
|
|
23515
24271
|
properties:
|
|
23516
24272
|
object:
|
|
23517
24273
|
type: string
|
|
23518
|
-
description:
|
|
23519
|
-
|
|
24274
|
+
description: >-
|
|
24275
|
+
Distinguishes the agent registration claim attempt
|
|
24276
|
+
object.
|
|
24277
|
+
const: agent_registration_claim_attempt
|
|
23520
24278
|
id:
|
|
23521
24279
|
type: string
|
|
23522
|
-
description:
|
|
23523
|
-
|
|
23524
|
-
|
|
23525
|
-
|
|
23526
|
-
|
|
23527
|
-
properties:
|
|
23528
|
-
type:
|
|
23529
|
-
type: string
|
|
23530
|
-
description: The type of the API key owner.
|
|
23531
|
-
const: organization
|
|
23532
|
-
id:
|
|
23533
|
-
type: string
|
|
23534
|
-
description: The unique identifier of the API key owner.
|
|
23535
|
-
example: org_01EHWNCE74X7JSDV0X3SZ3KJNY
|
|
23536
|
-
required:
|
|
23537
|
-
- type
|
|
23538
|
-
- id
|
|
23539
|
-
- type: object
|
|
23540
|
-
properties:
|
|
23541
|
-
type:
|
|
23542
|
-
type: string
|
|
23543
|
-
description: The type of the API key owner.
|
|
23544
|
-
const: user
|
|
23545
|
-
id:
|
|
23546
|
-
type: string
|
|
23547
|
-
description: >-
|
|
23548
|
-
The unique identifier of the user who owns the
|
|
23549
|
-
API key.
|
|
23550
|
-
example: user_01EHWNCE74X7JSDV0X3SZ3KJNY
|
|
23551
|
-
organization_id:
|
|
23552
|
-
type: string
|
|
23553
|
-
description: >-
|
|
23554
|
-
The unique identifier of the organization the
|
|
23555
|
-
API key belongs to.
|
|
23556
|
-
example: org_01EHWNCE74X7JSDV0X3SZ3KJNY
|
|
23557
|
-
required:
|
|
23558
|
-
- type
|
|
23559
|
-
- id
|
|
23560
|
-
- organization_id
|
|
23561
|
-
description: The owner of the API key.
|
|
23562
|
-
name:
|
|
24280
|
+
description: >-
|
|
24281
|
+
Unique identifier of the agent registration claim
|
|
24282
|
+
attempt.
|
|
24283
|
+
example: agent_reg_claim_attempt_01EHWNCE74X7JSDV0X3SZ3KJNY
|
|
24284
|
+
agent_registration_id:
|
|
23563
24285
|
type: string
|
|
23564
|
-
description: The
|
|
23565
|
-
example:
|
|
23566
|
-
|
|
24286
|
+
description: The ID of the agent registration.
|
|
24287
|
+
example: agent_reg_01EHWNCE74X7JSDV0X3SZ3KJNY
|
|
24288
|
+
agent_registration_claim_id:
|
|
23567
24289
|
type: string
|
|
23568
|
-
description: The
|
|
23569
|
-
example:
|
|
23570
|
-
|
|
23571
|
-
type:
|
|
23572
|
-
|
|
23573
|
-
|
|
23574
|
-
description: The timestamp when the API key was last used.
|
|
23575
|
-
example: '2026-01-15T12:00:00.000Z'
|
|
24290
|
+
description: The ID of the agent registration claim.
|
|
24291
|
+
example: agent_reg_claim_01EHWNCE74X7JSDV0X3SZ3KJNY
|
|
24292
|
+
login_hint:
|
|
24293
|
+
type: string
|
|
24294
|
+
description: The login hint for the claim attempt.
|
|
24295
|
+
example: jane@example.com
|
|
23576
24296
|
expires_at:
|
|
23577
|
-
type:
|
|
23578
|
-
|
|
23579
|
-
|
|
23580
|
-
format: date-time
|
|
23581
|
-
description: >-
|
|
23582
|
-
Timestamp when the API Key expires. Null means the key
|
|
23583
|
-
does not expire.
|
|
23584
|
-
example: null
|
|
23585
|
-
permissions:
|
|
23586
|
-
type: array
|
|
23587
|
-
items:
|
|
23588
|
-
type: string
|
|
23589
|
-
description: The permissions granted to the API key.
|
|
23590
|
-
example: &ref_17
|
|
23591
|
-
- users:read
|
|
23592
|
-
- users:write
|
|
24297
|
+
type: string
|
|
24298
|
+
description: The timestamp when the claim attempt expires.
|
|
24299
|
+
example: '2024-01-15T10:35:00.000Z'
|
|
23593
24300
|
created_at:
|
|
23594
24301
|
type: string
|
|
23595
|
-
description: The timestamp when the
|
|
23596
|
-
example: '
|
|
24302
|
+
description: The timestamp when the claim attempt was created.
|
|
24303
|
+
example: '2024-01-15T10:30:00.000Z'
|
|
23597
24304
|
updated_at:
|
|
23598
24305
|
type: string
|
|
23599
|
-
description: The timestamp when the
|
|
23600
|
-
example: '
|
|
24306
|
+
description: The timestamp when the claim attempt was last updated.
|
|
24307
|
+
example: '2024-01-15T10:30:00.000Z'
|
|
23601
24308
|
required:
|
|
23602
24309
|
- object
|
|
23603
24310
|
- id
|
|
23604
|
-
-
|
|
23605
|
-
-
|
|
23606
|
-
-
|
|
23607
|
-
- last_used_at
|
|
24311
|
+
- agent_registration_id
|
|
24312
|
+
- agent_registration_claim_id
|
|
24313
|
+
- login_hint
|
|
23608
24314
|
- expires_at
|
|
23609
|
-
- permissions
|
|
23610
24315
|
- created_at
|
|
23611
24316
|
- updated_at
|
|
23612
24317
|
description: The event payload.
|
|
@@ -23635,102 +24340,574 @@ components:
|
|
|
23635
24340
|
example: event_01EHZNVPK3SFK441A1RGBFSHRT
|
|
23636
24341
|
event:
|
|
23637
24342
|
type: string
|
|
23638
|
-
const:
|
|
24343
|
+
const: agent.registration.claim.completed
|
|
23639
24344
|
data:
|
|
23640
24345
|
type: object
|
|
23641
24346
|
properties:
|
|
23642
24347
|
object:
|
|
23643
24348
|
type: string
|
|
23644
|
-
description: Distinguishes the
|
|
23645
|
-
const:
|
|
24349
|
+
description: Distinguishes the agent registration claim object.
|
|
24350
|
+
const: agent_registration_claim
|
|
23646
24351
|
id:
|
|
23647
24352
|
type: string
|
|
23648
|
-
description: Unique identifier of the
|
|
23649
|
-
example:
|
|
23650
|
-
|
|
23651
|
-
oneOf:
|
|
23652
|
-
- type: object
|
|
23653
|
-
properties:
|
|
23654
|
-
type:
|
|
23655
|
-
type: string
|
|
23656
|
-
description: The type of the API key owner.
|
|
23657
|
-
const: organization
|
|
23658
|
-
id:
|
|
23659
|
-
type: string
|
|
23660
|
-
description: The unique identifier of the API key owner.
|
|
23661
|
-
example: org_01EHWNCE74X7JSDV0X3SZ3KJNY
|
|
23662
|
-
required:
|
|
23663
|
-
- type
|
|
23664
|
-
- id
|
|
23665
|
-
- type: object
|
|
23666
|
-
properties:
|
|
23667
|
-
type:
|
|
23668
|
-
type: string
|
|
23669
|
-
description: The type of the API key owner.
|
|
23670
|
-
const: user
|
|
23671
|
-
id:
|
|
23672
|
-
type: string
|
|
23673
|
-
description: >-
|
|
23674
|
-
The unique identifier of the user who owns the
|
|
23675
|
-
API key.
|
|
23676
|
-
example: user_01EHWNCE74X7JSDV0X3SZ3KJNY
|
|
23677
|
-
organization_id:
|
|
23678
|
-
type: string
|
|
23679
|
-
description: >-
|
|
23680
|
-
The unique identifier of the organization the
|
|
23681
|
-
API key belongs to.
|
|
23682
|
-
example: org_01EHWNCE74X7JSDV0X3SZ3KJNY
|
|
23683
|
-
required:
|
|
23684
|
-
- type
|
|
23685
|
-
- id
|
|
23686
|
-
- organization_id
|
|
23687
|
-
description: The owner of the API key.
|
|
23688
|
-
name:
|
|
24353
|
+
description: Unique identifier of the agent registration claim.
|
|
24354
|
+
example: agent_reg_claim_01EHWNCE74X7JSDV0X3SZ3KJNY
|
|
24355
|
+
agent_registration_id:
|
|
23689
24356
|
type: string
|
|
23690
|
-
description: The
|
|
23691
|
-
example:
|
|
23692
|
-
|
|
24357
|
+
description: The ID of the agent registration.
|
|
24358
|
+
example: agent_reg_01EHWNCE74X7JSDV0X3SZ3KJNY
|
|
24359
|
+
completed_by_attempt_id:
|
|
23693
24360
|
type: string
|
|
23694
|
-
description: The
|
|
23695
|
-
example:
|
|
23696
|
-
|
|
23697
|
-
type:
|
|
23698
|
-
|
|
23699
|
-
|
|
23700
|
-
|
|
23701
|
-
|
|
23702
|
-
|
|
23703
|
-
|
|
23704
|
-
|
|
23705
|
-
|
|
23706
|
-
|
|
23707
|
-
|
|
23708
|
-
|
|
23709
|
-
|
|
23710
|
-
|
|
23711
|
-
|
|
23712
|
-
|
|
23713
|
-
|
|
23714
|
-
|
|
23715
|
-
|
|
23716
|
-
|
|
24361
|
+
description: The ID of the claim attempt that completed the claim.
|
|
24362
|
+
example: agent_reg_claim_attempt_01EHWNCE74X7JSDV0X3SZ3KJNY
|
|
24363
|
+
claimed_by:
|
|
24364
|
+
type: object
|
|
24365
|
+
properties:
|
|
24366
|
+
user_id:
|
|
24367
|
+
type: string
|
|
24368
|
+
description: The ID of the user who completed the claim.
|
|
24369
|
+
example: user_01EHWNCE74X7JSDV0X3SZ3KJNY
|
|
24370
|
+
organization_id:
|
|
24371
|
+
oneOf:
|
|
24372
|
+
- type: string
|
|
24373
|
+
- oneOf:
|
|
24374
|
+
- type: string
|
|
24375
|
+
const: 'null'
|
|
24376
|
+
- type: 'null'
|
|
24377
|
+
description: >-
|
|
24378
|
+
The ID of the organization the claiming user belongs
|
|
24379
|
+
to.
|
|
24380
|
+
example: null
|
|
24381
|
+
required:
|
|
24382
|
+
- user_id
|
|
24383
|
+
- organization_id
|
|
24384
|
+
description: The user who completed the claim.
|
|
24385
|
+
completed_at:
|
|
24386
|
+
type: string
|
|
24387
|
+
description: The timestamp when the claim was completed.
|
|
24388
|
+
example: '2024-01-15T10:32:00.000Z'
|
|
23717
24389
|
created_at:
|
|
23718
24390
|
type: string
|
|
23719
|
-
description: The timestamp when the
|
|
23720
|
-
example: '
|
|
24391
|
+
description: The timestamp when the claim was created.
|
|
24392
|
+
example: '2024-01-15T10:30:00.000Z'
|
|
23721
24393
|
updated_at:
|
|
23722
24394
|
type: string
|
|
23723
|
-
description: The timestamp when the
|
|
23724
|
-
example: '
|
|
24395
|
+
description: The timestamp when the claim was last updated.
|
|
24396
|
+
example: '2024-01-15T10:32:00.000Z'
|
|
23725
24397
|
required:
|
|
23726
24398
|
- object
|
|
23727
24399
|
- id
|
|
23728
|
-
-
|
|
23729
|
-
-
|
|
23730
|
-
-
|
|
23731
|
-
-
|
|
23732
|
-
-
|
|
23733
|
-
-
|
|
24400
|
+
- agent_registration_id
|
|
24401
|
+
- completed_by_attempt_id
|
|
24402
|
+
- claimed_by
|
|
24403
|
+
- completed_at
|
|
24404
|
+
- created_at
|
|
24405
|
+
- updated_at
|
|
24406
|
+
description: The event payload.
|
|
24407
|
+
created_at:
|
|
24408
|
+
format: date-time
|
|
24409
|
+
type: string
|
|
24410
|
+
description: An ISO 8601 timestamp.
|
|
24411
|
+
example: '2026-01-15T12:00:00.000Z'
|
|
24412
|
+
context:
|
|
24413
|
+
$ref: '#/components/schemas/EventContextDto'
|
|
24414
|
+
object:
|
|
24415
|
+
type: string
|
|
24416
|
+
description: Distinguishes the Event object.
|
|
24417
|
+
const: event
|
|
24418
|
+
required:
|
|
24419
|
+
- id
|
|
24420
|
+
- event
|
|
24421
|
+
- data
|
|
24422
|
+
- created_at
|
|
24423
|
+
- object
|
|
24424
|
+
- type: object
|
|
24425
|
+
properties:
|
|
24426
|
+
id:
|
|
24427
|
+
type: string
|
|
24428
|
+
description: Unique identifier for the event.
|
|
24429
|
+
example: event_01EHZNVPK3SFK441A1RGBFSHRT
|
|
24430
|
+
event:
|
|
24431
|
+
type: string
|
|
24432
|
+
const: agent.registration.created
|
|
24433
|
+
data:
|
|
24434
|
+
type: object
|
|
24435
|
+
properties:
|
|
24436
|
+
object:
|
|
24437
|
+
type: string
|
|
24438
|
+
description: Distinguishes the agent registration object.
|
|
24439
|
+
const: agent_registration
|
|
24440
|
+
id:
|
|
24441
|
+
type: string
|
|
24442
|
+
description: Unique identifier of the agent registration.
|
|
24443
|
+
example: agent_reg_01EHWNCE74X7JSDV0X3SZ3KJNY
|
|
24444
|
+
agent_identity:
|
|
24445
|
+
type: object
|
|
24446
|
+
properties:
|
|
24447
|
+
object:
|
|
24448
|
+
type: string
|
|
24449
|
+
description: Distinguishes the agent identity object.
|
|
24450
|
+
const: agent_identity
|
|
24451
|
+
id:
|
|
24452
|
+
type: string
|
|
24453
|
+
description: Unique identifier of the agent identity.
|
|
24454
|
+
example: agent_identity_01EHWNCE74X7JSDV0X3SZ3KJNY
|
|
24455
|
+
userland_user_id:
|
|
24456
|
+
oneOf:
|
|
24457
|
+
- type: string
|
|
24458
|
+
- oneOf:
|
|
24459
|
+
- type: string
|
|
24460
|
+
const: 'null'
|
|
24461
|
+
- type: 'null'
|
|
24462
|
+
description: >-
|
|
24463
|
+
The ID of the userland user bound to this agent
|
|
24464
|
+
identity.
|
|
24465
|
+
example: null
|
|
24466
|
+
required:
|
|
24467
|
+
- object
|
|
24468
|
+
- id
|
|
24469
|
+
- userland_user_id
|
|
24470
|
+
description: The agent identity for this registration.
|
|
24471
|
+
organization_id:
|
|
24472
|
+
type: string
|
|
24473
|
+
description: The ID of the organization the registration belongs to.
|
|
24474
|
+
example: org_01EHWNCE74X7JSDV0X3SZ3KJNY
|
|
24475
|
+
status:
|
|
24476
|
+
type: string
|
|
24477
|
+
enum:
|
|
24478
|
+
- unverified
|
|
24479
|
+
- verified
|
|
24480
|
+
- expired
|
|
24481
|
+
- revoked
|
|
24482
|
+
description: The current status of the registration.
|
|
24483
|
+
example: unverified
|
|
24484
|
+
kind:
|
|
24485
|
+
type: string
|
|
24486
|
+
enum:
|
|
24487
|
+
- anonymous
|
|
24488
|
+
- service_auth
|
|
24489
|
+
- identity_assertion
|
|
24490
|
+
description: The kind of the registration.
|
|
24491
|
+
example: anonymous
|
|
24492
|
+
method:
|
|
24493
|
+
type: string
|
|
24494
|
+
enum:
|
|
24495
|
+
- anonymous
|
|
24496
|
+
- service_auth
|
|
24497
|
+
- id_jag
|
|
24498
|
+
description: The authentication method of the registration.
|
|
24499
|
+
example: anonymous
|
|
24500
|
+
created_at:
|
|
24501
|
+
type: string
|
|
24502
|
+
description: The timestamp when the registration was created.
|
|
24503
|
+
example: '2024-01-15T10:30:00.000Z'
|
|
24504
|
+
updated_at:
|
|
24505
|
+
type: string
|
|
24506
|
+
description: The timestamp when the registration was last updated.
|
|
24507
|
+
example: '2024-01-15T10:30:00.000Z'
|
|
24508
|
+
required:
|
|
24509
|
+
- object
|
|
24510
|
+
- id
|
|
24511
|
+
- agent_identity
|
|
24512
|
+
- organization_id
|
|
24513
|
+
- status
|
|
24514
|
+
- kind
|
|
24515
|
+
- method
|
|
24516
|
+
- created_at
|
|
24517
|
+
- updated_at
|
|
24518
|
+
description: The event payload.
|
|
24519
|
+
created_at:
|
|
24520
|
+
format: date-time
|
|
24521
|
+
type: string
|
|
24522
|
+
description: An ISO 8601 timestamp.
|
|
24523
|
+
example: '2026-01-15T12:00:00.000Z'
|
|
24524
|
+
context:
|
|
24525
|
+
$ref: '#/components/schemas/EventContextDto'
|
|
24526
|
+
object:
|
|
24527
|
+
type: string
|
|
24528
|
+
description: Distinguishes the Event object.
|
|
24529
|
+
const: event
|
|
24530
|
+
required:
|
|
24531
|
+
- id
|
|
24532
|
+
- event
|
|
24533
|
+
- data
|
|
24534
|
+
- created_at
|
|
24535
|
+
- object
|
|
24536
|
+
- type: object
|
|
24537
|
+
properties:
|
|
24538
|
+
id:
|
|
24539
|
+
type: string
|
|
24540
|
+
description: Unique identifier for the event.
|
|
24541
|
+
example: event_01EHZNVPK3SFK441A1RGBFSHRT
|
|
24542
|
+
event:
|
|
24543
|
+
type: string
|
|
24544
|
+
const: agent.registration.credential.issued
|
|
24545
|
+
data:
|
|
24546
|
+
type: object
|
|
24547
|
+
properties:
|
|
24548
|
+
object:
|
|
24549
|
+
type: string
|
|
24550
|
+
description: Distinguishes the agent registration credential object.
|
|
24551
|
+
const: agent_registration_credential
|
|
24552
|
+
id:
|
|
24553
|
+
type: string
|
|
24554
|
+
description: Unique identifier of the agent registration credential.
|
|
24555
|
+
example: agent_reg_credential_01EHWNCE74X7JSDV0X3SZ3KJNY
|
|
24556
|
+
agent_registration_id:
|
|
24557
|
+
type: string
|
|
24558
|
+
description: The ID of the agent registration.
|
|
24559
|
+
example: agent_reg_01EHWNCE74X7JSDV0X3SZ3KJNY
|
|
24560
|
+
detail:
|
|
24561
|
+
oneOf:
|
|
24562
|
+
- type: object
|
|
24563
|
+
properties:
|
|
24564
|
+
kind:
|
|
24565
|
+
type: string
|
|
24566
|
+
description: The kind of credential issued.
|
|
24567
|
+
const: api_key
|
|
24568
|
+
api_key_id:
|
|
24569
|
+
type: string
|
|
24570
|
+
description: The ID of the issued API key.
|
|
24571
|
+
example: api_key_01HWDP91J37GZW2FT9GCEX8YWV
|
|
24572
|
+
required:
|
|
24573
|
+
- kind
|
|
24574
|
+
- api_key_id
|
|
24575
|
+
- type: object
|
|
24576
|
+
properties:
|
|
24577
|
+
kind:
|
|
24578
|
+
type: string
|
|
24579
|
+
description: The kind of credential issued.
|
|
24580
|
+
const: access_token
|
|
24581
|
+
jti:
|
|
24582
|
+
type: string
|
|
24583
|
+
description: The JWT ID of the issued access token.
|
|
24584
|
+
example: jti_01EHWNCE74X7JSDV0X3SZ3KJNY
|
|
24585
|
+
expires_at:
|
|
24586
|
+
oneOf:
|
|
24587
|
+
- type: string
|
|
24588
|
+
- oneOf:
|
|
24589
|
+
- type: string
|
|
24590
|
+
const: 'null'
|
|
24591
|
+
- type: 'null'
|
|
24592
|
+
description: The timestamp when the access token expires.
|
|
24593
|
+
example: '2024-01-15T11:30:00.000Z'
|
|
24594
|
+
required:
|
|
24595
|
+
- kind
|
|
24596
|
+
- jti
|
|
24597
|
+
- expires_at
|
|
24598
|
+
description: Details of the issued credential.
|
|
24599
|
+
created_at:
|
|
24600
|
+
type: string
|
|
24601
|
+
description: The timestamp when the credential was issued.
|
|
24602
|
+
example: '2024-01-15T10:33:00.000Z'
|
|
24603
|
+
updated_at:
|
|
24604
|
+
type: string
|
|
24605
|
+
description: The timestamp when the credential was last updated.
|
|
24606
|
+
example: '2024-01-15T10:33:00.000Z'
|
|
24607
|
+
required:
|
|
24608
|
+
- object
|
|
24609
|
+
- id
|
|
24610
|
+
- agent_registration_id
|
|
24611
|
+
- detail
|
|
24612
|
+
- created_at
|
|
24613
|
+
- updated_at
|
|
24614
|
+
description: The event payload.
|
|
24615
|
+
created_at:
|
|
24616
|
+
format: date-time
|
|
24617
|
+
type: string
|
|
24618
|
+
description: An ISO 8601 timestamp.
|
|
24619
|
+
example: '2026-01-15T12:00:00.000Z'
|
|
24620
|
+
context:
|
|
24621
|
+
$ref: '#/components/schemas/EventContextDto'
|
|
24622
|
+
object:
|
|
24623
|
+
type: string
|
|
24624
|
+
description: Distinguishes the Event object.
|
|
24625
|
+
const: event
|
|
24626
|
+
required:
|
|
24627
|
+
- id
|
|
24628
|
+
- event
|
|
24629
|
+
- data
|
|
24630
|
+
- created_at
|
|
24631
|
+
- object
|
|
24632
|
+
- type: object
|
|
24633
|
+
properties:
|
|
24634
|
+
id:
|
|
24635
|
+
type: string
|
|
24636
|
+
description: Unique identifier for the event.
|
|
24637
|
+
example: event_01EHZNVPK3SFK441A1RGBFSHRT
|
|
24638
|
+
event:
|
|
24639
|
+
type: string
|
|
24640
|
+
const: agent.registration.organization.switched
|
|
24641
|
+
data:
|
|
24642
|
+
type: object
|
|
24643
|
+
properties:
|
|
24644
|
+
agent_registration_id:
|
|
24645
|
+
type: string
|
|
24646
|
+
description: The agent registration that was moved.
|
|
24647
|
+
example: agent_reg_01EHWNCE74X7JSDV0X3SZ3KJNY
|
|
24648
|
+
from_organization_id:
|
|
24649
|
+
type: string
|
|
24650
|
+
description: >-
|
|
24651
|
+
The agent-created organization the registration is
|
|
24652
|
+
moving off of. Migrate its resources to
|
|
24653
|
+
`to_organization_id`, then delete it.
|
|
24654
|
+
example: org_01EHWNCE74X7JSDV0X3SZ3KJNY
|
|
24655
|
+
to_organization_id:
|
|
24656
|
+
type: string
|
|
24657
|
+
description: The organization the registration now belongs to.
|
|
24658
|
+
example: org_01EHWNCE74X7JSDV0X3SZ3KJNZ
|
|
24659
|
+
required:
|
|
24660
|
+
- agent_registration_id
|
|
24661
|
+
- from_organization_id
|
|
24662
|
+
- to_organization_id
|
|
24663
|
+
description: The event payload.
|
|
24664
|
+
created_at:
|
|
24665
|
+
format: date-time
|
|
24666
|
+
type: string
|
|
24667
|
+
description: An ISO 8601 timestamp.
|
|
24668
|
+
example: '2026-01-15T12:00:00.000Z'
|
|
24669
|
+
context:
|
|
24670
|
+
$ref: '#/components/schemas/EventContextDto'
|
|
24671
|
+
object:
|
|
24672
|
+
type: string
|
|
24673
|
+
description: Distinguishes the Event object.
|
|
24674
|
+
const: event
|
|
24675
|
+
required:
|
|
24676
|
+
- id
|
|
24677
|
+
- event
|
|
24678
|
+
- data
|
|
24679
|
+
- created_at
|
|
24680
|
+
- object
|
|
24681
|
+
- type: object
|
|
24682
|
+
properties:
|
|
24683
|
+
id:
|
|
24684
|
+
type: string
|
|
24685
|
+
description: Unique identifier for the event.
|
|
24686
|
+
example: event_01EHZNVPK3SFK441A1RGBFSHRT
|
|
24687
|
+
event:
|
|
24688
|
+
type: string
|
|
24689
|
+
const: api_key.created
|
|
24690
|
+
data:
|
|
24691
|
+
type: object
|
|
24692
|
+
properties:
|
|
24693
|
+
object:
|
|
24694
|
+
type: string
|
|
24695
|
+
description: Distinguishes the API key object.
|
|
24696
|
+
const: api_key
|
|
24697
|
+
id:
|
|
24698
|
+
type: string
|
|
24699
|
+
description: Unique identifier of the API key.
|
|
24700
|
+
example: api_key_01EHWNCE74X7JSDV0X3SZ3KJNY
|
|
24701
|
+
owner:
|
|
24702
|
+
oneOf:
|
|
24703
|
+
- type: object
|
|
24704
|
+
properties:
|
|
24705
|
+
type:
|
|
24706
|
+
type: string
|
|
24707
|
+
description: The type of the API key owner.
|
|
24708
|
+
const: organization
|
|
24709
|
+
id:
|
|
24710
|
+
type: string
|
|
24711
|
+
description: The unique identifier of the API key owner.
|
|
24712
|
+
example: org_01EHWNCE74X7JSDV0X3SZ3KJNY
|
|
24713
|
+
required:
|
|
24714
|
+
- type
|
|
24715
|
+
- id
|
|
24716
|
+
- type: object
|
|
24717
|
+
properties:
|
|
24718
|
+
type:
|
|
24719
|
+
type: string
|
|
24720
|
+
description: The type of the API key owner.
|
|
24721
|
+
const: user
|
|
24722
|
+
id:
|
|
24723
|
+
type: string
|
|
24724
|
+
description: >-
|
|
24725
|
+
The unique identifier of the user who owns the
|
|
24726
|
+
API key.
|
|
24727
|
+
example: user_01EHWNCE74X7JSDV0X3SZ3KJNY
|
|
24728
|
+
organization_id:
|
|
24729
|
+
type: string
|
|
24730
|
+
description: >-
|
|
24731
|
+
The unique identifier of the organization the
|
|
24732
|
+
API key belongs to.
|
|
24733
|
+
example: org_01EHWNCE74X7JSDV0X3SZ3KJNY
|
|
24734
|
+
required:
|
|
24735
|
+
- type
|
|
24736
|
+
- id
|
|
24737
|
+
- organization_id
|
|
24738
|
+
description: The owner of the API key.
|
|
24739
|
+
name:
|
|
24740
|
+
type: string
|
|
24741
|
+
description: The name of the API key.
|
|
24742
|
+
example: My API Key
|
|
24743
|
+
obfuscated_value:
|
|
24744
|
+
type: string
|
|
24745
|
+
description: The obfuscated value of the API key.
|
|
24746
|
+
example: sk_test_...1234
|
|
24747
|
+
last_used_at:
|
|
24748
|
+
type:
|
|
24749
|
+
- string
|
|
24750
|
+
- 'null'
|
|
24751
|
+
description: The timestamp when the API key was last used.
|
|
24752
|
+
example: '2026-01-15T12:00:00.000Z'
|
|
24753
|
+
expires_at:
|
|
24754
|
+
type:
|
|
24755
|
+
- string
|
|
24756
|
+
- 'null'
|
|
24757
|
+
format: date-time
|
|
24758
|
+
description: >-
|
|
24759
|
+
Timestamp when the API Key expires. Null means the key
|
|
24760
|
+
does not expire.
|
|
24761
|
+
example: null
|
|
24762
|
+
permissions:
|
|
24763
|
+
type: array
|
|
24764
|
+
items:
|
|
24765
|
+
type: string
|
|
24766
|
+
description: The permissions granted to the API key.
|
|
24767
|
+
example: &ref_17
|
|
24768
|
+
- users:read
|
|
24769
|
+
- users:write
|
|
24770
|
+
created_at:
|
|
24771
|
+
type: string
|
|
24772
|
+
description: The timestamp when the API key was created.
|
|
24773
|
+
example: '2026-01-15T12:00:00.000Z'
|
|
24774
|
+
updated_at:
|
|
24775
|
+
type: string
|
|
24776
|
+
description: The timestamp when the API key was last updated.
|
|
24777
|
+
example: '2026-01-15T12:00:00.000Z'
|
|
24778
|
+
required:
|
|
24779
|
+
- object
|
|
24780
|
+
- id
|
|
24781
|
+
- owner
|
|
24782
|
+
- name
|
|
24783
|
+
- obfuscated_value
|
|
24784
|
+
- last_used_at
|
|
24785
|
+
- expires_at
|
|
24786
|
+
- permissions
|
|
24787
|
+
- created_at
|
|
24788
|
+
- updated_at
|
|
24789
|
+
description: The event payload.
|
|
24790
|
+
created_at:
|
|
24791
|
+
format: date-time
|
|
24792
|
+
type: string
|
|
24793
|
+
description: An ISO 8601 timestamp.
|
|
24794
|
+
example: '2026-01-15T12:00:00.000Z'
|
|
24795
|
+
context:
|
|
24796
|
+
$ref: '#/components/schemas/EventContextDto'
|
|
24797
|
+
object:
|
|
24798
|
+
type: string
|
|
24799
|
+
description: Distinguishes the Event object.
|
|
24800
|
+
const: event
|
|
24801
|
+
required:
|
|
24802
|
+
- id
|
|
24803
|
+
- event
|
|
24804
|
+
- data
|
|
24805
|
+
- created_at
|
|
24806
|
+
- object
|
|
24807
|
+
- type: object
|
|
24808
|
+
properties:
|
|
24809
|
+
id:
|
|
24810
|
+
type: string
|
|
24811
|
+
description: Unique identifier for the event.
|
|
24812
|
+
example: event_01EHZNVPK3SFK441A1RGBFSHRT
|
|
24813
|
+
event:
|
|
24814
|
+
type: string
|
|
24815
|
+
const: api_key.revoked
|
|
24816
|
+
data:
|
|
24817
|
+
type: object
|
|
24818
|
+
properties:
|
|
24819
|
+
object:
|
|
24820
|
+
type: string
|
|
24821
|
+
description: Distinguishes the API key object.
|
|
24822
|
+
const: api_key
|
|
24823
|
+
id:
|
|
24824
|
+
type: string
|
|
24825
|
+
description: Unique identifier of the API key.
|
|
24826
|
+
example: api_key_01EHWNCE74X7JSDV0X3SZ3KJNY
|
|
24827
|
+
owner:
|
|
24828
|
+
oneOf:
|
|
24829
|
+
- type: object
|
|
24830
|
+
properties:
|
|
24831
|
+
type:
|
|
24832
|
+
type: string
|
|
24833
|
+
description: The type of the API key owner.
|
|
24834
|
+
const: organization
|
|
24835
|
+
id:
|
|
24836
|
+
type: string
|
|
24837
|
+
description: The unique identifier of the API key owner.
|
|
24838
|
+
example: org_01EHWNCE74X7JSDV0X3SZ3KJNY
|
|
24839
|
+
required:
|
|
24840
|
+
- type
|
|
24841
|
+
- id
|
|
24842
|
+
- type: object
|
|
24843
|
+
properties:
|
|
24844
|
+
type:
|
|
24845
|
+
type: string
|
|
24846
|
+
description: The type of the API key owner.
|
|
24847
|
+
const: user
|
|
24848
|
+
id:
|
|
24849
|
+
type: string
|
|
24850
|
+
description: >-
|
|
24851
|
+
The unique identifier of the user who owns the
|
|
24852
|
+
API key.
|
|
24853
|
+
example: user_01EHWNCE74X7JSDV0X3SZ3KJNY
|
|
24854
|
+
organization_id:
|
|
24855
|
+
type: string
|
|
24856
|
+
description: >-
|
|
24857
|
+
The unique identifier of the organization the
|
|
24858
|
+
API key belongs to.
|
|
24859
|
+
example: org_01EHWNCE74X7JSDV0X3SZ3KJNY
|
|
24860
|
+
required:
|
|
24861
|
+
- type
|
|
24862
|
+
- id
|
|
24863
|
+
- organization_id
|
|
24864
|
+
description: The owner of the API key.
|
|
24865
|
+
name:
|
|
24866
|
+
type: string
|
|
24867
|
+
description: The name of the API key.
|
|
24868
|
+
example: My API Key
|
|
24869
|
+
obfuscated_value:
|
|
24870
|
+
type: string
|
|
24871
|
+
description: The obfuscated value of the API key.
|
|
24872
|
+
example: sk_test_...1234
|
|
24873
|
+
last_used_at:
|
|
24874
|
+
type:
|
|
24875
|
+
- string
|
|
24876
|
+
- 'null'
|
|
24877
|
+
description: The timestamp when the API key was last used.
|
|
24878
|
+
example: '2026-01-15T12:00:00.000Z'
|
|
24879
|
+
expires_at:
|
|
24880
|
+
type:
|
|
24881
|
+
- string
|
|
24882
|
+
- 'null'
|
|
24883
|
+
format: date-time
|
|
24884
|
+
description: >-
|
|
24885
|
+
Timestamp when the API Key expires. Null means the key
|
|
24886
|
+
does not expire.
|
|
24887
|
+
example: null
|
|
24888
|
+
permissions:
|
|
24889
|
+
type: array
|
|
24890
|
+
items:
|
|
24891
|
+
type: string
|
|
24892
|
+
description: The permissions granted to the API key.
|
|
24893
|
+
example: *ref_17
|
|
24894
|
+
created_at:
|
|
24895
|
+
type: string
|
|
24896
|
+
description: The timestamp when the API key was created.
|
|
24897
|
+
example: '2026-01-15T12:00:00.000Z'
|
|
24898
|
+
updated_at:
|
|
24899
|
+
type: string
|
|
24900
|
+
description: The timestamp when the API key was last updated.
|
|
24901
|
+
example: '2026-01-15T12:00:00.000Z'
|
|
24902
|
+
required:
|
|
24903
|
+
- object
|
|
24904
|
+
- id
|
|
24905
|
+
- owner
|
|
24906
|
+
- name
|
|
24907
|
+
- obfuscated_value
|
|
24908
|
+
- last_used_at
|
|
24909
|
+
- expires_at
|
|
24910
|
+
- permissions
|
|
23734
24911
|
- created_at
|
|
23735
24912
|
- updated_at
|
|
23736
24913
|
description: The event payload.
|
|
@@ -24191,16 +25368,245 @@ components:
|
|
|
24191
25368
|
example: event_01EHZNVPK3SFK441A1RGBFSHRT
|
|
24192
25369
|
event:
|
|
24193
25370
|
type: string
|
|
24194
|
-
const: authentication.mfa_failed
|
|
25371
|
+
const: authentication.mfa_failed
|
|
25372
|
+
data:
|
|
25373
|
+
type: object
|
|
25374
|
+
properties:
|
|
25375
|
+
type:
|
|
25376
|
+
type: string
|
|
25377
|
+
const: mfa
|
|
25378
|
+
status:
|
|
25379
|
+
type: string
|
|
25380
|
+
const: failed
|
|
25381
|
+
ip_address:
|
|
25382
|
+
type:
|
|
25383
|
+
- string
|
|
25384
|
+
- 'null'
|
|
25385
|
+
description: The IP address of the request.
|
|
25386
|
+
example: 203.0.113.42
|
|
25387
|
+
user_agent:
|
|
25388
|
+
type:
|
|
25389
|
+
- string
|
|
25390
|
+
- 'null'
|
|
25391
|
+
description: The user agent of the request.
|
|
25392
|
+
example: Mozilla/5.0
|
|
25393
|
+
user_id:
|
|
25394
|
+
type:
|
|
25395
|
+
- string
|
|
25396
|
+
- 'null'
|
|
25397
|
+
description: The ID of the user.
|
|
25398
|
+
example: user_01E4ZCR3C56J083X43JQXF3JK5
|
|
25399
|
+
email:
|
|
25400
|
+
type:
|
|
25401
|
+
- string
|
|
25402
|
+
- 'null'
|
|
25403
|
+
description: The email address of the user.
|
|
25404
|
+
example: user@example.com
|
|
25405
|
+
error:
|
|
25406
|
+
type: object
|
|
25407
|
+
properties:
|
|
25408
|
+
code:
|
|
25409
|
+
type: string
|
|
25410
|
+
description: The error code.
|
|
25411
|
+
example: mfa_challenge_failed
|
|
25412
|
+
message:
|
|
25413
|
+
type: string
|
|
25414
|
+
description: A human-readable error message.
|
|
25415
|
+
example: The MFA challenge has failed.
|
|
25416
|
+
required:
|
|
25417
|
+
- code
|
|
25418
|
+
- message
|
|
25419
|
+
description: Details about the authentication error.
|
|
25420
|
+
required:
|
|
25421
|
+
- type
|
|
25422
|
+
- status
|
|
25423
|
+
- ip_address
|
|
25424
|
+
- user_agent
|
|
25425
|
+
- user_id
|
|
25426
|
+
- email
|
|
25427
|
+
- error
|
|
25428
|
+
description: The event payload.
|
|
25429
|
+
created_at:
|
|
25430
|
+
format: date-time
|
|
25431
|
+
type: string
|
|
25432
|
+
description: An ISO 8601 timestamp.
|
|
25433
|
+
example: '2026-01-15T12:00:00.000Z'
|
|
25434
|
+
context:
|
|
25435
|
+
$ref: '#/components/schemas/EventContextDto'
|
|
25436
|
+
object:
|
|
25437
|
+
type: string
|
|
25438
|
+
description: Distinguishes the Event object.
|
|
25439
|
+
const: event
|
|
25440
|
+
required:
|
|
25441
|
+
- id
|
|
25442
|
+
- event
|
|
25443
|
+
- data
|
|
25444
|
+
- created_at
|
|
25445
|
+
- object
|
|
25446
|
+
- type: object
|
|
25447
|
+
properties:
|
|
25448
|
+
id:
|
|
25449
|
+
type: string
|
|
25450
|
+
description: Unique identifier for the event.
|
|
25451
|
+
example: event_01EHZNVPK3SFK441A1RGBFSHRT
|
|
25452
|
+
event:
|
|
25453
|
+
type: string
|
|
25454
|
+
const: authentication.mfa_succeeded
|
|
25455
|
+
data:
|
|
25456
|
+
type: object
|
|
25457
|
+
properties:
|
|
25458
|
+
type:
|
|
25459
|
+
type: string
|
|
25460
|
+
const: mfa
|
|
25461
|
+
status:
|
|
25462
|
+
type: string
|
|
25463
|
+
const: succeeded
|
|
25464
|
+
ip_address:
|
|
25465
|
+
type:
|
|
25466
|
+
- string
|
|
25467
|
+
- 'null'
|
|
25468
|
+
description: The IP address of the request.
|
|
25469
|
+
example: 203.0.113.42
|
|
25470
|
+
user_agent:
|
|
25471
|
+
type:
|
|
25472
|
+
- string
|
|
25473
|
+
- 'null'
|
|
25474
|
+
description: The user agent of the request.
|
|
25475
|
+
example: Mozilla/5.0
|
|
25476
|
+
user_id:
|
|
25477
|
+
type: string
|
|
25478
|
+
description: The ID of the user.
|
|
25479
|
+
example: user_01E4ZCR3C56J083X43JQXF3JK5
|
|
25480
|
+
email:
|
|
25481
|
+
type: string
|
|
25482
|
+
description: The email address of the user.
|
|
25483
|
+
example: user@example.com
|
|
25484
|
+
required:
|
|
25485
|
+
- type
|
|
25486
|
+
- status
|
|
25487
|
+
- ip_address
|
|
25488
|
+
- user_agent
|
|
25489
|
+
- user_id
|
|
25490
|
+
- email
|
|
25491
|
+
description: The event payload.
|
|
25492
|
+
created_at:
|
|
25493
|
+
format: date-time
|
|
25494
|
+
type: string
|
|
25495
|
+
description: An ISO 8601 timestamp.
|
|
25496
|
+
example: '2026-01-15T12:00:00.000Z'
|
|
25497
|
+
context:
|
|
25498
|
+
$ref: '#/components/schemas/EventContextDto'
|
|
25499
|
+
object:
|
|
25500
|
+
type: string
|
|
25501
|
+
description: Distinguishes the Event object.
|
|
25502
|
+
const: event
|
|
25503
|
+
required:
|
|
25504
|
+
- id
|
|
25505
|
+
- event
|
|
25506
|
+
- data
|
|
25507
|
+
- created_at
|
|
25508
|
+
- object
|
|
25509
|
+
- type: object
|
|
25510
|
+
properties:
|
|
25511
|
+
id:
|
|
25512
|
+
type: string
|
|
25513
|
+
description: Unique identifier for the event.
|
|
25514
|
+
example: event_01EHZNVPK3SFK441A1RGBFSHRT
|
|
25515
|
+
event:
|
|
25516
|
+
type: string
|
|
25517
|
+
const: authentication.oauth_failed
|
|
25518
|
+
data:
|
|
25519
|
+
type: object
|
|
25520
|
+
properties:
|
|
25521
|
+
type:
|
|
25522
|
+
type: string
|
|
25523
|
+
const: oauth
|
|
25524
|
+
status:
|
|
25525
|
+
type: string
|
|
25526
|
+
const: failed
|
|
25527
|
+
ip_address:
|
|
25528
|
+
type:
|
|
25529
|
+
- string
|
|
25530
|
+
- 'null'
|
|
25531
|
+
description: The IP address of the request.
|
|
25532
|
+
example: 203.0.113.42
|
|
25533
|
+
user_agent:
|
|
25534
|
+
type:
|
|
25535
|
+
- string
|
|
25536
|
+
- 'null'
|
|
25537
|
+
description: The user agent of the request.
|
|
25538
|
+
example: Mozilla/5.0
|
|
25539
|
+
user_id:
|
|
25540
|
+
type:
|
|
25541
|
+
- string
|
|
25542
|
+
- 'null'
|
|
25543
|
+
description: The ID of the user.
|
|
25544
|
+
example: user_01E4ZCR3C56J083X43JQXF3JK5
|
|
25545
|
+
email:
|
|
25546
|
+
type:
|
|
25547
|
+
- string
|
|
25548
|
+
- 'null'
|
|
25549
|
+
description: The email address of the user.
|
|
25550
|
+
example: user@example.com
|
|
25551
|
+
error:
|
|
25552
|
+
type: object
|
|
25553
|
+
properties:
|
|
25554
|
+
code:
|
|
25555
|
+
type: string
|
|
25556
|
+
description: The error code.
|
|
25557
|
+
example: mfa_challenge_failed
|
|
25558
|
+
message:
|
|
25559
|
+
type: string
|
|
25560
|
+
description: A human-readable error message.
|
|
25561
|
+
example: The MFA challenge has failed.
|
|
25562
|
+
required:
|
|
25563
|
+
- code
|
|
25564
|
+
- message
|
|
25565
|
+
description: Details about the authentication error.
|
|
25566
|
+
required:
|
|
25567
|
+
- type
|
|
25568
|
+
- status
|
|
25569
|
+
- ip_address
|
|
25570
|
+
- user_agent
|
|
25571
|
+
- user_id
|
|
25572
|
+
- email
|
|
25573
|
+
- error
|
|
25574
|
+
description: The event payload.
|
|
25575
|
+
created_at:
|
|
25576
|
+
format: date-time
|
|
25577
|
+
type: string
|
|
25578
|
+
description: An ISO 8601 timestamp.
|
|
25579
|
+
example: '2026-01-15T12:00:00.000Z'
|
|
25580
|
+
context:
|
|
25581
|
+
$ref: '#/components/schemas/EventContextDto'
|
|
25582
|
+
object:
|
|
25583
|
+
type: string
|
|
25584
|
+
description: Distinguishes the Event object.
|
|
25585
|
+
const: event
|
|
25586
|
+
required:
|
|
25587
|
+
- id
|
|
25588
|
+
- event
|
|
25589
|
+
- data
|
|
25590
|
+
- created_at
|
|
25591
|
+
- object
|
|
25592
|
+
- type: object
|
|
25593
|
+
properties:
|
|
25594
|
+
id:
|
|
25595
|
+
type: string
|
|
25596
|
+
description: Unique identifier for the event.
|
|
25597
|
+
example: event_01EHZNVPK3SFK441A1RGBFSHRT
|
|
25598
|
+
event:
|
|
25599
|
+
type: string
|
|
25600
|
+
const: authentication.oauth_succeeded
|
|
24195
25601
|
data:
|
|
24196
25602
|
type: object
|
|
24197
25603
|
properties:
|
|
24198
25604
|
type:
|
|
24199
25605
|
type: string
|
|
24200
|
-
const:
|
|
25606
|
+
const: oauth
|
|
24201
25607
|
status:
|
|
24202
25608
|
type: string
|
|
24203
|
-
const:
|
|
25609
|
+
const: succeeded
|
|
24204
25610
|
ip_address:
|
|
24205
25611
|
type:
|
|
24206
25612
|
- string
|
|
@@ -24219,87 +25625,6 @@ components:
|
|
|
24219
25625
|
- 'null'
|
|
24220
25626
|
description: The ID of the user.
|
|
24221
25627
|
example: user_01E4ZCR3C56J083X43JQXF3JK5
|
|
24222
|
-
email:
|
|
24223
|
-
type:
|
|
24224
|
-
- string
|
|
24225
|
-
- 'null'
|
|
24226
|
-
description: The email address of the user.
|
|
24227
|
-
example: user@example.com
|
|
24228
|
-
error:
|
|
24229
|
-
type: object
|
|
24230
|
-
properties:
|
|
24231
|
-
code:
|
|
24232
|
-
type: string
|
|
24233
|
-
description: The error code.
|
|
24234
|
-
example: mfa_challenge_failed
|
|
24235
|
-
message:
|
|
24236
|
-
type: string
|
|
24237
|
-
description: A human-readable error message.
|
|
24238
|
-
example: The MFA challenge has failed.
|
|
24239
|
-
required:
|
|
24240
|
-
- code
|
|
24241
|
-
- message
|
|
24242
|
-
description: Details about the authentication error.
|
|
24243
|
-
required:
|
|
24244
|
-
- type
|
|
24245
|
-
- status
|
|
24246
|
-
- ip_address
|
|
24247
|
-
- user_agent
|
|
24248
|
-
- user_id
|
|
24249
|
-
- email
|
|
24250
|
-
- error
|
|
24251
|
-
description: The event payload.
|
|
24252
|
-
created_at:
|
|
24253
|
-
format: date-time
|
|
24254
|
-
type: string
|
|
24255
|
-
description: An ISO 8601 timestamp.
|
|
24256
|
-
example: '2026-01-15T12:00:00.000Z'
|
|
24257
|
-
context:
|
|
24258
|
-
$ref: '#/components/schemas/EventContextDto'
|
|
24259
|
-
object:
|
|
24260
|
-
type: string
|
|
24261
|
-
description: Distinguishes the Event object.
|
|
24262
|
-
const: event
|
|
24263
|
-
required:
|
|
24264
|
-
- id
|
|
24265
|
-
- event
|
|
24266
|
-
- data
|
|
24267
|
-
- created_at
|
|
24268
|
-
- object
|
|
24269
|
-
- type: object
|
|
24270
|
-
properties:
|
|
24271
|
-
id:
|
|
24272
|
-
type: string
|
|
24273
|
-
description: Unique identifier for the event.
|
|
24274
|
-
example: event_01EHZNVPK3SFK441A1RGBFSHRT
|
|
24275
|
-
event:
|
|
24276
|
-
type: string
|
|
24277
|
-
const: authentication.mfa_succeeded
|
|
24278
|
-
data:
|
|
24279
|
-
type: object
|
|
24280
|
-
properties:
|
|
24281
|
-
type:
|
|
24282
|
-
type: string
|
|
24283
|
-
const: mfa
|
|
24284
|
-
status:
|
|
24285
|
-
type: string
|
|
24286
|
-
const: succeeded
|
|
24287
|
-
ip_address:
|
|
24288
|
-
type:
|
|
24289
|
-
- string
|
|
24290
|
-
- 'null'
|
|
24291
|
-
description: The IP address of the request.
|
|
24292
|
-
example: 203.0.113.42
|
|
24293
|
-
user_agent:
|
|
24294
|
-
type:
|
|
24295
|
-
- string
|
|
24296
|
-
- 'null'
|
|
24297
|
-
description: The user agent of the request.
|
|
24298
|
-
example: Mozilla/5.0
|
|
24299
|
-
user_id:
|
|
24300
|
-
type: string
|
|
24301
|
-
description: The ID of the user.
|
|
24302
|
-
example: user_01E4ZCR3C56J083X43JQXF3JK5
|
|
24303
25628
|
email:
|
|
24304
25629
|
type: string
|
|
24305
25630
|
description: The email address of the user.
|
|
@@ -24337,13 +25662,13 @@ components:
|
|
|
24337
25662
|
example: event_01EHZNVPK3SFK441A1RGBFSHRT
|
|
24338
25663
|
event:
|
|
24339
25664
|
type: string
|
|
24340
|
-
const: authentication.
|
|
25665
|
+
const: authentication.passkey_failed
|
|
24341
25666
|
data:
|
|
24342
25667
|
type: object
|
|
24343
25668
|
properties:
|
|
24344
25669
|
type:
|
|
24345
25670
|
type: string
|
|
24346
|
-
const:
|
|
25671
|
+
const: passkey
|
|
24347
25672
|
status:
|
|
24348
25673
|
type: string
|
|
24349
25674
|
const: failed
|
|
@@ -24420,13 +25745,13 @@ components:
|
|
|
24420
25745
|
example: event_01EHZNVPK3SFK441A1RGBFSHRT
|
|
24421
25746
|
event:
|
|
24422
25747
|
type: string
|
|
24423
|
-
const: authentication.
|
|
25748
|
+
const: authentication.passkey_succeeded
|
|
24424
25749
|
data:
|
|
24425
25750
|
type: object
|
|
24426
25751
|
properties:
|
|
24427
25752
|
type:
|
|
24428
25753
|
type: string
|
|
24429
|
-
const:
|
|
25754
|
+
const: passkey
|
|
24430
25755
|
status:
|
|
24431
25756
|
type: string
|
|
24432
25757
|
const: succeeded
|
|
@@ -24443,9 +25768,7 @@ components:
|
|
|
24443
25768
|
description: The user agent of the request.
|
|
24444
25769
|
example: Mozilla/5.0
|
|
24445
25770
|
user_id:
|
|
24446
|
-
type:
|
|
24447
|
-
- string
|
|
24448
|
-
- 'null'
|
|
25771
|
+
type: string
|
|
24449
25772
|
description: The ID of the user.
|
|
24450
25773
|
example: user_01E4ZCR3C56J083X43JQXF3JK5
|
|
24451
25774
|
email:
|
|
@@ -24485,13 +25808,13 @@ components:
|
|
|
24485
25808
|
example: event_01EHZNVPK3SFK441A1RGBFSHRT
|
|
24486
25809
|
event:
|
|
24487
25810
|
type: string
|
|
24488
|
-
const: authentication.
|
|
25811
|
+
const: authentication.password_failed
|
|
24489
25812
|
data:
|
|
24490
25813
|
type: object
|
|
24491
25814
|
properties:
|
|
24492
25815
|
type:
|
|
24493
25816
|
type: string
|
|
24494
|
-
const:
|
|
25817
|
+
const: password
|
|
24495
25818
|
status:
|
|
24496
25819
|
type: string
|
|
24497
25820
|
const: failed
|
|
@@ -24568,13 +25891,13 @@ components:
|
|
|
24568
25891
|
example: event_01EHZNVPK3SFK441A1RGBFSHRT
|
|
24569
25892
|
event:
|
|
24570
25893
|
type: string
|
|
24571
|
-
const: authentication.
|
|
25894
|
+
const: authentication.password_succeeded
|
|
24572
25895
|
data:
|
|
24573
25896
|
type: object
|
|
24574
25897
|
properties:
|
|
24575
25898
|
type:
|
|
24576
25899
|
type: string
|
|
24577
|
-
const:
|
|
25900
|
+
const: password
|
|
24578
25901
|
status:
|
|
24579
25902
|
type: string
|
|
24580
25903
|
const: succeeded
|
|
@@ -24631,99 +25954,31 @@ components:
|
|
|
24631
25954
|
example: event_01EHZNVPK3SFK441A1RGBFSHRT
|
|
24632
25955
|
event:
|
|
24633
25956
|
type: string
|
|
24634
|
-
const: authentication.
|
|
25957
|
+
const: authentication.radar_risk_detected
|
|
24635
25958
|
data:
|
|
24636
25959
|
type: object
|
|
24637
25960
|
properties:
|
|
24638
|
-
|
|
25961
|
+
auth_method:
|
|
24639
25962
|
type: string
|
|
24640
|
-
|
|
24641
|
-
|
|
25963
|
+
description: The authentication method used.
|
|
25964
|
+
example: password
|
|
25965
|
+
action:
|
|
24642
25966
|
type: string
|
|
24643
|
-
|
|
24644
|
-
|
|
24645
|
-
|
|
24646
|
-
|
|
24647
|
-
- 'null'
|
|
24648
|
-
description: The IP address of the request.
|
|
24649
|
-
example: 203.0.113.42
|
|
24650
|
-
user_agent:
|
|
24651
|
-
type:
|
|
24652
|
-
- string
|
|
24653
|
-
- 'null'
|
|
24654
|
-
description: The user agent of the request.
|
|
24655
|
-
example: Mozilla/5.0
|
|
24656
|
-
user_id:
|
|
25967
|
+
enum:
|
|
25968
|
+
- signup
|
|
25969
|
+
- login
|
|
25970
|
+
control:
|
|
24657
25971
|
type:
|
|
24658
25972
|
- string
|
|
24659
25973
|
- 'null'
|
|
24660
|
-
description: The
|
|
24661
|
-
example:
|
|
24662
|
-
|
|
25974
|
+
description: The control action taken for the detected risk.
|
|
25975
|
+
example: block
|
|
25976
|
+
blocklist_type:
|
|
24663
25977
|
type:
|
|
24664
25978
|
- string
|
|
24665
25979
|
- 'null'
|
|
24666
|
-
description: The
|
|
24667
|
-
example:
|
|
24668
|
-
error:
|
|
24669
|
-
type: object
|
|
24670
|
-
properties:
|
|
24671
|
-
code:
|
|
24672
|
-
type: string
|
|
24673
|
-
description: The error code.
|
|
24674
|
-
example: mfa_challenge_failed
|
|
24675
|
-
message:
|
|
24676
|
-
type: string
|
|
24677
|
-
description: A human-readable error message.
|
|
24678
|
-
example: The MFA challenge has failed.
|
|
24679
|
-
required:
|
|
24680
|
-
- code
|
|
24681
|
-
- message
|
|
24682
|
-
description: Details about the authentication error.
|
|
24683
|
-
required:
|
|
24684
|
-
- type
|
|
24685
|
-
- status
|
|
24686
|
-
- ip_address
|
|
24687
|
-
- user_agent
|
|
24688
|
-
- user_id
|
|
24689
|
-
- email
|
|
24690
|
-
- error
|
|
24691
|
-
description: The event payload.
|
|
24692
|
-
created_at:
|
|
24693
|
-
format: date-time
|
|
24694
|
-
type: string
|
|
24695
|
-
description: An ISO 8601 timestamp.
|
|
24696
|
-
example: '2026-01-15T12:00:00.000Z'
|
|
24697
|
-
context:
|
|
24698
|
-
$ref: '#/components/schemas/EventContextDto'
|
|
24699
|
-
object:
|
|
24700
|
-
type: string
|
|
24701
|
-
description: Distinguishes the Event object.
|
|
24702
|
-
const: event
|
|
24703
|
-
required:
|
|
24704
|
-
- id
|
|
24705
|
-
- event
|
|
24706
|
-
- data
|
|
24707
|
-
- created_at
|
|
24708
|
-
- object
|
|
24709
|
-
- type: object
|
|
24710
|
-
properties:
|
|
24711
|
-
id:
|
|
24712
|
-
type: string
|
|
24713
|
-
description: Unique identifier for the event.
|
|
24714
|
-
example: event_01EHZNVPK3SFK441A1RGBFSHRT
|
|
24715
|
-
event:
|
|
24716
|
-
type: string
|
|
24717
|
-
const: authentication.password_succeeded
|
|
24718
|
-
data:
|
|
24719
|
-
type: object
|
|
24720
|
-
properties:
|
|
24721
|
-
type:
|
|
24722
|
-
type: string
|
|
24723
|
-
const: password
|
|
24724
|
-
status:
|
|
24725
|
-
type: string
|
|
24726
|
-
const: succeeded
|
|
25980
|
+
description: The type of blocklist that triggered the risk detection.
|
|
25981
|
+
example: ip
|
|
24727
25982
|
ip_address:
|
|
24728
25983
|
type:
|
|
24729
25984
|
- string
|
|
@@ -24745,8 +26000,10 @@ components:
|
|
|
24745
26000
|
description: The email address of the user.
|
|
24746
26001
|
example: user@example.com
|
|
24747
26002
|
required:
|
|
24748
|
-
-
|
|
24749
|
-
-
|
|
26003
|
+
- auth_method
|
|
26004
|
+
- action
|
|
26005
|
+
- control
|
|
26006
|
+
- blocklist_type
|
|
24750
26007
|
- ip_address
|
|
24751
26008
|
- user_agent
|
|
24752
26009
|
- user_id
|
|
@@ -24777,31 +26034,16 @@ components:
|
|
|
24777
26034
|
example: event_01EHZNVPK3SFK441A1RGBFSHRT
|
|
24778
26035
|
event:
|
|
24779
26036
|
type: string
|
|
24780
|
-
const: authentication.
|
|
26037
|
+
const: authentication.reauthentication_succeeded
|
|
24781
26038
|
data:
|
|
24782
26039
|
type: object
|
|
24783
26040
|
properties:
|
|
24784
|
-
|
|
26041
|
+
type:
|
|
24785
26042
|
type: string
|
|
24786
|
-
|
|
24787
|
-
|
|
24788
|
-
action:
|
|
26043
|
+
const: reauthentication
|
|
26044
|
+
status:
|
|
24789
26045
|
type: string
|
|
24790
|
-
|
|
24791
|
-
- signup
|
|
24792
|
-
- login
|
|
24793
|
-
control:
|
|
24794
|
-
type:
|
|
24795
|
-
- string
|
|
24796
|
-
- 'null'
|
|
24797
|
-
description: The control action taken for the detected risk.
|
|
24798
|
-
example: block
|
|
24799
|
-
blocklist_type:
|
|
24800
|
-
type:
|
|
24801
|
-
- string
|
|
24802
|
-
- 'null'
|
|
24803
|
-
description: The type of blocklist that triggered the risk detection.
|
|
24804
|
-
example: ip
|
|
26046
|
+
const: succeeded
|
|
24805
26047
|
ip_address:
|
|
24806
26048
|
type:
|
|
24807
26049
|
- string
|
|
@@ -24823,10 +26065,8 @@ components:
|
|
|
24823
26065
|
description: The email address of the user.
|
|
24824
26066
|
example: user@example.com
|
|
24825
26067
|
required:
|
|
24826
|
-
-
|
|
24827
|
-
-
|
|
24828
|
-
- control
|
|
24829
|
-
- blocklist_type
|
|
26068
|
+
- type
|
|
26069
|
+
- status
|
|
24830
26070
|
- ip_address
|
|
24831
26071
|
- user_agent
|
|
24832
26072
|
- user_id
|
|
@@ -30232,36 +31472,7 @@ components:
|
|
|
30232
31472
|
example: event_01EHZNVPK3SFK441A1RGBFSHRT
|
|
30233
31473
|
event:
|
|
30234
31474
|
type: string
|
|
30235
|
-
const: pipes.connected_account.disconnected
|
|
30236
|
-
data:
|
|
30237
|
-
$ref: '#/components/schemas/PipesConnectedAccount'
|
|
30238
|
-
description: The event payload.
|
|
30239
|
-
created_at:
|
|
30240
|
-
format: date-time
|
|
30241
|
-
type: string
|
|
30242
|
-
description: An ISO 8601 timestamp.
|
|
30243
|
-
example: '2026-01-15T12:00:00.000Z'
|
|
30244
|
-
context:
|
|
30245
|
-
$ref: '#/components/schemas/EventContextDto'
|
|
30246
|
-
object:
|
|
30247
|
-
type: string
|
|
30248
|
-
description: Distinguishes the Event object.
|
|
30249
|
-
const: event
|
|
30250
|
-
required:
|
|
30251
|
-
- id
|
|
30252
|
-
- event
|
|
30253
|
-
- data
|
|
30254
|
-
- created_at
|
|
30255
|
-
- object
|
|
30256
|
-
- type: object
|
|
30257
|
-
properties:
|
|
30258
|
-
id:
|
|
30259
|
-
type: string
|
|
30260
|
-
description: Unique identifier for the event.
|
|
30261
|
-
example: event_01EHZNVPK3SFK441A1RGBFSHRT
|
|
30262
|
-
event:
|
|
30263
|
-
type: string
|
|
30264
|
-
const: pipes.connected_account.reauthorization_needed
|
|
31475
|
+
const: pipes.connected_account.disconnected
|
|
30265
31476
|
data:
|
|
30266
31477
|
$ref: '#/components/schemas/PipesConnectedAccount'
|
|
30267
31478
|
description: The event payload.
|
|
@@ -30290,46 +31501,9 @@ components:
|
|
|
30290
31501
|
example: event_01EHZNVPK3SFK441A1RGBFSHRT
|
|
30291
31502
|
event:
|
|
30292
31503
|
type: string
|
|
30293
|
-
const:
|
|
31504
|
+
const: pipes.connected_account.reauthorization_needed
|
|
30294
31505
|
data:
|
|
30295
|
-
|
|
30296
|
-
properties:
|
|
30297
|
-
object:
|
|
30298
|
-
type: string
|
|
30299
|
-
description: Distinguishes the role object.
|
|
30300
|
-
const: role
|
|
30301
|
-
slug:
|
|
30302
|
-
type: string
|
|
30303
|
-
description: The slug identifier of the role.
|
|
30304
|
-
example: admin
|
|
30305
|
-
resource_type_slug:
|
|
30306
|
-
type: string
|
|
30307
|
-
description: The slug of the resource type the role applies to.
|
|
30308
|
-
example: organization
|
|
30309
|
-
permissions:
|
|
30310
|
-
type: array
|
|
30311
|
-
items:
|
|
30312
|
-
type: string
|
|
30313
|
-
description: The permissions granted by the role.
|
|
30314
|
-
example: &ref_22
|
|
30315
|
-
- users:read
|
|
30316
|
-
- users:write
|
|
30317
|
-
created_at:
|
|
30318
|
-
format: date-time
|
|
30319
|
-
type: string
|
|
30320
|
-
description: An ISO 8601 timestamp.
|
|
30321
|
-
example: '2026-01-15T12:00:00.000Z'
|
|
30322
|
-
updated_at:
|
|
30323
|
-
format: date-time
|
|
30324
|
-
type: string
|
|
30325
|
-
description: An ISO 8601 timestamp.
|
|
30326
|
-
example: '2026-01-15T12:00:00.000Z'
|
|
30327
|
-
required:
|
|
30328
|
-
- object
|
|
30329
|
-
- slug
|
|
30330
|
-
- resource_type_slug
|
|
30331
|
-
- created_at
|
|
30332
|
-
- updated_at
|
|
31506
|
+
$ref: '#/components/schemas/PipesConnectedAccount'
|
|
30333
31507
|
description: The event payload.
|
|
30334
31508
|
created_at:
|
|
30335
31509
|
format: date-time
|
|
@@ -30356,7 +31530,7 @@ components:
|
|
|
30356
31530
|
example: event_01EHZNVPK3SFK441A1RGBFSHRT
|
|
30357
31531
|
event:
|
|
30358
31532
|
type: string
|
|
30359
|
-
const: role.
|
|
31533
|
+
const: role.created
|
|
30360
31534
|
data:
|
|
30361
31535
|
type: object
|
|
30362
31536
|
properties:
|
|
@@ -30377,7 +31551,9 @@ components:
|
|
|
30377
31551
|
items:
|
|
30378
31552
|
type: string
|
|
30379
31553
|
description: The permissions granted by the role.
|
|
30380
|
-
example:
|
|
31554
|
+
example: &ref_22
|
|
31555
|
+
- users:read
|
|
31556
|
+
- users:write
|
|
30381
31557
|
created_at:
|
|
30382
31558
|
format: date-time
|
|
30383
31559
|
type: string
|
|
@@ -30420,7 +31596,7 @@ components:
|
|
|
30420
31596
|
example: event_01EHZNVPK3SFK441A1RGBFSHRT
|
|
30421
31597
|
event:
|
|
30422
31598
|
type: string
|
|
30423
|
-
const: role.
|
|
31599
|
+
const: role.deleted
|
|
30424
31600
|
data:
|
|
30425
31601
|
type: object
|
|
30426
31602
|
properties:
|
|
@@ -30484,102 +31660,28 @@ components:
|
|
|
30484
31660
|
example: event_01EHZNVPK3SFK441A1RGBFSHRT
|
|
30485
31661
|
event:
|
|
30486
31662
|
type: string
|
|
30487
|
-
const:
|
|
31663
|
+
const: role.updated
|
|
30488
31664
|
data:
|
|
30489
31665
|
type: object
|
|
30490
31666
|
properties:
|
|
30491
31667
|
object:
|
|
30492
31668
|
type: string
|
|
30493
|
-
description: Distinguishes the
|
|
30494
|
-
const:
|
|
30495
|
-
|
|
30496
|
-
type: string
|
|
30497
|
-
description: The unique ID of the session.
|
|
30498
|
-
example: session_01H93ZY4F80QPBEZ1R5B2SHQG8
|
|
30499
|
-
impersonator:
|
|
30500
|
-
type: object
|
|
30501
|
-
properties:
|
|
30502
|
-
email:
|
|
30503
|
-
type: string
|
|
30504
|
-
description: >-
|
|
30505
|
-
The email address of the WorkOS Dashboard user who
|
|
30506
|
-
is impersonating the user.
|
|
30507
|
-
example: admin@foocorp.com
|
|
30508
|
-
reason:
|
|
30509
|
-
type:
|
|
30510
|
-
- string
|
|
30511
|
-
- 'null'
|
|
30512
|
-
description: >-
|
|
30513
|
-
The justification the impersonator gave for
|
|
30514
|
-
impersonating the user.
|
|
30515
|
-
example: Investigating an issue with the customer's account.
|
|
30516
|
-
required:
|
|
30517
|
-
- email
|
|
30518
|
-
- reason
|
|
30519
|
-
description: >-
|
|
30520
|
-
Information about the impersonator if this session was
|
|
30521
|
-
created via impersonation.
|
|
30522
|
-
ip_address:
|
|
30523
|
-
type:
|
|
30524
|
-
- string
|
|
30525
|
-
- 'null'
|
|
30526
|
-
description: The IP address from which the session was created.
|
|
30527
|
-
example: 198.51.100.42
|
|
30528
|
-
organization_id:
|
|
30529
|
-
type: string
|
|
30530
|
-
description: >-
|
|
30531
|
-
The ID of the organization this session is associated
|
|
30532
|
-
with.
|
|
30533
|
-
example: org_01H945H0YD4F97JN9MATX7BYAG
|
|
30534
|
-
user_agent:
|
|
30535
|
-
type:
|
|
30536
|
-
- string
|
|
30537
|
-
- 'null'
|
|
30538
|
-
description: >-
|
|
30539
|
-
The user agent string from the device that created the
|
|
30540
|
-
session.
|
|
30541
|
-
example: >-
|
|
30542
|
-
Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7)
|
|
30543
|
-
AppleWebKit/537.36
|
|
30544
|
-
user_id:
|
|
30545
|
-
type: string
|
|
30546
|
-
description: The ID of the user this session belongs to.
|
|
30547
|
-
example: user_01E4ZCR3C56J083X43JQXF3JK5
|
|
30548
|
-
auth_method:
|
|
30549
|
-
type: string
|
|
30550
|
-
enum:
|
|
30551
|
-
- cross_app_auth
|
|
30552
|
-
- external_auth
|
|
30553
|
-
- impersonation
|
|
30554
|
-
- magic_code
|
|
30555
|
-
- migrated_session
|
|
30556
|
-
- oauth
|
|
30557
|
-
- passkey
|
|
30558
|
-
- password
|
|
30559
|
-
- sso
|
|
30560
|
-
- unknown
|
|
30561
|
-
description: The authentication method used to create this session.
|
|
30562
|
-
example: sso
|
|
30563
|
-
status:
|
|
31669
|
+
description: Distinguishes the role object.
|
|
31670
|
+
const: role
|
|
31671
|
+
slug:
|
|
30564
31672
|
type: string
|
|
30565
|
-
|
|
30566
|
-
|
|
30567
|
-
|
|
30568
|
-
- revoked
|
|
30569
|
-
description: The current status of the session.
|
|
30570
|
-
example: active
|
|
30571
|
-
expires_at:
|
|
30572
|
-
format: date-time
|
|
31673
|
+
description: The slug identifier of the role.
|
|
31674
|
+
example: admin
|
|
31675
|
+
resource_type_slug:
|
|
30573
31676
|
type: string
|
|
30574
|
-
description: The
|
|
30575
|
-
example:
|
|
30576
|
-
|
|
30577
|
-
|
|
30578
|
-
|
|
30579
|
-
|
|
30580
|
-
|
|
30581
|
-
|
|
30582
|
-
example: null
|
|
31677
|
+
description: The slug of the resource type the role applies to.
|
|
31678
|
+
example: organization
|
|
31679
|
+
permissions:
|
|
31680
|
+
type: array
|
|
31681
|
+
items:
|
|
31682
|
+
type: string
|
|
31683
|
+
description: The permissions granted by the role.
|
|
31684
|
+
example: *ref_22
|
|
30583
31685
|
created_at:
|
|
30584
31686
|
format: date-time
|
|
30585
31687
|
type: string
|
|
@@ -30592,14 +31694,8 @@ components:
|
|
|
30592
31694
|
example: '2026-01-15T12:00:00.000Z'
|
|
30593
31695
|
required:
|
|
30594
31696
|
- object
|
|
30595
|
-
-
|
|
30596
|
-
-
|
|
30597
|
-
- user_agent
|
|
30598
|
-
- user_id
|
|
30599
|
-
- auth_method
|
|
30600
|
-
- status
|
|
30601
|
-
- expires_at
|
|
30602
|
-
- ended_at
|
|
31697
|
+
- slug
|
|
31698
|
+
- resource_type_slug
|
|
30603
31699
|
- created_at
|
|
30604
31700
|
- updated_at
|
|
30605
31701
|
description: The event payload.
|
|
@@ -30628,7 +31724,7 @@ components:
|
|
|
30628
31724
|
example: event_01EHZNVPK3SFK441A1RGBFSHRT
|
|
30629
31725
|
event:
|
|
30630
31726
|
type: string
|
|
30631
|
-
const: session.
|
|
31727
|
+
const: session.created
|
|
30632
31728
|
data:
|
|
30633
31729
|
type: object
|
|
30634
31730
|
properties:
|
|
@@ -32654,6 +33750,132 @@ components:
|
|
|
32654
33750
|
required:
|
|
32655
33751
|
- code
|
|
32656
33752
|
- message
|
|
33753
|
+
DataIntegrationCredentialsResponse:
|
|
33754
|
+
oneOf:
|
|
33755
|
+
- type: object
|
|
33756
|
+
properties:
|
|
33757
|
+
active:
|
|
33758
|
+
type: boolean
|
|
33759
|
+
description: Indicates credentials are available.
|
|
33760
|
+
const: true
|
|
33761
|
+
credential:
|
|
33762
|
+
type: object
|
|
33763
|
+
properties:
|
|
33764
|
+
object:
|
|
33765
|
+
type: string
|
|
33766
|
+
description: Distinguishes the credential object.
|
|
33767
|
+
const: credential
|
|
33768
|
+
auth_method:
|
|
33769
|
+
type: string
|
|
33770
|
+
description: >-
|
|
33771
|
+
The authentication method for this credential. Additional
|
|
33772
|
+
values may be added in the future; handle unknown values
|
|
33773
|
+
gracefully.
|
|
33774
|
+
x-extensible-enum:
|
|
33775
|
+
- oauth
|
|
33776
|
+
- api_key
|
|
33777
|
+
const: oauth
|
|
33778
|
+
value:
|
|
33779
|
+
type: string
|
|
33780
|
+
description: The OAuth access token.
|
|
33781
|
+
example: gho_16C7e42F292c6912E7710c838347Ae178B4a
|
|
33782
|
+
expires_at:
|
|
33783
|
+
type:
|
|
33784
|
+
- string
|
|
33785
|
+
- 'null'
|
|
33786
|
+
description: >-
|
|
33787
|
+
The ISO-8601 formatted timestamp indicating when the
|
|
33788
|
+
credential expires.
|
|
33789
|
+
example: '2025-12-31T23:59:59.000Z'
|
|
33790
|
+
scopes:
|
|
33791
|
+
type: array
|
|
33792
|
+
items:
|
|
33793
|
+
type: string
|
|
33794
|
+
description: The scopes granted to the access token.
|
|
33795
|
+
example:
|
|
33796
|
+
- repo
|
|
33797
|
+
- user:email
|
|
33798
|
+
missing_scopes:
|
|
33799
|
+
type: array
|
|
33800
|
+
items:
|
|
33801
|
+
type: string
|
|
33802
|
+
description: >-
|
|
33803
|
+
If the integration has requested scopes that aren't present
|
|
33804
|
+
on the access token, they're listed here.
|
|
33805
|
+
example: []
|
|
33806
|
+
required:
|
|
33807
|
+
- object
|
|
33808
|
+
- auth_method
|
|
33809
|
+
- value
|
|
33810
|
+
- expires_at
|
|
33811
|
+
- scopes
|
|
33812
|
+
- missing_scopes
|
|
33813
|
+
description: The credential object containing the vended secret.
|
|
33814
|
+
required:
|
|
33815
|
+
- active
|
|
33816
|
+
- credential
|
|
33817
|
+
- type: object
|
|
33818
|
+
properties:
|
|
33819
|
+
active:
|
|
33820
|
+
type: boolean
|
|
33821
|
+
description: Indicates credentials are available.
|
|
33822
|
+
const: true
|
|
33823
|
+
credential:
|
|
33824
|
+
type: object
|
|
33825
|
+
properties:
|
|
33826
|
+
object:
|
|
33827
|
+
type: string
|
|
33828
|
+
description: Distinguishes the credential object.
|
|
33829
|
+
const: credential
|
|
33830
|
+
auth_method:
|
|
33831
|
+
type: string
|
|
33832
|
+
description: >-
|
|
33833
|
+
The authentication method for this credential. Additional
|
|
33834
|
+
values may be added in the future; handle unknown values
|
|
33835
|
+
gracefully.
|
|
33836
|
+
x-extensible-enum:
|
|
33837
|
+
- oauth
|
|
33838
|
+
- api_key
|
|
33839
|
+
const: api_key
|
|
33840
|
+
value:
|
|
33841
|
+
type: string
|
|
33842
|
+
description: The API key secret.
|
|
33843
|
+
example: sk-1234567890abcdef
|
|
33844
|
+
required:
|
|
33845
|
+
- object
|
|
33846
|
+
- auth_method
|
|
33847
|
+
- value
|
|
33848
|
+
description: The credential object containing the vended secret.
|
|
33849
|
+
required:
|
|
33850
|
+
- active
|
|
33851
|
+
- credential
|
|
33852
|
+
- type: object
|
|
33853
|
+
properties:
|
|
33854
|
+
active:
|
|
33855
|
+
type: boolean
|
|
33856
|
+
description: Indicates credentials are not available.
|
|
33857
|
+
const: false
|
|
33858
|
+
error:
|
|
33859
|
+
type: string
|
|
33860
|
+
enum:
|
|
33861
|
+
- not_installed
|
|
33862
|
+
- needs_reauthorization
|
|
33863
|
+
description: >-
|
|
33864
|
+
The reason credentials are unavailable. Additional values may be
|
|
33865
|
+
added in the future; handle unknown values gracefully.
|
|
33866
|
+
|
|
33867
|
+
- `"not_installed"`: The user does not have the integration
|
|
33868
|
+
installed.
|
|
33869
|
+
|
|
33870
|
+
- `"needs_reauthorization"`: The user needs to reauthorize the
|
|
33871
|
+
integration.
|
|
33872
|
+
example: not_installed
|
|
33873
|
+
x-extensible-enum:
|
|
33874
|
+
- not_installed
|
|
33875
|
+
- needs_reauthorization
|
|
33876
|
+
required:
|
|
33877
|
+
- active
|
|
33878
|
+
- error
|
|
32657
33879
|
ConnectedAccount:
|
|
32658
33880
|
type: object
|
|
32659
33881
|
properties:
|