@workos/openapi-spec 0.7.0 → 0.8.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.
@@ -1170,6 +1170,430 @@ paths:
1170
1170
  summary: Complete external authentication
1171
1171
  tags:
1172
1172
  - workos-connect
1173
+ /authorization/groups/{group_id}/role_assignments:
1174
+ get:
1175
+ description: >-
1176
+ List all role assignments granted to a group. Each assignment represents
1177
+ a role granted to the group on a resource.
1178
+ operationId: AuthorizationGroupRoleAssignmentsController_list
1179
+ parameters:
1180
+ - name: group_id
1181
+ required: true
1182
+ in: path
1183
+ description: The ID of the group.
1184
+ schema:
1185
+ type: string
1186
+ example: group_01HXYZ123456789ABCDEFGHIJ
1187
+ - name: before
1188
+ required: false
1189
+ in: query
1190
+ description: >-
1191
+ An object ID that defines your place in the list. When the ID is not
1192
+ present, you are at the end of the list. For example, if you make a
1193
+ list request and receive 100 objects, ending with `"obj_123"`, your
1194
+ subsequent call can include `before="obj_123"` to fetch a new batch
1195
+ of objects before `"obj_123"`.
1196
+ schema:
1197
+ example: xxx_01HXYZ123456789ABCDEFGHIJ
1198
+ type: string
1199
+ - name: after
1200
+ required: false
1201
+ in: query
1202
+ description: >-
1203
+ An object ID that defines your place in the list. When the ID is not
1204
+ present, you are at the end of the list. For example, if you make a
1205
+ list request and receive 100 objects, ending with `"obj_123"`, your
1206
+ subsequent call can include `after="obj_123"` to fetch a new batch
1207
+ of objects after `"obj_123"`.
1208
+ schema:
1209
+ example: xxx_01HXYZ987654321KJIHGFEDCBA
1210
+ type: string
1211
+ - name: limit
1212
+ required: false
1213
+ in: query
1214
+ description: >-
1215
+ Upper limit on the number of objects to return, between `1` and
1216
+ `100`.
1217
+ schema:
1218
+ minimum: 1
1219
+ maximum: 100
1220
+ default: 10
1221
+ example: 10
1222
+ type: integer
1223
+ - name: order
1224
+ required: false
1225
+ in: query
1226
+ description: >-
1227
+ Order the results by the creation time. Supported values are `"asc"`
1228
+ (ascending), `"desc"` (descending), and `"normal"` (descending with
1229
+ reversed cursor semantics where `before` fetches older records and
1230
+ `after` fetches newer records).
1231
+ schema:
1232
+ $ref: '#/components/schemas/PaginationOrder'
1233
+ responses:
1234
+ '200':
1235
+ description: OK
1236
+ content:
1237
+ application/json:
1238
+ schema:
1239
+ $ref: '#/components/schemas/GroupRoleAssignmentList'
1240
+ '403':
1241
+ description: Forbidden
1242
+ content:
1243
+ application/json:
1244
+ schema:
1245
+ type: object
1246
+ properties:
1247
+ message:
1248
+ type: string
1249
+ description: A human-readable description of the error.
1250
+ example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
1251
+ required:
1252
+ - message
1253
+ '404':
1254
+ description: Not Found
1255
+ content:
1256
+ application/json:
1257
+ schema:
1258
+ type: object
1259
+ properties:
1260
+ message:
1261
+ type: string
1262
+ description: A human-readable description of the error.
1263
+ example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
1264
+ required:
1265
+ - message
1266
+ summary: List role assignments for a group
1267
+ tags:
1268
+ - authorization
1269
+ x-feature-flag: user-groups-role-assignment-enabled
1270
+ post:
1271
+ description: Assign a role to a group on a specific resource.
1272
+ operationId: AuthorizationGroupRoleAssignmentsController_create
1273
+ parameters:
1274
+ - name: group_id
1275
+ required: true
1276
+ in: path
1277
+ description: The ID of the group.
1278
+ schema:
1279
+ type: string
1280
+ example: group_01HXYZ123456789ABCDEFGHIJ
1281
+ requestBody:
1282
+ required: true
1283
+ content:
1284
+ application/json:
1285
+ schema:
1286
+ $ref: '#/components/schemas/CreateGroupRoleAssignmentDto'
1287
+ responses:
1288
+ '201':
1289
+ description: Created
1290
+ content:
1291
+ application/json:
1292
+ schema:
1293
+ $ref: '#/components/schemas/GroupRoleAssignment'
1294
+ '403':
1295
+ description: Forbidden
1296
+ content:
1297
+ application/json:
1298
+ schema:
1299
+ type: object
1300
+ properties:
1301
+ message:
1302
+ type: string
1303
+ description: A human-readable description of the error.
1304
+ example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
1305
+ required:
1306
+ - message
1307
+ '404':
1308
+ description: Not Found
1309
+ content:
1310
+ application/json:
1311
+ schema:
1312
+ type: object
1313
+ properties:
1314
+ message:
1315
+ type: string
1316
+ description: A human-readable description of the error.
1317
+ example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
1318
+ required:
1319
+ - message
1320
+ '409':
1321
+ description: ''
1322
+ content:
1323
+ application/json:
1324
+ schema:
1325
+ type: object
1326
+ properties:
1327
+ code:
1328
+ type: string
1329
+ description: The error code identifying the type of error.
1330
+ example: duplicate_group_role_assignment
1331
+ const: duplicate_group_role_assignment
1332
+ message:
1333
+ type: string
1334
+ description: A human-readable description of the error.
1335
+ example: Request could not be processed.
1336
+ required:
1337
+ - code
1338
+ - message
1339
+ '422':
1340
+ description: Unprocessable Entity
1341
+ content:
1342
+ application/json:
1343
+ schema:
1344
+ type: object
1345
+ properties:
1346
+ message:
1347
+ type: string
1348
+ description: A human-readable description of the error.
1349
+ example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
1350
+ required:
1351
+ - message
1352
+ summary: Assign a role to a group
1353
+ tags:
1354
+ - authorization
1355
+ x-feature-flag: user-groups-role-assignment-enabled
1356
+ put:
1357
+ description: >-
1358
+ Replace all role assignments for a group with the provided list.
1359
+ Existing assignments not in the list will be removed.
1360
+ operationId: AuthorizationGroupRoleAssignmentsController_replaceGroupRoleAssignments
1361
+ parameters:
1362
+ - name: group_id
1363
+ required: true
1364
+ in: path
1365
+ description: The ID of the group.
1366
+ schema:
1367
+ type: string
1368
+ example: group_01HXYZ123456789ABCDEFGHIJ
1369
+ requestBody:
1370
+ required: true
1371
+ content:
1372
+ application/json:
1373
+ schema:
1374
+ $ref: '#/components/schemas/ReplaceGroupRoleAssignmentsDto'
1375
+ responses:
1376
+ '200':
1377
+ description: OK
1378
+ content:
1379
+ application/json:
1380
+ schema:
1381
+ $ref: '#/components/schemas/GroupRoleAssignmentList'
1382
+ '403':
1383
+ description: Forbidden
1384
+ content:
1385
+ application/json:
1386
+ schema:
1387
+ type: object
1388
+ properties:
1389
+ message:
1390
+ type: string
1391
+ description: A human-readable description of the error.
1392
+ example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
1393
+ required:
1394
+ - message
1395
+ '404':
1396
+ description: Not Found
1397
+ content:
1398
+ application/json:
1399
+ schema:
1400
+ type: object
1401
+ properties:
1402
+ message:
1403
+ type: string
1404
+ description: A human-readable description of the error.
1405
+ example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
1406
+ required:
1407
+ - message
1408
+ '422':
1409
+ description: Unprocessable Entity
1410
+ content:
1411
+ application/json:
1412
+ schema:
1413
+ type: object
1414
+ properties:
1415
+ message:
1416
+ type: string
1417
+ description: A human-readable description of the error.
1418
+ example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
1419
+ required:
1420
+ - message
1421
+ summary: Replace all role assignments for a group
1422
+ tags:
1423
+ - authorization
1424
+ x-feature-flag: user-groups-role-assignment-enabled
1425
+ delete:
1426
+ description: >-
1427
+ Remove role assignments from a group that match the provided criteria.
1428
+ Returns 404 when no matching active assignment is found.
1429
+ operationId: AuthorizationGroupRoleAssignmentsController_removeGroupRoleAssignments
1430
+ parameters:
1431
+ - name: group_id
1432
+ required: true
1433
+ in: path
1434
+ description: The ID of the group.
1435
+ schema:
1436
+ type: string
1437
+ example: group_01HXYZ123456789ABCDEFGHIJ
1438
+ requestBody:
1439
+ required: true
1440
+ content:
1441
+ application/json:
1442
+ schema:
1443
+ $ref: '#/components/schemas/DeleteGroupRoleAssignmentsByCriteriaDto'
1444
+ responses:
1445
+ '204':
1446
+ description: No Content
1447
+ '403':
1448
+ description: Forbidden
1449
+ content:
1450
+ application/json:
1451
+ schema:
1452
+ type: object
1453
+ properties:
1454
+ message:
1455
+ type: string
1456
+ description: A human-readable description of the error.
1457
+ example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
1458
+ required:
1459
+ - message
1460
+ '404':
1461
+ description: Not Found
1462
+ content:
1463
+ application/json:
1464
+ schema:
1465
+ type: object
1466
+ properties:
1467
+ message:
1468
+ type: string
1469
+ description: A human-readable description of the error.
1470
+ example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
1471
+ required:
1472
+ - message
1473
+ '422':
1474
+ description: Unprocessable Entity
1475
+ content:
1476
+ application/json:
1477
+ schema:
1478
+ type: object
1479
+ properties:
1480
+ message:
1481
+ type: string
1482
+ description: A human-readable description of the error.
1483
+ example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
1484
+ required:
1485
+ - message
1486
+ summary: Remove group role assignments by criteria
1487
+ tags:
1488
+ - authorization
1489
+ x-feature-flag: user-groups-role-assignment-enabled
1490
+ /authorization/groups/{group_id}/role_assignments/{role_assignment_id}:
1491
+ get:
1492
+ description: Get a specific role assignment for a group by its ID.
1493
+ operationId: AuthorizationGroupRoleAssignmentsController_get
1494
+ parameters:
1495
+ - name: group_id
1496
+ required: true
1497
+ in: path
1498
+ description: The ID of the group.
1499
+ schema:
1500
+ type: string
1501
+ example: group_01HXYZ123456789ABCDEFGHIJ
1502
+ - name: role_assignment_id
1503
+ required: true
1504
+ in: path
1505
+ description: The ID of the group role assignment.
1506
+ schema:
1507
+ type: string
1508
+ example: gra_01HXYZ123456789ABCDEFGHIJ
1509
+ responses:
1510
+ '200':
1511
+ description: OK
1512
+ content:
1513
+ application/json:
1514
+ schema:
1515
+ $ref: '#/components/schemas/GroupRoleAssignment'
1516
+ '403':
1517
+ description: Forbidden
1518
+ content:
1519
+ application/json:
1520
+ schema:
1521
+ type: object
1522
+ properties:
1523
+ message:
1524
+ type: string
1525
+ description: A human-readable description of the error.
1526
+ example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
1527
+ required:
1528
+ - message
1529
+ '404':
1530
+ description: Not Found
1531
+ content:
1532
+ application/json:
1533
+ schema:
1534
+ type: object
1535
+ properties:
1536
+ message:
1537
+ type: string
1538
+ description: A human-readable description of the error.
1539
+ example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
1540
+ required:
1541
+ - message
1542
+ summary: Get a group role assignment
1543
+ tags:
1544
+ - authorization
1545
+ x-feature-flag: user-groups-role-assignment-enabled
1546
+ delete:
1547
+ description: Remove a specific role assignment from a group by its ID.
1548
+ operationId: AuthorizationGroupRoleAssignmentsController_removeGroupRoleAssignment
1549
+ parameters:
1550
+ - name: group_id
1551
+ required: true
1552
+ in: path
1553
+ description: The ID of the group.
1554
+ schema:
1555
+ type: string
1556
+ example: group_01HXYZ123456789ABCDEFGHIJ
1557
+ - name: role_assignment_id
1558
+ required: true
1559
+ in: path
1560
+ description: The ID of the group role assignment to remove.
1561
+ schema:
1562
+ type: string
1563
+ example: gra_01HXYZ123456789ABCDEFGHIJ
1564
+ responses:
1565
+ '204':
1566
+ description: No Content
1567
+ '403':
1568
+ description: Forbidden
1569
+ content:
1570
+ application/json:
1571
+ schema:
1572
+ type: object
1573
+ properties:
1574
+ message:
1575
+ type: string
1576
+ description: A human-readable description of the error.
1577
+ example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
1578
+ required:
1579
+ - message
1580
+ '404':
1581
+ description: Not Found
1582
+ content:
1583
+ application/json:
1584
+ schema:
1585
+ type: object
1586
+ properties:
1587
+ message:
1588
+ type: string
1589
+ description: A human-readable description of the error.
1590
+ example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
1591
+ required:
1592
+ - message
1593
+ summary: Remove a group role assignment
1594
+ tags:
1595
+ - authorization
1596
+ x-feature-flag: user-groups-role-assignment-enabled
1173
1597
  /authorization/organization_memberships/{organization_membership_id}/check:
