@workos/openapi-spec 0.1.0 → 0.2.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/open-api-spec.yaml +638 -599
- package/package.json +1 -1
- package/types.d.ts +253 -72
package/open-api-spec.yaml
CHANGED
|
@@ -2,9 +2,8 @@ openapi: 3.1.1
|
|
|
2
2
|
paths:
|
|
3
3
|
/api_keys/validations:
|
|
4
4
|
post:
|
|
5
|
-
operationId: ApiKeysController_validateApiKey
|
|
6
|
-
summary: Validate API key
|
|
7
5
|
description: Validate an API key value and return the API key object if valid.
|
|
6
|
+
operationId: ApiKeysController_validateApiKey
|
|
8
7
|
parameters: []
|
|
9
8
|
requestBody:
|
|
10
9
|
required: true
|
|
@@ -34,15 +33,15 @@ paths:
|
|
|
34
33
|
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
35
34
|
required:
|
|
36
35
|
- message
|
|
36
|
+
summary: Validate API key
|
|
37
37
|
tags:
|
|
38
38
|
- api_keys
|
|
39
39
|
/api_keys/{id}:
|
|
40
40
|
delete:
|
|
41
|
-
operationId: ApiKeysController_delete
|
|
42
|
-
summary: Delete an API key
|
|
43
41
|
description: >-
|
|
44
42
|
Permanently deletes an API key. This action cannot be undone. Once
|
|
45
43
|
deleted, any requests using this API key will fail authentication.
|
|
44
|
+
operationId: ApiKeysController_delete
|
|
46
45
|
parameters:
|
|
47
46
|
- name: id
|
|
48
47
|
required: true
|
|
@@ -67,13 +66,13 @@ paths:
|
|
|
67
66
|
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
68
67
|
required:
|
|
69
68
|
- message
|
|
69
|
+
summary: Delete an API key
|
|
70
70
|
tags:
|
|
71
71
|
- api_keys
|
|
72
72
|
/audit_logs/actions:
|
|
73
73
|
get:
|
|
74
|
-
operationId: AuditLogValidatorsController_list
|
|
75
|
-
summary: List Actions
|
|
76
74
|
description: Get a list of all Audit Log actions in the current environment.
|
|
75
|
+
operationId: AuditLogValidatorsController_list
|
|
77
76
|
parameters:
|
|
78
77
|
- name: before
|
|
79
78
|
required: false
|
|
@@ -110,13 +109,7 @@ paths:
|
|
|
110
109
|
in: query
|
|
111
110
|
description: Order the results by the creation time.
|
|
112
111
|
schema:
|
|
113
|
-
|
|
114
|
-
example: desc
|
|
115
|
-
enum:
|
|
116
|
-
- normal
|
|
117
|
-
- desc
|
|
118
|
-
- asc
|
|
119
|
-
type: string
|
|
112
|
+
$ref: '#/components/schemas/PaginationOrder'
|
|
120
113
|
responses:
|
|
121
114
|
'200':
|
|
122
115
|
description: OK
|
|
@@ -190,16 +183,16 @@ paths:
|
|
|
190
183
|
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
191
184
|
required:
|
|
192
185
|
- message
|
|
186
|
+
summary: List Actions
|
|
193
187
|
tags:
|
|
194
188
|
- audit-logs
|
|
195
189
|
/audit_logs/actions/{actionName}/schemas:
|
|
196
190
|
post:
|
|
197
|
-
operationId: AuditLogValidatorVersionsController_create
|
|
198
|
-
summary: Create Schema
|
|
199
191
|
description: >-
|
|
200
192
|
Creates a new Audit Log schema used to validate the payload of incoming
|
|
201
193
|
Audit Log Events. If the `action` does not exist, it will also be
|
|
202
194
|
created.
|
|
195
|
+
operationId: AuditLogValidatorVersionsController_create
|
|
203
196
|
parameters:
|
|
204
197
|
- name: actionName
|
|
205
198
|
required: true
|
|
@@ -234,14 +227,14 @@ paths:
|
|
|
234
227
|
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
235
228
|
required:
|
|
236
229
|
- message
|
|
230
|
+
summary: Create Schema
|
|
237
231
|
tags:
|
|
238
232
|
- audit-logs
|
|
239
233
|
get:
|
|
240
|
-
operationId: AuditLogValidatorVersionsController_schemas
|
|
241
|
-
summary: List Schemas
|
|
242
234
|
description: >-
|
|
243
235
|
Get a list of all schemas for the Audit Logs action identified by
|
|
244
236
|
`:name`.
|
|
237
|
+
operationId: AuditLogValidatorVersionsController_schemas
|
|
245
238
|
parameters:
|
|
246
239
|
- name: actionName
|
|
247
240
|
required: true
|
|
@@ -285,13 +278,7 @@ paths:
|
|
|
285
278
|
in: query
|
|
286
279
|
description: Order the results by the creation time.
|
|
287
280
|
schema:
|
|
288
|
-
|
|
289
|
-
example: desc
|
|
290
|
-
enum:
|
|
291
|
-
- normal
|
|
292
|
-
- desc
|
|
293
|
-
- asc
|
|
294
|
-
type: string
|
|
281
|
+
$ref: '#/components/schemas/PaginationOrder'
|
|
295
282
|
responses:
|
|
296
283
|
'200':
|
|
297
284
|
description: OK
|
|
@@ -365,12 +352,11 @@ paths:
|
|
|
365
352
|
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
366
353
|
required:
|
|
367
354
|
- message
|
|
355
|
+
summary: List Schemas
|
|
368
356
|
tags:
|
|
369
357
|
- audit-logs
|
|
370
358
|
/audit_logs/events:
|
|
371
359
|
post:
|
|
372
|
-
operationId: AuditLogEventsController_create
|
|
373
|
-
summary: Create Event
|
|
374
360
|
description: >-
|
|
375
361
|
Create an Audit Log Event.
|
|
376
362
|
|
|
@@ -392,6 +378,7 @@ paths:
|
|
|
392
378
|
|
|
393
379
|
Idempotency keys expire after 24 hours. The API will generate a new
|
|
394
380
|
response if you submit a request with an expired key.
|
|
381
|
+
operationId: AuditLogEventsController_create
|
|
395
382
|
parameters:
|
|
396
383
|
- name: idempotency-key
|
|
397
384
|
in: header
|
|
@@ -539,15 +526,15 @@ paths:
|
|
|
539
526
|
message: Too many requests.
|
|
540
527
|
code: rate_limit_exceeded
|
|
541
528
|
description: ''
|
|
529
|
+
summary: Create Event
|
|
542
530
|
tags:
|
|
543
531
|
- audit-logs
|
|
544
532
|
/audit_logs/exports:
|
|
545
533
|
post:
|
|
546
|
-
operationId: AuditLogExportsController_exports
|
|
547
|
-
summary: Create Export
|
|
548
534
|
description: >-
|
|
549
535
|
Create an Audit Log Export. Exports are scoped to a single organization
|
|
550
536
|
within a specified date range.
|
|
537
|
+
operationId: AuditLogExportsController_exports
|
|
551
538
|
parameters: []
|
|
552
539
|
requestBody:
|
|
553
540
|
required: true
|
|
@@ -605,16 +592,16 @@ paths:
|
|
|
605
592
|
example:
|
|
606
593
|
message: Invalid date range
|
|
607
594
|
code: invalid_audit_log_export_range_date
|
|
595
|
+
summary: Create Export
|
|
608
596
|
tags:
|
|
609
597
|
- audit-logs
|
|
610
598
|
/audit_logs/exports/{auditLogExportId}:
|
|
611
599
|
get:
|
|
612
|
-
operationId: AuditLogExportsController_export
|
|
613
|
-
summary: Get Export
|
|
614
600
|
description: >-
|
|
615
601
|
Get an Audit Log Export. The URL will expire after 10 minutes. If the
|
|
616
602
|
export is needed again at a later time, refetching the export will
|
|
617
603
|
regenerate the URL.
|
|
604
|
+
operationId: AuditLogExportsController_export
|
|
618
605
|
parameters:
|
|
619
606
|
- name: auditLogExportId
|
|
620
607
|
required: true
|
|
@@ -654,13 +641,13 @@ paths:
|
|
|
654
641
|
message: >-
|
|
655
642
|
Audit Log Export not found:
|
|
656
643
|
'audit_log_export_01GBZK5MP7TD1YCFQHFR22180V'.
|
|
644
|
+
summary: Get Export
|
|
657
645
|
tags:
|
|
658
646
|
- audit-logs
|
|
659
647
|
/auth/challenges/{id}/verify:
|
|
660
648
|
post:
|
|
661
|
-
operationId: AuthenticationChallengesController_verify
|
|
662
|
-
summary: Verify Challenge
|
|
663
649
|
description: Verifies an Authentication Challenge.
|
|
650
|
+
operationId: AuthenticationChallengesController_verify
|
|
664
651
|
parameters:
|
|
665
652
|
- name: id
|
|
666
653
|
required: true
|
|
@@ -734,16 +721,16 @@ paths:
|
|
|
734
721
|
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
735
722
|
required:
|
|
736
723
|
- message
|
|
724
|
+
summary: Verify Challenge
|
|
737
725
|
tags:
|
|
738
726
|
- multi-factor-auth.challenges
|
|
739
727
|
/auth/factors/enroll:
|
|
740
728
|
post:
|
|
741
|
-
operationId: AuthenticationFactorsController_create
|
|
742
|
-
summary: Enroll Factor
|
|
743
729
|
description: >-
|
|
744
730
|
Enrolls an Authentication Factor to be used as an additional factor of
|
|
745
731
|
authentication. The returned ID should be used to create an
|
|
746
732
|
authentication Challenge.
|
|
733
|
+
operationId: AuthenticationFactorsController_create
|
|
747
734
|
parameters: []
|
|
748
735
|
requestBody:
|
|
749
736
|
required: true
|
|
@@ -798,13 +785,13 @@ paths:
|
|
|
798
785
|
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
799
786
|
required:
|
|
800
787
|
- message
|
|
788
|
+
summary: Enroll Factor
|
|
801
789
|
tags:
|
|
802
790
|
- multi-factor-auth
|
|
803
791
|
/auth/factors/{id}:
|
|
804
792
|
get:
|
|
805
|
-
operationId: AuthenticationFactorsController_get
|
|
806
|
-
summary: Get Factor
|
|
807
793
|
description: Gets an Authentication Factor.
|
|
794
|
+
operationId: AuthenticationFactorsController_get
|
|
808
795
|
parameters:
|
|
809
796
|
- name: id
|
|
810
797
|
required: true
|
|
@@ -843,12 +830,12 @@ paths:
|
|
|
843
830
|
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
844
831
|
required:
|
|
845
832
|
- message
|
|
833
|
+
summary: Get Factor
|
|
846
834
|
tags:
|
|
847
835
|
- multi-factor-auth
|
|
848
836
|
delete:
|
|
849
|
-
operationId: AuthenticationFactorsController_delete
|
|
850
|
-
summary: Delete Factor
|
|
851
837
|
description: Permanently deletes an Authentication Factor. It cannot be undone.
|
|
838
|
+
operationId: AuthenticationFactorsController_delete
|
|
852
839
|
parameters:
|
|
853
840
|
- name: id
|
|
854
841
|
required: true
|
|
@@ -875,13 +862,13 @@ paths:
|
|
|
875
862
|
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
876
863
|
required:
|
|
877
864
|
- message
|
|
865
|
+
summary: Delete Factor
|
|
878
866
|
tags:
|
|
879
867
|
- multi-factor-auth
|
|
880
868
|
/auth/factors/{id}/challenge:
|
|
881
869
|
post:
|
|
882
|
-
operationId: AuthenticationFactorsController_challenge
|
|
883
|
-
summary: Challenge Factor
|
|
884
870
|
description: Creates a Challenge for an Authentication Factor.
|
|
871
|
+
operationId: AuthenticationFactorsController_challenge
|
|
885
872
|
parameters:
|
|
886
873
|
- name: id
|
|
887
874
|
required: true
|
|
@@ -929,12 +916,11 @@ paths:
|
|
|
929
916
|
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
930
917
|
required:
|
|
931
918
|
- message
|
|
919
|
+
summary: Challenge Factor
|
|
932
920
|
tags:
|
|
933
921
|
- multi-factor-auth
|
|
934
922
|
/authkit/oauth2/complete:
|
|
935
923
|
post:
|
|
936
|
-
operationId: ExternalAuthController_completeLogin
|
|
937
|
-
summary: Complete external authentication
|
|
938
924
|
description: >-
|
|
939
925
|
Completes an external authentication flow and returns control to
|
|
940
926
|
AuthKit. This endpoint is used with [Standalone
|
|
@@ -961,6 +947,7 @@ paths:
|
|
|
961
947
|
If you provide a new `id` with an `email` that already belongs to an
|
|
962
948
|
existing user, the request will fail with an error as email addresses
|
|
963
949
|
are unique to a user.
|
|
950
|
+
operationId: ExternalAuthController_completeLogin
|
|
964
951
|
parameters: []
|
|
965
952
|
requestBody:
|
|
966
953
|
required: true
|
|
@@ -1076,16 +1063,16 @@ paths:
|
|
|
1076
1063
|
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
1077
1064
|
required:
|
|
1078
1065
|
- message
|
|
1066
|
+
summary: Complete external authentication
|
|
1079
1067
|
tags:
|
|
1080
1068
|
- workos-connect
|
|
1081
1069
|
/authorization/organization_memberships/{organization_membership_id}/check:
|
|
1082
1070
|
post:
|
|
1083
|
-
operationId: AuthorizationController_check
|
|
1084
|
-
summary: Check authorization
|
|
1085
1071
|
description: >-
|
|
1086
1072
|
Check if an organization membership has a specific permission on a
|
|
1087
1073
|
resource. Supports identification by resource_id OR by
|
|
1088
1074
|
resource_external_id + resource_type_slug.
|
|
1075
|
+
operationId: AuthorizationController_check
|
|
1089
1076
|
parameters:
|
|
1090
1077
|
- name: organization_membership_id
|
|
1091
1078
|
required: true
|
|
@@ -1146,6 +1133,7 @@ paths:
|
|
|
1146
1133
|
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
1147
1134
|
required:
|
|
1148
1135
|
- message
|
|
1136
|
+
summary: Check authorization
|
|
1149
1137
|
tags:
|
|
1150
1138
|
- authorization
|
|
1151
1139
|
x-mutually-exclusive-body-groups: &ref_3
|
|
@@ -1159,8 +1147,6 @@ paths:
|
|
|
1159
1147
|
- resource_type_slug
|
|
1160
1148
|
/authorization/organization_memberships/{organization_membership_id}/resources:
|
|
1161
1149
|
get:
|
|
1162
|
-
operationId: AuthorizationController_listResourcesForMembership
|
|
1163
|
-
summary: List resources for organization membership
|
|
1164
1150
|
description: >-
|
|
1165
1151
|
Returns all child resources of a parent resource where the organization
|
|
1166
1152
|
membership has a specific permission. This is useful for resource
|
|
@@ -1171,6 +1157,7 @@ paths:
|
|
|
1171
1157
|
You must provide either `parent_resource_id` or both
|
|
1172
1158
|
`parent_resource_external_id` and `parent_resource_type_slug` to
|
|
1173
1159
|
identify the parent resource.
|
|
1160
|
+
operationId: AuthorizationController_listResourcesForMembership
|
|
1174
1161
|
parameters:
|
|
1175
1162
|
- name: organization_membership_id
|
|
1176
1163
|
required: true
|
|
@@ -1224,13 +1211,7 @@ paths:
|
|
|
1224
1211
|
reversed cursor semantics where `before` fetches older records and
|
|
1225
1212
|
`after` fetches newer records). Defaults to descending.
|
|
1226
1213
|
schema:
|
|
1227
|
-
|
|
1228
|
-
example: desc
|
|
1229
|
-
enum:
|
|
1230
|
-
- normal
|
|
1231
|
-
- desc
|
|
1232
|
-
- asc
|
|
1233
|
-
type: string
|
|
1214
|
+
$ref: '#/components/schemas/PaginationOrder'
|
|
1234
1215
|
- name: permission_slug
|
|
1235
1216
|
required: true
|
|
1236
1217
|
in: query
|
|
@@ -1338,6 +1319,7 @@ paths:
|
|
|
1338
1319
|
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
1339
1320
|
required:
|
|
1340
1321
|
- message
|
|
1322
|
+
summary: List resources for organization membership
|
|
1341
1323
|
tags:
|
|
1342
1324
|
- authorization
|
|
1343
1325
|
x-mutually-exclusive-parameter-groups:
|
|
@@ -1351,12 +1333,11 @@ paths:
|
|
|
1351
1333
|
- parent_resource_external_id
|
|
1352
1334
|
/authorization/organization_memberships/{organization_membership_id}/resources/{resource_id}/permissions:
|
|
1353
1335
|
get:
|
|
1354
|
-
operationId: AuthorizationController_listEffectivePermissions
|
|
1355
|
-
summary: List effective permissions for an organization membership on a resource
|
|
1356
1336
|
description: >-
|
|
1357
1337
|
Returns all permissions the organization membership effectively has on a
|
|
1358
1338
|
resource, including permissions inherited through roles assigned to
|
|
1359
1339
|
ancestor resources.
|
|
1340
|
+
operationId: AuthorizationController_listEffectivePermissions
|
|
1360
1341
|
parameters:
|
|
1361
1342
|
- name: organization_membership_id
|
|
1362
1343
|
required: true
|
|
@@ -1417,13 +1398,7 @@ paths:
|
|
|
1417
1398
|
reversed cursor semantics where `before` fetches older records and
|
|
1418
1399
|
`after` fetches newer records). Defaults to descending.
|
|
1419
1400
|
schema:
|
|
1420
|
-
|
|
1421
|
-
example: desc
|
|
1422
|
-
enum:
|
|
1423
|
-
- normal
|
|
1424
|
-
- desc
|
|
1425
|
-
- asc
|
|
1426
|
-
type: string
|
|
1401
|
+
$ref: '#/components/schemas/PaginationOrder'
|
|
1427
1402
|
responses:
|
|
1428
1403
|
'200':
|
|
1429
1404
|
description: OK
|
|
@@ -1470,18 +1445,16 @@ paths:
|
|
|
1470
1445
|
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
1471
1446
|
required:
|
|
1472
1447
|
- message
|
|
1448
|
+
summary: List effective permissions for an organization membership on a resource
|
|
1473
1449
|
tags:
|
|
1474
1450
|
- authorization
|
|
1475
1451
|
/authorization/organization_memberships/{organization_membership_id}/resources/{resource_type_slug}/{external_id}/permissions:
|
|
1476
1452
|
get:
|
|
1477
|
-
operationId: AuthorizationController_listEffectivePermissionsByExternalId
|
|
1478
|
-
summary: >-
|
|
1479
|
-
List effective permissions for an organization membership on a resource
|
|
1480
|
-
by external ID
|
|
1481
1453
|
description: >-
|
|
1482
1454
|
Returns all permissions the organization membership effectively has on a
|
|
1483
1455
|
resource identified by its external ID, including permissions inherited
|
|
1484
1456
|
through roles assigned to ancestor resources.
|
|
1457
|
+
operationId: AuthorizationController_listEffectivePermissionsByExternalId
|
|
1485
1458
|
parameters:
|
|
1486
1459
|
- name: organization_membership_id
|
|
1487
1460
|
required: true
|
|
@@ -1549,13 +1522,7 @@ paths:
|
|
|
1549
1522
|
reversed cursor semantics where `before` fetches older records and
|
|
1550
1523
|
`after` fetches newer records). Defaults to descending.
|
|
1551
1524
|
schema:
|
|
1552
|
-
|
|
1553
|
-
example: desc
|
|
1554
|
-
enum:
|
|
1555
|
-
- normal
|
|
1556
|
-
- desc
|
|
1557
|
-
- asc
|
|
1558
|
-
type: string
|
|
1525
|
+
$ref: '#/components/schemas/PaginationOrder'
|
|
1559
1526
|
responses:
|
|
1560
1527
|
'200':
|
|
1561
1528
|
description: OK
|
|
@@ -1602,16 +1569,18 @@ paths:
|
|
|
1602
1569
|
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
1603
1570
|
required:
|
|
1604
1571
|
- message
|
|
1572
|
+
summary: >-
|
|
1573
|
+
List effective permissions for an organization membership on a resource
|
|
1574
|
+
by external ID
|
|
1605
1575
|
tags:
|
|
1606
1576
|
- authorization
|
|
1607
1577
|
/authorization/organization_memberships/{organization_membership_id}/role_assignments:
|
|
1608
1578
|
get:
|
|
1609
|
-
operationId: AuthorizationRoleAssignmentsController_listRoleAssignments
|
|
1610
|
-
summary: List role assignments
|
|
1611
1579
|
description: >-
|
|
1612
1580
|
List all role assignments for an organization membership. This returns
|
|
1613
1581
|
all roles that have been assigned to the user on resources, including
|
|
1614
1582
|
organization-level and sub-resource roles.
|
|
1583
|
+
operationId: AuthorizationRoleAssignmentsController_listRoleAssignments
|
|
1615
1584
|
parameters:
|
|
1616
1585
|
- name: organization_membership_id
|
|
1617
1586
|
required: true
|
|
@@ -1665,20 +1634,14 @@ paths:
|
|
|
1665
1634
|
reversed cursor semantics where `before` fetches older records and
|
|
1666
1635
|
`after` fetches newer records). Defaults to descending.
|
|
1667
1636
|
schema:
|
|
1668
|
-
|
|
1669
|
-
example: desc
|
|
1670
|
-
enum:
|
|
1671
|
-
- normal
|
|
1672
|
-
- desc
|
|
1673
|
-
- asc
|
|
1674
|
-
type: string
|
|
1637
|
+
$ref: '#/components/schemas/PaginationOrder'
|
|
1675
1638
|
responses:
|
|
1676
1639
|
'200':
|
|
1677
1640
|
description: OK
|
|
1678
1641
|
content:
|
|
1679
1642
|
application/json:
|
|
1680
1643
|
schema:
|
|
1681
|
-
$ref: '#/components/schemas/
|
|
1644
|
+
$ref: '#/components/schemas/UserRoleAssignmentList'
|
|
1682
1645
|
'403':
|
|
1683
1646
|
description: Forbidden
|
|
1684
1647
|
content:
|
|
@@ -1705,12 +1668,12 @@ paths:
|
|
|
1705
1668
|
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
1706
1669
|
required:
|
|
1707
1670
|
- message
|
|
1671
|
+
summary: List role assignments
|
|
1708
1672
|
tags:
|
|
1709
1673
|
- authorization
|
|
1710
1674
|
post:
|
|
1711
|
-
operationId: AuthorizationRoleAssignmentsController_assignRole
|
|
1712
|
-
summary: Assign a role
|
|
1713
1675
|
description: Assign a role to an organization membership on a specific resource.
|
|
1676
|
+
operationId: AuthorizationRoleAssignmentsController_assignRole
|
|
1714
1677
|
parameters:
|
|
1715
1678
|
- name: organization_membership_id
|
|
1716
1679
|
required: true
|
|
@@ -1730,10 +1693,11 @@ paths:
|
|
|
1730
1693
|
content:
|
|
1731
1694
|
application/json:
|
|
1732
1695
|
schema:
|
|
1733
|
-
$ref: '#/components/schemas/
|
|
1696
|
+
$ref: '#/components/schemas/UserRoleAssignment'
|
|
1734
1697
|
example:
|
|
1735
1698
|
object: role_assignment
|
|
1736
1699
|
id: role_assignment_01HXYZ123456789ABCDEFGH
|
|
1700
|
+
organization_membership_id: om_01HXYZ123456789ABCDEFGHIJ
|
|
1737
1701
|
role:
|
|
1738
1702
|
slug: editor
|
|
1739
1703
|
resource:
|
|
@@ -1782,6 +1746,7 @@ paths:
|
|
|
1782
1746
|
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
1783
1747
|
required:
|
|
1784
1748
|
- message
|
|
1749
|
+
summary: Assign a role
|
|
1785
1750
|
tags:
|
|
1786
1751
|
- authorization
|
|
1787
1752
|
x-mutually-exclusive-body-groups: &ref_4
|
|
@@ -1794,9 +1759,8 @@ paths:
|
|
|
1794
1759
|
- resource_external_id
|
|
1795
1760
|
- resource_type_slug
|
|
1796
1761
|
delete:
|
|
1797
|
-
operationId: AuthorizationRoleAssignmentsController_removeRoleByCriteria
|
|
1798
|
-
summary: Remove a role assignment
|
|
1799
1762
|
description: Remove a role assignment by role slug and resource.
|
|
1763
|
+
operationId: AuthorizationRoleAssignmentsController_removeRoleByCriteria
|
|
1800
1764
|
parameters:
|
|
1801
1765
|
- name: organization_membership_id
|
|
1802
1766
|
required: true
|
|
@@ -1853,6 +1817,7 @@ paths:
|
|
|
1853
1817
|
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
1854
1818
|
required:
|
|
1855
1819
|
- message
|
|
1820
|
+
summary: Remove a role assignment
|
|
1856
1821
|
tags:
|
|
1857
1822
|
- authorization
|
|
1858
1823
|
x-mutually-exclusive-body-groups: &ref_5
|
|
@@ -1866,9 +1831,8 @@ paths:
|
|
|
1866
1831
|
- resource_type_slug
|
|
1867
1832
|
/authorization/organization_memberships/{organization_membership_id}/role_assignments/{role_assignment_id}:
|
|
1868
1833
|
delete:
|
|
1869
|
-
operationId: AuthorizationRoleAssignmentsController_removeRoleById
|
|
1870
|
-
summary: Remove a role assignment by ID
|
|
1871
1834
|
description: Remove a role assignment using its ID.
|
|
1835
|
+
operationId: AuthorizationRoleAssignmentsController_removeRoleById
|
|
1872
1836
|
parameters:
|
|
1873
1837
|
- name: organization_membership_id
|
|
1874
1838
|
required: true
|
|
@@ -1913,13 +1877,13 @@ paths:
|
|
|
1913
1877
|
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
1914
1878
|
required:
|
|
1915
1879
|
- message
|
|
1880
|
+
summary: Remove a role assignment by ID
|
|
1916
1881
|
tags:
|
|
1917
1882
|
- authorization
|
|
1918
1883
|
/authorization/organizations/{organizationId}/roles:
|
|
1919
1884
|
post:
|
|
1920
|
-
operationId: AuthorizationOrganizationRolesController_create
|
|
1921
|
-
summary: Create a custom role
|
|
1922
1885
|
description: Create a new custom role for this organization.
|
|
1886
|
+
operationId: AuthorizationOrganizationRolesController_create
|
|
1923
1887
|
parameters:
|
|
1924
1888
|
- name: organizationId
|
|
1925
1889
|
required: true
|
|
@@ -2085,14 +2049,14 @@ paths:
|
|
|
2085
2049
|
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
2086
2050
|
required:
|
|
2087
2051
|
- message
|
|
2052
|
+
summary: Create a custom role
|
|
2088
2053
|
tags:
|
|
2089
2054
|
- authorization
|
|
2090
2055
|
get:
|
|
2091
|
-
operationId: AuthorizationOrganizationRolesController_list
|
|
2092
|
-
summary: List custom roles
|
|
2093
2056
|
description: >-
|
|
2094
2057
|
Get a list of all roles that apply to an organization. This includes
|
|
2095
2058
|
both environment roles and custom roles, returned in priority order.
|
|
2059
|
+
operationId: AuthorizationOrganizationRolesController_list
|
|
2096
2060
|
parameters:
|
|
2097
2061
|
- name: organizationId
|
|
2098
2062
|
required: true
|
|
@@ -2134,15 +2098,15 @@ paths:
|
|
|
2134
2098
|
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
2135
2099
|
required:
|
|
2136
2100
|
- message
|
|
2101
|
+
summary: List custom roles
|
|
2137
2102
|
tags:
|
|
2138
2103
|
- authorization
|
|
2139
2104
|
/authorization/organizations/{organizationId}/roles/{slug}:
|
|
2140
2105
|
get:
|
|
2141
|
-
operationId: AuthorizationOrganizationRolesController_get
|
|
2142
|
-
summary: Get a custom role
|
|
2143
2106
|
description: >-
|
|
2144
2107
|
Retrieve a role that applies to an organization by its slug. This can
|
|
2145
2108
|
return either an environment role or a custom role.
|
|
2109
|
+
operationId: AuthorizationOrganizationRolesController_get
|
|
2146
2110
|
parameters:
|
|
2147
2111
|
- name: organizationId
|
|
2148
2112
|
required: true
|
|
@@ -2258,14 +2222,14 @@ paths:
|
|
|
2258
2222
|
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
2259
2223
|
required:
|
|
2260
2224
|
- message
|
|
2225
|
+
summary: Get a custom role
|
|
2261
2226
|
tags:
|
|
2262
2227
|
- authorization
|
|
2263
2228
|
patch:
|
|
2264
|
-
operationId: AuthorizationOrganizationRolesController_update
|
|
2265
|
-
summary: Update a custom role
|
|
2266
2229
|
description: >-
|
|
2267
2230
|
Update an existing custom role. Only the fields provided in the request
|
|
2268
2231
|
body will be updated.
|
|
2232
|
+
operationId: AuthorizationOrganizationRolesController_update
|
|
2269
2233
|
parameters:
|
|
2270
2234
|
- name: organizationId
|
|
2271
2235
|
required: true
|
|
@@ -2419,12 +2383,12 @@ paths:
|
|
|
2419
2383
|
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
2420
2384
|
required:
|
|
2421
2385
|
- message
|
|
2386
|
+
summary: Update a custom role
|
|
2422
2387
|
tags:
|
|
2423
2388
|
- authorization
|
|
2424
2389
|
delete:
|
|
2425
|
-
operationId: AuthorizationOrganizationRolesController_delete
|
|
2426
|
-
summary: Delete a custom role
|
|
2427
2390
|
description: Delete an existing custom role.
|
|
2391
|
+
operationId: AuthorizationOrganizationRolesController_delete
|
|
2428
2392
|
parameters:
|
|
2429
2393
|
- name: organizationId
|
|
2430
2394
|
required: true
|
|
@@ -2522,13 +2486,13 @@ paths:
|
|
|
2522
2486
|
required:
|
|
2523
2487
|
- code
|
|
2524
2488
|
- message
|
|
2489
|
+
summary: Delete a custom role
|
|
2525
2490
|
tags:
|
|
2526
2491
|
- authorization
|
|
2527
2492
|
/authorization/organizations/{organizationId}/roles/{slug}/permissions:
|
|
2528
2493
|
put:
|
|
2529
|
-
operationId: AuthorizationOrganizationRolePermissionsController_setPermissions
|
|
2530
|
-
summary: Set permissions for a custom role
|
|
2531
2494
|
description: Replace all permissions on a custom role with the provided list.
|
|
2495
|
+
operationId: AuthorizationOrganizationRolePermissionsController_setPermissions
|
|
2532
2496
|
parameters:
|
|
2533
2497
|
- name: organizationId
|
|
2534
2498
|
required: true
|
|
@@ -2665,14 +2629,14 @@ paths:
|
|
|
2665
2629
|
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
2666
2630
|
required:
|
|
2667
2631
|
- message
|
|
2632
|
+
summary: Set permissions for a custom role
|
|
2668
2633
|
tags:
|
|
2669
2634
|
- authorization
|
|
2670
2635
|
post:
|
|
2671
|
-
operationId: AuthorizationOrganizationRolePermissionsController_addPermission
|
|
2672
|
-
summary: Add a permission to a custom role
|
|
2673
2636
|
description: >-
|
|
2674
2637
|
Add a single permission to a custom role. If the permission is already
|
|
2675
2638
|
assigned to the role, this operation has no effect.
|
|
2639
|
+
operationId: AuthorizationOrganizationRolePermissionsController_addPermission
|
|
2676
2640
|
parameters:
|
|
2677
2641
|
- name: organizationId
|
|
2678
2642
|
required: true
|
|
@@ -2825,13 +2789,13 @@ paths:
|
|
|
2825
2789
|
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
2826
2790
|
required:
|
|
2827
2791
|
- message
|
|
2792
|
+
summary: Add a permission to a custom role
|
|
2828
2793
|
tags:
|
|
2829
2794
|
- authorization
|
|
2830
2795
|
/authorization/organizations/{organizationId}/roles/{slug}/permissions/{permissionSlug}:
|
|
2831
2796
|
delete:
|
|
2832
|
-
operationId: AuthorizationOrganizationRolePermissionsController_removePermission
|
|
2833
|
-
summary: Remove a permission from a custom role
|
|
2834
2797
|
description: Remove a single permission from a custom role by its slug.
|
|
2798
|
+
operationId: AuthorizationOrganizationRolePermissionsController_removePermission
|
|
2835
2799
|
parameters:
|
|
2836
2800
|
- name: organizationId
|
|
2837
2801
|
required: true
|
|
@@ -2887,17 +2851,17 @@ paths:
|
|
|
2887
2851
|
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
2888
2852
|
required:
|
|
2889
2853
|
- message
|
|
2854
|
+
summary: Remove a permission from a custom role
|
|
2890
2855
|
tags:
|
|
2891
2856
|
- authorization
|
|
2892
2857
|
/authorization/organizations/{organization_id}/resources/{resource_type_slug}/{external_id}:
|
|
2893
2858
|
get:
|
|
2894
|
-
operationId: AuthorizationResourcesByExternalIdController_getByExternalId
|
|
2895
|
-
summary: Get a resource by external ID
|
|
2896
2859
|
description: >-
|
|
2897
2860
|
Retrieve the details of an authorization resource by its external ID,
|
|
2898
2861
|
organization, and resource type. This is useful when you only have the
|
|
2899
2862
|
external ID from your system and need to fetch the full resource
|
|
2900
2863
|
details.
|
|
2864
|
+
operationId: AuthorizationResourcesByExternalIdController_getByExternalId
|
|
2901
2865
|
parameters:
|
|
2902
2866
|
- name: organization_id
|
|
2903
2867
|
required: true
|
|
@@ -2953,12 +2917,12 @@ paths:
|
|
|
2953
2917
|
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
2954
2918
|
required:
|
|
2955
2919
|
- message
|
|
2920
|
+
summary: Get a resource by external ID
|
|
2956
2921
|
tags:
|
|
2957
2922
|
- authorization
|
|
2958
2923
|
patch:
|
|
2959
|
-
operationId: AuthorizationResourcesByExternalIdController_updateByExternalId
|
|
2960
|
-
summary: Update a resource by external ID
|
|
2961
2924
|
description: Update an existing authorization resource using its external ID.
|
|
2925
|
+
operationId: AuthorizationResourcesByExternalIdController_updateByExternalId
|
|
2962
2926
|
parameters:
|
|
2963
2927
|
- name: organization_id
|
|
2964
2928
|
required: true
|
|
@@ -3132,6 +3096,7 @@ paths:
|
|
|
3132
3096
|
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
3133
3097
|
required:
|
|
3134
3098
|
- message
|
|
3099
|
+
summary: Update a resource by external ID
|
|
3135
3100
|
tags:
|
|
3136
3101
|
- authorization
|
|
3137
3102
|
x-mutually-exclusive-body-groups: &ref_0
|
|
@@ -3144,11 +3109,10 @@ paths:
|
|
|
3144
3109
|
- parent_resource_external_id
|
|
3145
3110
|
- parent_resource_type_slug
|
|
3146
3111
|
delete:
|
|
3147
|
-
operationId: AuthorizationResourcesByExternalIdController_deleteByExternalId
|
|
3148
|
-
summary: Delete an authorization resource by external ID
|
|
3149
3112
|
description: >-
|
|
3150
3113
|
Delete an authorization resource by organization, resource type, and
|
|
3151
3114
|
external ID. This also deletes all descendant resources.
|
|
3115
|
+
operationId: AuthorizationResourcesByExternalIdController_deleteByExternalId
|
|
3152
3116
|
parameters:
|
|
3153
3117
|
- name: organization_id
|
|
3154
3118
|
required: true
|
|
@@ -3264,18 +3228,18 @@ paths:
|
|
|
3264
3228
|
required:
|
|
3265
3229
|
- code
|
|
3266
3230
|
- message
|
|
3231
|
+
summary: Delete an authorization resource by external ID
|
|
3267
3232
|
tags:
|
|
3268
3233
|
- authorization
|
|
3269
3234
|
/authorization/organizations/{organization_id}/resources/{resource_type_slug}/{external_id}/organization_memberships:
|
|
3270
3235
|
get:
|
|
3271
|
-
operationId: >-
|
|
3272
|
-
AuthorizationResourcesByExternalIdController_listOrganizationMembershipsForResourceByExternalId
|
|
3273
|
-
summary: List memberships for a resource by external ID
|
|
3274
3236
|
description: >-
|
|
3275
3237
|
Returns all organization memberships that have a specific permission on
|
|
3276
3238
|
a resource, using the resource's external ID. This is useful for
|
|
3277
3239
|
answering "Who can access this resource?" when you only have the
|
|
3278
3240
|
external ID.
|
|
3241
|
+
operationId: >-
|
|
3242
|
+
AuthorizationResourcesByExternalIdController_listOrganizationMembershipsForResourceByExternalId
|
|
3279
3243
|
parameters:
|
|
3280
3244
|
- name: organization_id
|
|
3281
3245
|
required: true
|
|
@@ -3343,13 +3307,7 @@ paths:
|
|
|
3343
3307
|
reversed cursor semantics where `before` fetches older records and
|
|
3344
3308
|
`after` fetches newer records). Defaults to descending.
|
|
3345
3309
|
schema:
|
|
3346
|
-
|
|
3347
|
-
example: desc
|
|
3348
|
-
enum:
|
|
3349
|
-
- normal
|
|
3350
|
-
- desc
|
|
3351
|
-
- asc
|
|
3352
|
-
type: string
|
|
3310
|
+
$ref: '#/components/schemas/PaginationOrder'
|
|
3353
3311
|
- name: permission_slug
|
|
3354
3312
|
required: true
|
|
3355
3313
|
in: query
|
|
@@ -3437,13 +3395,125 @@ paths:
|
|
|
3437
3395
|
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
3438
3396
|
required:
|
|
3439
3397
|
- message
|
|
3398
|
+
summary: List memberships for a resource by external ID
|
|
3399
|
+
tags:
|
|
3400
|
+
- authorization
|
|
3401
|
+
/authorization/organizations/{organization_id}/resources/{resource_type_slug}/{external_id}/role_assignments:
|
|
3402
|
+
get:
|
|
3403
|
+
description: >-
|
|
3404
|
+
List all role assignments granted on a resource, identified by its
|
|
3405
|
+
external ID. Each assignment includes the organization membership it was
|
|
3406
|
+
granted to.
|
|
3407
|
+
operationId: >-
|
|
3408
|
+
AuthorizationRoleAssignmentsController_listRoleAssignmentsForResourceByExternalId
|
|
3409
|
+
parameters:
|
|
3410
|
+
- name: organization_id
|
|
3411
|
+
required: true
|
|
3412
|
+
in: path
|
|
3413
|
+
description: The ID of the organization that owns the resource.
|
|
3414
|
+
schema:
|
|
3415
|
+
type: string
|
|
3416
|
+
example: org_01EHZNVPK3SFK441A1RGBFSHRT
|
|
3417
|
+
- name: resource_type_slug
|
|
3418
|
+
required: true
|
|
3419
|
+
in: path
|
|
3420
|
+
description: The slug of the resource type.
|
|
3421
|
+
schema:
|
|
3422
|
+
type: string
|
|
3423
|
+
example: project
|
|
3424
|
+
- name: external_id
|
|
3425
|
+
required: true
|
|
3426
|
+
in: path
|
|
3427
|
+
description: An identifier you provide to reference the resource in your system.
|
|
3428
|
+
schema:
|
|
3429
|
+
type: string
|
|
3430
|
+
example: proj-456
|
|
3431
|
+
- name: before
|
|
3432
|
+
required: false
|
|
3433
|
+
in: query
|
|
3434
|
+
description: >-
|
|
3435
|
+
An object ID that defines your place in the list. When the ID is not
|
|
3436
|
+
present, you are at the end of the list. For example, if you make a
|
|
3437
|
+
list request and receive 100 objects, ending with `"obj_123"`, your
|
|
3438
|
+
subsequent call can include `before="obj_123"` to fetch a new batch
|
|
3439
|
+
of objects before `"obj_123"`.
|
|
3440
|
+
schema:
|
|
3441
|
+
example: xxx_01HXYZ123456789ABCDEFGHIJ
|
|
3442
|
+
type: string
|
|
3443
|
+
- name: after
|
|
3444
|
+
required: false
|
|
3445
|
+
in: query
|
|
3446
|
+
description: >-
|
|
3447
|
+
An object ID that defines your place in the list. When the ID is not
|
|
3448
|
+
present, you are at the end of the list. For example, if you make a
|
|
3449
|
+
list request and receive 100 objects, ending with `"obj_123"`, your
|
|
3450
|
+
subsequent call can include `after="obj_123"` to fetch a new batch
|
|
3451
|
+
of objects after `"obj_123"`.
|
|
3452
|
+
schema:
|
|
3453
|
+
example: xxx_01HXYZ987654321KJIHGFEDCBA
|
|
3454
|
+
type: string
|
|
3455
|
+
- name: limit
|
|
3456
|
+
required: false
|
|
3457
|
+
in: query
|
|
3458
|
+
description: >-
|
|
3459
|
+
Upper limit on the number of objects to return, between `1` and
|
|
3460
|
+
`100`.
|
|
3461
|
+
schema:
|
|
3462
|
+
minimum: 1
|
|
3463
|
+
maximum: 100
|
|
3464
|
+
default: 10
|
|
3465
|
+
example: 10
|
|
3466
|
+
type: integer
|
|
3467
|
+
- name: order
|
|
3468
|
+
required: false
|
|
3469
|
+
in: query
|
|
3470
|
+
description: >-
|
|
3471
|
+
Order the results by the creation time. Supported values are `"asc"`
|
|
3472
|
+
(ascending), `"desc"` (descending), and `"normal"` (descending with
|
|
3473
|
+
reversed cursor semantics where `before` fetches older records and
|
|
3474
|
+
`after` fetches newer records). Defaults to descending.
|
|
3475
|
+
schema:
|
|
3476
|
+
$ref: '#/components/schemas/PaginationOrder'
|
|
3477
|
+
responses:
|
|
3478
|
+
'200':
|
|
3479
|
+
description: OK
|
|
3480
|
+
content:
|
|
3481
|
+
application/json:
|
|
3482
|
+
schema:
|
|
3483
|
+
$ref: '#/components/schemas/UserRoleAssignmentList'
|
|
3484
|
+
'403':
|
|
3485
|
+
description: Forbidden
|
|
3486
|
+
content:
|
|
3487
|
+
application/json:
|
|
3488
|
+
schema:
|
|
3489
|
+
type: object
|
|
3490
|
+
properties:
|
|
3491
|
+
message:
|
|
3492
|
+
type: string
|
|
3493
|
+
description: A human-readable description of the error.
|
|
3494
|
+
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
3495
|
+
required:
|
|
3496
|
+
- message
|
|
3497
|
+
'404':
|
|
3498
|
+
description: Not Found
|
|
3499
|
+
content:
|
|
3500
|
+
application/json:
|
|
3501
|
+
schema:
|
|
3502
|
+
type: object
|
|
3503
|
+
properties:
|
|
3504
|
+
message:
|
|
3505
|
+
type: string
|
|
3506
|
+
description: A human-readable description of the error.
|
|
3507
|
+
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
3508
|
+
required:
|
|
3509
|
+
- message
|
|
3510
|
+
summary: List role assignments for a resource by external ID
|
|
3440
3511
|
tags:
|
|
3441
3512
|
- authorization
|
|
3442
3513
|
/authorization/permissions:
|
|
3443
3514
|
get:
|
|
3444
|
-
operationId: AuthorizationPermissionsController_list
|
|
3445
|
-
summary: List permissions
|
|
3446
3515
|
description: Get a list of all permissions in your WorkOS environment.
|
|
3516
|
+
operationId: AuthorizationPermissionsController_list
|
|
3447
3517
|
parameters:
|
|
3448
3518
|
- name: before
|
|
3449
3519
|
required: false
|
|
@@ -3490,13 +3560,7 @@ paths:
|
|
|
3490
3560
|
reversed cursor semantics where `before` fetches older records and
|
|
3491
3561
|
`after` fetches newer records). Defaults to descending.
|
|
3492
3562
|
schema:
|
|
3493
|
-
|
|
3494
|
-
example: desc
|
|
3495
|
-
enum:
|
|
3496
|
-
- normal
|
|
3497
|
-
- desc
|
|
3498
|
-
- asc
|
|
3499
|
-
type: string
|
|
3563
|
+
$ref: '#/components/schemas/PaginationOrder'
|
|
3500
3564
|
responses:
|
|
3501
3565
|
'200':
|
|
3502
3566
|
description: OK
|
|
@@ -3517,14 +3581,14 @@ paths:
|
|
|
3517
3581
|
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
3518
3582
|
required:
|
|
3519
3583
|
- message
|
|
3584
|
+
summary: List permissions
|
|
3520
3585
|
tags:
|
|
3521
3586
|
- permissions
|
|
3522
3587
|
post:
|
|
3523
|
-
operationId: AuthorizationPermissionsController_create
|
|
3524
|
-
summary: Create a permission
|
|
3525
3588
|
description: >-
|
|
3526
3589
|
Create a new permission in your WorkOS environment. The permission can
|
|
3527
3590
|
then be assigned to environment roles and custom roles.
|
|
3591
|
+
operationId: AuthorizationPermissionsController_create
|
|
3528
3592
|
parameters: []
|
|
3529
3593
|
requestBody:
|
|
3530
3594
|
required: true
|
|
@@ -3662,13 +3726,13 @@ paths:
|
|
|
3662
3726
|
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
3663
3727
|
required:
|
|
3664
3728
|
- message
|
|
3729
|
+
summary: Create a permission
|
|
3665
3730
|
tags:
|
|
3666
3731
|
- permissions
|
|
3667
3732
|
/authorization/permissions/{slug}:
|
|
3668
3733
|
get:
|
|
3669
|
-
operationId: AuthorizationPermissionsController_find
|
|
3670
|
-
summary: Get a permission
|
|
3671
3734
|
description: Retrieve a permission by its unique slug.
|
|
3735
|
+
operationId: AuthorizationPermissionsController_find
|
|
3672
3736
|
parameters:
|
|
3673
3737
|
- name: slug
|
|
3674
3738
|
required: true
|
|
@@ -3700,14 +3764,14 @@ paths:
|
|
|
3700
3764
|
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
3701
3765
|
required:
|
|
3702
3766
|
- message
|
|
3767
|
+
summary: Get a permission
|
|
3703
3768
|
tags:
|
|
3704
3769
|
- permissions
|
|
3705
3770
|
patch:
|
|
3706
|
-
operationId: AuthorizationPermissionsController_update
|
|
3707
|
-
summary: Update a permission
|
|
3708
3771
|
description: >-
|
|
3709
3772
|
Update an existing permission. Only the fields provided in the request
|
|
3710
3773
|
body will be updated.
|
|
3774
|
+
operationId: AuthorizationPermissionsController_update
|
|
3711
3775
|
parameters:
|
|
3712
3776
|
- name: slug
|
|
3713
3777
|
required: true
|
|
@@ -3771,12 +3835,12 @@ paths:
|
|
|
3771
3835
|
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
3772
3836
|
required:
|
|
3773
3837
|
- message
|
|
3838
|
+
summary: Update a permission
|
|
3774
3839
|
tags:
|
|
3775
3840
|
- permissions
|
|
3776
3841
|
delete:
|
|
3777
|
-
operationId: AuthorizationPermissionsController_delete
|
|
3778
|
-
summary: Delete a permission
|
|
3779
3842
|
description: Delete an existing permission. System permissions cannot be deleted.
|
|
3843
|
+
operationId: AuthorizationPermissionsController_delete
|
|
3780
3844
|
parameters:
|
|
3781
3845
|
- name: slug
|
|
3782
3846
|
required: true
|
|
@@ -3817,13 +3881,13 @@ paths:
|
|
|
3817
3881
|
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
3818
3882
|
required:
|
|
3819
3883
|
- message
|
|
3884
|
+
summary: Delete a permission
|
|
3820
3885
|
tags:
|
|
3821
3886
|
- permissions
|
|
3822
3887
|
/authorization/resources:
|
|
3823
3888
|
get:
|
|
3824
|
-
operationId: AuthorizationResourcesController_list
|
|
3825
|
-
summary: List resources
|
|
3826
3889
|
description: Get a paginated list of authorization resources.
|
|
3890
|
+
operationId: AuthorizationResourcesController_list
|
|
3827
3891
|
parameters:
|
|
3828
3892
|
- name: before
|
|
3829
3893
|
required: false
|
|
@@ -3870,13 +3934,7 @@ paths:
|
|
|
3870
3934
|
reversed cursor semantics where `before` fetches older records and
|
|
3871
3935
|
`after` fetches newer records). Defaults to descending.
|
|
3872
3936
|
schema:
|
|
3873
|
-
|
|
3874
|
-
example: desc
|
|
3875
|
-
enum:
|
|
3876
|
-
- normal
|
|
3877
|
-
- desc
|
|
3878
|
-
- asc
|
|
3879
|
-
type: string
|
|
3937
|
+
$ref: '#/components/schemas/PaginationOrder'
|
|
3880
3938
|
- name: organization_id
|
|
3881
3939
|
required: false
|
|
3882
3940
|
in: query
|
|
@@ -3966,6 +4024,7 @@ paths:
|
|
|
3966
4024
|
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
3967
4025
|
required:
|
|
3968
4026
|
- message
|
|
4027
|
+
summary: List resources
|
|
3969
4028
|
tags:
|
|
3970
4029
|
- authorization
|
|
3971
4030
|
x-mutually-exclusive-parameter-groups:
|
|
@@ -3978,9 +4037,8 @@ paths:
|
|
|
3978
4037
|
- parent_resource_type_slug
|
|
3979
4038
|
- parent_external_id
|
|
3980
4039
|
post:
|
|
3981
|
-
operationId: AuthorizationResourcesController_create
|
|
3982
|
-
summary: Create an authorization resource
|
|
3983
4040
|
description: Create a new authorization resource.
|
|
4041
|
+
operationId: AuthorizationResourcesController_create
|
|
3984
4042
|
parameters: []
|
|
3985
4043
|
requestBody:
|
|
3986
4044
|
required: true
|
|
@@ -4163,6 +4221,7 @@ paths:
|
|
|
4163
4221
|
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
4164
4222
|
required:
|
|
4165
4223
|
- message
|
|
4224
|
+
summary: Create an authorization resource
|
|
4166
4225
|
tags:
|
|
4167
4226
|
- authorization
|
|
4168
4227
|
x-mutually-exclusive-body-groups: &ref_6
|
|
@@ -4176,9 +4235,8 @@ paths:
|
|
|
4176
4235
|
- parent_resource_type_slug
|
|
4177
4236
|
/authorization/resources/{resource_id}:
|
|
4178
4237
|
get:
|
|
4179
|
-
operationId: AuthorizationResourcesController_findById
|
|
4180
|
-
summary: Get a resource
|
|
4181
4238
|
description: Retrieve the details of an authorization resource by its ID.
|
|
4239
|
+
operationId: AuthorizationResourcesController_findById
|
|
4182
4240
|
parameters:
|
|
4183
4241
|
- name: resource_id
|
|
4184
4242
|
required: true
|
|
@@ -4233,12 +4291,12 @@ paths:
|
|
|
4233
4291
|
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
4234
4292
|
required:
|
|
4235
4293
|
- message
|
|
4294
|
+
summary: Get a resource
|
|
4236
4295
|
tags:
|
|
4237
4296
|
- authorization
|
|
4238
4297
|
patch:
|
|
4239
|
-
operationId: AuthorizationResourcesController_update
|
|
4240
|
-
summary: Update a resource
|
|
4241
4298
|
description: Update an existing authorization resource.
|
|
4299
|
+
operationId: AuthorizationResourcesController_update
|
|
4242
4300
|
parameters:
|
|
4243
4301
|
- name: resource_id
|
|
4244
4302
|
required: true
|
|
@@ -4398,13 +4456,13 @@ paths:
|
|
|
4398
4456
|
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
4399
4457
|
required:
|
|
4400
4458
|
- message
|
|
4459
|
+
summary: Update a resource
|
|
4401
4460
|
tags:
|
|
4402
4461
|
- authorization
|
|
4403
4462
|
x-mutually-exclusive-body-groups: *ref_0
|
|
4404
4463
|
delete:
|
|
4405
|
-
operationId: AuthorizationResourcesController_delete
|
|
4406
|
-
summary: Delete an authorization resource
|
|
4407
4464
|
description: Delete an authorization resource and all its descendants.
|
|
4465
|
+
operationId: AuthorizationResourcesController_delete
|
|
4408
4466
|
parameters:
|
|
4409
4467
|
- name: resource_id
|
|
4410
4468
|
required: true
|
|
@@ -4506,16 +4564,16 @@ paths:
|
|
|
4506
4564
|
required:
|
|
4507
4565
|
- code
|
|
4508
4566
|
- message
|
|
4567
|
+
summary: Delete an authorization resource
|
|
4509
4568
|
tags:
|
|
4510
4569
|
- authorization
|
|
4511
4570
|
/authorization/resources/{resource_id}/organization_memberships:
|
|
4512
4571
|
get:
|
|
4513
|
-
operationId: AuthorizationResourcesController_listOrganizationMembershipsForResource
|
|
4514
|
-
summary: List organization memberships for resource
|
|
4515
4572
|
description: >-
|
|
4516
4573
|
Returns all organization memberships that have a specific permission on
|
|
4517
4574
|
a resource instance. This is useful for answering "Who can access this
|
|
4518
4575
|
resource?".
|
|
4576
|
+
operationId: AuthorizationResourcesController_listOrganizationMembershipsForResource
|
|
4519
4577
|
parameters:
|
|
4520
4578
|
- name: resource_id
|
|
4521
4579
|
required: true
|
|
@@ -4569,13 +4627,7 @@ paths:
|
|
|
4569
4627
|
reversed cursor semantics where `before` fetches older records and
|
|
4570
4628
|
`after` fetches newer records). Defaults to descending.
|
|
4571
4629
|
schema:
|
|
4572
|
-
|
|
4573
|
-
example: desc
|
|
4574
|
-
enum:
|
|
4575
|
-
- normal
|
|
4576
|
-
- desc
|
|
4577
|
-
- asc
|
|
4578
|
-
type: string
|
|
4630
|
+
$ref: '#/components/schemas/PaginationOrder'
|
|
4579
4631
|
- name: permission_slug
|
|
4580
4632
|
required: true
|
|
4581
4633
|
in: query
|
|
@@ -4663,13 +4715,109 @@ paths:
|
|
|
4663
4715
|
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
4664
4716
|
required:
|
|
4665
4717
|
- message
|
|
4718
|
+
summary: List organization memberships for resource
|
|
4719
|
+
tags:
|
|
4720
|
+
- authorization
|
|
4721
|
+
/authorization/resources/{resource_id}/role_assignments:
|
|
4722
|
+
get:
|
|
4723
|
+
description: >-
|
|
4724
|
+
List all role assignments granted on a specific resource instance. Each
|
|
4725
|
+
assignment includes the organization membership it was granted to.
|
|
4726
|
+
operationId: AuthorizationRoleAssignmentsController_listRoleAssignmentsForResource
|
|
4727
|
+
parameters:
|
|
4728
|
+
- name: resource_id
|
|
4729
|
+
required: true
|
|
4730
|
+
in: path
|
|
4731
|
+
description: The ID of the authorization resource.
|
|
4732
|
+
schema:
|
|
4733
|
+
type: string
|
|
4734
|
+
example: authz_resource_01HXYZ123456789ABCDEFGHIJ
|
|
4735
|
+
- name: before
|
|
4736
|
+
required: false
|
|
4737
|
+
in: query
|
|
4738
|
+
description: >-
|
|
4739
|
+
An object ID that defines your place in the list. When the ID is not
|
|
4740
|
+
present, you are at the end of the list. For example, if you make a
|
|
4741
|
+
list request and receive 100 objects, ending with `"obj_123"`, your
|
|
4742
|
+
subsequent call can include `before="obj_123"` to fetch a new batch
|
|
4743
|
+
of objects before `"obj_123"`.
|
|
4744
|
+
schema:
|
|
4745
|
+
example: xxx_01HXYZ123456789ABCDEFGHIJ
|
|
4746
|
+
type: string
|
|
4747
|
+
- name: after
|
|
4748
|
+
required: false
|
|
4749
|
+
in: query
|
|
4750
|
+
description: >-
|
|
4751
|
+
An object ID that defines your place in the list. When the ID is not
|
|
4752
|
+
present, you are at the end of the list. For example, if you make a
|
|
4753
|
+
list request and receive 100 objects, ending with `"obj_123"`, your
|
|
4754
|
+
subsequent call can include `after="obj_123"` to fetch a new batch
|
|
4755
|
+
of objects after `"obj_123"`.
|
|
4756
|
+
schema:
|
|
4757
|
+
example: xxx_01HXYZ987654321KJIHGFEDCBA
|
|
4758
|
+
type: string
|
|
4759
|
+
- name: limit
|
|
4760
|
+
required: false
|
|
4761
|
+
in: query
|
|
4762
|
+
description: >-
|
|
4763
|
+
Upper limit on the number of objects to return, between `1` and
|
|
4764
|
+
`100`.
|
|
4765
|
+
schema:
|
|
4766
|
+
minimum: 1
|
|
4767
|
+
maximum: 100
|
|
4768
|
+
default: 10
|
|
4769
|
+
example: 10
|
|
4770
|
+
type: integer
|
|
4771
|
+
- name: order
|
|
4772
|
+
required: false
|
|
4773
|
+
in: query
|
|
4774
|
+
description: >-
|
|
4775
|
+
Order the results by the creation time. Supported values are `"asc"`
|
|
4776
|
+
(ascending), `"desc"` (descending), and `"normal"` (descending with
|
|
4777
|
+
reversed cursor semantics where `before` fetches older records and
|
|
4778
|
+
`after` fetches newer records). Defaults to descending.
|
|
4779
|
+
schema:
|
|
4780
|
+
$ref: '#/components/schemas/PaginationOrder'
|
|
4781
|
+
responses:
|
|
4782
|
+
'200':
|
|
4783
|
+
description: OK
|
|
4784
|
+
content:
|
|
4785
|
+
application/json:
|
|
4786
|
+
schema:
|
|
4787
|
+
$ref: '#/components/schemas/UserRoleAssignmentList'
|
|
4788
|
+
'403':
|
|
4789
|
+
description: Forbidden
|
|
4790
|
+
content:
|
|
4791
|
+
application/json:
|
|
4792
|
+
schema:
|
|
4793
|
+
type: object
|
|
4794
|
+
properties:
|
|
4795
|
+
message:
|
|
4796
|
+
type: string
|
|
4797
|
+
description: A human-readable description of the error.
|
|
4798
|
+
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
4799
|
+
required:
|
|
4800
|
+
- message
|
|
4801
|
+
'404':
|
|
4802
|
+
description: Not Found
|
|
4803
|
+
content:
|
|
4804
|
+
application/json:
|
|
4805
|
+
schema:
|
|
4806
|
+
type: object
|
|
4807
|
+
properties:
|
|
4808
|
+
message:
|
|
4809
|
+
type: string
|
|
4810
|
+
description: A human-readable description of the error.
|
|
4811
|
+
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
4812
|
+
required:
|
|
4813
|
+
- message
|
|
4814
|
+
summary: List role assignments for a resource
|
|
4666
4815
|
tags:
|
|
4667
4816
|
- authorization
|
|
4668
4817
|
/authorization/roles:
|
|
4669
4818
|
post:
|
|
4670
|
-
operationId: AuthorizationRolesController_create
|
|
4671
|
-
summary: Create an environment role
|
|
4672
4819
|
description: Create a new environment role.
|
|
4820
|
+
operationId: AuthorizationRolesController_create
|
|
4673
4821
|
parameters: []
|
|
4674
4822
|
requestBody:
|
|
4675
4823
|
required: true
|
|
@@ -4828,12 +4976,12 @@ paths:
|
|
|
4828
4976
|
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
4829
4977
|
required:
|
|
4830
4978
|
- message
|
|
4979
|
+
summary: Create an environment role
|
|
4831
4980
|
tags:
|
|
4832
4981
|
- authorization
|
|
4833
4982
|
get:
|
|
4834
|
-
operationId: AuthorizationRolesController_list
|
|
4835
|
-
summary: List environment roles
|
|
4836
4983
|
description: List all environment roles in priority order.
|
|
4984
|
+
operationId: AuthorizationRolesController_list
|
|
4837
4985
|
parameters: []
|
|
4838
4986
|
responses:
|
|
4839
4987
|
'200':
|
|
@@ -4855,13 +5003,13 @@ paths:
|
|
|
4855
5003
|
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
4856
5004
|
required:
|
|
4857
5005
|
- message
|
|
5006
|
+
summary: List environment roles
|
|
4858
5007
|
tags:
|
|
4859
5008
|
- authorization
|
|
4860
5009
|
/authorization/roles/{slug}:
|
|
4861
5010
|
get:
|
|
4862
|
-
operationId: AuthorizationRolesController_get
|
|
4863
|
-
summary: Get an environment role
|
|
4864
5011
|
description: Get an environment role by its slug.
|
|
5012
|
+
operationId: AuthorizationRolesController_get
|
|
4865
5013
|
parameters:
|
|
4866
5014
|
- name: slug
|
|
4867
5015
|
required: true
|
|
@@ -4903,12 +5051,12 @@ paths:
|
|
|
4903
5051
|
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
4904
5052
|
required:
|
|
4905
5053
|
- message
|
|
5054
|
+
summary: Get an environment role
|
|
4906
5055
|
tags:
|
|
4907
5056
|
- authorization
|
|
4908
5057
|
patch:
|
|
4909
|
-
operationId: AuthorizationRolesController_update
|
|
4910
|
-
summary: Update an environment role
|
|
4911
5058
|
description: Update an existing environment role.
|
|
5059
|
+
operationId: AuthorizationRolesController_update
|
|
4912
5060
|
parameters:
|
|
4913
5061
|
- name: slug
|
|
4914
5062
|
required: true
|
|
@@ -5055,13 +5203,13 @@ paths:
|
|
|
5055
5203
|
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
5056
5204
|
required:
|
|
5057
5205
|
- message
|
|
5206
|
+
summary: Update an environment role
|
|
5058
5207
|
tags:
|
|
5059
5208
|
- authorization
|
|
5060
5209
|
/authorization/roles/{slug}/permissions:
|
|
5061
5210
|
put:
|
|
5062
|
-
operationId: AuthorizationRolePermissionsController_setPermissions
|
|
5063
|
-
summary: Set permissions for an environment role
|
|
5064
5211
|
description: Replace all permissions on an environment role with the provided list.
|
|
5212
|
+
operationId: AuthorizationRolePermissionsController_setPermissions
|
|
5065
5213
|
parameters:
|
|
5066
5214
|
- name: slug
|
|
5067
5215
|
required: true
|
|
@@ -5210,14 +5358,14 @@ paths:
|
|
|
5210
5358
|
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
5211
5359
|
required:
|
|
5212
5360
|
- message
|
|
5361
|
+
summary: Set permissions for an environment role
|
|
5213
5362
|
tags:
|
|
5214
5363
|
- authorization
|
|
5215
5364
|
post:
|
|
5216
|
-
operationId: AuthorizationRolePermissionsController_addPermission
|
|
5217
|
-
summary: Add a permission to an environment role
|
|
5218
5365
|
description: >-
|
|
5219
5366
|
Add a single permission to an environment role. If the permission is
|
|
5220
5367
|
already assigned to the role, this operation has no effect.
|
|
5368
|
+
operationId: AuthorizationRolePermissionsController_addPermission
|
|
5221
5369
|
parameters:
|
|
5222
5370
|
- name: slug
|
|
5223
5371
|
required: true
|
|
@@ -5363,15 +5511,15 @@ paths:
|
|
|
5363
5511
|
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
5364
5512
|
required:
|
|
5365
5513
|
- message
|
|
5514
|
+
summary: Add a permission to an environment role
|
|
5366
5515
|
tags:
|
|
5367
5516
|
- authorization
|
|
5368
5517
|
/connect/applications:
|
|
5369
5518
|
get:
|
|
5370
|
-
operationId: ApplicationsController_list
|
|
5371
|
-
summary: List Connect Applications
|
|
5372
5519
|
description: >-
|
|
5373
5520
|
List all Connect Applications in the current environment with optional
|
|
5374
5521
|
filtering.
|
|
5522
|
+
operationId: ApplicationsController_list
|
|
5375
5523
|
parameters:
|
|
5376
5524
|
- name: before
|
|
5377
5525
|
required: false
|
|
@@ -5418,13 +5566,7 @@ paths:
|
|
|
5418
5566
|
reversed cursor semantics where `before` fetches older records and
|
|
5419
5567
|
`after` fetches newer records). Defaults to descending.
|
|
5420
5568
|
schema:
|
|
5421
|
-
|
|
5422
|
-
example: desc
|
|
5423
|
-
enum:
|
|
5424
|
-
- normal
|
|
5425
|
-
- desc
|
|
5426
|
-
- asc
|
|
5427
|
-
type: string
|
|
5569
|
+
$ref: '#/components/schemas/PaginationOrder'
|
|
5428
5570
|
- name: organization_id
|
|
5429
5571
|
required: false
|
|
5430
5572
|
in: query
|
|
@@ -5452,14 +5594,14 @@ paths:
|
|
|
5452
5594
|
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
5453
5595
|
required:
|
|
5454
5596
|
- message
|
|
5597
|
+
summary: List Connect Applications
|
|
5455
5598
|
tags:
|
|
5456
5599
|
- applications
|
|
5457
5600
|
post:
|
|
5458
|
-
operationId: ApplicationsController_create
|
|
5459
|
-
summary: Create a Connect Application
|
|
5460
5601
|
description: >-
|
|
5461
5602
|
Create a new Connect Application. Supports both OAuth and
|
|
5462
5603
|
Machine-to-Machine (M2M) application types.
|
|
5604
|
+
operationId: ApplicationsController_create
|
|
5463
5605
|
parameters: []
|
|
5464
5606
|
requestBody:
|
|
5465
5607
|
required: true
|
|
@@ -5502,13 +5644,13 @@ paths:
|
|
|
5502
5644
|
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
5503
5645
|
required:
|
|
5504
5646
|
- message
|
|
5647
|
+
summary: Create a Connect Application
|
|
5505
5648
|
tags:
|
|
5506
5649
|
- applications
|
|
5507
5650
|
/connect/applications/{id}:
|
|
5508
5651
|
get:
|
|
5509
|
-
operationId: ApplicationsController_find
|
|
5510
|
-
summary: Get a Connect Application
|
|
5511
5652
|
description: Retrieve details for a specific Connect Application by ID or client ID.
|
|
5653
|
+
operationId: ApplicationsController_find
|
|
5512
5654
|
parameters:
|
|
5513
5655
|
- name: id
|
|
5514
5656
|
required: true
|
|
@@ -5537,15 +5679,15 @@ paths:
|
|
|
5537
5679
|
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
5538
5680
|
required:
|
|
5539
5681
|
- message
|
|
5682
|
+
summary: Get a Connect Application
|
|
5540
5683
|
tags:
|
|
5541
5684
|
- applications
|
|
5542
5685
|
put:
|
|
5543
|
-
operationId: ApplicationsController_update
|
|
5544
|
-
summary: Update a Connect Application
|
|
5545
5686
|
description: >-
|
|
5546
5687
|
Update an existing Connect Application. For OAuth applications, you can
|
|
5547
5688
|
update redirect URIs. For all applications, you can update the name,
|
|
5548
5689
|
description, and scopes.
|
|
5690
|
+
operationId: ApplicationsController_update
|
|
5549
5691
|
parameters:
|
|
5550
5692
|
- name: id
|
|
5551
5693
|
required: true
|
|
@@ -5593,12 +5735,12 @@ paths:
|
|
|
5593
5735
|
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
5594
5736
|
required:
|
|
5595
5737
|
- message
|
|
5738
|
+
summary: Update a Connect Application
|
|
5596
5739
|
tags:
|
|
5597
5740
|
- applications
|
|
5598
5741
|
delete:
|
|
5599
|
-
operationId: ApplicationsController_delete
|
|
5600
|
-
summary: Delete a Connect Application
|
|
5601
5742
|
description: Delete an existing Connect Application.
|
|
5743
|
+
operationId: ApplicationsController_delete
|
|
5602
5744
|
parameters:
|
|
5603
5745
|
- name: id
|
|
5604
5746
|
required: true
|
|
@@ -5623,13 +5765,13 @@ paths:
|
|
|
5623
5765
|
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
5624
5766
|
required:
|
|
5625
5767
|
- message
|
|
5768
|
+
summary: Delete a Connect Application
|
|
5626
5769
|
tags:
|
|
5627
5770
|
- applications
|
|
5628
5771
|
/connect/applications/{id}/client_secrets:
|
|
5629
5772
|
get:
|
|
5630
|
-
operationId: ApplicationCredentialsController_list
|
|
5631
|
-
summary: List Client Secrets for a Connect Application
|
|
5632
5773
|
description: List all client secrets associated with a Connect Application.
|
|
5774
|
+
operationId: ApplicationCredentialsController_list
|
|
5633
5775
|
parameters:
|
|
5634
5776
|
- name: id
|
|
5635
5777
|
required: true
|
|
@@ -5700,12 +5842,12 @@ paths:
|
|
|
5700
5842
|
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
5701
5843
|
required:
|
|
5702
5844
|
- message
|
|
5845
|
+
summary: List Client Secrets for a Connect Application
|
|
5703
5846
|
tags:
|
|
5704
5847
|
- application.client-secrets
|
|
5705
5848
|
post:
|
|
5706
|
-
operationId: ApplicationCredentialsController_create
|
|
5707
|
-
summary: Create a new client secret for a Connect Application
|
|
5708
5849
|
description: Create new secrets for a Connect Application.
|
|
5850
|
+
operationId: ApplicationCredentialsController_create
|
|
5709
5851
|
parameters:
|
|
5710
5852
|
- name: id
|
|
5711
5853
|
required: true
|
|
@@ -5753,13 +5895,13 @@ paths:
|
|
|
5753
5895
|
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
5754
5896
|
required:
|
|
5755
5897
|
- message
|
|
5898
|
+
summary: Create a new client secret for a Connect Application
|
|
5756
5899
|
tags:
|
|
5757
5900
|
- application.client-secrets
|
|
5758
5901
|
/connect/client_secrets/{id}:
|
|
5759
5902
|
delete:
|
|
5760
|
-
operationId: ApplicationCredentialsController_delete
|
|
5761
|
-
summary: Delete a Client Secret
|
|
5762
5903
|
description: Delete (revoke) an existing client secret.
|
|
5904
|
+
operationId: ApplicationCredentialsController_delete
|
|
5763
5905
|
parameters:
|
|
5764
5906
|
- name: id
|
|
5765
5907
|
required: true
|
|
@@ -5784,15 +5926,15 @@ paths:
|
|
|
5784
5926
|
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
5785
5927
|
required:
|
|
5786
5928
|
- message
|
|
5929
|
+
summary: Delete a Client Secret
|
|
5787
5930
|
tags:
|
|
5788
5931
|
- application.client-secrets
|
|
5789
5932
|
/connections:
|
|
5790
5933
|
get:
|
|
5791
|
-
operationId: ConnectionsController_list
|
|
5792
|
-
summary: List Connections
|
|
5793
5934
|
description: >-
|
|
5794
5935
|
Get a list of all of your existing connections matching the criteria
|
|
5795
5936
|
specified.
|
|
5937
|
+
operationId: ConnectionsController_list
|
|
5796
5938
|
parameters:
|
|
5797
5939
|
- name: before
|
|
5798
5940
|
required: false
|
|
@@ -5829,13 +5971,7 @@ paths:
|
|
|
5829
5971
|
in: query
|
|
5830
5972
|
description: Order the results by the creation time.
|
|
5831
5973
|
schema:
|
|
5832
|
-
|
|
5833
|
-
example: desc
|
|
5834
|
-
enum:
|
|
5835
|
-
- normal
|
|
5836
|
-
- desc
|
|
5837
|
-
- asc
|
|
5838
|
-
type: string
|
|
5974
|
+
$ref: '#/components/schemas/PaginationOrder'
|
|
5839
5975
|
- name: connection_type
|
|
5840
5976
|
required: false
|
|
5841
5977
|
in: query
|
|
@@ -5946,13 +6082,13 @@ paths:
|
|
|
5946
6082
|
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
5947
6083
|
required:
|
|
5948
6084
|
- message
|
|
6085
|
+
summary: List Connections
|
|
5949
6086
|
tags:
|
|
5950
6087
|
- connections
|
|
5951
6088
|
/connections/{id}:
|
|
5952
6089
|
get:
|
|
5953
|
-
operationId: ConnectionsController_find
|
|
5954
|
-
summary: Get a Connection
|
|
5955
6090
|
description: Get the details of an existing connection.
|
|
6091
|
+
operationId: ConnectionsController_find
|
|
5956
6092
|
parameters:
|
|
5957
6093
|
- name: id
|
|
5958
6094
|
required: true
|
|
@@ -5994,12 +6130,12 @@ paths:
|
|
|
5994
6130
|
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
5995
6131
|
required:
|
|
5996
6132
|
- message
|
|
6133
|
+
summary: Get a Connection
|
|
5997
6134
|
tags:
|
|
5998
6135
|
- connections
|
|
5999
6136
|
delete:
|
|
6000
|
-
operationId: ConnectionsController_delete
|
|
6001
|
-
summary: Delete a Connection
|
|
6002
6137
|
description: Permanently deletes an existing connection. It cannot be undone.
|
|
6138
|
+
operationId: ConnectionsController_delete
|
|
6003
6139
|
parameters:
|
|
6004
6140
|
- name: id
|
|
6005
6141
|
required: true
|
|
@@ -6039,16 +6175,16 @@ paths:
|
|
|
6039
6175
|
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
6040
6176
|
required:
|
|
6041
6177
|
- message
|
|
6178
|
+
summary: Delete a Connection
|
|
6042
6179
|
tags:
|
|
6043
6180
|
- connections
|
|
6044
6181
|
/data-integrations/{slug}/authorize:
|
|
6045
6182
|
post:
|
|
6046
|
-
operationId: DataIntegrationsController_getDataIntegrationAuthorizeUrl
|
|
6047
|
-
summary: Get authorization URL
|
|
6048
6183
|
description: >-
|
|
6049
6184
|
Generates an OAuth authorization URL to initiate the connection flow for
|
|
6050
6185
|
a user. Redirect the user to the returned URL to begin the OAuth flow
|
|
6051
6186
|
with the third-party provider.
|
|
6187
|
+
operationId: DataIntegrationsController_getDataIntegrationAuthorizeUrl
|
|
6052
6188
|
parameters:
|
|
6053
6189
|
- name: slug
|
|
6054
6190
|
required: true
|
|
@@ -6131,16 +6267,16 @@ paths:
|
|
|
6131
6267
|
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
6132
6268
|
required:
|
|
6133
6269
|
- message
|
|
6270
|
+
summary: Get authorization URL
|
|
6134
6271
|
tags:
|
|
6135
6272
|
- pipes
|
|
6136
6273
|
/data-integrations/{slug}/token:
|
|
6137
6274
|
post:
|
|
6138
|
-
operationId: DataIntegrationsController_getUserlandUserToken
|
|
6139
|
-
summary: Get an access token for a connected account
|
|
6140
6275
|
description: >-
|
|
6141
6276
|
Fetches a valid OAuth access token for a user's connected account.
|
|
6142
6277
|
WorkOS automatically handles token refresh, ensuring you always receive
|
|
6143
6278
|
a valid, non-expired token.
|
|
6279
|
+
operationId: DataIntegrationsController_getUserlandUserToken
|
|
6144
6280
|
parameters:
|
|
6145
6281
|
- name: slug
|
|
6146
6282
|
required: true
|
|
@@ -6204,15 +6340,15 @@ paths:
|
|
|
6204
6340
|
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
6205
6341
|
required:
|
|
6206
6342
|
- message
|
|
6343
|
+
summary: Get an access token for a connected account
|
|
6207
6344
|
tags:
|
|
6208
6345
|
- pipes
|
|
6209
6346
|
/directories:
|
|
6210
6347
|
get:
|
|
6211
|
-
operationId: DirectoriesController_list
|
|
6212
|
-
summary: List Directories
|
|
6213
6348
|
description: >-
|
|
6214
6349
|
Get a list of all of your existing directories matching the criteria
|
|
6215
6350
|
specified.
|
|
6351
|
+
operationId: DirectoriesController_list
|
|
6216
6352
|
parameters:
|
|
6217
6353
|
- name: before
|
|
6218
6354
|
required: false
|
|
@@ -6249,13 +6385,7 @@ paths:
|
|
|
6249
6385
|
in: query
|
|
6250
6386
|
description: Order the results by the creation time.
|
|
6251
6387
|
schema:
|
|
6252
|
-
|
|
6253
|
-
example: desc
|
|
6254
|
-
enum:
|
|
6255
|
-
- normal
|
|
6256
|
-
- desc
|
|
6257
|
-
- asc
|
|
6258
|
-
type: string
|
|
6388
|
+
$ref: '#/components/schemas/PaginationOrder'
|
|
6259
6389
|
- name: organization_id
|
|
6260
6390
|
required: false
|
|
6261
6391
|
in: query
|
|
@@ -6311,13 +6441,13 @@ paths:
|
|
|
6311
6441
|
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
6312
6442
|
required:
|
|
6313
6443
|
- message
|
|
6444
|
+
summary: List Directories
|
|
6314
6445
|
tags:
|
|
6315
6446
|
- directories
|
|
6316
6447
|
/directories/{id}:
|
|
6317
6448
|
get:
|
|
6318
|
-
operationId: DirectoriesController_find
|
|
6319
|
-
summary: Get a Directory
|
|
6320
6449
|
description: Get the details of an existing directory.
|
|
6450
|
+
operationId: DirectoriesController_find
|
|
6321
6451
|
parameters:
|
|
6322
6452
|
- name: id
|
|
6323
6453
|
required: true
|
|
@@ -6359,12 +6489,12 @@ paths:
|
|
|
6359
6489
|
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
6360
6490
|
required:
|
|
6361
6491
|
- message
|
|
6492
|
+
summary: Get a Directory
|
|
6362
6493
|
tags:
|
|
6363
6494
|
- directories
|
|
6364
6495
|
delete:
|
|
6365
|
-
operationId: DirectoriesController_deleteDirectory
|
|
6366
|
-
summary: Delete a Directory
|
|
6367
6496
|
description: Permanently deletes an existing directory. It cannot be undone.
|
|
6497
|
+
operationId: DirectoriesController_deleteDirectory
|
|
6368
6498
|
parameters:
|
|
6369
6499
|
- name: id
|
|
6370
6500
|
required: true
|
|
@@ -6394,15 +6524,15 @@ paths:
|
|
|
6394
6524
|
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
6395
6525
|
required:
|
|
6396
6526
|
- message
|
|
6527
|
+
summary: Delete a Directory
|
|
6397
6528
|
tags:
|
|
6398
6529
|
- directories
|
|
6399
6530
|
/directory_groups:
|
|
6400
6531
|
get:
|
|
6401
|
-
operationId: DirectoryGroupsController_list
|
|
6402
|
-
summary: List Directory Groups
|
|
6403
6532
|
description: >-
|
|
6404
6533
|
Get a list of all of existing directory groups matching the criteria
|
|
6405
6534
|
specified.
|
|
6535
|
+
operationId: DirectoryGroupsController_list
|
|
6406
6536
|
parameters:
|
|
6407
6537
|
- name: before
|
|
6408
6538
|
required: false
|
|
@@ -6449,13 +6579,7 @@ paths:
|
|
|
6449
6579
|
reversed cursor semantics where `before` fetches older records and
|
|
6450
6580
|
`after` fetches newer records). Defaults to descending.
|
|
6451
6581
|
schema:
|
|
6452
|
-
|
|
6453
|
-
example: desc
|
|
6454
|
-
enum:
|
|
6455
|
-
- normal
|
|
6456
|
-
- desc
|
|
6457
|
-
- asc
|
|
6458
|
-
type: string
|
|
6582
|
+
$ref: '#/components/schemas/PaginationOrder'
|
|
6459
6583
|
- name: directory
|
|
6460
6584
|
required: false
|
|
6461
6585
|
in: query
|
|
@@ -6520,13 +6644,13 @@ paths:
|
|
|
6520
6644
|
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
6521
6645
|
required:
|
|
6522
6646
|
- message
|
|
6647
|
+
summary: List Directory Groups
|
|
6523
6648
|
tags:
|
|
6524
6649
|
- directory-groups
|
|
6525
6650
|
/directory_groups/{id}:
|
|
6526
6651
|
get:
|
|
6527
|
-
operationId: DirectoryGroupsController_find
|
|
6528
|
-
summary: Get a Directory Group
|
|
6529
6652
|
description: Get the details of an existing Directory Group.
|
|
6653
|
+
operationId: DirectoryGroupsController_find
|
|
6530
6654
|
parameters:
|
|
6531
6655
|
- name: id
|
|
6532
6656
|
required: true
|
|
@@ -6568,15 +6692,15 @@ paths:
|
|
|
6568
6692
|
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
6569
6693
|
required:
|
|
6570
6694
|
- message
|
|
6695
|
+
summary: Get a Directory Group
|
|
6571
6696
|
tags:
|
|
6572
6697
|
- directory-groups
|
|
6573
6698
|
/directory_users:
|
|
6574
6699
|
get:
|
|
6575
|
-
operationId: DirectoryUsersController_list
|
|
6576
|
-
summary: List Directory Users
|
|
6577
6700
|
description: >-
|
|
6578
6701
|
Get a list of all of existing Directory Users matching the criteria
|
|
6579
6702
|
specified.
|
|
6703
|
+
operationId: DirectoryUsersController_list
|
|
6580
6704
|
parameters:
|
|
6581
6705
|
- name: before
|
|
6582
6706
|
required: false
|
|
@@ -6623,13 +6747,7 @@ paths:
|
|
|
6623
6747
|
reversed cursor semantics where `before` fetches older records and
|
|
6624
6748
|
`after` fetches newer records). Defaults to descending.
|
|
6625
6749
|
schema:
|
|
6626
|
-
|
|
6627
|
-
example: desc
|
|
6628
|
-
enum:
|
|
6629
|
-
- normal
|
|
6630
|
-
- desc
|
|
6631
|
-
- asc
|
|
6632
|
-
type: string
|
|
6750
|
+
$ref: '#/components/schemas/PaginationOrder'
|
|
6633
6751
|
- name: directory
|
|
6634
6752
|
required: false
|
|
6635
6753
|
in: query
|
|
@@ -6701,13 +6819,13 @@ paths:
|
|
|
6701
6819
|
schema:
|
|
6702
6820
|
type: string
|
|
6703
6821
|
const: Ratelimited
|
|
6822
|
+
summary: List Directory Users
|
|
6704
6823
|
tags:
|
|
6705
6824
|
- directory-users
|
|
6706
6825
|
/directory_users/{id}:
|
|
6707
6826
|
get:
|
|
6708
|
-
operationId: DirectoryUsersController_find
|
|
6709
|
-
summary: Get a Directory User
|
|
6710
6827
|
description: Get the details of an existing Directory User.
|
|
6828
|
+
operationId: DirectoryUsersController_find
|
|
6711
6829
|
parameters:
|
|
6712
6830
|
- name: id
|
|
6713
6831
|
required: true
|
|
@@ -6749,13 +6867,13 @@ paths:
|
|
|
6749
6867
|
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
6750
6868
|
required:
|
|
6751
6869
|
- message
|
|
6870
|
+
summary: Get a Directory User
|
|
6752
6871
|
tags:
|
|
6753
6872
|
- directory-users
|
|
6754
6873
|
/events:
|
|
6755
6874
|
get:
|
|
6756
|
-
operationId: EventsController_list
|
|
6757
|
-
summary: List events
|
|
6758
6875
|
description: List events for the current environment.
|
|
6876
|
+
operationId: EventsController_list
|
|
6759
6877
|
parameters:
|
|
6760
6878
|
- name: before
|
|
6761
6879
|
required: false
|
|
@@ -6802,13 +6920,7 @@ paths:
|
|
|
6802
6920
|
reversed cursor semantics where `before` fetches older records and
|
|
6803
6921
|
`after` fetches newer records). Defaults to descending.
|
|
6804
6922
|
schema:
|
|
6805
|
-
|
|
6806
|
-
example: desc
|
|
6807
|
-
enum:
|
|
6808
|
-
- normal
|
|
6809
|
-
- desc
|
|
6810
|
-
- asc
|
|
6811
|
-
type: string
|
|
6923
|
+
$ref: '#/components/schemas/PaginationOrder'
|
|
6812
6924
|
- name: events
|
|
6813
6925
|
required: false
|
|
6814
6926
|
in: query
|
|
@@ -6898,15 +7010,15 @@ paths:
|
|
|
6898
7010
|
required:
|
|
6899
7011
|
- errors
|
|
6900
7012
|
- message
|
|
7013
|
+
summary: List events
|
|
6901
7014
|
tags:
|
|
6902
7015
|
- events
|
|
6903
7016
|
/feature-flags:
|
|
6904
7017
|
get:
|
|
6905
|
-
operationId: FeatureFlagsController_list
|
|
6906
|
-
summary: List feature flags
|
|
6907
7018
|
description: >-
|
|
6908
7019
|
Get a list of all of your existing feature flags matching the criteria
|
|
6909
7020
|
specified.
|
|
7021
|
+
operationId: FeatureFlagsController_list
|
|
6910
7022
|
parameters:
|
|
6911
7023
|
- name: before
|
|
6912
7024
|
required: false
|
|
@@ -6943,13 +7055,7 @@ paths:
|
|
|
6943
7055
|
in: query
|
|
6944
7056
|
description: Order the results by the creation time.
|
|
6945
7057
|
schema:
|
|
6946
|
-
|
|
6947
|
-
example: desc
|
|
6948
|
-
enum:
|
|
6949
|
-
- normal
|
|
6950
|
-
- desc
|
|
6951
|
-
- asc
|
|
6952
|
-
type: string
|
|
7058
|
+
$ref: '#/components/schemas/PaginationOrder'
|
|
6953
7059
|
responses:
|
|
6954
7060
|
'200':
|
|
6955
7061
|
description: OK
|
|
@@ -7002,13 +7108,13 @@ paths:
|
|
|
7002
7108
|
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
7003
7109
|
required:
|
|
7004
7110
|
- message
|
|
7111
|
+
summary: List feature flags
|
|
7005
7112
|
tags:
|
|
7006
7113
|
- feature-flags
|
|
7007
7114
|
/feature-flags/{slug}:
|
|
7008
7115
|
get:
|
|
7009
|
-
operationId: FeatureFlagsController_findBySlug
|
|
7010
|
-
summary: Get a feature flag
|
|
7011
7116
|
description: Get the details of an existing feature flag by its slug.
|
|
7117
|
+
operationId: FeatureFlagsController_findBySlug
|
|
7012
7118
|
parameters:
|
|
7013
7119
|
- name: slug
|
|
7014
7120
|
required: true
|
|
@@ -7037,13 +7143,13 @@ paths:
|
|
|
7037
7143
|
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
7038
7144
|
required:
|
|
7039
7145
|
- message
|
|
7146
|
+
summary: Get a feature flag
|
|
7040
7147
|
tags:
|
|
7041
7148
|
- feature-flags
|
|
7042
7149
|
/feature-flags/{slug}/disable:
|
|
7043
7150
|
put:
|
|
7044
|
-
operationId: FeatureFlagsController_disableFlag
|
|
7045
|
-
summary: Disable a feature flag
|
|
7046
7151
|
description: Disables a feature flag in the current environment.
|
|
7152
|
+
operationId: FeatureFlagsController_disableFlag
|
|
7047
7153
|
parameters:
|
|
7048
7154
|
- name: slug
|
|
7049
7155
|
required: true
|
|
@@ -7167,13 +7273,13 @@ paths:
|
|
|
7167
7273
|
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
7168
7274
|
required:
|
|
7169
7275
|
- message
|
|
7276
|
+
summary: Disable a feature flag
|
|
7170
7277
|
tags:
|
|
7171
7278
|
- feature-flags
|
|
7172
7279
|
/feature-flags/{slug}/enable:
|
|
7173
7280
|
put:
|
|
7174
|
-
operationId: FeatureFlagsController_enableFlag
|
|
7175
|
-
summary: Enable a feature flag
|
|
7176
7281
|
description: Enables a feature flag in the current environment.
|
|
7282
|
+
operationId: FeatureFlagsController_enableFlag
|
|
7177
7283
|
parameters:
|
|
7178
7284
|
- name: slug
|
|
7179
7285
|
required: true
|
|
@@ -7297,15 +7403,15 @@ paths:
|
|
|
7297
7403
|
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
7298
7404
|
required:
|
|
7299
7405
|
- message
|
|
7406
|
+
summary: Enable a feature flag
|
|
7300
7407
|
tags:
|
|
7301
7408
|
- feature-flags
|
|
7302
7409
|
/feature-flags/{slug}/targets/{resourceId}:
|
|
7303
7410
|
post:
|
|
7304
|
-
operationId: FlagTargetsController_createTarget
|
|
7305
|
-
summary: Add a feature flag target
|
|
7306
7411
|
description: >-
|
|
7307
7412
|
Enables a feature flag for a specific target in the current environment.
|
|
7308
7413
|
Currently, supported targets include users and organizations.
|
|
7414
|
+
operationId: FlagTargetsController_createTarget
|
|
7309
7415
|
parameters:
|
|
7310
7416
|
- name: resourceId
|
|
7311
7417
|
required: true
|
|
@@ -7369,15 +7475,15 @@ paths:
|
|
|
7369
7475
|
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
7370
7476
|
required:
|
|
7371
7477
|
- message
|
|
7478
|
+
summary: Add a feature flag target
|
|
7372
7479
|
tags:
|
|
7373
7480
|
- feature-flags.targets
|
|
7374
7481
|
delete:
|
|
7375
|
-
operationId: FlagTargetsController_deleteTarget
|
|
7376
|
-
summary: Remove a feature flag target
|
|
7377
7482
|
description: >-
|
|
7378
7483
|
Removes a target from the feature flag's target list in the current
|
|
7379
7484
|
environment. Currently, supported targets include users and
|
|
7380
7485
|
organizations.
|
|
7486
|
+
operationId: FlagTargetsController_deleteTarget
|
|
7381
7487
|
parameters:
|
|
7382
7488
|
- name: resourceId
|
|
7383
7489
|
required: true
|
|
@@ -7441,13 +7547,13 @@ paths:
|
|
|
7441
7547
|
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
7442
7548
|
required:
|
|
7443
7549
|
- message
|
|
7550
|
+
summary: Remove a feature flag target
|
|
7444
7551
|
tags:
|
|
7445
7552
|
- feature-flags.targets
|
|
7446
7553
|
/organization_domains:
|
|
7447
7554
|
post:
|
|
7448
|
-
operationId: OrganizationDomainsController_create
|
|
7449
|
-
summary: Create an Organization Domain
|
|
7450
7555
|
description: Creates a new Organization Domain.
|
|
7556
|
+
operationId: OrganizationDomainsController_create
|
|
7451
7557
|
parameters: []
|
|
7452
7558
|
requestBody:
|
|
7453
7559
|
required: true
|
|
@@ -7540,13 +7646,13 @@ paths:
|
|
|
7540
7646
|
required:
|
|
7541
7647
|
- code
|
|
7542
7648
|
- message
|
|
7649
|
+
summary: Create an Organization Domain
|
|
7543
7650
|
tags:
|
|
7544
7651
|
- organization-domains
|
|
7545
7652
|
/organization_domains/{id}:
|
|
7546
7653
|
get:
|
|
7547
|
-
operationId: OrganizationDomainsController_get
|
|
7548
|
-
summary: Get an Organization Domain
|
|
7549
7654
|
description: Get the details of an existing organization domain.
|
|
7655
|
+
operationId: OrganizationDomainsController_get
|
|
7550
7656
|
parameters:
|
|
7551
7657
|
- name: id
|
|
7552
7658
|
required: true
|
|
@@ -7575,12 +7681,12 @@ paths:
|
|
|
7575
7681
|
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
7576
7682
|
required:
|
|
7577
7683
|
- message
|
|
7684
|
+
summary: Get an Organization Domain
|
|
7578
7685
|
tags:
|
|
7579
7686
|
- organization-domains
|
|
7580
7687
|
delete:
|
|
7581
|
-
operationId: OrganizationDomainsController_delete
|
|
7582
|
-
summary: Delete an Organization Domain
|
|
7583
7688
|
description: Permanently deletes an organization domain. It cannot be undone.
|
|
7689
|
+
operationId: OrganizationDomainsController_delete
|
|
7584
7690
|
parameters:
|
|
7585
7691
|
- name: id
|
|
7586
7692
|
required: true
|
|
@@ -7605,13 +7711,13 @@ paths:
|
|
|
7605
7711
|
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
7606
7712
|
required:
|
|
7607
7713
|
- message
|
|
7714
|
+
summary: Delete an Organization Domain
|
|
7608
7715
|
tags:
|
|
7609
7716
|
- organization-domains
|
|
7610
7717
|
/organization_domains/{id}/verify:
|
|
7611
7718
|
post:
|
|
7612
|
-
operationId: OrganizationDomainsController_verify
|
|
7613
|
-
summary: Verify an Organization Domain
|
|
7614
7719
|
description: Initiates verification process for an Organization Domain.
|
|
7720
|
+
operationId: OrganizationDomainsController_verify
|
|
7615
7721
|
parameters:
|
|
7616
7722
|
- name: id
|
|
7617
7723
|
required: true
|
|
@@ -7645,15 +7751,15 @@ paths:
|
|
|
7645
7751
|
required:
|
|
7646
7752
|
- code
|
|
7647
7753
|
- message
|
|
7754
|
+
summary: Verify an Organization Domain
|
|
7648
7755
|
tags:
|
|
7649
7756
|
- organization-domains
|
|
7650
7757
|
/organizations:
|
|
7651
7758
|
get:
|
|
7652
|
-
operationId: OrganizationsController_list
|
|
7653
|
-
summary: List Organizations
|
|
7654
7759
|
description: >-
|
|
7655
7760
|
Get a list of all of your existing organizations matching the criteria
|
|
7656
7761
|
specified.
|
|
7762
|
+
operationId: OrganizationsController_list
|
|
7657
7763
|
parameters:
|
|
7658
7764
|
- name: before
|
|
7659
7765
|
required: false
|
|
@@ -7700,13 +7806,7 @@ paths:
|
|
|
7700
7806
|
reversed cursor semantics where `before` fetches older records and
|
|
7701
7807
|
`after` fetches newer records). Defaults to descending.
|
|
7702
7808
|
schema:
|
|
7703
|
-
|
|
7704
|
-
example: desc
|
|
7705
|
-
enum:
|
|
7706
|
-
- normal
|
|
7707
|
-
- desc
|
|
7708
|
-
- asc
|
|
7709
|
-
type: string
|
|
7809
|
+
$ref: '#/components/schemas/PaginationOrder'
|
|
7710
7810
|
- name: domains
|
|
7711
7811
|
required: false
|
|
7712
7812
|
in: query
|
|
@@ -7750,12 +7850,12 @@ paths:
|
|
|
7750
7850
|
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
7751
7851
|
required:
|
|
7752
7852
|
- message
|
|
7853
|
+
summary: List Organizations
|
|
7753
7854
|
tags:
|
|
7754
7855
|
- organizations
|
|
7755
7856
|
post:
|
|
7756
|
-
operationId: OrganizationsController_create
|
|
7757
|
-
summary: Create an Organization
|
|
7758
7857
|
description: Creates a new organization in the current environment.
|
|
7858
|
+
operationId: OrganizationsController_create
|
|
7759
7859
|
parameters: []
|
|
7760
7860
|
requestBody:
|
|
7761
7861
|
required: true
|
|
@@ -7852,15 +7952,15 @@ paths:
|
|
|
7852
7952
|
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
7853
7953
|
required:
|
|
7854
7954
|
- message
|
|
7955
|
+
summary: Create an Organization
|
|
7855
7956
|
tags:
|
|
7856
7957
|
- organizations
|
|
7857
7958
|
/organizations/external_id/{external_id}:
|
|
7858
7959
|
get:
|
|
7859
|
-
operationId: OrganizationsController_getByExternalId
|
|
7860
|
-
summary: Get an Organization by External ID
|
|
7861
7960
|
description: >-
|
|
7862
7961
|
Get the details of an existing organization by an [external
|
|
7863
7962
|
identifier](/authkit/metadata/external-identifiers).
|
|
7963
|
+
operationId: OrganizationsController_getByExternalId
|
|
7864
7964
|
parameters:
|
|
7865
7965
|
- name: external_id
|
|
7866
7966
|
required: true
|
|
@@ -7889,13 +7989,13 @@ paths:
|
|
|
7889
7989
|
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
7890
7990
|
required:
|
|
7891
7991
|
- message
|
|
7992
|
+
summary: Get an Organization by External ID
|
|
7892
7993
|
tags:
|
|
7893
7994
|
- organizations
|
|
7894
7995
|
/organizations/{id}:
|
|
7895
7996
|
get:
|
|
7896
|
-
operationId: OrganizationsController_find
|
|
7897
|
-
summary: Get an Organization
|
|
7898
7997
|
description: Get the details of an existing organization.
|
|
7998
|
+
operationId: OrganizationsController_find
|
|
7899
7999
|
parameters:
|
|
7900
8000
|
- name: id
|
|
7901
8001
|
required: true
|
|
@@ -7924,12 +8024,12 @@ paths:
|
|
|
7924
8024
|
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
7925
8025
|
required:
|
|
7926
8026
|
- message
|
|
8027
|
+
summary: Get an Organization
|
|
7927
8028
|
tags:
|
|
7928
8029
|
- organizations
|
|
7929
8030
|
put:
|
|
7930
|
-
operationId: OrganizationsController_updateOrganization
|
|
7931
|
-
summary: Update an Organization
|
|
7932
8031
|
description: Updates an organization in the current environment.
|
|
8032
|
+
operationId: OrganizationsController_updateOrganization
|
|
7933
8033
|
parameters:
|
|
7934
8034
|
- name: id
|
|
7935
8035
|
required: true
|
|
@@ -8073,14 +8173,14 @@ paths:
|
|
|
8073
8173
|
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
8074
8174
|
required:
|
|
8075
8175
|
- message
|
|
8176
|
+
summary: Update an Organization
|
|
8076
8177
|
tags:
|
|
8077
8178
|
- organizations
|
|
8078
8179
|
delete:
|
|
8079
|
-
operationId: OrganizationsController_deleteOrganization
|
|
8080
|
-
summary: Delete an Organization
|
|
8081
8180
|
description: >-
|
|
8082
8181
|
Permanently deletes an organization in the current environment. It
|
|
8083
8182
|
cannot be undone.
|
|
8183
|
+
operationId: OrganizationsController_deleteOrganization
|
|
8084
8184
|
parameters:
|
|
8085
8185
|
- name: id
|
|
8086
8186
|
required: true
|
|
@@ -8107,15 +8207,15 @@ paths:
|
|
|
8107
8207
|
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
8108
8208
|
required:
|
|
8109
8209
|
- message
|
|
8210
|
+
summary: Delete an Organization
|
|
8110
8211
|
tags:
|
|
8111
8212
|
- organizations
|
|
8112
8213
|
/organizations/{id}/audit_log_configuration:
|
|
8113
8214
|
get:
|
|
8114
|
-
operationId: OrganizationsController_getAuditLogConfiguration
|
|
8115
|
-
summary: Get Audit Log Configuration
|
|
8116
8215
|
description: >-
|
|
8117
8216
|
Get the unified view of audit log trail and stream configuration for an
|
|
8118
8217
|
organization.
|
|
8218
|
+
operationId: OrganizationsController_getAuditLogConfiguration
|
|
8119
8219
|
parameters:
|
|
8120
8220
|
- name: id
|
|
8121
8221
|
required: true
|
|
@@ -8144,13 +8244,13 @@ paths:
|
|
|
8144
8244
|
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
8145
8245
|
required:
|
|
8146
8246
|
- message
|
|
8247
|
+
summary: Get Audit Log Configuration
|
|
8147
8248
|
tags:
|
|
8148
8249
|
- organizations
|
|
8149
8250
|
/organizations/{id}/audit_logs_retention:
|
|
8150
8251
|
get:
|
|
8151
|
-
operationId: AuditLogsRetentionController_auditLogsRetention
|
|
8152
|
-
summary: Get Retention
|
|
8153
8252
|
description: Get the configured event retention period for the given Organization.
|
|
8253
|
+
operationId: AuditLogsRetentionController_auditLogsRetention
|
|
8154
8254
|
parameters:
|
|
8155
8255
|
- name: id
|
|
8156
8256
|
required: true
|
|
@@ -8179,12 +8279,12 @@ paths:
|
|
|
8179
8279
|
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
8180
8280
|
required:
|
|
8181
8281
|
- message
|
|
8282
|
+
summary: Get Retention
|
|
8182
8283
|
tags:
|
|
8183
8284
|
- audit-logs
|
|
8184
8285
|
put:
|
|
8185
|
-
operationId: AuditLogsRetentionController_updateAuditLogsRetention
|
|
8186
|
-
summary: Set Retention
|
|
8187
8286
|
description: Set the event retention period for the given Organization.
|
|
8287
|
+
operationId: AuditLogsRetentionController_updateAuditLogsRetention
|
|
8188
8288
|
parameters:
|
|
8189
8289
|
- name: id
|
|
8190
8290
|
required: true
|
|
@@ -8232,13 +8332,13 @@ paths:
|
|
|
8232
8332
|
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
8233
8333
|
required:
|
|
8234
8334
|
- message
|
|
8335
|
+
summary: Set Retention
|
|
8235
8336
|
tags:
|
|
8236
8337
|
- audit-logs
|
|
8237
8338
|
/organizations/{organizationId}/api_keys:
|
|
8238
8339
|
get:
|
|
8239
|
-
operationId: OrganizationApiKeysController_list
|
|
8240
|
-
summary: List API keys for an organization
|
|
8241
8340
|
description: Get a list of all API keys for an organization.
|
|
8341
|
+
operationId: OrganizationApiKeysController_list
|
|
8242
8342
|
parameters:
|
|
8243
8343
|
- name: organizationId
|
|
8244
8344
|
required: true
|
|
@@ -8282,13 +8382,7 @@ paths:
|
|
|
8282
8382
|
in: query
|
|
8283
8383
|
description: Order the results by the creation time.
|
|
8284
8384
|
schema:
|
|
8285
|
-
|
|
8286
|
-
example: desc
|
|
8287
|
-
enum:
|
|
8288
|
-
- normal
|
|
8289
|
-
- desc
|
|
8290
|
-
- asc
|
|
8291
|
-
type: string
|
|
8385
|
+
$ref: '#/components/schemas/PaginationOrder'
|
|
8292
8386
|
responses:
|
|
8293
8387
|
'200':
|
|
8294
8388
|
description: OK
|
|
@@ -8309,12 +8403,12 @@ paths:
|
|
|
8309
8403
|
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
8310
8404
|
required:
|
|
8311
8405
|
- message
|
|
8406
|
+
summary: List API keys for an organization
|
|
8312
8407
|
tags:
|
|
8313
8408
|
- organizations.api_keys
|
|
8314
8409
|
post:
|
|
8315
|
-
operationId: OrganizationApiKeysController_create
|
|
8316
|
-
summary: Create an API key for an organization
|
|
8317
8410
|
description: Create a new API key for an organization.
|
|
8411
|
+
operationId: OrganizationApiKeysController_create
|
|
8318
8412
|
parameters:
|
|
8319
8413
|
- name: organizationId
|
|
8320
8414
|
required: true
|
|
@@ -8380,13 +8474,13 @@ paths:
|
|
|
8380
8474
|
required:
|
|
8381
8475
|
- message
|
|
8382
8476
|
- errors
|
|
8477
|
+
summary: Create an API key for an organization
|
|
8383
8478
|
tags:
|
|
8384
8479
|
- organizations.api_keys
|
|
8385
8480
|
/organizations/{organizationId}/feature-flags:
|
|
8386
8481
|
get:
|
|
8387
|
-
operationId: OrganizationFeatureFlagsController_list
|
|
8388
|
-
summary: List enabled feature flags for an organization
|
|
8389
8482
|
description: Get a list of all enabled feature flags for an organization.
|
|
8483
|
+
operationId: OrganizationFeatureFlagsController_list
|
|
8390
8484
|
parameters:
|
|
8391
8485
|
- name: organizationId
|
|
8392
8486
|
required: true
|
|
@@ -8430,13 +8524,7 @@ paths:
|
|
|
8430
8524
|
in: query
|
|
8431
8525
|
description: Order the results by the creation time.
|
|
8432
8526
|
schema:
|
|
8433
|
-
|
|
8434
|
-
example: desc
|
|
8435
|
-
enum:
|
|
8436
|
-
- normal
|
|
8437
|
-
- desc
|
|
8438
|
-
- asc
|
|
8439
|
-
type: string
|
|
8527
|
+
$ref: '#/components/schemas/PaginationOrder'
|
|
8440
8528
|
responses:
|
|
8441
8529
|
'200':
|
|
8442
8530
|
description: OK
|
|
@@ -8457,13 +8545,13 @@ paths:
|
|
|
8457
8545
|
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
8458
8546
|
required:
|
|
8459
8547
|
- message
|
|
8548
|
+
summary: List enabled feature flags for an organization
|
|
8460
8549
|
tags:
|
|
8461
8550
|
- organizations.feature-flags
|
|
8462
8551
|
/organizations/{organizationId}/groups:
|
|
8463
8552
|
post:
|
|
8464
|
-
operationId: GroupsController_create
|
|
8465
|
-
summary: Create a group
|
|
8466
8553
|
description: Create a new group within an organization.
|
|
8554
|
+
operationId: GroupsController_create
|
|
8467
8555
|
parameters:
|
|
8468
8556
|
- name: organizationId
|
|
8469
8557
|
required: true
|
|
@@ -8543,13 +8631,13 @@ paths:
|
|
|
8543
8631
|
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
8544
8632
|
required:
|
|
8545
8633
|
- message
|
|
8634
|
+
summary: Create a group
|
|
8546
8635
|
tags:
|
|
8547
8636
|
- groups
|
|
8548
8637
|
x-feature-flag: user-groups-enabled
|
|
8549
8638
|
get:
|
|
8550
|
-
operationId: GroupsController_list
|
|
8551
|
-
summary: List groups
|
|
8552
8639
|
description: Get a paginated list of groups within an organization.
|
|
8640
|
+
operationId: GroupsController_list
|
|
8553
8641
|
parameters:
|
|
8554
8642
|
- name: organizationId
|
|
8555
8643
|
required: true
|
|
@@ -8603,13 +8691,7 @@ paths:
|
|
|
8603
8691
|
reversed cursor semantics where `before` fetches older records and
|
|
8604
8692
|
`after` fetches newer records). Defaults to descending.
|
|
8605
8693
|
schema:
|
|
8606
|
-
|
|
8607
|
-
example: desc
|
|
8608
|
-
enum:
|
|
8609
|
-
- normal
|
|
8610
|
-
- desc
|
|
8611
|
-
- asc
|
|
8612
|
-
type: string
|
|
8694
|
+
$ref: '#/components/schemas/PaginationOrder'
|
|
8613
8695
|
responses:
|
|
8614
8696
|
'200':
|
|
8615
8697
|
description: OK
|
|
@@ -8643,14 +8725,14 @@ paths:
|
|
|
8643
8725
|
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
8644
8726
|
required:
|
|
8645
8727
|
- message
|
|
8728
|
+
summary: List groups
|
|
8646
8729
|
tags:
|
|
8647
8730
|
- groups
|
|
8648
8731
|
x-feature-flag: user-groups-enabled
|
|
8649
8732
|
/organizations/{organizationId}/groups/{groupId}:
|
|
8650
8733
|
get:
|
|
8651
|
-
operationId: GroupsController_get
|
|
8652
|
-
summary: Get a group
|
|
8653
8734
|
description: Retrieve a group by its ID within an organization.
|
|
8735
|
+
operationId: GroupsController_get
|
|
8654
8736
|
parameters:
|
|
8655
8737
|
- name: organizationId
|
|
8656
8738
|
required: true
|
|
@@ -8699,15 +8781,15 @@ paths:
|
|
|
8699
8781
|
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
8700
8782
|
required:
|
|
8701
8783
|
- message
|
|
8784
|
+
summary: Get a group
|
|
8702
8785
|
tags:
|
|
8703
8786
|
- groups
|
|
8704
8787
|
x-feature-flag: user-groups-enabled
|
|
8705
8788
|
patch:
|
|
8706
|
-
operationId: GroupsController_update
|
|
8707
|
-
summary: Update a group
|
|
8708
8789
|
description: >-
|
|
8709
8790
|
Update an existing group. Only the fields provided in the request body
|
|
8710
8791
|
will be updated.
|
|
8792
|
+
operationId: GroupsController_update
|
|
8711
8793
|
parameters:
|
|
8712
8794
|
- name: organizationId
|
|
8713
8795
|
required: true
|
|
@@ -8794,13 +8876,13 @@ paths:
|
|
|
8794
8876
|
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
8795
8877
|
required:
|
|
8796
8878
|
- message
|
|
8879
|
+
summary: Update a group
|
|
8797
8880
|
tags:
|
|
8798
8881
|
- groups
|
|
8799
8882
|
x-feature-flag: user-groups-enabled
|
|
8800
8883
|
delete:
|
|
8801
|
-
operationId: GroupsController_delete
|
|
8802
|
-
summary: Delete a group
|
|
8803
8884
|
description: Delete a group from an organization.
|
|
8885
|
+
operationId: GroupsController_delete
|
|
8804
8886
|
parameters:
|
|
8805
8887
|
- name: organizationId
|
|
8806
8888
|
required: true
|
|
@@ -8845,14 +8927,14 @@ paths:
|
|
|
8845
8927
|
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
8846
8928
|
required:
|
|
8847
8929
|
- message
|
|
8930
|
+
summary: Delete a group
|
|
8848
8931
|
tags:
|
|
8849
8932
|
- groups
|
|
8850
8933
|
x-feature-flag: user-groups-enabled
|
|
8851
8934
|
/organizations/{organizationId}/groups/{groupId}/organization-memberships:
|
|
8852
8935
|
post:
|
|
8853
|
-
operationId: GroupMembershipsController_addMember
|
|
8854
|
-
summary: Add a member to a Group
|
|
8855
8936
|
description: Add an organization membership to a group.
|
|
8937
|
+
operationId: GroupMembershipsController_addMember
|
|
8856
8938
|
parameters:
|
|
8857
8939
|
- name: organizationId
|
|
8858
8940
|
required: true
|
|
@@ -8920,13 +9002,13 @@ paths:
|
|
|
8920
9002
|
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
8921
9003
|
required:
|
|
8922
9004
|
- message
|
|
9005
|
+
summary: Add a member to a Group
|
|
8923
9006
|
tags:
|
|
8924
9007
|
- groups
|
|
8925
9008
|
x-feature-flag: user-groups-enabled
|
|
8926
9009
|
get:
|
|
8927
|
-
operationId: GroupMembershipsController_listMembers
|
|
8928
|
-
summary: List Group members
|
|
8929
9010
|
description: Get a list of organization memberships in a group.
|
|
9011
|
+
operationId: GroupMembershipsController_listMembers
|
|
8930
9012
|
parameters:
|
|
8931
9013
|
- name: organizationId
|
|
8932
9014
|
required: true
|
|
@@ -8987,13 +9069,7 @@ paths:
|
|
|
8987
9069
|
reversed cursor semantics where `before` fetches older records and
|
|
8988
9070
|
`after` fetches newer records). Defaults to descending.
|
|
8989
9071
|
schema:
|
|
8990
|
-
|
|
8991
|
-
example: desc
|
|
8992
|
-
enum:
|
|
8993
|
-
- normal
|
|
8994
|
-
- desc
|
|
8995
|
-
- asc
|
|
8996
|
-
type: string
|
|
9072
|
+
$ref: '#/components/schemas/PaginationOrder'
|
|
8997
9073
|
responses:
|
|
8998
9074
|
'200':
|
|
8999
9075
|
description: OK
|
|
@@ -9028,14 +9104,14 @@ paths:
|
|
|
9028
9104
|
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
9029
9105
|
required:
|
|
9030
9106
|
- message
|
|
9107
|
+
summary: List Group members
|
|
9031
9108
|
tags:
|
|
9032
9109
|
- groups
|
|
9033
9110
|
x-feature-flag: user-groups-enabled
|
|
9034
9111
|
/organizations/{organizationId}/groups/{groupId}/organization-memberships/{omId}:
|
|
9035
9112
|
delete:
|
|
9036
|
-
operationId: GroupMembershipsController_removeMember
|
|
9037
|
-
summary: Remove a member from a Group
|
|
9038
9113
|
description: Remove an organization membership from a group.
|
|
9114
|
+
operationId: GroupMembershipsController_removeMember
|
|
9039
9115
|
parameters:
|
|
9040
9116
|
- name: organizationId
|
|
9041
9117
|
required: true
|
|
@@ -9087,14 +9163,14 @@ paths:
|
|
|
9087
9163
|
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
9088
9164
|
required:
|
|
9089
9165
|
- message
|
|
9166
|
+
summary: Remove a member from a Group
|
|
9090
9167
|
tags:
|
|
9091
9168
|
- groups
|
|
9092
9169
|
x-feature-flag: user-groups-enabled
|
|
9093
9170
|
/portal/generate_link:
|
|
9094
9171
|
post:
|
|
9095
|
-
operationId: PortalSessionsController_create
|
|
9096
|
-
summary: Generate a Portal Link
|
|
9097
9172
|
description: Generate a Portal Link scoped to an Organization.
|
|
9173
|
+
operationId: PortalSessionsController_create
|
|
9098
9174
|
parameters: []
|
|
9099
9175
|
requestBody:
|
|
9100
9176
|
required: true
|
|
@@ -9161,13 +9237,13 @@ paths:
|
|
|
9161
9237
|
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
9162
9238
|
required:
|
|
9163
9239
|
- message
|
|
9240
|
+
summary: Generate a Portal Link
|
|
9164
9241
|
tags:
|
|
9165
9242
|
- admin-portal
|
|
9166
9243
|
/radar/attempts:
|
|
9167
9244
|
post:
|
|
9168
|
-
operationId: RadarStandaloneController_assess
|
|
9169
|
-
summary: Create an attempt
|
|
9170
9245
|
description: Assess a request for risk using the Radar engine and receive a verdict.
|
|
9246
|
+
operationId: RadarStandaloneController_assess
|
|
9171
9247
|
parameters: []
|
|
9172
9248
|
requestBody:
|
|
9173
9249
|
required: true
|
|
@@ -9249,16 +9325,16 @@ paths:
|
|
|
9249
9325
|
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
9250
9326
|
required:
|
|
9251
9327
|
- message
|
|
9328
|
+
summary: Create an attempt
|
|
9252
9329
|
tags:
|
|
9253
9330
|
- radar
|
|
9254
9331
|
/radar/attempts/{id}:
|
|
9255
9332
|
put:
|
|
9256
|
-
operationId: RadarStandaloneController_updateRadarAttempt
|
|
9257
|
-
summary: Update a Radar attempt
|
|
9258
9333
|
description: >-
|
|
9259
9334
|
You may optionally inform Radar that an authentication attempt or
|
|
9260
9335
|
challenge was successful using this endpoint. Some Radar controls depend
|
|
9261
9336
|
on tracking recent successful attempts, such as impossible travel.
|
|
9337
|
+
operationId: RadarStandaloneController_updateRadarAttempt
|
|
9262
9338
|
parameters:
|
|
9263
9339
|
- name: id
|
|
9264
9340
|
required: true
|
|
@@ -9315,13 +9391,13 @@ paths:
|
|
|
9315
9391
|
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
9316
9392
|
required:
|
|
9317
9393
|
- message
|
|
9394
|
+
summary: Update a Radar attempt
|
|
9318
9395
|
tags:
|
|
9319
9396
|
- radar
|
|
9320
9397
|
/radar/lists/{type}/{action}:
|
|
9321
9398
|
post:
|
|
9322
|
-
operationId: RadarStandaloneController_updateRadarList
|
|
9323
|
-
summary: Add an entry to a Radar list
|
|
9324
9399
|
description: Add an entry to a Radar list.
|
|
9400
|
+
operationId: RadarStandaloneController_updateRadarList
|
|
9325
9401
|
parameters:
|
|
9326
9402
|
- name: type
|
|
9327
9403
|
required: true
|
|
@@ -9390,12 +9466,12 @@ paths:
|
|
|
9390
9466
|
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
9391
9467
|
required:
|
|
9392
9468
|
- message
|
|
9469
|
+
summary: Add an entry to a Radar list
|
|
9393
9470
|
tags:
|
|
9394
9471
|
- radar
|
|
9395
9472
|
delete:
|
|
9396
|
-
operationId: RadarStandaloneController_deleteRadarListEntry
|
|
9397
|
-
summary: Remove an entry from a Radar list
|
|
9398
9473
|
description: Remove an entry from a Radar list.
|
|
9474
|
+
operationId: RadarStandaloneController_deleteRadarListEntry
|
|
9399
9475
|
parameters:
|
|
9400
9476
|
- name: type
|
|
9401
9477
|
required: true
|
|
@@ -9468,14 +9544,13 @@ paths:
|
|
|
9468
9544
|
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
9469
9545
|
required:
|
|
9470
9546
|
- message
|
|
9547
|
+
summary: Remove an entry from a Radar list
|
|
9471
9548
|
tags:
|
|
9472
9549
|
- radar
|
|
9473
9550
|
/sso/authorize:
|
|
9474
9551
|
get:
|
|
9475
|
-
operationId: SsoController_authorize
|
|
9476
|
-
summary: Initiate SSO
|
|
9477
9552
|
description: Initiates the single sign-on flow.
|
|
9478
|
-
|
|
9553
|
+
operationId: SsoController_authorize
|
|
9479
9554
|
parameters:
|
|
9480
9555
|
- name: provider_scopes
|
|
9481
9556
|
required: false
|
|
@@ -9658,15 +9733,16 @@ paths:
|
|
|
9658
9733
|
type: string
|
|
9659
9734
|
format: uri
|
|
9660
9735
|
description: ''
|
|
9736
|
+
security: []
|
|
9737
|
+
summary: Initiate SSO
|
|
9661
9738
|
tags:
|
|
9662
9739
|
- sso
|
|
9663
9740
|
/sso/jwks/{clientId}:
|
|
9664
9741
|
get:
|
|
9665
|
-
operationId: SsoController_jsonWebKeySet
|
|
9666
|
-
summary: Get JWKS
|
|
9667
9742
|
description: >-
|
|
9668
9743
|
Returns the JSON Web Key Set (JWKS) containing the public keys used for
|
|
9669
9744
|
verifying access tokens.
|
|
9745
|
+
operationId: SsoController_jsonWebKeySet
|
|
9670
9746
|
parameters:
|
|
9671
9747
|
- name: clientId
|
|
9672
9748
|
required: true
|
|
@@ -9698,14 +9774,11 @@ paths:
|
|
|
9698
9774
|
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
9699
9775
|
required:
|
|
9700
9776
|
- message
|
|
9777
|
+
summary: Get JWKS
|
|
9701
9778
|
tags:
|
|
9702
9779
|
- user-management.session-tokens
|
|
9703
9780
|
/sso/logout:
|
|
9704
9781
|
get:
|
|
9705
|
-
operationId: SsoController_logout
|
|
9706
|
-
summary: Logout Redirect
|
|
9707
|
-
servers:
|
|
9708
|
-
- url: https://auth.workos.com
|
|
9709
9782
|
description: >-
|
|
9710
9783
|
Logout allows to sign out a user from your application by triggering the
|
|
9711
9784
|
identity provider sign out flow. This `GET` endpoint should be a
|
|
@@ -9716,7 +9789,7 @@ paths:
|
|
|
9716
9789
|
Before redirecting to this endpoint, you need to generate a short-lived
|
|
9717
9790
|
logout token using the [Logout
|
|
9718
9791
|
Authorize](/reference/sso/logout/authorize) endpoint.
|
|
9719
|
-
|
|
9792
|
+
operationId: SsoController_logout
|
|
9720
9793
|
parameters:
|
|
9721
9794
|
- name: token
|
|
9722
9795
|
required: true
|
|
@@ -9751,18 +9824,19 @@ paths:
|
|
|
9751
9824
|
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
9752
9825
|
required:
|
|
9753
9826
|
- message
|
|
9827
|
+
security: []
|
|
9828
|
+
servers:
|
|
9829
|
+
- url: https://auth.workos.com
|
|
9830
|
+
summary: Logout Redirect
|
|
9754
9831
|
tags:
|
|
9755
9832
|
- sso
|
|
9756
9833
|
/sso/logout/authorize:
|
|
9757
9834
|
post:
|
|
9758
|
-
operationId: SsoController_logoutAuthorize
|
|
9759
|
-
summary: Logout Authorize
|
|
9760
|
-
servers:
|
|
9761
|
-
- url: https://auth.workos.com
|
|
9762
9835
|
description: >-
|
|
9763
9836
|
You should call this endpoint from your server to generate a logout
|
|
9764
9837
|
token which is required for the [Logout Redirect](/reference/sso/logout)
|
|
9765
9838
|
endpoint.
|
|
9839
|
+
operationId: SsoController_logoutAuthorize
|
|
9766
9840
|
parameters: []
|
|
9767
9841
|
requestBody:
|
|
9768
9842
|
required: true
|
|
@@ -9831,14 +9905,13 @@ paths:
|
|
|
9831
9905
|
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
9832
9906
|
required:
|
|
9833
9907
|
- message
|
|
9908
|
+
servers:
|
|
9909
|
+
- url: https://auth.workos.com
|
|
9910
|
+
summary: Logout Authorize
|
|
9834
9911
|
tags:
|
|
9835
9912
|
- sso
|
|
9836
9913
|
/sso/profile:
|
|
9837
9914
|
get:
|
|
9838
|
-
operationId: SsoController_getProfile
|
|
9839
|
-
summary: Get a User Profile
|
|
9840
|
-
security:
|
|
9841
|
-
- access_token: []
|
|
9842
9915
|
description: >-
|
|
9843
9916
|
Exchange an access token for a user's [Profile](/reference/sso/profile).
|
|
9844
9917
|
Because this profile is returned in the [Get a Profile and Token
|
|
@@ -9846,6 +9919,7 @@ paths:
|
|
|
9846
9919
|
usually does not need to call this endpoint. It is available for any
|
|
9847
9920
|
authentication flows that require an additional endpoint to retrieve a
|
|
9848
9921
|
user's profile.
|
|
9922
|
+
operationId: SsoController_getProfile
|
|
9849
9923
|
parameters: []
|
|
9850
9924
|
responses:
|
|
9851
9925
|
'200':
|
|
@@ -9879,17 +9953,18 @@ paths:
|
|
|
9879
9953
|
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
9880
9954
|
required:
|
|
9881
9955
|
- message
|
|
9956
|
+
security:
|
|
9957
|
+
- access_token: []
|
|
9958
|
+
summary: Get a User Profile
|
|
9882
9959
|
tags:
|
|
9883
9960
|
- sso
|
|
9884
9961
|
/sso/token:
|
|
9885
9962
|
post:
|
|
9886
|
-
operationId: SsoController_token
|
|
9887
|
-
summary: Get a Profile and Token
|
|
9888
9963
|
description: >-
|
|
9889
9964
|
Get an access token along with the user
|
|
9890
9965
|
[Profile](/reference/sso/profile) using the code passed to your
|
|
9891
9966
|
[Redirect URI](/reference/sso/get-authorization-url/redirect-uri).
|
|
9892
|
-
|
|
9967
|
+
operationId: SsoController_token
|
|
9893
9968
|
parameters:
|
|
9894
9969
|
- name: client_id
|
|
9895
9970
|
required: true
|
|
@@ -10015,15 +10090,16 @@ paths:
|
|
|
10015
10090
|
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
10016
10091
|
required:
|
|
10017
10092
|
- message
|
|
10093
|
+
security: []
|
|
10094
|
+
summary: Get a Profile and Token
|
|
10018
10095
|
tags:
|
|
10019
10096
|
- sso
|
|
10020
10097
|
/user_management/authenticate:
|
|
10021
10098
|
post:
|
|
10022
|
-
operationId: UserlandSessionsController_authenticate
|
|
10023
|
-
summary: Authenticate
|
|
10024
10099
|
description: >-
|
|
10025
10100
|
Authenticate a user with a specified [authentication
|
|
10026
10101
|
method](/reference/authkit/authentication).
|
|
10102
|
+
operationId: UserlandSessionsController_authenticate[0]
|
|
10027
10103
|
parameters: []
|
|
10028
10104
|
requestBody:
|
|
10029
10105
|
required: true
|
|
@@ -11052,16 +11128,15 @@ paths:
|
|
|
11052
11128
|
required:
|
|
11053
11129
|
- code
|
|
11054
11130
|
- message
|
|
11131
|
+
summary: Authenticate
|
|
11055
11132
|
tags:
|
|
11056
11133
|
- user-management.authentication
|
|
11057
11134
|
/user_management/authorize:
|
|
11058
11135
|
get:
|
|
11059
|
-
operationId: UserlandSsoController_authorize
|
|
11060
|
-
summary: Get an authorization URL
|
|
11061
11136
|
description: >-
|
|
11062
11137
|
Generates an OAuth 2.0 authorization URL to authenticate a user with
|
|
11063
11138
|
AuthKit or SSO.
|
|
11064
|
-
|
|
11139
|
+
operationId: UserlandSsoController_authorize
|
|
11065
11140
|
parameters:
|
|
11066
11141
|
- name: code_challenge_method
|
|
11067
11142
|
required: false
|
|
@@ -11239,19 +11314,19 @@ paths:
|
|
|
11239
11314
|
type: string
|
|
11240
11315
|
format: uri
|
|
11241
11316
|
description: ''
|
|
11317
|
+
security: []
|
|
11318
|
+
summary: Get an authorization URL
|
|
11242
11319
|
tags:
|
|
11243
11320
|
- user-management.authentication
|
|
11244
11321
|
/user_management/authorize/device:
|
|
11245
11322
|
post:
|
|
11246
|
-
operationId: UserlandSsoController_deviceAuthorization
|
|
11247
|
-
summary: Get device authorization URL
|
|
11248
11323
|
description: >-
|
|
11249
11324
|
Initiates the CLI Auth flow by requesting a device code and verification
|
|
11250
11325
|
URLs. This endpoint implements the OAuth 2.0 Device Authorization Flow
|
|
11251
11326
|
([RFC 8628](https://datatracker.ietf.org/doc/html/rfc8628)) and is
|
|
11252
11327
|
designed for command-line applications or other devices with limited
|
|
11253
11328
|
input capabilities.
|
|
11254
|
-
|
|
11329
|
+
operationId: UserlandSsoController_deviceAuthorization
|
|
11255
11330
|
parameters: []
|
|
11256
11331
|
requestBody:
|
|
11257
11332
|
required: true
|
|
@@ -11309,15 +11384,16 @@ paths:
|
|
|
11309
11384
|
required:
|
|
11310
11385
|
- error
|
|
11311
11386
|
- error_description
|
|
11387
|
+
security: []
|
|
11388
|
+
summary: Get device authorization URL
|
|
11312
11389
|
tags:
|
|
11313
11390
|
- user-management.authentication
|
|
11314
11391
|
/user_management/cors_origins:
|
|
11315
11392
|
post:
|
|
11316
|
-
operationId: CorsOriginsController_createCorsOrigin
|
|
11317
|
-
summary: Create a CORS origin
|
|
11318
11393
|
description: >-
|
|
11319
11394
|
Creates a new CORS origin for the current environment. CORS origins
|
|
11320
11395
|
allow browser-based applications to make requests to the WorkOS API.
|
|
11396
|
+
operationId: CorsOriginsController_createCorsOrigin
|
|
11321
11397
|
parameters: []
|
|
11322
11398
|
requestBody:
|
|
11323
11399
|
required: true
|
|
@@ -11370,15 +11446,15 @@ paths:
|
|
|
11370
11446
|
example: origin
|
|
11371
11447
|
constraints:
|
|
11372
11448
|
type: object
|
|
11449
|
+
summary: Create a CORS origin
|
|
11373
11450
|
tags:
|
|
11374
11451
|
- user-management.cors-origins
|
|
11375
11452
|
/user_management/email_verification/{id}:
|
|
11376
11453
|
get:
|
|
11377
|
-
operationId: UserlandUsersController_getEmailVerification
|
|
11378
|
-
summary: Get an email verification code
|
|
11379
11454
|
description: >-
|
|
11380
11455
|
Get the details of an existing email verification code that can be used
|
|
11381
11456
|
to send an email to a user for verification.
|
|
11457
|
+
operationId: UserlandUsersController_getEmailVerification
|
|
11382
11458
|
parameters:
|
|
11383
11459
|
- name: id
|
|
11384
11460
|
required: true
|
|
@@ -11407,13 +11483,13 @@ paths:
|
|
|
11407
11483
|
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
11408
11484
|
required:
|
|
11409
11485
|
- message
|
|
11486
|
+
summary: Get an email verification code
|
|
11410
11487
|
tags:
|
|
11411
11488
|
- user-management.users
|
|
11412
11489
|
/user_management/invitations:
|
|
11413
11490
|
get:
|
|
11414
|
-
operationId: UserlandUserInvitesController_list
|
|
11415
|
-
summary: List invitations
|
|
11416
11491
|
description: Get a list of all of invitations matching the criteria specified.
|
|
11492
|
+
operationId: UserlandUserInvitesController_list
|
|
11417
11493
|
parameters:
|
|
11418
11494
|
- name: before
|
|
11419
11495
|
required: false
|
|
@@ -11460,13 +11536,7 @@ paths:
|
|
|
11460
11536
|
reversed cursor semantics where `before` fetches older records and
|
|
11461
11537
|
`after` fetches newer records). Defaults to descending.
|
|
11462
11538
|
schema:
|
|
11463
|
-
|
|
11464
|
-
example: desc
|
|
11465
|
-
enum:
|
|
11466
|
-
- normal
|
|
11467
|
-
- desc
|
|
11468
|
-
- asc
|
|
11469
|
-
type: string
|
|
11539
|
+
$ref: '#/components/schemas/PaginationOrder'
|
|
11470
11540
|
- name: organization_id
|
|
11471
11541
|
required: false
|
|
11472
11542
|
in: query
|
|
@@ -11481,6 +11551,7 @@ paths:
|
|
|
11481
11551
|
in: query
|
|
11482
11552
|
description: The email address of the recipient.
|
|
11483
11553
|
schema:
|
|
11554
|
+
format: email
|
|
11484
11555
|
example: marcelina.davis@example.com
|
|
11485
11556
|
type: string
|
|
11486
11557
|
responses:
|
|
@@ -11549,12 +11620,12 @@ paths:
|
|
|
11549
11620
|
required:
|
|
11550
11621
|
- code
|
|
11551
11622
|
- message
|
|
11623
|
+
summary: List invitations
|
|
11552
11624
|
tags:
|
|
11553
11625
|
- user-management.invitations
|
|
11554
11626
|
post:
|
|
11555
|
-
operationId: UserlandUserInvitesController_create
|
|
11556
|
-
summary: Send an invitation
|
|
11557
11627
|
description: Sends an invitation email to the recipient.
|
|
11628
|
+
operationId: UserlandUserInvitesController_create
|
|
11558
11629
|
parameters: []
|
|
11559
11630
|
requestBody:
|
|
11560
11631
|
required: true
|
|
@@ -11705,14 +11776,14 @@ paths:
|
|
|
11705
11776
|
required:
|
|
11706
11777
|
- code
|
|
11707
11778
|
- message
|
|
11779
|
+
summary: Send an invitation
|
|
11708
11780
|
tags:
|
|
11709
11781
|
- user-management.invitations
|
|
11710
11782
|
x-sends-email: true
|
|
11711
11783
|
/user_management/invitations/by_token/{token}:
|
|
11712
11784
|
get:
|
|
11713
|
-
operationId: UserlandUserInvitesController_getByToken
|
|
11714
|
-
summary: Find an invitation by token
|
|
11715
11785
|
description: Retrieve an existing invitation using the token.
|
|
11786
|
+
operationId: UserlandUserInvitesController_getByToken
|
|
11716
11787
|
parameters:
|
|
11717
11788
|
- name: token
|
|
11718
11789
|
required: true
|
|
@@ -11741,13 +11812,13 @@ paths:
|
|
|
11741
11812
|
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
11742
11813
|
required:
|
|
11743
11814
|
- message
|
|
11815
|
+
summary: Find an invitation by token
|
|
11744
11816
|
tags:
|
|
11745
11817
|
- user-management.invitations
|
|
11746
11818
|
/user_management/invitations/{id}:
|
|
11747
11819
|
get:
|
|
11748
|
-
operationId: UserlandUserInvitesController_get
|
|
11749
|
-
summary: Get an invitation
|
|
11750
11820
|
description: Get the details of an existing invitation.
|
|
11821
|
+
operationId: UserlandUserInvitesController_get
|
|
11751
11822
|
parameters:
|
|
11752
11823
|
- name: id
|
|
11753
11824
|
required: true
|
|
@@ -11776,15 +11847,15 @@ paths:
|
|
|
11776
11847
|
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
11777
11848
|
required:
|
|
11778
11849
|
- message
|
|
11850
|
+
summary: Get an invitation
|
|
11779
11851
|
tags:
|
|
11780
11852
|
- user-management.invitations
|
|
11781
11853
|
/user_management/invitations/{id}/accept:
|
|
11782
11854
|
post:
|
|
11783
|
-
operationId: UserlandUserInvitesController_accept
|
|
11784
|
-
summary: Accept an invitation
|
|
11785
11855
|
description: >-
|
|
11786
11856
|
Accepts an invitation and, if linked to an organization, activates the
|
|
11787
11857
|
user's membership in that organization.
|
|
11858
|
+
operationId: UserlandUserInvitesController_accept
|
|
11788
11859
|
parameters:
|
|
11789
11860
|
- name: id
|
|
11790
11861
|
required: true
|
|
@@ -11946,15 +12017,15 @@ paths:
|
|
|
11946
12017
|
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
11947
12018
|
required:
|
|
11948
12019
|
- message
|
|
12020
|
+
summary: Accept an invitation
|
|
11949
12021
|
tags:
|
|
11950
12022
|
- user-management.invitations
|
|
11951
12023
|
/user_management/invitations/{id}/resend:
|
|
11952
12024
|
post:
|
|
11953
|
-
operationId: UserlandUserInvitesController_resend
|
|
11954
|
-
summary: Resend an invitation
|
|
11955
12025
|
description: >-
|
|
11956
12026
|
Resends an invitation email to the recipient. The invitation must be in
|
|
11957
12027
|
a pending state.
|
|
12028
|
+
operationId: UserlandUserInvitesController_resend
|
|
11958
12029
|
parameters:
|
|
11959
12030
|
- name: id
|
|
11960
12031
|
required: true
|
|
@@ -12050,14 +12121,14 @@ paths:
|
|
|
12050
12121
|
required:
|
|
12051
12122
|
- code
|
|
12052
12123
|
- message
|
|
12124
|
+
summary: Resend an invitation
|
|
12053
12125
|
tags:
|
|
12054
12126
|
- user-management.invitations
|
|
12055
12127
|
x-sends-email: true
|
|
12056
12128
|
/user_management/invitations/{id}/revoke:
|
|
12057
12129
|
post:
|
|
12058
|
-
operationId: UserlandUserInvitesController_revoke
|
|
12059
|
-
summary: Revoke an invitation
|
|
12060
12130
|
description: Revokes an existing invitation.
|
|
12131
|
+
operationId: UserlandUserInvitesController_revoke
|
|
12061
12132
|
parameters:
|
|
12062
12133
|
- name: id
|
|
12063
12134
|
required: true
|
|
@@ -12205,13 +12276,13 @@ paths:
|
|
|
12205
12276
|
required:
|
|
12206
12277
|
- code
|
|
12207
12278
|
- message
|
|
12279
|
+
summary: Revoke an invitation
|
|
12208
12280
|
tags:
|
|
12209
12281
|
- user-management.invitations
|
|
12210
12282
|
/user_management/jwt_template:
|
|
12211
12283
|
get:
|
|
12212
|
-
operationId: JwtTemplatesController_getJwtTemplate
|
|
12213
|
-
summary: Get JWT template
|
|
12214
12284
|
description: Get the JWT template for the current environment.
|
|
12285
|
+
operationId: JwtTemplatesController_getJwtTemplate
|
|
12215
12286
|
parameters: []
|
|
12216
12287
|
responses:
|
|
12217
12288
|
'200':
|
|
@@ -12233,12 +12304,12 @@ paths:
|
|
|
12233
12304
|
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
12234
12305
|
required:
|
|
12235
12306
|
- message
|
|
12307
|
+
summary: Get JWT template
|
|
12236
12308
|
tags:
|
|
12237
12309
|
- user-management.jwt-template
|
|
12238
12310
|
put:
|
|
12239
|
-
operationId: JwtTemplatesController_updateJwtTemplate
|
|
12240
|
-
summary: Update JWT template
|
|
12241
12311
|
description: Update the JWT template for the current environment.
|
|
12312
|
+
operationId: JwtTemplatesController_updateJwtTemplate
|
|
12242
12313
|
parameters: []
|
|
12243
12314
|
requestBody:
|
|
12244
12315
|
required: true
|
|
@@ -12272,17 +12343,17 @@ paths:
|
|
|
12272
12343
|
required:
|
|
12273
12344
|
- code
|
|
12274
12345
|
- message
|
|
12346
|
+
summary: Update JWT template
|
|
12275
12347
|
tags:
|
|
12276
12348
|
- user-management.jwt-template
|
|
12277
12349
|
/user_management/magic_auth:
|
|
12278
12350
|
post:
|
|
12279
|
-
operationId: UserlandMagicAuthController_sendMagicAuthCodeAndReturn
|
|
12280
|
-
summary: Create a Magic Auth code
|
|
12281
12351
|
description: >-
|
|
12282
12352
|
Creates a one-time authentication code that can be sent to the user's
|
|
12283
12353
|
email address. The code expires in 10 minutes. To verify the code,
|
|
12284
12354
|
[authenticate the user with Magic
|
|
12285
12355
|
Auth](/reference/authkit/authentication/magic-auth).
|
|
12356
|
+
operationId: UserlandMagicAuthController_sendMagicAuthCodeAndReturn
|
|
12286
12357
|
parameters: []
|
|
12287
12358
|
requestBody:
|
|
12288
12359
|
required: true
|
|
@@ -12379,17 +12450,17 @@ paths:
|
|
|
12379
12450
|
required:
|
|
12380
12451
|
- code
|
|
12381
12452
|
- message
|
|
12453
|
+
summary: Create a Magic Auth code
|
|
12382
12454
|
tags:
|
|
12383
12455
|
- user-management.magic-auth
|
|
12384
12456
|
x-sends-email: true
|
|
12385
12457
|
/user_management/magic_auth/{id}:
|
|
12386
12458
|
get:
|
|
12387
|
-
operationId: UserlandMagicAuthController_get
|
|
12388
|
-
summary: Get Magic Auth code details
|
|
12389
12459
|
description: >-
|
|
12390
12460
|
Get the details of an existing [Magic
|
|
12391
12461
|
Auth](/reference/authkit/magic-auth) code that can be used to send an
|
|
12392
12462
|
email to a user for authentication.
|
|
12463
|
+
operationId: UserlandMagicAuthController_get
|
|
12393
12464
|
parameters:
|
|
12394
12465
|
- name: id
|
|
12395
12466
|
required: true
|
|
@@ -12418,17 +12489,17 @@ paths:
|
|
|
12418
12489
|
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
12419
12490
|
required:
|
|
12420
12491
|
- message
|
|
12492
|
+
summary: Get Magic Auth code details
|
|
12421
12493
|
tags:
|
|
12422
12494
|
- user-management.magic-auth
|
|
12423
12495
|
/user_management/organization_memberships:
|
|
12424
12496
|
get:
|
|
12425
|
-
operationId: UserlandUserOrganizationMembershipsController_list
|
|
12426
|
-
summary: List organization memberships
|
|
12427
12497
|
description: >-
|
|
12428
12498
|
Get a list of all organization memberships matching the criteria
|
|
12429
12499
|
specified. At least one of `user_id` or `organization_id` must be
|
|
12430
12500
|
provided. By default only active memberships are returned. Use the
|
|
12431
12501
|
`statuses` parameter to filter by other statuses.
|
|
12502
|
+
operationId: UserlandUserOrganizationMembershipsController_list
|
|
12432
12503
|
parameters:
|
|
12433
12504
|
- name: before
|
|
12434
12505
|
required: false
|
|
@@ -12475,13 +12546,7 @@ paths:
|
|
|
12475
12546
|
reversed cursor semantics where `before` fetches older records and
|
|
12476
12547
|
`after` fetches newer records). Defaults to descending.
|
|
12477
12548
|
schema:
|
|
12478
|
-
|
|
12479
|
-
example: desc
|
|
12480
|
-
enum:
|
|
12481
|
-
- normal
|
|
12482
|
-
- desc
|
|
12483
|
-
- asc
|
|
12484
|
-
type: string
|
|
12549
|
+
$ref: '#/components/schemas/PaginationOrder'
|
|
12485
12550
|
- name: organization_id
|
|
12486
12551
|
required: false
|
|
12487
12552
|
in: query
|
|
@@ -12624,11 +12689,10 @@ paths:
|
|
|
12624
12689
|
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
12625
12690
|
required:
|
|
12626
12691
|
- message
|
|
12692
|
+
summary: List organization memberships
|
|
12627
12693
|
tags:
|
|
12628
12694
|
- user-management.organization-membership
|
|
12629
12695
|
post:
|
|
12630
|
-
operationId: UserlandUserOrganizationMembershipsController_create
|
|
12631
|
-
summary: Create an organization membership
|
|
12632
12696
|
description: >-
|
|
12633
12697
|
Creates a new `active` organization membership for the given
|
|
12634
12698
|
organization and user.
|
|
@@ -12637,6 +12701,7 @@ paths:
|
|
|
12637
12701
|
Calling this API with an organization and user that match an `inactive`
|
|
12638
12702
|
organization membership will activate the membership with the specified
|
|
12639
12703
|
role(s).
|
|
12704
|
+
operationId: UserlandUserOrganizationMembershipsController_create
|
|
12640
12705
|
parameters: []
|
|
12641
12706
|
requestBody:
|
|
12642
12707
|
required: true
|
|
@@ -12836,6 +12901,7 @@ paths:
|
|
|
12836
12901
|
- message
|
|
12837
12902
|
- code
|
|
12838
12903
|
- role_slug
|
|
12904
|
+
summary: Create an organization membership
|
|
12839
12905
|
tags:
|
|
12840
12906
|
- user-management.organization-membership
|
|
12841
12907
|
x-mutually-exclusive-body-groups: &ref_9
|
|
@@ -12848,9 +12914,8 @@ paths:
|
|
|
12848
12914
|
- role_slugs
|
|
12849
12915
|
/user_management/organization_memberships/{id}:
|
|
12850
12916
|
get:
|
|
12851
|
-
operationId: UserlandUserOrganizationMembershipsController_get
|
|
12852
|
-
summary: Get an organization membership
|
|
12853
12917
|
description: Get the details of an existing organization membership.
|
|
12918
|
+
operationId: UserlandUserOrganizationMembershipsController_get
|
|
12854
12919
|
parameters:
|
|
12855
12920
|
- name: id
|
|
12856
12921
|
required: true
|
|
@@ -12879,14 +12944,14 @@ paths:
|
|
|
12879
12944
|
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
12880
12945
|
required:
|
|
12881
12946
|
- message
|
|
12947
|
+
summary: Get an organization membership
|
|
12882
12948
|
tags:
|
|
12883
12949
|
- user-management.organization-membership
|
|
12884
12950
|
delete:
|
|
12885
|
-
operationId: UserlandUserOrganizationMembershipsController_delete
|
|
12886
|
-
summary: Delete an organization membership
|
|
12887
12951
|
description: >-
|
|
12888
12952
|
Permanently deletes an existing organization membership. It cannot be
|
|
12889
12953
|
undone.
|
|
12954
|
+
operationId: UserlandUserOrganizationMembershipsController_delete
|
|
12890
12955
|
parameters:
|
|
12891
12956
|
- name: id
|
|
12892
12957
|
required: true
|
|
@@ -12911,12 +12976,12 @@ paths:
|
|
|
12911
12976
|
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
12912
12977
|
required:
|
|
12913
12978
|
- message
|
|
12979
|
+
summary: Delete an organization membership
|
|
12914
12980
|
tags:
|
|
12915
12981
|
- user-management.organization-membership
|
|
12916
12982
|
put:
|
|
12917
|
-
operationId: UserlandUserOrganizationMembershipsController_update
|
|
12918
|
-
summary: Update an organization membership
|
|
12919
12983
|
description: Update the details of an existing organization membership.
|
|
12984
|
+
operationId: UserlandUserOrganizationMembershipsController_update
|
|
12920
12985
|
parameters:
|
|
12921
12986
|
- name: id
|
|
12922
12987
|
required: true
|
|
@@ -13020,6 +13085,7 @@ paths:
|
|
|
13020
13085
|
- message
|
|
13021
13086
|
- code
|
|
13022
13087
|
- role_slug
|
|
13088
|
+
summary: Update an organization membership
|
|
13023
13089
|
tags:
|
|
13024
13090
|
- user-management.organization-membership
|
|
13025
13091
|
x-mutually-exclusive-body-groups: &ref_10
|
|
@@ -13032,8 +13098,6 @@ paths:
|
|
|
13032
13098
|
- role_slugs
|
|
13033
13099
|
/user_management/organization_memberships/{id}/deactivate:
|
|
13034
13100
|
put:
|
|
13035
|
-
operationId: UserlandUserOrganizationMembershipsController_deactivate
|
|
13036
|
-
summary: Deactivate an organization membership
|
|
13037
13101
|
description: >-
|
|
13038
13102
|
Deactivates an `active` organization membership. Emits an
|
|
13039
13103
|
[organization_membership.updated](/events/organization-membership) event
|
|
@@ -13051,6 +13115,7 @@ paths:
|
|
|
13051
13115
|
See the [membership management
|
|
13052
13116
|
documentation](/authkit/users-organizations/organizations/membership-management)
|
|
13053
13117
|
for additional details.
|
|
13118
|
+
operationId: UserlandUserOrganizationMembershipsController_deactivate
|
|
13054
13119
|
parameters:
|
|
13055
13120
|
- name: id
|
|
13056
13121
|
required: true
|
|
@@ -13201,12 +13266,11 @@ paths:
|
|
|
13201
13266
|
required:
|
|
13202
13267
|
- code
|
|
13203
13268
|
- message
|
|
13269
|
+
summary: Deactivate an organization membership
|
|
13204
13270
|
tags:
|
|
13205
13271
|
- user-management.organization-membership
|
|
13206
13272
|
/user_management/organization_memberships/{id}/reactivate:
|
|
13207
13273
|
put:
|
|
13208
|
-
operationId: UserlandUserOrganizationMembershipsController_reactivate
|
|
13209
|
-
summary: Reactivate an organization membership
|
|
13210
13274
|
description: >-
|
|
13211
13275
|
Reactivates an `inactive` organization membership, retaining the
|
|
13212
13276
|
pre-existing role(s). Emits an
|
|
@@ -13224,6 +13288,7 @@ paths:
|
|
|
13224
13288
|
See the [membership management
|
|
13225
13289
|
documentation](/authkit/users-organizations/organizations/membership-management)
|
|
13226
13290
|
for additional details.
|
|
13291
|
+
operationId: UserlandUserOrganizationMembershipsController_reactivate
|
|
13227
13292
|
parameters:
|
|
13228
13293
|
- name: id
|
|
13229
13294
|
required: true
|
|
@@ -13292,13 +13357,13 @@ paths:
|
|
|
13292
13357
|
required:
|
|
13293
13358
|
- code
|
|
13294
13359
|
- message
|
|
13360
|
+
summary: Reactivate an organization membership
|
|
13295
13361
|
tags:
|
|
13296
13362
|
- user-management.organization-membership
|
|
13297
13363
|
/user_management/organization_memberships/{omId}/groups:
|
|
13298
13364
|
get:
|
|
13299
|
-
operationId: OrganizationMembershipGroupsController_listGroups
|
|
13300
|
-
summary: List groups
|
|
13301
13365
|
description: Get a list of groups that an organization membership belongs to.
|
|
13366
|
+
operationId: OrganizationMembershipGroupsController_listGroups
|
|
13302
13367
|
parameters:
|
|
13303
13368
|
- name: omId
|
|
13304
13369
|
required: true
|
|
@@ -13352,13 +13417,7 @@ paths:
|
|
|
13352
13417
|
reversed cursor semantics where `before` fetches older records and
|
|
13353
13418
|
`after` fetches newer records). Defaults to descending.
|
|
13354
13419
|
schema:
|
|
13355
|
-
|
|
13356
|
-
example: desc
|
|
13357
|
-
enum:
|
|
13358
|
-
- normal
|
|
13359
|
-
- desc
|
|
13360
|
-
- asc
|
|
13361
|
-
type: string
|
|
13420
|
+
$ref: '#/components/schemas/PaginationOrder'
|
|
13362
13421
|
responses:
|
|
13363
13422
|
'200':
|
|
13364
13423
|
description: OK
|
|
@@ -13379,14 +13438,14 @@ paths:
|
|
|
13379
13438
|
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
13380
13439
|
required:
|
|
13381
13440
|
- message
|
|
13441
|
+
summary: List groups
|
|
13382
13442
|
tags:
|
|
13383
13443
|
- user-management.organization-membership.groups
|
|
13384
13444
|
x-feature-flag: user-groups-enabled
|
|
13385
13445
|
/user_management/password_reset:
|
|
13386
13446
|
post:
|
|
13387
|
-
operationId: UserlandUsersController_createPasswordResetToken
|
|
13388
|
-
summary: Create a password reset token
|
|
13389
13447
|
description: Creates a one-time token that can be used to reset a user's password.
|
|
13448
|
+
operationId: UserlandUsersController_createPasswordResetToken
|
|
13390
13449
|
parameters: []
|
|
13391
13450
|
requestBody:
|
|
13392
13451
|
required: true
|
|
@@ -13486,17 +13545,17 @@ paths:
|
|
|
13486
13545
|
required:
|
|
13487
13546
|
- code
|
|
13488
13547
|
- message
|
|
13548
|
+
summary: Create a password reset token
|
|
13489
13549
|
tags:
|
|
13490
13550
|
- user-management.users
|
|
13491
13551
|
x-sends-email: true
|
|
13492
13552
|
/user_management/password_reset/confirm:
|
|
13493
13553
|
post:
|
|
13494
|
-
operationId: UserlandUsersController_resetPassword
|
|
13495
|
-
summary: Reset the password
|
|
13496
13554
|
description: >-
|
|
13497
13555
|
Sets a new password using the `token` query parameter from the link that
|
|
13498
13556
|
the user received. Successfully resetting the password will verify a
|
|
13499
13557
|
user's email, if it hasn't been verified yet.
|
|
13558
|
+
operationId: UserlandUsersController_resetPassword[0]
|
|
13500
13559
|
parameters: []
|
|
13501
13560
|
requestBody:
|
|
13502
13561
|
required: true
|
|
@@ -13601,15 +13660,15 @@ paths:
|
|
|
13601
13660
|
required:
|
|
13602
13661
|
- code
|
|
13603
13662
|
- message
|
|
13663
|
+
summary: Reset the password
|
|
13604
13664
|
tags:
|
|
13605
13665
|
- user-management.users
|
|
13606
13666
|
/user_management/password_reset/{id}:
|
|
13607
13667
|
get:
|
|
13608
|
-
operationId: UserlandUsersController_getPasswordReset
|
|
13609
|
-
summary: Get a password reset token
|
|
13610
13668
|
description: >-
|
|
13611
13669
|
Get the details of an existing password reset token that can be used to
|
|
13612
13670
|
reset a user's password.
|
|
13671
|
+
operationId: UserlandUsersController_getPasswordReset
|
|
13613
13672
|
parameters:
|
|
13614
13673
|
- name: id
|
|
13615
13674
|
required: true
|
|
@@ -13638,13 +13697,13 @@ paths:
|
|
|
13638
13697
|
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
13639
13698
|
required:
|
|
13640
13699
|
- message
|
|
13700
|
+
summary: Get a password reset token
|
|
13641
13701
|
tags:
|
|
13642
13702
|
- user-management.users
|
|
13643
13703
|
/user_management/redirect_uris:
|
|
13644
13704
|
post:
|
|
13645
|
-
operationId: RedirectUrisController_create
|
|
13646
|
-
summary: Create a redirect URI
|
|
13647
13705
|
description: Creates a new redirect URI for an environment.
|
|
13706
|
+
operationId: RedirectUrisController_create
|
|
13648
13707
|
parameters: []
|
|
13649
13708
|
requestBody:
|
|
13650
13709
|
required: true
|
|
@@ -13711,14 +13770,13 @@ paths:
|
|
|
13711
13770
|
- message
|
|
13712
13771
|
example:
|
|
13713
13772
|
message: Redirect URI 'https://example.com/callback' already exists.
|
|
13773
|
+
summary: Create a redirect URI
|
|
13714
13774
|
tags:
|
|
13715
13775
|
- user-management.redirect-uris
|
|
13716
13776
|
/user_management/sessions/logout:
|
|
13717
13777
|
get:
|
|
13718
|
-
operationId: UserlandSessionsController_logout
|
|
13719
|
-
summary: Logout
|
|
13720
|
-
security: []
|
|
13721
13778
|
description: Logout a user from the current [session](/reference/authkit/session).
|
|
13779
|
+
operationId: UserlandSessionsController_logout
|
|
13722
13780
|
parameters:
|
|
13723
13781
|
- name: session_id
|
|
13724
13782
|
required: true
|
|
@@ -13764,13 +13822,14 @@ paths:
|
|
|
13764
13822
|
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
13765
13823
|
required:
|
|
13766
13824
|
- message
|
|
13825
|
+
security: []
|
|
13826
|
+
summary: Logout
|
|
13767
13827
|
tags:
|
|
13768
13828
|
- user-management.authentication
|
|
13769
13829
|
/user_management/sessions/revoke:
|
|
13770
13830
|
post:
|
|
13771
|
-
operationId: UserlandSessionsController_revokeSession
|
|
13772
|
-
summary: Revoke Session
|
|
13773
13831
|
description: Revoke a [user session](/reference/authkit/session).
|
|
13832
|
+
operationId: UserlandSessionsController_revokeSession
|
|
13774
13833
|
parameters: []
|
|
13775
13834
|
requestBody:
|
|
13776
13835
|
required: true
|
|
@@ -13794,15 +13853,15 @@ paths:
|
|
|
13794
13853
|
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
13795
13854
|
required:
|
|
13796
13855
|
- message
|
|
13856
|
+
summary: Revoke Session
|
|
13797
13857
|
tags:
|
|
13798
13858
|
- user-management.authentication
|
|
13799
13859
|
/user_management/users:
|
|
13800
13860
|
get:
|
|
13801
|
-
operationId: UserlandUsersController_list
|
|
13802
|
-
summary: List users
|
|
13803
13861
|
description: >-
|
|
13804
13862
|
Get a list of all of your existing users matching the criteria
|
|
13805
13863
|
specified.
|
|
13864
|
+
operationId: UserlandUsersController_list[0]
|
|
13806
13865
|
parameters:
|
|
13807
13866
|
- name: before
|
|
13808
13867
|
required: false
|
|
@@ -13849,13 +13908,7 @@ paths:
|
|
|
13849
13908
|
reversed cursor semantics where `before` fetches older records and
|
|
13850
13909
|
`after` fetches newer records). Defaults to descending.
|
|
13851
13910
|
schema:
|
|
13852
|
-
|
|
13853
|
-
example: desc
|
|
13854
|
-
enum:
|
|
13855
|
-
- normal
|
|
13856
|
-
- desc
|
|
13857
|
-
- asc
|
|
13858
|
-
type: string
|
|
13911
|
+
$ref: '#/components/schemas/PaginationOrder'
|
|
13859
13912
|
- name: organization
|
|
13860
13913
|
required: false
|
|
13861
13914
|
in: query
|
|
@@ -13900,12 +13953,12 @@ paths:
|
|
|
13900
13953
|
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
13901
13954
|
required:
|
|
13902
13955
|
- message
|
|
13956
|
+
summary: List users
|
|
13903
13957
|
tags:
|
|
13904
13958
|
- user-management.users
|
|
13905
13959
|
post:
|
|
13906
|
-
operationId: UserlandUsersController_create
|
|
13907
|
-
summary: Create a user
|
|
13908
13960
|
description: Create a new user in the current environment.
|
|
13961
|
+
operationId: UserlandUsersController_create[0]
|
|
13909
13962
|
parameters: []
|
|
13910
13963
|
requestBody:
|
|
13911
13964
|
required: true
|
|
@@ -14082,6 +14135,7 @@ paths:
|
|
|
14082
14135
|
required:
|
|
14083
14136
|
- code
|
|
14084
14137
|
- message
|
|
14138
|
+
summary: Create a user
|
|
14085
14139
|
tags:
|
|
14086
14140
|
- user-management.users
|
|
14087
14141
|
x-mutually-exclusive-body-groups: &ref_11
|
|
@@ -14095,11 +14149,10 @@ paths:
|
|
|
14095
14149
|
- password_hash_type
|
|
14096
14150
|
/user_management/users/external_id/{external_id}:
|
|
14097
14151
|
get:
|
|
14098
|
-
operationId: UserlandUsersController_getByExternalId
|
|
14099
|
-
summary: Get a user by external ID
|
|
14100
14152
|
description: >-
|
|
14101
14153
|
Get the details of an existing user by an [external
|
|
14102
14154
|
identifier](/authkit/metadata/external-identifiers).
|
|
14155
|
+
operationId: UserlandUsersController_getByExternalId
|
|
14103
14156
|
parameters:
|
|
14104
14157
|
- name: external_id
|
|
14105
14158
|
required: true
|
|
@@ -14128,15 +14181,15 @@ paths:
|
|
|
14128
14181
|
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
14129
14182
|
required:
|
|
14130
14183
|
- message
|
|
14184
|
+
summary: Get a user by external ID
|
|
14131
14185
|
tags:
|
|
14132
14186
|
- user-management.users
|
|
14133
14187
|
/user_management/users/{id}:
|
|
14134
14188
|
put:
|
|
14135
|
-
operationId: UserlandUsersController_update
|
|
14136
|
-
summary: Update a user
|
|
14137
14189
|
description: >-
|
|
14138
14190
|
Updates properties of a user. The omitted properties will be left
|
|
14139
14191
|
unchanged.
|
|
14192
|
+
operationId: UserlandUsersController_update[0]
|
|
14140
14193
|
parameters:
|
|
14141
14194
|
- name: id
|
|
14142
14195
|
required: true
|
|
@@ -14357,6 +14410,7 @@ paths:
|
|
|
14357
14410
|
required:
|
|
14358
14411
|
- code
|
|
14359
14412
|
- message
|
|
14413
|
+
summary: Update a user
|
|
14360
14414
|
tags:
|
|
14361
14415
|
- user-management.users
|
|
14362
14416
|
x-mutually-exclusive-body-groups: &ref_14
|
|
@@ -14369,9 +14423,8 @@ paths:
|
|
|
14369
14423
|
- password_hash
|
|
14370
14424
|
- password_hash_type
|
|
14371
14425
|
get:
|
|
14372
|
-
operationId: UserlandUsersController_get
|
|
14373
|
-
summary: Get a user
|
|
14374
14426
|
description: Get the details of an existing user.
|
|
14427
|
+
operationId: UserlandUsersController_get[0]
|
|
14375
14428
|
parameters:
|
|
14376
14429
|
- name: id
|
|
14377
14430
|
required: true
|
|
@@ -14400,14 +14453,14 @@ paths:
|
|
|
14400
14453
|
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
14401
14454
|
required:
|
|
14402
14455
|
- message
|
|
14456
|
+
summary: Get a user
|
|
14403
14457
|
tags:
|
|
14404
14458
|
- user-management.users
|
|
14405
14459
|
delete:
|
|
14406
|
-
operationId: UserlandUsersController_delete
|
|
14407
|
-
summary: Delete a user
|
|
14408
14460
|
description: >-
|
|
14409
14461
|
Permanently deletes a user in the current environment. It cannot be
|
|
14410
14462
|
undone.
|
|
14463
|
+
operationId: UserlandUsersController_delete[0]
|
|
14411
14464
|
parameters:
|
|
14412
14465
|
- name: id
|
|
14413
14466
|
required: true
|
|
@@ -14432,13 +14485,13 @@ paths:
|
|
|
14432
14485
|
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
14433
14486
|
required:
|
|
14434
14487
|
- message
|
|
14488
|
+
summary: Delete a user
|
|
14435
14489
|
tags:
|
|
14436
14490
|
- user-management.users
|
|
14437
14491
|
/user_management/users/{id}/email_change/confirm:
|
|
14438
14492
|
post:
|
|
14439
|
-
operationId: UserlandUsersController_confirmEmailChange
|
|
14440
|
-
summary: Confirm email change
|
|
14441
14493
|
description: Confirms an email change using the one-time code received by the user.
|
|
14494
|
+
operationId: UserlandUsersController_confirmEmailChange
|
|
14442
14495
|
parameters:
|
|
14443
14496
|
- name: id
|
|
14444
14497
|
required: true
|
|
@@ -14723,15 +14776,15 @@ paths:
|
|
|
14723
14776
|
required:
|
|
14724
14777
|
- code
|
|
14725
14778
|
- message
|
|
14779
|
+
summary: Confirm email change
|
|
14726
14780
|
tags:
|
|
14727
14781
|
- user-management.users
|
|
14728
14782
|
/user_management/users/{id}/email_change/send:
|
|
14729
14783
|
post:
|
|
14730
|
-
operationId: UserlandUsersController_sendEmailChange
|
|
14731
|
-
summary: Send email change code
|
|
14732
14784
|
description: >-
|
|
14733
14785
|
Sends an email that contains a one-time code used to change a user's
|
|
14734
14786
|
email address.
|
|
14787
|
+
operationId: UserlandUsersController_sendEmailChange
|
|
14735
14788
|
parameters:
|
|
14736
14789
|
- name: id
|
|
14737
14790
|
required: true
|
|
@@ -14867,14 +14920,14 @@ paths:
|
|
|
14867
14920
|
required:
|
|
14868
14921
|
- code
|
|
14869
14922
|
- message
|
|
14923
|
+
summary: Send email change code
|
|
14870
14924
|
tags:
|
|
14871
14925
|
- user-management.users
|
|
14872
14926
|
x-sends-email: true
|
|
14873
14927
|
/user_management/users/{id}/email_verification/confirm:
|
|
14874
14928
|
post:
|
|
14875
|
-
operationId: UserlandUsersController_emailVerification
|
|
14876
|
-
summary: Verify email
|
|
14877
14929
|
description: Verifies an email address using the one-time code received by the user.
|
|
14930
|
+
operationId: UserlandUsersController_emailVerification[0]
|
|
14878
14931
|
parameters:
|
|
14879
14932
|
- name: id
|
|
14880
14933
|
required: true
|
|
@@ -14990,15 +15043,15 @@ paths:
|
|
|
14990
15043
|
required:
|
|
14991
15044
|
- code
|
|
14992
15045
|
- message
|
|
15046
|
+
summary: Verify email
|
|
14993
15047
|
tags:
|
|
14994
15048
|
- user-management.users
|
|
14995
15049
|
/user_management/users/{id}/email_verification/send:
|
|
14996
15050
|
post:
|
|
14997
|
-
operationId: UserlandUsersController_sendVerificationEmail
|
|
14998
|
-
summary: Send verification email
|
|
14999
15051
|
description: >-
|
|
15000
15052
|
Sends an email that contains a one-time code used to verify a user’s
|
|
15001
15053
|
email address.
|
|
15054
|
+
operationId: UserlandUsersController_sendVerificationEmail[0]
|
|
15002
15055
|
parameters:
|
|
15003
15056
|
- name: id
|
|
15004
15057
|
required: true
|
|
@@ -15065,17 +15118,17 @@ paths:
|
|
|
15065
15118
|
required:
|
|
15066
15119
|
- code
|
|
15067
15120
|
- message
|
|
15121
|
+
summary: Send verification email
|
|
15068
15122
|
tags:
|
|
15069
15123
|
- user-management.users
|
|
15070
15124
|
/user_management/users/{id}/identities:
|
|
15071
15125
|
get:
|
|
15072
|
-
operationId: UserlandUserIdentitiesController_get
|
|
15073
|
-
summary: Get user identities
|
|
15074
15126
|
description: >-
|
|
15075
15127
|
Get a list of identities associated with the user. A user can have
|
|
15076
15128
|
multiple associated identities after going through [identity
|
|
15077
15129
|
linking](/authkit/identity-linking). Currently only OAuth identities are
|
|
15078
15130
|
supported. More provider types may be added in the future.
|
|
15131
|
+
operationId: UserlandUserIdentitiesController_get
|
|
15079
15132
|
parameters:
|
|
15080
15133
|
- name: id
|
|
15081
15134
|
required: true
|
|
@@ -15140,13 +15193,13 @@ paths:
|
|
|
15140
15193
|
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
15141
15194
|
required:
|
|
15142
15195
|
- message
|
|
15196
|
+
summary: Get user identities
|
|
15143
15197
|
tags:
|
|
15144
15198
|
- user-management.users
|
|
15145
15199
|
/user_management/users/{id}/sessions:
|
|
15146
15200
|
get:
|
|
15147
|
-
operationId: UserlandUserSessionsController_list
|
|
15148
|
-
summary: List sessions
|
|
15149
15201
|
description: Get a list of all active sessions for a specific user.
|
|
15202
|
+
operationId: UserlandUserSessionsController_list
|
|
15150
15203
|
parameters:
|
|
15151
15204
|
- name: id
|
|
15152
15205
|
required: true
|
|
@@ -15200,13 +15253,7 @@ paths:
|
|
|
15200
15253
|
reversed cursor semantics where `before` fetches older records and
|
|
15201
15254
|
`after` fetches newer records). Defaults to descending.
|
|
15202
15255
|
schema:
|
|
15203
|
-
|
|
15204
|
-
example: desc
|
|
15205
|
-
enum:
|
|
15206
|
-
- normal
|
|
15207
|
-
- desc
|
|
15208
|
-
- asc
|
|
15209
|
-
type: string
|
|
15256
|
+
$ref: '#/components/schemas/PaginationOrder'
|
|
15210
15257
|
responses:
|
|
15211
15258
|
'200':
|
|
15212
15259
|
description: OK
|
|
@@ -15407,13 +15454,13 @@ paths:
|
|
|
15407
15454
|
required:
|
|
15408
15455
|
- code
|
|
15409
15456
|
- message
|
|
15457
|
+
summary: List sessions
|
|
15410
15458
|
tags:
|
|
15411
15459
|
- user-management.users
|
|
15412
15460
|
/user_management/users/{userId}/api_keys:
|
|
15413
15461
|
get:
|
|
15414
|
-
operationId: UserApiKeysController_list
|
|
15415
|
-
summary: List API keys for a user
|
|
15416
15462
|
description: Get a list of API keys owned by a specific user.
|
|
15463
|
+
operationId: UserApiKeysController_list
|
|
15417
15464
|
parameters:
|
|
15418
15465
|
- name: userId
|
|
15419
15466
|
required: true
|
|
@@ -15457,13 +15504,7 @@ paths:
|
|
|
15457
15504
|
in: query
|
|
15458
15505
|
description: Order the results by the creation time.
|
|
15459
15506
|
schema:
|
|
15460
|
-
|
|
15461
|
-
example: desc
|
|
15462
|
-
enum:
|
|
15463
|
-
- normal
|
|
15464
|
-
- desc
|
|
15465
|
-
- asc
|
|
15466
|
-
type: string
|
|
15507
|
+
$ref: '#/components/schemas/PaginationOrder'
|
|
15467
15508
|
- name: organization_id
|
|
15468
15509
|
required: false
|
|
15469
15510
|
in: query
|
|
@@ -15494,15 +15535,15 @@ paths:
|
|
|
15494
15535
|
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
15495
15536
|
required:
|
|
15496
15537
|
- message
|
|
15538
|
+
summary: List API keys for a user
|
|
15497
15539
|
tags:
|
|
15498
15540
|
- api_keys
|
|
15499
15541
|
x-feature-flag: user-api-keys
|
|
15500
15542
|
post:
|
|
15501
|
-
operationId: UserApiKeysController_create
|
|
15502
|
-
summary: Create an API key for a user
|
|
15503
15543
|
description: >-
|
|
15504
15544
|
Create a new API key owned by a user. The user must have an active
|
|
15505
15545
|
membership in the specified organization.
|
|
15546
|
+
operationId: UserApiKeysController_create
|
|
15506
15547
|
parameters:
|
|
15507
15548
|
- name: userId
|
|
15508
15549
|
required: true
|
|
@@ -15581,17 +15622,17 @@ paths:
|
|
|
15581
15622
|
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
15582
15623
|
required:
|
|
15583
15624
|
- message
|
|
15625
|
+
summary: Create an API key for a user
|
|
15584
15626
|
tags:
|
|
15585
15627
|
- api_keys
|
|
15586
15628
|
x-feature-flag: user-api-keys
|
|
15587
15629
|
/user_management/users/{userId}/feature-flags:
|
|
15588
15630
|
get:
|
|
15589
|
-
operationId: UserlandUserFeatureFlagsController_list
|
|
15590
|
-
summary: List enabled feature flags for a user
|
|
15591
15631
|
description: >-
|
|
15592
15632
|
Get a list of all enabled feature flags for the provided user. This
|
|
15593
15633
|
includes feature flags enabled specifically for the user as well as any
|
|
15594
15634
|
organizations that the user is a member of.
|
|
15635
|
+
operationId: UserlandUserFeatureFlagsController_list
|
|
15595
15636
|
parameters:
|
|
15596
15637
|
- name: userId
|
|
15597
15638
|
required: true
|
|
@@ -15635,13 +15676,7 @@ paths:
|
|
|
15635
15676
|
in: query
|
|
15636
15677
|
description: Order the results by the creation time.
|
|
15637
15678
|
schema:
|
|
15638
|
-
|
|
15639
|
-
example: desc
|
|
15640
|
-
enum:
|
|
15641
|
-
- normal
|
|
15642
|
-
- desc
|
|
15643
|
-
- asc
|
|
15644
|
-
type: string
|
|
15679
|
+
$ref: '#/components/schemas/PaginationOrder'
|
|
15645
15680
|
responses:
|
|
15646
15681
|
'200':
|
|
15647
15682
|
description: OK
|
|
@@ -15662,13 +15697,13 @@ paths:
|
|
|
15662
15697
|
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
15663
15698
|
required:
|
|
15664
15699
|
- message
|
|
15700
|
+
summary: List enabled feature flags for a user
|
|
15665
15701
|
tags:
|
|
15666
15702
|
- user-management.users.feature-flags
|
|
15667
15703
|
/user_management/users/{user_id}/authorized_applications:
|
|
15668
15704
|
get:
|
|
15669
|
-
operationId: AuthorizedApplicationsController_list
|
|
15670
|
-
summary: List authorized applications
|
|
15671
15705
|
description: Get a list of all Connect applications that the user has authorized.
|
|
15706
|
+
operationId: AuthorizedApplicationsController_list
|
|
15672
15707
|
parameters:
|
|
15673
15708
|
- name: user_id
|
|
15674
15709
|
required: true
|
|
@@ -15722,13 +15757,7 @@ paths:
|
|
|
15722
15757
|
reversed cursor semantics where `before` fetches older records and
|
|
15723
15758
|
`after` fetches newer records). Defaults to descending.
|
|
15724
15759
|
schema:
|
|
15725
|
-
|
|
15726
|
-
example: desc
|
|
15727
|
-
enum:
|
|
15728
|
-
- normal
|
|
15729
|
-
- desc
|
|
15730
|
-
- asc
|
|
15731
|
-
type: string
|
|
15760
|
+
$ref: '#/components/schemas/PaginationOrder'
|
|
15732
15761
|
responses:
|
|
15733
15762
|
'200':
|
|
15734
15763
|
description: OK
|
|
@@ -15762,13 +15791,13 @@ paths:
|
|
|
15762
15791
|
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
15763
15792
|
required:
|
|
15764
15793
|
- message
|
|
15794
|
+
summary: List authorized applications
|
|
15765
15795
|
tags:
|
|
15766
15796
|
- user-management.users.authorized-applications
|
|
15767
15797
|
/user_management/users/{user_id}/authorized_applications/{application_id}:
|
|
15768
15798
|
delete:
|
|
15769
|
-
operationId: AuthorizedApplicationsController_delete
|
|
15770
|
-
summary: Delete an authorized application
|
|
15771
15799
|
description: Delete an existing Authorized Connect Application.
|
|
15800
|
+
operationId: AuthorizedApplicationsController_delete
|
|
15772
15801
|
parameters:
|
|
15773
15802
|
- name: application_id
|
|
15774
15803
|
required: true
|
|
@@ -15800,15 +15829,15 @@ paths:
|
|
|
15800
15829
|
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
15801
15830
|
required:
|
|
15802
15831
|
- message
|
|
15832
|
+
summary: Delete an authorized application
|
|
15803
15833
|
tags:
|
|
15804
15834
|
- user-management.users.authorized-applications
|
|
15805
15835
|
/user_management/users/{user_id}/connected_accounts/{slug}:
|
|
15806
15836
|
get:
|
|
15807
|
-
operationId: DataIntegrationsUserManagementController_getUserDataInstallation
|
|
15808
|
-
summary: Get a connected account
|
|
15809
15837
|
description: >-
|
|
15810
15838
|
Retrieves a user's [connected
|
|
15811
15839
|
account](/reference/pipes/connected-account) for a specific provider.
|
|
15840
|
+
operationId: DataIntegrationsUserManagementController_getUserDataInstallation
|
|
15812
15841
|
parameters:
|
|
15813
15842
|
- name: user_id
|
|
15814
15843
|
required: true
|
|
@@ -15857,15 +15886,15 @@ paths:
|
|
|
15857
15886
|
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
15858
15887
|
required:
|
|
15859
15888
|
- message
|
|
15889
|
+
summary: Get a connected account
|
|
15860
15890
|
tags:
|
|
15861
15891
|
- user-management.data-providers
|
|
15862
15892
|
delete:
|
|
15863
|
-
operationId: DataIntegrationsUserManagementController_deleteUserDataInstallation
|
|
15864
|
-
summary: Delete a connected account
|
|
15865
15893
|
description: >-
|
|
15866
15894
|
Disconnects WorkOS's account for the user, including removing any stored
|
|
15867
15895
|
access and refresh tokens. The user will need to reauthorize if they
|
|
15868
15896
|
want to reconnect. This does not revoke access on the provider side.
|
|
15897
|
+
operationId: DataIntegrationsUserManagementController_deleteUserDataInstallation
|
|
15869
15898
|
parameters:
|
|
15870
15899
|
- name: user_id
|
|
15871
15900
|
required: true
|
|
@@ -15910,17 +15939,17 @@ paths:
|
|
|
15910
15939
|
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
15911
15940
|
required:
|
|
15912
15941
|
- message
|
|
15942
|
+
summary: Delete a connected account
|
|
15913
15943
|
tags:
|
|
15914
15944
|
- user-management.data-providers
|
|
15915
15945
|
/user_management/users/{user_id}/data_providers:
|
|
15916
15946
|
get:
|
|
15917
|
-
operationId: DataIntegrationsUserManagementController_getUserDataIntegrations
|
|
15918
|
-
summary: List providers
|
|
15919
15947
|
description: >-
|
|
15920
15948
|
Retrieves a list of available providers and the user's connection status
|
|
15921
15949
|
for each. Returns all providers configured for your environment, along
|
|
15922
15950
|
with the user's [connected account](/reference/pipes/connected-account)
|
|
15923
15951
|
information where applicable.
|
|
15952
|
+
operationId: DataIntegrationsUserManagementController_getUserDataIntegrations
|
|
15924
15953
|
parameters:
|
|
15925
15954
|
- name: user_id
|
|
15926
15955
|
required: true
|
|
@@ -15962,15 +15991,15 @@ paths:
|
|
|
15962
15991
|
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
15963
15992
|
required:
|
|
15964
15993
|
- message
|
|
15994
|
+
summary: List providers
|
|
15965
15995
|
tags:
|
|
15966
15996
|
- user-management.data-providers
|
|
15967
15997
|
/user_management/users/{userlandUserId}/auth_factors:
|
|
15968
15998
|
post:
|
|
15969
|
-
operationId: UserlandUserAuthenticationFactorsController_create
|
|
15970
|
-
summary: Enroll an authentication factor
|
|
15971
15999
|
description: >-
|
|
15972
16000
|
Enrolls a user in a new [authentication
|
|
15973
16001
|
factor](/reference/authkit/mfa/authentication-factor).
|
|
16002
|
+
operationId: UserlandUserAuthenticationFactorsController_create[0]
|
|
15974
16003
|
parameters:
|
|
15975
16004
|
- name: userlandUserId
|
|
15976
16005
|
required: true
|
|
@@ -16006,14 +16035,14 @@ paths:
|
|
|
16006
16035
|
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
16007
16036
|
required:
|
|
16008
16037
|
- message
|
|
16038
|
+
summary: Enroll an authentication factor
|
|
16009
16039
|
tags:
|
|
16010
16040
|
- user-management.multi-factor-authentication
|
|
16011
16041
|
get:
|
|
16012
|
-
operationId: UserlandUserAuthenticationFactorsController_list
|
|
16013
|
-
summary: List authentication factors
|
|
16014
16042
|
description: >-
|
|
16015
16043
|
Lists the [authentication
|
|
16016
16044
|
factors](/reference/authkit/mfa/authentication-factor) for a user.
|
|
16045
|
+
operationId: UserlandUserAuthenticationFactorsController_list[0]
|
|
16017
16046
|
parameters:
|
|
16018
16047
|
- name: userlandUserId
|
|
16019
16048
|
required: true
|
|
@@ -16057,13 +16086,7 @@ paths:
|
|
|
16057
16086
|
in: query
|
|
16058
16087
|
description: Order the results by the creation time.
|
|
16059
16088
|
schema:
|
|
16060
|
-
|
|
16061
|
-
example: desc
|
|
16062
|
-
enum:
|
|
16063
|
-
- normal
|
|
16064
|
-
- desc
|
|
16065
|
-
- asc
|
|
16066
|
-
type: string
|
|
16089
|
+
$ref: '#/components/schemas/PaginationOrder'
|
|
16067
16090
|
responses:
|
|
16068
16091
|
'200':
|
|
16069
16092
|
description: OK
|
|
@@ -16084,13 +16107,13 @@ paths:
|
|
|
16084
16107
|
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
16085
16108
|
required:
|
|
16086
16109
|
- message
|
|
16110
|
+
summary: List authentication factors
|
|
16087
16111
|
tags:
|
|
16088
16112
|
- user-management.multi-factor-authentication
|
|
16089
16113
|
/webhook_endpoints:
|
|
16090
16114
|
get:
|
|
16091
|
-
operationId: WebhookEndpointsController_list
|
|
16092
|
-
summary: List Webhook Endpoints
|
|
16093
16115
|
description: Get a list of all of your existing webhook endpoints.
|
|
16116
|
+
operationId: WebhookEndpointsController_list
|
|
16094
16117
|
parameters:
|
|
16095
16118
|
- name: before
|
|
16096
16119
|
required: false
|
|
@@ -16137,13 +16160,7 @@ paths:
|
|
|
16137
16160
|
reversed cursor semantics where `before` fetches older records and
|
|
16138
16161
|
`after` fetches newer records). Defaults to descending.
|
|
16139
16162
|
schema:
|
|
16140
|
-
|
|
16141
|
-
example: desc
|
|
16142
|
-
enum:
|
|
16143
|
-
- normal
|
|
16144
|
-
- desc
|
|
16145
|
-
- asc
|
|
16146
|
-
type: string
|
|
16163
|
+
$ref: '#/components/schemas/PaginationOrder'
|
|
16147
16164
|
responses:
|
|
16148
16165
|
'200':
|
|
16149
16166
|
description: List of webhook endpoints.
|
|
@@ -16151,12 +16168,12 @@ paths:
|
|
|
16151
16168
|
application/json:
|
|
16152
16169
|
schema:
|
|
16153
16170
|
$ref: '#/components/schemas/WebhookEndpointList'
|
|
16171
|
+
summary: List Webhook Endpoints
|
|
16154
16172
|
tags:
|
|
16155
16173
|
- webhooks
|
|
16156
16174
|
post:
|
|
16157
|
-
operationId: WebhookEndpointsController_create
|
|
16158
|
-
summary: Create a Webhook Endpoint
|
|
16159
16175
|
description: Create a new webhook endpoint to receive event notifications.
|
|
16176
|
+
operationId: WebhookEndpointsController_create
|
|
16160
16177
|
parameters: []
|
|
16161
16178
|
requestBody:
|
|
16162
16179
|
required: true
|
|
@@ -16244,13 +16261,13 @@ paths:
|
|
|
16244
16261
|
- code
|
|
16245
16262
|
- message
|
|
16246
16263
|
- errors
|
|
16264
|
+
summary: Create a Webhook Endpoint
|
|
16247
16265
|
tags:
|
|
16248
16266
|
- webhooks
|
|
16249
16267
|
/webhook_endpoints/{id}:
|
|
16250
16268
|
patch:
|
|
16251
|
-
operationId: WebhookEndpointsController_update
|
|
16252
|
-
summary: Update a Webhook Endpoint
|
|
16253
16269
|
description: Update the properties of an existing webhook endpoint.
|
|
16270
|
+
operationId: WebhookEndpointsController_update
|
|
16254
16271
|
parameters:
|
|
16255
16272
|
- name: id
|
|
16256
16273
|
required: true
|
|
@@ -16364,12 +16381,12 @@ paths:
|
|
|
16364
16381
|
- code
|
|
16365
16382
|
- message
|
|
16366
16383
|
- errors
|
|
16384
|
+
summary: Update a Webhook Endpoint
|
|
16367
16385
|
tags:
|
|
16368
16386
|
- webhooks
|
|
16369
16387
|
delete:
|
|
16370
|
-
operationId: WebhookEndpointsController_delete
|
|
16371
|
-
summary: Delete a Webhook Endpoint
|
|
16372
16388
|
description: Delete an existing webhook endpoint.
|
|
16389
|
+
operationId: WebhookEndpointsController_delete
|
|
16373
16390
|
parameters:
|
|
16374
16391
|
- name: id
|
|
16375
16392
|
required: true
|
|
@@ -16400,15 +16417,15 @@ paths:
|
|
|
16400
16417
|
required:
|
|
16401
16418
|
- code
|
|
16402
16419
|
- message
|
|
16420
|
+
summary: Delete a Webhook Endpoint
|
|
16403
16421
|
tags:
|
|
16404
16422
|
- webhooks
|
|
16405
16423
|
/widgets/token:
|
|
16406
16424
|
post:
|
|
16407
|
-
operationId: WidgetsPublicController_issueWidgetSessionToken
|
|
16408
|
-
summary: Generate a widget token
|
|
16409
16425
|
description: >-
|
|
16410
16426
|
Generate a widget token scoped to an organization and user with the
|
|
16411
16427
|
specified scopes.
|
|
16428
|
+
operationId: WidgetsPublicController_issueWidgetSessionToken
|
|
16412
16429
|
parameters: []
|
|
16413
16430
|
requestBody:
|
|
16414
16431
|
required: true
|
|
@@ -16481,6 +16498,7 @@ paths:
|
|
|
16481
16498
|
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
16482
16499
|
required:
|
|
16483
16500
|
- message
|
|
16501
|
+
summary: Generate a widget token
|
|
16484
16502
|
tags:
|
|
16485
16503
|
- widgets
|
|
16486
16504
|
info:
|
|
@@ -16703,6 +16721,14 @@ components:
|
|
|
16703
16721
|
example: sk_example_1234567890abcdef
|
|
16704
16722
|
required:
|
|
16705
16723
|
- value
|
|
16724
|
+
PaginationOrder:
|
|
16725
|
+
type: string
|
|
16726
|
+
enum:
|
|
16727
|
+
- normal
|
|
16728
|
+
- desc
|
|
16729
|
+
- asc
|
|
16730
|
+
example: desc
|
|
16731
|
+
default: desc
|
|
16706
16732
|
RedirectUriDto:
|
|
16707
16733
|
type: object
|
|
16708
16734
|
properties:
|
|
@@ -17078,6 +17104,7 @@ components:
|
|
|
17078
17104
|
description: The metadata schema for the actor.
|
|
17079
17105
|
$ref: '#/components/schemas/AuditLogSchemaActorDto'
|
|
17080
17106
|
targets:
|
|
17107
|
+
minItems: 1
|
|
17081
17108
|
description: The list of targets for the schema.
|
|
17082
17109
|
type: array
|
|
17083
17110
|
items:
|
|
@@ -17529,6 +17556,7 @@ components:
|
|
|
17529
17556
|
external_id:
|
|
17530
17557
|
type: string
|
|
17531
17558
|
maxLength: 128
|
|
17559
|
+
pattern: ^[\x00-\x7F]+$
|
|
17532
17560
|
description: An external identifier for the resource.
|
|
17533
17561
|
example: my-workspace-01
|
|
17534
17562
|
name:
|
|
@@ -17785,6 +17813,7 @@ components:
|
|
|
17785
17813
|
- string
|
|
17786
17814
|
- 'null'
|
|
17787
17815
|
maxLength: 128
|
|
17816
|
+
pattern: ^[\x00-\x7F]+$
|
|
17788
17817
|
example: ext_12345
|
|
17789
17818
|
description: An external identifier for the Organization.
|
|
17790
17819
|
required:
|
|
@@ -17840,6 +17869,7 @@ components:
|
|
|
17840
17869
|
- string
|
|
17841
17870
|
- 'null'
|
|
17842
17871
|
maxLength: 128
|
|
17872
|
+
pattern: ^[\x00-\x7F]+$
|
|
17843
17873
|
example: 2fe01467-f7ea-4dd2-8b79-c2b4f56d0191
|
|
17844
17874
|
description: An external identifier for the Organization.
|
|
17845
17875
|
SsoIntentOptions:
|
|
@@ -17929,6 +17959,7 @@ components:
|
|
|
17929
17959
|
maxItems: 20
|
|
17930
17960
|
items:
|
|
17931
17961
|
type: string
|
|
17962
|
+
format: email
|
|
17932
17963
|
type: array
|
|
17933
17964
|
required:
|
|
17934
17965
|
- organization
|
|
@@ -17975,6 +18006,7 @@ components:
|
|
|
17975
18006
|
properties:
|
|
17976
18007
|
email:
|
|
17977
18008
|
type: string
|
|
18009
|
+
format: email
|
|
17978
18010
|
description: The email address to send the magic code to.
|
|
17979
18011
|
example: marcelina.davis@example.com
|
|
17980
18012
|
invitation_token:
|
|
@@ -17988,6 +18020,7 @@ components:
|
|
|
17988
18020
|
properties:
|
|
17989
18021
|
email:
|
|
17990
18022
|
type: string
|
|
18023
|
+
format: email
|
|
17991
18024
|
description: The email address of the recipient.
|
|
17992
18025
|
example: marcelina.davis@example.com
|
|
17993
18026
|
organization_id:
|
|
@@ -18368,6 +18401,7 @@ components:
|
|
|
18368
18401
|
properties:
|
|
18369
18402
|
email:
|
|
18370
18403
|
type: string
|
|
18404
|
+
format: email
|
|
18371
18405
|
description: The email address of the user.
|
|
18372
18406
|
example: marcelina.davis@example.com
|
|
18373
18407
|
first_name:
|
|
@@ -18406,6 +18440,7 @@ components:
|
|
|
18406
18440
|
- string
|
|
18407
18441
|
- 'null'
|
|
18408
18442
|
maxLength: 128
|
|
18443
|
+
pattern: ^[\x00-\x7F]+$
|
|
18409
18444
|
description: The external ID of the user.
|
|
18410
18445
|
example: f1ffa2b2-c20b-4d39-be5c-212726e11222
|
|
18411
18446
|
required:
|
|
@@ -18492,6 +18527,7 @@ components:
|
|
|
18492
18527
|
properties:
|
|
18493
18528
|
email:
|
|
18494
18529
|
type: string
|
|
18530
|
+
format: email
|
|
18495
18531
|
description: The email address of the user.
|
|
18496
18532
|
example: marcelina.davis@example.com
|
|
18497
18533
|
first_name:
|
|
@@ -18523,6 +18559,7 @@ components:
|
|
|
18523
18559
|
- string
|
|
18524
18560
|
- 'null'
|
|
18525
18561
|
maxLength: 128
|
|
18562
|
+
pattern: ^[\x00-\x7F]+$
|
|
18526
18563
|
description: The external ID of the user.
|
|
18527
18564
|
example: f1ffa2b2-c20b-4d39-be5c-212726e11222
|
|
18528
18565
|
locale:
|
|
@@ -18613,6 +18650,7 @@ components:
|
|
|
18613
18650
|
properties:
|
|
18614
18651
|
email:
|
|
18615
18652
|
type: string
|
|
18653
|
+
format: email
|
|
18616
18654
|
description: The email address of the user requesting a password reset.
|
|
18617
18655
|
example: marcelina.davis@example.com
|
|
18618
18656
|
required:
|
|
@@ -19865,7 +19903,7 @@ components:
|
|
|
19865
19903
|
required:
|
|
19866
19904
|
- slug
|
|
19867
19905
|
description: The primary role assigned to the user.
|
|
19868
|
-
|
|
19906
|
+
UserRoleAssignment:
|
|
19869
19907
|
type: object
|
|
19870
19908
|
properties:
|
|
19871
19909
|
object:
|
|
@@ -19876,6 +19914,10 @@ components:
|
|
|
19876
19914
|
type: string
|
|
19877
19915
|
description: Unique identifier of the role assignment.
|
|
19878
19916
|
example: role_assignment_01HXYZ123456789ABCDEFGH
|
|
19917
|
+
organization_membership_id:
|
|
19918
|
+
type: string
|
|
19919
|
+
description: The ID of the organization membership the role is assigned to.
|
|
19920
|
+
example: om_01HXYZ123456789ABCDEFGHIJ
|
|
19879
19921
|
role:
|
|
19880
19922
|
$ref: '#/components/schemas/SlimRole'
|
|
19881
19923
|
description: The role included in the assignment.
|
|
@@ -19900,7 +19942,7 @@ components:
|
|
|
19900
19942
|
- id
|
|
19901
19943
|
- external_id
|
|
19902
19944
|
- resource_type_slug
|
|
19903
|
-
description: The resource
|
|
19945
|
+
description: The resource the role is assigned on.
|
|
19904
19946
|
created_at:
|
|
19905
19947
|
format: date-time
|
|
19906
19948
|
type: string
|
|
@@ -19914,11 +19956,12 @@ components:
|
|
|
19914
19956
|
required:
|
|
19915
19957
|
- object
|
|
19916
19958
|
- id
|
|
19959
|
+
- organization_membership_id
|
|
19917
19960
|
- role
|
|
19918
19961
|
- resource
|
|
19919
19962
|
- created_at
|
|
19920
19963
|
- updated_at
|
|
19921
|
-
|
|
19964
|
+
UserRoleAssignmentList:
|
|
19922
19965
|
type: object
|
|
19923
19966
|
properties:
|
|
19924
19967
|
object:
|
|
@@ -19928,7 +19971,7 @@ components:
|
|
|
19928
19971
|
data:
|
|
19929
19972
|
type: array
|
|
19930
19973
|
items:
|
|
19931
|
-
$ref: '#/components/schemas/
|
|
19974
|
+
$ref: '#/components/schemas/UserRoleAssignment'
|
|
19932
19975
|
description: The list of records for the current page.
|
|
19933
19976
|
list_metadata:
|
|
19934
19977
|
type: object
|
|
@@ -21302,6 +21345,14 @@ components:
|
|
|
21302
21345
|
- custom_attributes
|
|
21303
21346
|
- created_at
|
|
21304
21347
|
- updated_at
|
|
21348
|
+
VaultByokKeyProvider:
|
|
21349
|
+
type: string
|
|
21350
|
+
enum:
|
|
21351
|
+
- AWS_KMS
|
|
21352
|
+
- GCP_KMS
|
|
21353
|
+
- AZURE_KEY_VAULT
|
|
21354
|
+
example: AWS_KMS
|
|
21355
|
+
description: The external key provider used for BYOK.
|
|
21305
21356
|
WaitlistUser:
|
|
21306
21357
|
type: object
|
|
21307
21358
|
properties:
|
|
@@ -28598,13 +28649,7 @@ components:
|
|
|
28598
28649
|
description: The unique identifier of the organization.
|
|
28599
28650
|
example: org_01EHT88Z8J8795GZNQ4ZP1J81T
|
|
28600
28651
|
key_provider:
|
|
28601
|
-
|
|
28602
|
-
enum:
|
|
28603
|
-
- AWS_KMS
|
|
28604
|
-
- GCP_KMS
|
|
28605
|
-
- AZURE_KEY_VAULT
|
|
28606
|
-
description: The external key provider used for BYOK.
|
|
28607
|
-
example: AWS_KMS
|
|
28652
|
+
$ref: '#/components/schemas/VaultByokKeyProvider'
|
|
28608
28653
|
required:
|
|
28609
28654
|
- organization_id
|
|
28610
28655
|
- key_provider
|
|
@@ -28643,13 +28688,7 @@ components:
|
|
|
28643
28688
|
description: The unique identifier of the organization.
|
|
28644
28689
|
example: org_01EHT88Z8J8795GZNQ4ZP1J81T
|
|
28645
28690
|
key_provider:
|
|
28646
|
-
|
|
28647
|
-
enum:
|
|
28648
|
-
- AWS_KMS
|
|
28649
|
-
- GCP_KMS
|
|
28650
|
-
- AZURE_KEY_VAULT
|
|
28651
|
-
description: The external key provider used for BYOK.
|
|
28652
|
-
example: AWS_KMS
|
|
28691
|
+
$ref: '#/components/schemas/VaultByokKeyProvider'
|
|
28653
28692
|
verified:
|
|
28654
28693
|
type: boolean
|
|
28655
28694
|
description: >-
|