1174
1598
  post:
1175
1599
  description: >-
@@ -4123,6 +4547,25 @@ paths:
4123
4547
  application/json:
4124
4548
  schema:
4125
4549
  $ref: '#/components/schemas/AuthorizationResourceList'
4550
+ '400':
4551
+ description: Bad Request
4552
+ content:
4553
+ application/json:
4554
+ schema:
4555
+ type: object
4556
+ properties:
4557
+ code:
4558
+ type: string
4559
+ description: The error code identifying the type of error.
4560
+ example: missing_organization_id_or_resource_type_slug
4561
+ const: missing_organization_id_or_resource_type_slug
4562
+ message:
4563
+ type: string
4564
+ description: A human-readable description of the error.
4565
+ example: Request could not be processed.
4566
+ required:
4567
+ - code
4568
+ - message
4126
4569
  '403':
4127
4570
  description: Forbidden
4128
4571
  content:
@@ -5646,6 +6089,68 @@ paths:
5646
6089
  summary: Add a permission to an environment role
5647
6090
  tags:
5648
6091
  - authorization
6092
+ /client/token:
6093
+ post:
6094
+ description: >-
6095
+ Generate a short-lived, session-bound token for the Client GraphQL API,
6096
+ scoped to an organization and user.
6097
+ operationId: ClientApiTokenController_issueClientApiToken
6098
+ parameters: []
6099
+ requestBody:
6100
+ required: true
6101
+ content:
6102
+ application/json:
6103
+ schema:
6104
+ $ref: '#/components/schemas/ClientApiTokenDto'
6105
+ responses:
6106
+ '201':
6107
+ description: Created
6108
+ content:
6109
+ application/json:
6110
+ schema:
6111
+ $ref: '#/components/schemas/ClientApiTokenResponse'
6112
+ '400':
6113
+ description: Bad Request
6114
+ content:
6115
+ application/json:
6116
+ schema:
6117
+ type: object
6118
+ properties:
6119
+ message:
6120
+ type: string
6121
+ description: A human-readable description of the error.
6122
+ example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
6123
+ required:
6124
+ - message
6125
+ '404':
6126
+ description: Not Found
6127
+ content:
6128
+ application/json:
6129
+ schema:
6130
+ type: object
6131
+ properties:
6132
+ message:
6133
+ type: string
6134
+ description: A human-readable description of the error.
6135
+ example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
6136
+ required:
6137
+ - message
6138
+ '422':
6139
+ description: Unprocessable Entity
6140
+ content:
6141
+ application/json:
6142
+ schema:
6143
+ type: object
6144
+ properties:
6145
+ message:
6146
+ type: string
6147
+ description: A human-readable description of the error.
6148
+ example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
6149
+ required:
6150
+ - message
6151
+ summary: Generate a Client API token
6152
+ tags:
6153
+ - client
5649
6154
  /connect/applications:
5650
6155
  get:
5651
6156
  description: >-
@@ -8564,7 +9069,156 @@ paths:
8564
9069
  schema:
8565
9070
  $ref: '#/components/schemas/OrganizationApiKeyWithValue'
8566
9071
  '404':
8567
- description: Not Found
9072
+ description: Not Found
9073
+ content:
9074
+ application/json:
9075
+ schema:
9076
+ type: object
9077
+ properties:
9078
+ message:
9079
+ type: string
9080
+ description: A human-readable description of the error.
9081
+ example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
9082
+ required:
9083
+ - message
9084
+ '422':
9085
+ description: Unprocessable Entity
9086
+ content:
9087
+ application/json:
9088
+ schema:
9089
+ type: object
9090
+ properties:
9091
+ message:
9092
+ type: string
9093
+ description: A human-readable description of the error.
9094
+ example: Validation failed.
9095
+ errors:
9096
+ type: array
9097
+ items:
9098
+ type: object
9099
+ properties:
9100
+ code:
9101
+ type: string
9102
+ description: The validation error code.
9103
+ example: required
9104
+ field:
9105
+ type: string
9106
+ description: The field that failed validation.
9107
+ example: event.action
9108
+ required:
9109
+ - code
9110
+ - field
9111
+ description: The list of validation errors.
9112
+ required:
9113
+ - message
9114
+ - errors
9115
+ summary: Create an API key for an organization
9116
+ tags:
9117
+ - organizations.api_keys
9118
+ /organizations/{organizationId}/data_integration_configurations:
9119
+ get:
9120
+ description: >-
9121
+ Returns a list of all providers available to the specified organization,
9122
+ along with any configured custom OAuth scopes, enabled state, and
9123
+ organization-managed credentials where applicable.
9124
+ operationId: ProviderController_listForOrganization
9125
+ parameters:
9126
+ - name: organizationId
9127
+ required: true
9128
+ in: path
9129
+ description: >-
9130
+ An [Organization](/reference/organization) identifier to list
9131
+ provider configurations for.
9132
+ schema:
9133
+ example: org_01EHZNVPK3SFK441A1RGBFSHRT
9134
+ type: string
9135
+ responses:
9136
+ '200':
9137
+ description: A list of provider configurations for the organization.
9138
+ content:
9139
+ application/json:
9140
+ schema:
9141
+ $ref: '#/components/schemas/DataIntegrationConfigurationListResponse'
9142
+ '401':
9143
+ description: The request is missing a valid API key.
9144
+ '404':
9145
+ description: The organization was not found.
9146
+ content:
9147
+ application/json:
9148
+ schema:
9149
+ type: object
9150
+ properties:
9151
+ message:
9152
+ type: string
9153
+ description: A human-readable description of the error.
9154
+ example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
9155
+ required:
9156
+ - message
9157
+ summary: List providers for an organization
9158
+ tags:
9159
+ - pipes.provider
9160
+ x-feature-flag: pipes-org-overrides
9161
+ /organizations/{organizationId}/data_integration_configurations/{slug}:
9162
+ put:
9163
+ description: >-
9164
+ Creates or updates an organization's provider configuration. Use this
9165
+ endpoint to enable or disable a provider, set custom OAuth scopes, or
9166
+ supply organization-managed OAuth credentials.
9167
+ operationId: ProviderController_configure
9168
+ parameters:
9169
+ - name: organizationId
9170
+ required: true
9171
+ in: path
9172
+ description: >-
9173
+ An [Organization](/reference/organization) identifier to configure
9174
+ the provider for.
9175
+ schema:
9176
+ example: org_01EHZNVPK3SFK441A1RGBFSHRT
9177
+ type: string
9178
+ - name: slug
9179
+ required: true
9180
+ in: path
9181
+ description: >-
9182
+ The slug identifier of the provider to configure (e.g., `github`,
9183
+ `slack`, `notion`).
9184
+ schema:
9185
+ example: github
9186
+ type: string
9187
+ requestBody:
9188
+ required: true
9189
+ content:
9190
+ application/json:
9191
+ schema:
9192
+ $ref: '#/components/schemas/ConfigureDataIntegrationBody'
9193
+ responses:
9194
+ '200':
9195
+ description: The provider configuration that was created or updated.
9196
+ content:
9197
+ application/json:
9198
+ schema:
9199
+ $ref: '#/components/schemas/DataIntegrationConfigurationResponse'
9200
+ '400':
9201
+ description: >-
9202
+ The request body is invalid. Possible reasons: the body is empty (at
9203
+ least one of `enabled`, `scopes`, or `client_id` must be provided);
9204
+ `client_id` and `client_secret` are not provided together; or
9205
+ `client_id`/`client_secret` were supplied for a provider that does
9206
+ not support organization-managed credentials.
9207
+ content:
9208
+ application/json:
9209
+ schema:
9210
+ type: object
9211
+ properties:
9212
+ message:
9213
+ type: string
9214
+ description: A human-readable description of the error.
9215
+ example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
9216
+ required:
9217
+ - message
9218
+ '401':
9219
+ description: The request is missing a valid API key.
9220
+ '404':
9221
+ description: The organization or provider was not found.
8568
9222
  content:
8569
9223
  application/json:
8570
9224
  schema:
@@ -8577,7 +9231,9 @@ paths:
8577
9231
  required:
8578
9232
  - message
8579
9233
  '422':
8580
- description: Unprocessable Entity
9234
+ description: >-
9235
+ One or more of the supplied `scopes` are not valid for the provider.
9236
+ Only scopes configured on the provider may be used.
8581
9237
  content:
8582
9238
  application/json:
8583
9239
  schema:
@@ -8586,30 +9242,13 @@ paths:
8586
9242
  message:
8587
9243
  type: string
8588
9244
  description: A human-readable description of the error.
8589
- example: Validation failed.
8590
- errors:
8591
- type: array
8592
- items:
8593
- type: object
8594
- properties:
8595
- code:
8596
- type: string
8597
- description: The validation error code.
8598
- example: required
8599
- field:
8600
- type: string
8601
- description: The field that failed validation.
8602
- example: event.action
8603
- required:
8604
- - code
8605
- - field
8606
- description: The list of validation errors.
9245
+ example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
8607
9246
  required:
8608
9247
  - message
8609
- - errors
8610
- summary: Create an API key for an organization
9248
+ summary: Configure a provider for an organization
8611
9249
  tags:
8612
- - organizations.api_keys
9250
+ - pipes.provider
9251
+ x-feature-flag: pipes-org-overrides
8613
9252
  /organizations/{organizationId}/feature-flags:
8614
9253
  get:
8615
9254
  description: Get a list of all enabled feature flags for an organization.
@@ -10254,7 +10893,10 @@ paths:
10254
10893
  example: client_01HXYZ123456789ABCDEFGHIJ
10255
10894
  client_secret:
10256
10895
  type: string
10257
- description: The client secret of the application.
10896
+ description: >-
10897
+ The client secret of the application. May be omitted by
10898
+ public clients that authenticate through other means,
10899
+ such as a PKCE `code_verifier`.
10258
10900
  example: sk_test_....
10259
10901
  grant_type:
10260
10902
  type: string
@@ -10287,7 +10929,6 @@ paths:
10287
10929
  example: Mozilla/5.0
10288
10930
  required:
10289
10931
  - client_id
10290
- - client_secret
10291
10932
  - grant_type
10292
10933
  - code
10293
10934
  - type: object
@@ -10341,7 +10982,10 @@ paths:
10341
10982
  example: client_01HXYZ123456789ABCDEFGHIJ
10342
10983
  client_secret:
10343
10984
  type: string
10344
- description: The client secret of the application.
10985
+ description: >-
10986
+ The client secret of the application. May be omitted by
10987
+ public clients that authenticate through other means,
10988
+ such as a PKCE `code_verifier`.
10345
10989
  example: sk_test_....
10346
10990
  grant_type:
10347
10991
  type: string
@@ -10368,7 +11012,6 @@ paths:
10368
11012
  example: Mozilla/5.0
10369
11013
  required:
10370
11014
  - client_id
10371
- - client_secret
10372
11015
  - grant_type
10373
11016
  - refresh_token
10374
11017
  - type: object
@@ -11699,47 +12342,7 @@ paths:
11699
12342
  content:
11700
12343
  application/json:
11701
12344
  schema:
11702
- allOf:
11703
- - type: object
11704
- properties:
11705
- object:
11706
- type: string
11707
- description: Indicates this is a list response.
11708
- const: list
11709
- list_metadata:
11710
- type: object
11711
- properties:
11712
- before:
11713
- type:
11714
- - string
11715
- - 'null'
11716
- description: >-
11717
- An object ID that defines your place in the list.
11718
- When the ID is not present, you are at the start
11719
- of the list.
11720
- example: invitation_01HXYZ123456789ABCDEFGHIJ
11721
- after:
11722
- type:
11723
- - string
11724
- - 'null'
11725
- description: >-
11726
- An object ID that defines your place in the list.
11727
- When the ID is not present, you are at the end of
11728
- the list.
11729
- example: invitation_01HXYZ987654321KJIHGFEDCBA
11730
- required:
11731
- - before
11732
- - after
11733
- description: >-
11734
- Pagination cursors for navigating between pages of
11735
- results.
11736
- - type: object
11737
- properties:
11738
- data:
11739
- type: array
11740
- description: The list of records for the current page.
11741
- items:
11742
- $ref: '#/components/schemas/UserlandUserInvite'
12345
+ $ref: '#/components/schemas/UserlandUserInviteList'
11743
12346
  '422':
11744
12347
  description: Unprocessable Entity
11745
12348
  content:
@@ -12726,48 +13329,7 @@ paths:
12726
13329
  content:
12727
13330
  application/json:
12728
13331
  schema:
12729
- allOf:
12730
- - type: object
12731
- properties:
12732
- object:
12733
- type: string
12734
- description: Indicates this is a list response.
12735
- const: list
12736
- list_metadata:
12737
- type: object
12738
- properties:
12739
- before:
12740
- type:
12741
- - string
12742
- - 'null'
12743
- description: >-
12744
- An object ID that defines your place in the list.
12745
- When the ID is not present, you are at the start
12746
- of the list.
12747
- example: om_01HXYZ123456789ABCDEFGHIJ
12748
- after:
12749
- type:
12750
- - string
12751
- - 'null'
12752
- description: >-
12753
- An object ID that defines your place in the list.
12754
- When the ID is not present, you are at the end of
12755
- the list.
12756
- example: om_01HXYZ987654321KJIHGFEDCBA
12757
- required:
12758
- - before
12759
- - after
12760
- description: >-
12761
- Pagination cursors for navigating between pages of
12762
- results.
12763
- - type: object
12764
- properties:
12765
- data:
12766
- type: array
12767
- description: The list of records for the current page.
12768
- items:
12769
- $ref: >-
12770
- #/components/schemas/UserlandUserOrganizationMembership
13332
+ $ref: '#/components/schemas/UserlandUserOrganizationMembershipList'
12771
13333
  '400':
12772
13334
  description: Bad Request
12773
13335
  content:
@@ -13841,7 +14403,7 @@ paths:
13841
14403
  - user-management.users
13842
14404
  /user_management/redirect_uris:
13843
14405
  post:
13844
- description: Creates a new redirect URI for an environment.
14406
+ description: Creates a new redirect URI for an application.
13845
14407
  operationId: RedirectUrisController_create
13846
14408
  parameters: []
13847
14409
  requestBody:
@@ -15194,7 +15756,7 @@ paths:
15194
15756
  /user_management/users/{id}/email_verification/send:
15195
15757
  post:
15196
15758
  description: >-
15197
- Sends an email that contains a one-time code used to verify a user’s
15759
+ Sends an email that contains a one-time code used to verify a user's
15198
15760
  email address.
15199
15761
  operationId: UserlandUsersController_sendVerificationEmail[0]
15200
15762
  parameters:
@@ -16136,7 +16698,7 @@ paths:
16136
16698
  example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
16137
16699
  required:
16138
16700
  - message
16139
- summary: List providers
16701
+ summary: List providers for a user
16140
16702
  tags:
16141
16703
  - user-management.data-providers
16142
16704
  /user_management/users/{userlandUserId}/auth_factors:
@@ -17096,6 +17658,8 @@ tags:
17096
17658
  description: Create and query audit log events.
17097
17659
  - name: authorization
17098
17660
  description: Authorization and access control.
17661
+ - name: client
17662
+ description: Client GraphQL API token management.
17099
17663
  - name: connections
17100
17664
  description: Manage SSO connections.
17101
17665
  - name: directories
@@ -17128,6 +17692,8 @@ tags:
17128
17692
  description: Manage permissions.
17129
17693
  - name: pipes
17130
17694
  description: Data integration endpoints.
17695
+ - name: pipes.provider
17696
+ description: Manage organization-scoped provider configurations.
17131
17697
  - name: radar
17132
17698
  description: Radar fraud detection.
17133
17699
  - name: sso
@@ -17777,6 +18343,88 @@ components:
17777
18343
  required:
17778
18344
  - resource_id
17779
18345
  x-mutually-exclusive-body-groups: *ref_3
18346
+ CreateGroupRoleAssignmentDto:
18347
+ type: object
18348
+ properties:
18349
+ role_slug:
18350
+ type: string
18351
+ description: The slug of the role to assign to the group.
18352
+ example: admin
18353
+ resource_id:
18354
+ type: string
18355
+ description: >-
18356
+ The ID of the resource. Omit along with the external-id fields to
18357
+ target the organization itself.
18358
+ example: authz_resource_01HXYZ123456789ABCDEFGH
18359
+ resource_external_id:
18360
+ type: string
18361
+ description: The external ID of the resource.
18362
+ example: proj-456
18363
+ resource_type_slug:
18364
+ type: string
18365
+ description: The resource type slug.
18366
+ example: project
18367
+ required:
18368
+ - role_slug
18369
+ ReplaceGroupRoleAssignmentEntryDto:
18370
+ type: object
18371
+ properties:
18372
+ role_slug:
18373
+ type: string
18374
+ description: The slug of the role to assign to the group.
18375
+ example: admin
18376
+ resource_id:
18377
+ type: string
18378
+ description: >-
18379
+ The ID of the resource. Omit along with the external-id fields to
18380
+ target the organization itself.
18381
+ example: authz_resource_01HXYZ123456789ABCDEFGH
18382
+ resource_external_id:
18383
+ type: string
18384
+ description: The external ID of the resource.
18385
+ example: proj-456
18386
+ resource_type_slug:
18387
+ type: string
18388
+ description: The resource type slug.
18389
+ example: project
18390
+ required:
18391
+ - role_slug
18392
+ ReplaceGroupRoleAssignmentsDto:
18393
+ type: object
18394
+ properties:
18395
+ role_assignments:
18396
+ maxItems: 100
18397
+ description: >-
18398
+ The list of role assignments that should exist for the group. All
18399
+ existing assignments will be replaced.
18400
+ type: array
18401
+ items:
18402
+ $ref: '#/components/schemas/ReplaceGroupRoleAssignmentEntryDto'
18403
+ required:
18404
+ - role_assignments
18405
+ DeleteGroupRoleAssignmentsByCriteriaDto:
18406
+ type: object
18407
+ properties:
18408
+ role_slug:
18409
+ type: string
18410
+ description: The slug of the role to remove assignments for.
18411
+ example: admin
18412
+ resource_id:
18413
+ type: string
18414
+ description: >-
18415
+ The ID of the resource. Mutually exclusive with
18416
+ `resource_external_id` and `resource_type_slug`.
18417
+ example: authz_resource_01HXYZ123456789ABCDEFGH
18418
+ resource_external_id:
18419
+ type: string
18420
+ description: The external ID of the resource.
18421
+ example: proj-456
18422
+ resource_type_slug:
18423
+ type: string
18424
+ description: The resource type slug.
18425
+ example: project
18426
+ required:
18427
+ - role_slug
17780
18428
  AssignRoleDto:
17781
18429
  allOf:
17782
18430
  - type: object
@@ -19458,10 +20106,25 @@ components:
19458
20106
  - widgets:api-keys:manage
19459
20107
  - widgets:dsync:manage
19460
20108
  - widgets:audit-log-streaming:manage
20109
+ - widgets:pipes:manage
19461
20110
  example:
19462
20111
  - widgets:users-table:manage
19463
20112
  required:
19464
20113
  - organization_id
20114
+ ClientApiTokenDto:
20115
+ type: object
20116
+ properties:
20117
+ organization_id:
20118
+ type: string
20119
+ description: The ID of the organization to scope the Client API token to.
20120
+ example: org_01EHZNVPK3SFK441A1RGBFSHRT
20121
+ user_id:
20122
+ type: string
20123
+ description: The ID of the user to issue the Client API token for.
20124
+ example: user_01E4ZCR3C56J083X43JQXF3JK5
20125
+ required:
20126
+ - organization_id
20127
+ - user_id
19465
20128
  TokenQueryDto:
19466
20129
  type: object
19467
20130
  properties:
@@ -20819,8 +21482,117 @@ components:
20819
21482
  example: false
20820
21483
  resource_type_slug:
20821
21484
  type: string
20822
- description: The slug of the resource type associated with the permission.
20823
- example: workspace
21485
+ description: The slug of the resource type associated with the permission.
21486
+ example: workspace
21487
+ created_at:
21488
+ format: date-time
21489
+ type: string
21490
+ description: An ISO 8601 timestamp.
21491
+ example: '2026-01-15T12:00:00.000Z'
21492
+ updated_at:
21493
+ format: date-time
21494
+ type: string
21495
+ description: An ISO 8601 timestamp.
21496
+ example: '2026-01-15T12:00:00.000Z'
21497
+ required:
21498
+ - object
21499
+ - id
21500
+ - slug
21501
+ - name
21502
+ - description
21503
+ - system
21504
+ - resource_type_slug
21505
+ - created_at
21506
+ - updated_at
21507
+ AuthorizationPermissionList:
21508
+ type: object
21509
+ properties:
21510
+ object:
21511
+ type: string
21512
+ description: Indicates this is a list response.
21513
+ const: list
21514
+ data:
21515
+ type: array
21516
+ items:
21517
+ $ref: '#/components/schemas/AuthorizationPermission'
21518
+ description: The list of records for the current page.
21519
+ list_metadata:
21520
+ type: object
21521
+ properties:
21522
+ before:
21523
+ type:
21524
+ - string
21525
+ - 'null'
21526
+ description: >-
21527
+ An object ID that defines your place in the list. When the ID is
21528
+ not present, you are at the start of the list.
21529
+ example: perm_01HXYZ123456789ABCDEFGHIJ
21530
+ after:
21531
+ type:
21532
+ - string
21533
+ - 'null'
21534
+ description: >-
21535
+ An object ID that defines your place in the list. When the ID is
21536
+ not present, you are at the end of the list.
21537
+ example: perm_01HXYZ987654321KJIHGFEDCBA
21538
+ required:
21539
+ - before
21540
+ - after
21541
+ description: Pagination cursors for navigating between pages of results.
21542
+ required:
21543
+ - object
21544
+ - data
21545
+ - list_metadata
21546
+ SlimRole:
21547
+ type: object
21548
+ properties:
21549
+ slug:
21550
+ type: string
21551
+ description: The slug of the assigned role.
21552
+ example: admin
21553
+ required:
21554
+ - slug
21555
+ description: The primary role assigned to the user.
21556
+ GroupRoleAssignment:
21557
+ type: object
21558
+ properties:
21559
+ object:
21560
+ type: string
21561
+ description: Distinguishes the group role assignment object.
21562
+ const: group_role_assignment
21563
+ id:
21564
+ type: string
21565
+ description: Unique identifier of the group role assignment.
21566
+ example: gra_01HXYZ123456789ABCDEFGH
21567
+ group_id:
21568
+ type: string
21569
+ description: The ID of the group the role is assigned to.
21570
+ example: group_01HXYZ123456789ABCDEFGHIJ
21571
+ role:
21572
+ $ref: '#/components/schemas/SlimRole'
21573
+ description: The role included in the assignment.
21574
+ resource:
21575
+ type: object
21576
+ properties:
21577
+ id:
21578
+ type: string
21579
+ description: The unique ID of the Resource.
21580
+ example: authz_resource_01HXYZ123456789ABCDEFGH
21581
+ external_id:
21582
+ type: string
21583
+ description: >-
21584
+ An identifier you provide to reference the resource in your
21585
+ system.
21586
+ example: proj-456
21587
+ resource_type_slug:
21588
+ type: string
21589
+ description: The slug of the resource type this resource belongs to.
21590
+ example: project
21591
+ required:
21592
+ - id
21593
+ - external_id
21594
+ - resource_type_slug
21595
+ description: The resource the role is assigned on.
20824
21596
  created_at:
20825
21597
  format: date-time
20826
21598
  type: string
@@ -20834,14 +21606,12 @@ components:
20834
21606
  required:
20835
21607
  - object
20836
21608
  - id
20837
- - slug
20838
- - name
20839
- - description
20840
- - system
20841
- - resource_type_slug
21609
+ - group_id
21610
+ - role
21611
+ - resource
20842
21612
  - created_at
20843
21613
  - updated_at
20844
- AuthorizationPermissionList:
21614
+ GroupRoleAssignmentList:
20845
21615
  type: object
20846
21616
  properties:
20847
21617
  object:
@@ -20851,7 +21621,7 @@ components:
20851
21621
  data:
20852
21622
  type: array
20853
21623
  items:
20854
- $ref: '#/components/schemas/AuthorizationPermission'
21624
+ $ref: '#/components/schemas/GroupRoleAssignment'
20855
21625
  description: The list of records for the current page.
20856
21626
  list_metadata:
20857
21627
  type: object
@@ -20863,7 +21633,7 @@ components:
20863
21633
  description: >-
20864
21634
  An object ID that defines your place in the list. When the ID is
20865
21635
  not present, you are at the start of the list.
20866
- example: perm_01HXYZ123456789ABCDEFGHIJ
21636
+ example: gra_01HXYZ123456789ABCDEFGHIJ
20867
21637
  after:
20868
21638
  type:
20869
21639
  - string
@@ -20871,7 +21641,7 @@ components:
20871
21641
  description: >-
20872
21642
  An object ID that defines your place in the list. When the ID is
20873
21643
  not present, you are at the end of the list.
20874
- example: perm_01HXYZ987654321KJIHGFEDCBA
21644
+ example: gra_01HXYZ987654321KJIHGFEDCBA
20875
21645
  required:
20876
21646
  - before
20877
21647
  - after
@@ -20880,16 +21650,6 @@ components:
20880
21650
  - object
20881
21651
  - data
20882
21652
  - list_metadata
20883
- SlimRole:
20884
- type: object
20885
- properties:
20886
- slug:
20887
- type: string
20888
- description: The slug of the assigned role.
20889
- example: admin
20890
- required:
20891
- - slug
20892
- description: The primary role assigned to the user.
20893
21653
  UserRoleAssignment:
20894
21654
  type: object
20895
21655
  properties:
@@ -31320,6 +32080,174 @@ components:
31320
32080
  - organization_id
31321
32081
  - retention_period_in_days
31322
32082
  - state
32083
+ DataIntegrationCredentials:
32084
+ type: object
32085
+ properties:
32086
+ credentials_type:
32087
+ type: string
32088
+ enum:
32089
+ - shared
32090
+ - custom
32091
+ - organization
32092
+ description: >-
32093
+ The credentials type for this integration (e.g., `shared`, `custom`,
32094
+ or `organization`).
32095
+ example: organization
32096
+ has_credentials:
32097
+ type: boolean
32098
+ description: >-
32099
+ Whether the organization has supplied OAuth credentials for this
32100
+ integration.
32101
+ example: true
32102
+ client_id:
32103
+ type:
32104
+ - string
32105
+ - 'null'
32106
+ description: >-
32107
+ The OAuth client ID supplied by the organization, or `null` when
32108
+ none is configured.
32109
+ example: client_01EHZNVPK3SFK441A1RGBFSHRT
32110
+ client_secret_last_four:
32111
+ type:
32112
+ - string
32113
+ - 'null'
32114
+ description: >-
32115
+ The last four characters of the organization-supplied OAuth client
32116
+ secret, or `null` when none is configured.
32117
+ example: 1a2b
32118
+ redirect_uri:
32119
+ type: string
32120
+ description: >-
32121
+ The redirect URI to register with the provider when configuring the
32122
+ organization-managed OAuth application.
32123
+ example: >-
32124
+ https://api.workos.com/data-integrations/github/dik_01EHZNVPK3SFK441A1RGBFSHRT/callback
32125
+ required:
32126
+ - credentials_type
32127
+ - has_credentials
32128
+ - client_id
32129
+ - client_secret_last_four
32130
+ - redirect_uri
32131
+ description: >-
32132
+ Organization-managed OAuth credential configuration. Present only for
32133
+ integrations whose credentials are supplied by the organization; absent
32134
+ otherwise.
32135
+ DataIntegrationConfigurationResponse:
32136
+ type: object
32137
+ properties:
32138
+ object:
32139
+ type: string
32140
+ description: Distinguishes the data integration configuration object.
32141
+ const: data_integration_configuration
32142
+ id:
32143
+ type: string
32144
+ description: The unique identifier of the data integration.
32145
+ example: data_integration_01EHZNVPK3SFK441A1RGBFSHRT
32146
+ organization_id:
32147
+ type: string
32148
+ description: >-
32149
+ The [Organization](/reference/organization) this configuration
32150
+ applies to.
32151
+ example: org_01EHZNVPK3SFK441A1RGBFSHRT
32152
+ slug:
32153
+ type: string
32154
+ description: >-
32155
+ The slug identifier of the provider (e.g., `github`, `slack`,
32156
+ `notion`).
32157
+ example: github
32158
+ name:
32159
+ type: string
32160
+ description: The display name of the data integration.
32161
+ example: GitHub
32162
+ enabled:
32163
+ type: boolean
32164
+ description: >-
32165
+ Whether the integration is enabled for this organization. Reflects
32166
+ the organization override when one exists, otherwise the provider
32167
+ default.
32168
+ example: true
32169
+ scopes:
32170
+ description: >-
32171
+ The OAuth scopes in effect for this organization. Reflects the
32172
+ organization override when one is set, otherwise the provider
32173
+ scopes, or `null` when none are configured.
32174
+ example:
32175
+ - repo
32176
+ - user:email
32177
+ oneOf:
32178
+ - type: array
32179
+ items:
32180
+ type: string
32181
+ - type: 'null'
32182
+ created_at:
32183
+ type: string
32184
+ description: The timestamp when the configuration was created.
32185
+ example: '2024-01-15T10:30:00.000Z'
32186
+ updated_at:
32187
+ type: string
32188
+ description: The timestamp when the configuration was last updated.
32189
+ example: '2024-01-15T10:30:00.000Z'
32190
+ credentials:
32191
+ $ref: '#/components/schemas/DataIntegrationCredentials'
32192
+ required:
32193
+ - object
32194
+ - id
32195
+ - organization_id
32196
+ - slug
32197
+ - name
32198
+ - enabled
32199
+ - scopes
32200
+ - created_at
32201
+ - updated_at
32202
+ DataIntegrationConfigurationListResponse:
32203
+ type: object
32204
+ properties:
32205
+ object:
32206
+ type: string
32207
+ description: Indicates this is a list response.
32208
+ const: list
32209
+ data:
32210
+ type: array
32211
+ items:
32212
+ $ref: '#/components/schemas/DataIntegrationConfigurationResponse'
32213
+ description: A list of data integration configurations for the organization.
32214
+ required:
32215
+ - object
32216
+ - data
32217
+ ConfigureDataIntegrationBody:
32218
+ type: object
32219
+ properties:
32220
+ enabled:
32221
+ type: boolean
32222
+ description: Whether the provider is enabled for the organization.
32223
+ example: true
32224
+ scopes:
32225
+ description: >-
32226
+ The OAuth scopes to request for the organization. Pass `null` to
32227
+ inherit the provider scopes.
32228
+ example:
32229
+ - repo
32230
+ - user:email
32231
+ oneOf:
32232
+ - type: array
32233
+ items:
32234
+ type: string
32235
+ - type: 'null'
32236
+ client_id:
32237
+ type: string
32238
+ minLength: 1
32239
+ description: >-
32240
+ The OAuth client ID of the organization's own application. Must be
32241
+ provided together with `client_secret`, and only for providers whose
32242
+ credentials are supplied by the organization.
32243
+ example: client_01EHZNVPK3SFK441A1RGBFSHRT
32244
+ client_secret:
32245
+ type: string
32246
+ minLength: 1
32247
+ description: >-
32248
+ The OAuth client secret of the organization's own application. Must
32249
+ be provided together with `client_id`.
32250
+ example: ••••••••
31323
32251
  DataIntegrationAuthorizeUrlResponse:
31324
32252
  type: object
31325
32253
  properties:
@@ -31445,6 +32373,23 @@ components:
31445
32373
  example:
31446
32374
  - repo
31447
32375
  - user:email
32376
+ auth_method:
32377
+ type: string
32378
+ enum:
32379
+ - oauth
32380
+ - api_key
32381
+ description: >-
32382
+ The authentication method used for this connection (`oauth` or
32383
+ `api_key`). Defaults to `oauth` if absent.
32384
+ example: oauth
32385
+ api_key_last_4:
32386
+ type:
32387
+ - string
32388
+ - 'null'
32389
+ description: >-
32390
+ The last four characters of the API key, or `null` for OAuth
32391
+ connections.
32392
+ example: null
31448
32393
  state:
31449
32394
  type: string
31450
32395
  enum:
@@ -31536,6 +32481,19 @@ components:
31536
32481
  items:
31537
32482
  type: string
31538
32483
  - type: 'null'
32484
+ auth_methods:
32485
+ type: array
32486
+ items:
32487
+ type: string
32488
+ enum:
32489
+ - oauth
32490
+ - api_key
32491
+ description: >-
32492
+ The authentication methods supported by this provider
32493
+ (`oauth`, `api_key`, or both). Defaults to `["oauth"]` if
32494
+ absent.
32495
+ example:
32496
+ - oauth
31539
32497
  ownership:
31540
32498
  type: string
31541
32499
  enum:
@@ -31607,6 +32565,23 @@ components:
31607
32565
  example:
31608
32566
  - repo
31609
32567
  - user:email
32568
+ auth_method:
32569
+ type: string
32570
+ enum:
32571
+ - oauth
32572
+ - api_key
32573
+ description: >-
32574
+ The authentication method used for this connection
32575
+ (`oauth` or `api_key`). Defaults to `oauth` if absent.
32576
+ example: oauth
32577
+ api_key_last_4:
32578
+ type:
32579
+ - string
32580
+ - 'null'
32581
+ description: >-
32582
+ The last four characters of the API key, or `null` for
32583
+ OAuth connections.
32584
+ example: null
31610
32585
  state:
31611
32586
  type: string
31612
32587
  enum:
@@ -32012,6 +32987,45 @@ components:
32012
32987
  - updated_at
32013
32988
  - token
32014
32989
  - accept_invitation_url
32990
+ UserlandUserInviteList:
32991
+ type: object
32992
+ properties:
32993
+ object:
32994
+ type: string
32995
+ description: Indicates this is a list response.
32996
+ const: list
32997
+ data:
32998
+ type: array
32999
+ items:
33000
+ $ref: '#/components/schemas/UserlandUserInvite'
33001
+ description: The list of records for the current page.
33002
+ list_metadata:
33003
+ type: object
33004
+ properties:
33005
+ before:
33006
+ type:
33007
+ - string
33008
+ - 'null'
33009
+ description: >-
33010
+ An object ID that defines your place in the list. When the ID is
33011
+ not present, you are at the start of the list.
33012
+ example: invitation_01HXYZ123456789ABCDEFGHIJ
33013
+ after:
33014
+ type:
33015
+ - string
33016
+ - 'null'
33017
+ description: >-
33018
+ An object ID that defines your place in the list. When the ID is
33019
+ not present, you are at the end of the list.
33020
+ example: invitation_01HXYZ987654321KJIHGFEDCBA
33021
+ required:
33022
+ - before
33023
+ - after
33024
+ description: Pagination cursors for navigating between pages of results.
33025
+ required:
33026
+ - object
33027
+ - data
33028
+ - list_metadata
32015
33029
  UserlandUserOrganizationMembership:
32016
33030
  type: object
32017
33031
  properties:
@@ -32090,6 +33104,45 @@ components:
32090
33104
  - updated_at
32091
33105
  - role
32092
33106
  - user
33107
+ UserlandUserOrganizationMembershipList:
33108
+ type: object
33109
+ properties:
33110
+ object:
33111
+ type: string
33112
+ description: Indicates this is a list response.
33113
+ const: list
33114
+ data:
33115
+ type: array
33116
+ items:
33117
+ $ref: '#/components/schemas/UserlandUserOrganizationMembership'
33118
+ description: The list of records for the current page.
33119
+ list_metadata:
33120
+ type: object
33121
+ properties:
33122
+ before:
33123
+ type:
33124
+ - string
33125
+ - 'null'
33126
+ description: >-
33127
+ An object ID that defines your place in the list. When the ID is
33128
+ not present, you are at the start of the list.
33129
+ example: om_01HXYZ123456789ABCDEFGHIJ
33130
+ after:
33131
+ type:
33132
+ - string
33133
+ - 'null'
33134
+ description: >-
33135
+ An object ID that defines your place in the list. When the ID is
33136
+ not present, you are at the end of the list.
33137
+ example: om_01HXYZ987654321KJIHGFEDCBA
33138
+ required:
33139
+ - before
33140
+ - after
33141
+ description: Pagination cursors for navigating between pages of results.
33142
+ required:
33143
+ - object
33144
+ - data
33145
+ - list_metadata
32093
33146
  UserApiKey:
32094
33147
  type: object
32095
33148
  properties:
@@ -32740,6 +33793,15 @@ components:
32740
33793
  example: eyJhbGciOiJSUzI1NiIsImtpZCI6InNlc3Npb24...
32741
33794
  required:
32742
33795
  - token
33796
+ ClientApiTokenResponse:
33797
+ type: object
33798
+ properties:
33799
+ token:
33800
+ type: string
33801
+ description: The Client API token.
33802
+ example: eyJhbGciOiJSUzI1NiIsImtpZCI6InNlc3Npb24...
33803
+ required:
33804
+ - token
32743
33805
  SsoAuthorizeUrlResponse:
32744
33806
  type: object
32745
33807
  properties: