-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathopenapi.yaml
7281 lines (7270 loc) · 342 KB
/
openapi.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
components:
schemas:
c1.api.app.v1.AddAppEntitlementOwnerRequestInput:
description: The request message for adding an app entitlement owner.
properties:
userId:
description: The user_id field for the user to add as an owner of the app entitlement.
type: string
title: Add App Entitlement Owner Request
type: object
x-speakeasy-name-override: AddAppEntitlementOwnerRequest
c1.api.app.v1.AddAppEntitlementOwnerResponse:
description: The empty response message for adding an app entitlement owner.
title: Add App Entitlement Owner Response
type: object
x-speakeasy-name-override: AddAppEntitlementOwnerResponse
c1.api.app.v1.AddAppOwnerRequestInput:
description: Empty request body. Just placeholder for the add app owner request which uses URL values for input.
title: Add App Owner Request
type: object
x-speakeasy-name-override: AddAppOwnerRequest
c1.api.app.v1.AddAppOwnerResponse:
description: Empty response with a status code indicating success
title: Add App Owner Response
type: object
x-speakeasy-name-override: AddAppOwnerResponse
c1.api.app.v1.App:
description: The App object provides all of the details for an app, as well as some configuration.
properties:
appAccountId:
description: The ID of the Account named by AccountName.
readOnly: true
type: string
appAccountName:
description: The AccountName of the app. For example, AWS is AccountID, Github is Org Name, and Okta is Okta Subdomain.
readOnly: true
type: string
certifyPolicyId:
description: The ID of the Certify Policy associated with this App.
type: string
createdAt:
format: date-time
readOnly: true
type: string
deletedAt:
format: date-time
readOnly: true
type: string
description:
description: The app's description.
type: string
displayName:
description: The app's display name.
type: string
fieldMask:
nullable: true
readOnly: true
type: string
grantPolicyId:
description: The ID of the Grant Policy associated with this App.
type: string
iconUrl:
description: The URL of an icon to display for the app.
type: string
id:
description: The ID of the app.
readOnly: true
type: string
logoUri:
description: The URL of a logo to display for the app.
readOnly: true
type: string
monthlyCostUsd:
description: The cost of an app per-seat, so that total cost can be calculated by the grant count.
format: int32
type: number
parentAppId:
description: The ID of the app that created this app, if any.
readOnly: true
type: string
revokePolicyId:
description: The ID of the Revoke Policy associated with this App.
type: string
updatedAt:
format: date-time
readOnly: true
type: string
userCount:
description: The number of users with grants to this app.
format: int64
readOnly: true
type: string
title: App
type: object
x-speakeasy-entity: App
x-speakeasy-name-override: App
c1.api.app.v1.AppActionsServiceGenerateReportRequestInput:
description: Empty request body. Just placeholder for the generate app report request which uses URL values for input.
title: App Actions Service Generate Report Request
type: object
x-speakeasy-name-override: AppActionsServiceGenerateReportRequest
c1.api.app.v1.AppActionsServiceGenerateReportResponse:
description: Empty response body. Status code indicates success.
title: App Actions Service Generate Report Response
type: object
x-speakeasy-name-override: AppActionsServiceGenerateReportResponse
c1.api.app.v1.AppEntitlement:
description: |
The app entitlement represents one permission in a downstream App (SAAS) that can be granted. For example, GitHub Read vs GitHub Write.
This message contains a oneof named max_grant_duration. Only a single field of the following list may be set at a time:
- durationUnset
- durationGrant
properties:
alias:
description: The alias of the app entitlement used by Cone. Also exact-match queryable.
readOnly: true
type: string
appId:
description: The ID of the app that is associated with the app entitlement.
type: string
appResourceId:
description: The ID of the app resource that is associated with the app entitlement
type: string
appResourceTypeId:
description: The ID of the app resource type that is associated with the app entitlement
type: string
certifyPolicyId:
description: The ID of the policy that will be used for certify tickets related to the app entitlement.
type: string
complianceFrameworkValueIds:
description: The IDs of different compliance frameworks associated with this app entitlement ex (SOX, HIPAA, PCI, etc.)
items:
type: string
nullable: true
type: array
createdAt:
format: date-time
readOnly: true
type: string
deletedAt:
format: date-time
readOnly: true
type: string
description:
description: The description of the app entitlement.
type: string
displayName:
description: The display name of the app entitlement.
type: string
durationGrant:
format: duration
type: string
durationUnset:
nullable: true
type: object
emergencyGrantEnabled:
description: This enables tasks to be created in an emergency and use a selected emergency access policy.
type: boolean
emergencyGrantPolicyId:
description: The ID of the policy that will be used for emergency access grant tasks.
type: string
grantCount:
description: The amount of grants open for this entitlement
format: int64
readOnly: true
type: string
grantPolicyId:
description: The ID of the policy that will be used for grant tickets related to the app entitlement.
type: string
id:
description: The unique ID for the App Entitlement.
readOnly: true
type: string
provisionerPolicy:
$ref: '#/components/schemas/c1.api.policy.v1.ProvisionPolicy'
revokePolicyId:
description: The ID of the policy that will be used for revoke tickets related to the app entitlement
type: string
riskLevelValueId:
description: The riskLevelValueId field.
type: string
slug:
description: The slug is displayed as an oval next to the name in the frontend of C1, it tells you what permission the entitlement grants. See https://www.conductorone.com/docs/product/manage-access/entitlements/
type: string
systemBuiltin:
description: This field indicates if this is a system builtin entitlement.
readOnly: true
type: boolean
updatedAt:
format: date-time
readOnly: true
type: string
title: App Entitlement
type: object
x-speakeasy-name-override: AppEntitlement
c1.api.app.v1.AppEntitlementExpandMask:
description: The app entitlement expand mask allows the user to get additional information when getting responses containing app entitlement views.
properties:
paths:
description: Array of strings to describe which items to expand on the return value. Can be any combination of "*", "app_id", "app_resource_type_id", or "app_resource_id".
items:
type: string
nullable: true
type: array
title: App Entitlement Expand Mask
type: object
x-speakeasy-name-override: AppEntitlementExpandMask
c1.api.app.v1.AppEntitlementRef:
description: The AppEntitlementRef message.
properties:
appId:
description: The appId field.
type: string
id:
description: The id field.
type: string
title: App Entitlement Ref
type: object
x-speakeasy-name-override: AppEntitlementRef
c1.api.app.v1.AppEntitlementSearchServiceSearchRequest:
description: Search app entitlements by a variety of filters.
properties:
accessReviewId:
description: Search for app entitlements that are being reviewed as part of this access review campaign.
type: string
alias:
description: Search for app entitlements that have this alias (exact match).
type: string
appIds:
description: Search for app entitlements contained in any of these apps.
items:
type: string
nullable: true
type: array
appUserIds:
description: Search for app entitlements that are granted to any of these app user ids.
items:
type: string
nullable: true
type: array
complianceFrameworkIds:
description: Search for app entitlements that are part of these compliace frameworks.
items:
type: string
nullable: true
type: array
excludeAppIds:
description: Exclude app entitlements from the results that are in these app IDs.
items:
type: string
nullable: true
type: array
excludeAppUserIds:
description: Exclude app entitlements from the results that these app users have granted.
items:
type: string
nullable: true
type: array
expandMask:
$ref: '#/components/schemas/c1.api.app.v1.AppEntitlementExpandMask'
includeDeleted:
description: Include deleted app entitlements, this includes app entitlements that have a deleted parent object (app, app resource, app resource type)
type: boolean
onlyGetExpiring:
description: Restrict results to only those who have expiring app entitlement user bindings.
type: boolean
pageSize:
description: The pageSize where 0 <= pageSize <= 100. Values < 10 will be set to 10. A value of 0 returns the default page size (currently 25)
format: int32
type: number
pageToken:
description: The pageToken field.
type: string
query:
description: Query the app entitlements with a fuzzy search on display name and description.
type: string
resourceTypeIds:
description: Search for app entitlements that are for items on these resource types.
items:
type: string
nullable: true
type: array
riskLevelIds:
description: Search for app entitlements with these risk levels.
items:
type: string
nullable: true
type: array
title: App Entitlement Search Service Search Request
type: object
x-speakeasy-name-override: AppEntitlementSearchServiceSearchRequest
c1.api.app.v1.AppEntitlementSearchServiceSearchResponse:
description: The AppEntitlementSearchServiceSearchResponse message.
properties:
expanded:
description: List of related objects.
items:
additionalProperties: true
description: Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.
properties:
'@type':
description: The type of the serialized message.
type: string
type: object
nullable: true
type: array
facets:
$ref: '#/components/schemas/c1.api.search.v1.Facets'
list:
description: List of app entitlement view objects.
items:
$ref: '#/components/schemas/c1.api.app.v1.AppEntitlementView'
nullable: true
type: array
nextPageToken:
description: The nextPageToken is shown for the next page if the number of results is larger than the max page size. The server returns one page of results and the nextPageToken until all results are retreived. To retrieve the next page, use the same request and append a pageToken field with the value of nextPageToken shown on the previous page.
type: string
title: App Entitlement Search Service Search Response
type: object
x-speakeasy-name-override: AppEntitlementSearchServiceSearchResponse
c1.api.app.v1.AppEntitlementUserBinding:
description: The AppEntitlementUserBinding represents the relationship that gives an app user access to an app entitlement
properties:
appEntitlementId:
description: The ID of the app entitlement that the app user has access to
type: string
appId:
description: The ID of the app associated with the app entitlement
type: string
appUserId:
description: The ID of the app user that has access to the app entitlement
type: string
createdAt:
format: date-time
readOnly: true
type: string
deletedAt:
format: date-time
readOnly: true
type: string
deprovisionAt:
format: date-time
readOnly: true
type: string
title: App Entitlement User Binding
type: object
x-speakeasy-name-override: AppEntitlementUserBinding
c1.api.app.v1.AppEntitlementUserView:
description: The AppEntitlementUserView (aka grant view) describes the relationship between an app user and an entitlement. They have more recently been referred to as grants.
properties:
appEntitlementUserBindingCreatedAt:
format: date-time
readOnly: true
type: string
appEntitlementUserBindingDeprovisionAt:
format: date-time
readOnly: true
type: string
appUser:
$ref: '#/components/schemas/c1.api.app.v1.AppUserView'
title: App Entitlement User View
type: object
x-speakeasy-name-override: AppEntitlementUserView
c1.api.app.v1.AppEntitlementView:
description: The app entitlement view contains the serialized app entitlement and paths to objects referenced by the app entitlement.
properties:
appEntitlement:
$ref: '#/components/schemas/c1.api.app.v1.AppEntitlement'
appPath:
description: JSONPATH expression indicating the location of the App object in the array.
type: string
appResourcePath:
description: JSONPATH expression indicating the location of the App Resource Type object in the expanded array.
type: string
appResourceTypePath:
description: JSONPATH expression indicating the location of the App Resource object in the array.
type: string
title: App Entitlement View
type: object
x-speakeasy-name-override: AppEntitlementView
c1.api.app.v1.AppEntitlementWithUserBindings:
description: The AppEntitlementWithUserBindings message represents an app entitlement and its associated user bindings.
properties:
appEntitlementUserBindings:
description: An array of AppEntitlementUserBinding objects which represent the relationships that give app users access to the specific app entitlement.
items:
$ref: '#/components/schemas/c1.api.app.v1.AppEntitlementUserBinding'
nullable: true
type: array
entitlement:
$ref: '#/components/schemas/c1.api.app.v1.AppEntitlementView'
title: App Entitlement With User Bindings
type: object
x-speakeasy-name-override: AppEntitlementWithUserBindings
c1.api.app.v1.AppPopulationReport:
description: The AppPopulationReport is a generated report for a specific app that gives details about the app's users. These details include what groups, roles, and other entitlements the users have access to.
properties:
appId:
description: The appId is the Id of the app which the report is generated for.
type: string
createdAt:
format: date-time
readOnly: true
type: string
downloadUrl:
description: The downloadUrl is the url used for downloading the AppPopulationReport.
type: string
hashes:
additionalProperties:
type: string
description: The hashes field contains the file hashes of the report.
type: object
id:
description: The id field.
type: string
state:
description: The state field tracks the state of the AppPopulationReport. This state field can be one of REPORT_STATE_PENDING, REPORT_STATE_UNSPECIFIED, REPORT_STATE_OK, REPORT_STATE_ERROR.
enum:
- REPORT_STATE_UNSPECIFIED
- REPORT_STATE_PENDING
- REPORT_STATE_OK
- REPORT_STATE_ERROR
type: string
title: App Population Report
type: object
x-speakeasy-name-override: AppPopulationReport
c1.api.app.v1.AppReportServiceListResponse:
description: The AppReportServiceListResponse message contains a list of results and a nextPageToken if applicable.
properties:
list:
description: The list of results containing up to X results, where X is the page size defined in the request.
items:
$ref: '#/components/schemas/c1.api.app.v1.AppPopulationReport'
nullable: true
type: array
nextPageToken:
description: |-
The nextPageToken is shown for the next page if the number of results is larger than the max page size.
The server returns one page of results and the nextPageToken until all results are retreived.
To retrieve the next page, use the same request and append a pageToken field with the value of nextPageToken shown on the previous page.
type: string
title: App Report Service List Response
type: object
x-speakeasy-name-override: AppReportServiceListResponse
c1.api.app.v1.AppResource:
description: The app resource message is a single resource that can have entitlements.
properties:
appId:
description: The app that this resource belongs to.
type: string
appResourceTypeId:
description: The resource type that this resource is.
type: string
createdAt:
format: date-time
readOnly: true
type: string
customDescription:
description: A custom description that can be set for a resource.
type: string
deletedAt:
format: date-time
readOnly: true
type: string
description:
description: The description set for the resource.
readOnly: true
type: string
displayName:
description: The display name for this resource.
type: string
grantCount:
description: The number of grants to this resource.
format: int64
type: string
id:
description: The id of the resource.
type: string
updatedAt:
format: date-time
readOnly: true
type: string
title: App Resource
type: object
x-speakeasy-name-override: AppResource
c1.api.app.v1.AppResourceServiceGetResponse:
description: The app resource service get response contains the app resource view and array of expanded items indicated by the request's expand mask.
properties:
appResourceView:
$ref: '#/components/schemas/c1.api.app.v1.AppResourceView'
expanded:
description: List of serialized related objects.
items:
additionalProperties: true
description: Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.
properties:
'@type':
description: The type of the serialized message.
type: string
type: object
nullable: true
type: array
title: App Resource Service Get Response
type: object
x-speakeasy-name-override: AppResourceServiceGetResponse
c1.api.app.v1.AppResourceServiceListResponse:
description: The AppResourceServiceListResponse message contains a list of results and a nextPageToken if applicable.
properties:
expanded:
description: List of serialized related objects.
items:
additionalProperties: true
description: Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.
properties:
'@type':
description: The type of the serialized message.
type: string
type: object
nullable: true
type: array
list:
description: The list of results containing up to X results, where X is the page size defined in the request.
items:
$ref: '#/components/schemas/c1.api.app.v1.AppResourceView'
nullable: true
type: array
nextPageToken:
description: |-
The nextPageToken is shown for the next page if the number of results is larger than the max page size.
The server returns one page of results and the nextPageToken until all results are retreived.
To retrieve the next page, use the same request and append a pageToken field with the value of nextPageToken shown on the previous page.
type: string
title: App Resource Service List Response
type: object
x-speakeasy-name-override: AppResourceServiceListResponse
c1.api.app.v1.AppResourceType:
description: The AppResourceType is referenced by an app entitlement defining its resource types. Commonly things like Group or Role.
properties:
appId:
description: The ID of the app that is associated with the app resource type
readOnly: true
type: string
createdAt:
format: date-time
readOnly: true
type: string
deletedAt:
format: date-time
readOnly: true
type: string
displayName:
description: The display name of the app resource type.
type: string
id:
description: The unique ID for the app resource type.
readOnly: true
type: string
updatedAt:
format: date-time
readOnly: true
type: string
title: App Resource Type
type: object
x-speakeasy-name-override: AppResourceType
c1.api.app.v1.AppResourceTypeServiceGetResponse:
description: |-
The AppResourceTypeServiceGetResponse contains an expanded array containing the expanded values indicated by the expand mask
in the request and an app resource type view containing the resource type and JSONPATHs indicating which objects are where in the expand mask.
properties:
appResourceTypeView:
$ref: '#/components/schemas/c1.api.app.v1.AppResourceTypeView'
expanded:
description: List of serialized related objects.
items:
additionalProperties: true
description: Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.
properties:
'@type':
description: The type of the serialized message.
type: string
type: object
nullable: true
type: array
title: App Resource Type Service Get Response
type: object
x-speakeasy-name-override: AppResourceTypeServiceGetResponse
c1.api.app.v1.AppResourceTypeServiceListResponse:
description: The AppResourceTypeServiceListResponse message contains a list of results and a nextPageToken if applicable.
properties:
expanded:
description: List of serialized related objects.
items:
additionalProperties: true
description: Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.
properties:
'@type':
description: The type of the serialized message.
type: string
type: object
nullable: true
type: array
list:
description: The list of results containing up to X results, where X is the page size defined in the request.
items:
$ref: '#/components/schemas/c1.api.app.v1.AppResourceTypeView'
nullable: true
type: array
nextPageToken:
description: |-
The nextPageToken is shown for the next page if the number of results is larger than the max page size.
The server returns one page of results and the nextPageToken until all results are retreived.
To retrieve the next page, use the same request and append a pageToken field with the value of nextPageToken shown on the previous page.
type: string
title: App Resource Type Service List Response
type: object
x-speakeasy-name-override: AppResourceTypeServiceListResponse
c1.api.app.v1.AppResourceTypeView:
description: The AppResourceTypeView message.
properties:
appPath:
description: JSONPATH expression indicating the location of the App object in the array
type: string
appResourceType:
$ref: '#/components/schemas/c1.api.app.v1.AppResourceType'
title: App Resource Type View
type: object
x-speakeasy-name-override: AppResourceTypeView
c1.api.app.v1.AppResourceView:
description: The app resource view returns an app resource with paths for items in the expand mask filled in when this response is returned and a request expand mask has "*" or "app_id" or "resource_type_id".
properties:
appPath:
description: JSONPATH expression indicating the location of the App object in the array
type: string
appResource:
$ref: '#/components/schemas/c1.api.app.v1.AppResource'
resourceTypePath:
description: JSONPATH expression indicating the location of the Resource Type object in the array
type: string
title: App Resource View
type: object
x-speakeasy-name-override: AppResourceView
c1.api.app.v1.AppUsageControls:
description: The AppUsageControls object describes some peripheral configuration for an app.
properties:
appId:
description: The app that this object belongs to.
type: string
notify:
description: Whether or not to notify some if they have access to the app, but has not used it within a configurable amount of time.
type: boolean
notifyAfterDays:
description: The duration in days after which we notify users of nonusage.
format: uint32
type: number
revoke:
description: Whether or not to revoke a grant if they have access to the app, but has not used it within a configurable amount of time.
type: boolean
revokeAfterDays:
description: The duration in days after which we revoke users that have not used that grant.
format: uint32
type: number
title: App Usage Controls
type: object
x-speakeasy-name-override: AppUsageControls
c1.api.app.v1.AppUser:
description: Application User that represents an account in the application.
properties:
appId:
description: The ID of the application.
readOnly: true
type: string
appUserType:
description: The appplication user type. Type can be user, system or service.
enum:
- APP_USER_TYPE_UNSPECIFIED
- APP_USER_TYPE_USER
- APP_USER_TYPE_SERVICE_ACCOUNT
- APP_USER_TYPE_SYSTEM_ACCOUNT
type: string
createdAt:
format: date-time
readOnly: true
type: string
deletedAt:
format: date-time
readOnly: true
type: string
displayName:
description: The display name of the application user.
readOnly: true
type: string
email:
description: The email field of the application user.
readOnly: true
type: string
id:
description: A unique idenditfier of the application user.
readOnly: true
type: string
identityUserId:
description: The conductor one user ID of the account owner.
readOnly: true
type: string
profile:
additionalProperties:
nullable: true
type:
- string
- number
- object
- array
- boolean
- "null"
readOnly: true
type: object
status:
$ref: '#/components/schemas/c1.api.app.v1.AppUserStatus'
updatedAt:
format: date-time
readOnly: true
type: string
title: App User
type: object
x-speakeasy-name-override: AppUser
c1.api.app.v1.AppUserExpandMask:
description: The AppUserExpandMask message contains a list of paths to expand in the response.
properties:
paths:
description: The paths to expand in the response. May be any combination of "*", "identity_user_id", "app_id", and "last_usage".
items:
type: string
nullable: true
type: array
title: App User Expand Mask
type: object
x-speakeasy-name-override: AppUserExpandMask
c1.api.app.v1.AppUserServiceUpdateRequestInput:
description: The AppUserServiceUpdateRequest message contains the app user and the fields to be updated.
properties:
appUser:
$ref: '#/components/schemas/c1.api.app.v1.AppUser'
expandMask:
$ref: '#/components/schemas/c1.api.app.v1.AppUserExpandMask'
updateMask:
nullable: true
type: string
title: App User Service Update Request
type: object
x-speakeasy-name-override: AppUserServiceUpdateRequest
c1.api.app.v1.AppUserServiceUpdateResponse:
description: The AppUserServiceUpdateResponse message.
properties:
appUserView:
$ref: '#/components/schemas/c1.api.app.v1.AppUserView'
expanded:
description: The expanded field.
items:
additionalProperties: true
description: Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.
properties:
'@type':
description: The type of the serialized message.
type: string
type: object
nullable: true
type: array
title: App User Service Update Response
type: object
x-speakeasy-name-override: AppUserServiceUpdateResponse
c1.api.app.v1.AppUserStatus:
description: The satus of the applicaiton user.
properties:
details:
description: The details of applicaiton user status.
readOnly: true
type: string
status:
description: The application user status field.
enum:
- STATUS_UNSPECIFIED
- STATUS_ENABLED
- STATUS_DISABLED
- STATUS_DELETED
readOnly: true
type: string
title: App User Status
type: object
x-speakeasy-name-override: AppUserStatus
c1.api.app.v1.AppUserView:
description: The AppUserView contains an app user as well as paths for apps, identity users, and last usage in expanded arrays.
properties:
appPath:
description: JSONPATH expression indicating where the app is expanded in expanded arrays indicated in the request.
type: string
appUser:
$ref: '#/components/schemas/c1.api.app.v1.AppUser'
identityUserPath:
description: JSONPATH expression indicating where the identity user is expanded in expanded arrays indicated in the request.
type: string
lastUsagePath:
description: JSONPATH expression indicating where the last usage information is expanded in expanded arrays indicated in the request.
type: string
title: App User View
type: object
x-speakeasy-name-override: AppUserView
c1.api.app.v1.Connector:
description: A Connector is used to sync objects into Apps
properties:
appId:
description: The id of the app the connector is associated with.
type: string
catalogId:
description: The catalogId describes which catalog entry this connector is an instance of. For example, every Okta connector will have the same catalogId indicating it is an Okta connector.
readOnly: true
type: string
config:
additionalProperties: true
description: Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.
properties:
'@type':
description: The type of the serialized message.
type: string
type: object
createdAt:
format: date-time
readOnly: true
type: string
deletedAt:
format: date-time
readOnly: true
type: string
description:
description: The description of the connector.
type: string
displayName:
description: The display name of the connector.
type: string
downloadUrl:
description: The downloadUrl for a spreadsheet if the connector was created from uploading a file.
readOnly: true
type: string
id:
description: The id of the connector.
type: string
oauthAuthorizedAs:
$ref: '#/components/schemas/c1.api.app.v1.OAuth2AuthorizedAs'
status:
$ref: '#/components/schemas/c1.api.app.v1.ConnectorStatus'
updatedAt:
format: date-time
readOnly: true
type: string
userIds:
description: The userIds field is used to define the integration owners of the connector.
items:
type: string
nullable: true
type: array
title: Connector
type: object
x-speakeasy-name-override: Connector
c1.api.app.v1.ConnectorCredential:
description: ConnectorCredential is used by a connector to authenticate with conductor one.
properties:
appId:
description: The appId of the app the connector is attached to.
type: string
clientId:
description: The client id of the ConnectorCredential.
type: string
connectorId:
description: The connectorId of the connector the credential is associated with.
type: string
createdAt:
format: date-time
readOnly: true
type: string
deletedAt:
format: date-time
readOnly: true
type: string
displayName:
description: The display name of the ConnectorCredential.
type: string
expiresTime:
format: date-time
readOnly: true
type: string
id:
description: The id of the ConnectorCredential.
type: string
lastUsedAt:
format: date-time
readOnly: true
type: string
updatedAt:
format: date-time
readOnly: true
type: string
title: Connector Credential
type: object
x-speakeasy-entity: ConnectorCredential
x-speakeasy-name-override: ConnectorCredential
c1.api.app.v1.ConnectorExpandMask:
description: The ConnectorExpandMask is used to expand related objects on a connector.
properties:
paths:
description: Paths that you want expanded in the response. Possible values are "app_id" and "*".
items:
type: string
nullable: true
type: array
title: Connector Expand Mask
type: object
x-speakeasy-name-override: ConnectorExpandMask
c1.api.app.v1.ConnectorServiceCreateDelegatedRequestInput:
description: The ConnectorServiceCreateDelegatedRequest message contains the fields required to create a connector.
properties:
catalogId:
description: The catalogId describes which catalog entry this connector is an instance of. For example, every Okta connector will have the same catalogId indicating it is an Okta connector.
type: string
description:
description: The description of the connector.
type: string
displayName:
description: The displayName of the connector.
type: string
expandMask:
$ref: '#/components/schemas/c1.api.app.v1.ConnectorExpandMask'
userIds:
description: The userIds field is used to define the integration owners of the connector.
items:
type: string
nullable: true
type: array
title: Connector Service Create Delegated Request
type: object
x-speakeasy-name-override: ConnectorServiceCreateDelegatedRequest
c1.api.app.v1.ConnectorServiceCreateRequestInput:
description: The ConnectorServiceCreateRequest message.
properties:
catalogId:
description: The catalogId field.
type: string
config:
additionalProperties: true
description: Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.
properties:
'@type':
description: The type of the serialized message.
type: string
type: object
description:
description: The description field.
type: string
expandMask:
$ref: '#/components/schemas/c1.api.app.v1.ConnectorExpandMask'
userIds:
description: The userIds field.
items:
type: string
nullable: true
type: array
title: Connector Service Create Request
type: object
x-speakeasy-name-override: ConnectorServiceCreateRequest
c1.api.app.v1.ConnectorServiceCreateResponse:
description: The ConnectorServiceCreateResponse is the response returned from creating a connector.
properties:
connectorView:
$ref: '#/components/schemas/c1.api.app.v1.ConnectorView'
expanded:
description: The array of expanded items indicated by the request.
items:
additionalProperties: true
description: Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.
properties:
'@type':
description: The type of the serialized message.
type: string
type: object
nullable: true
type: array
title: Connector Service Create Response
type: object
x-speakeasy-name-override: ConnectorServiceCreateResponse
c1.api.app.v1.ConnectorServiceDeleteRequestInput:
description: ConnectorServiceDeleteRequest is a request for deleting a connector. It uses URL values for input.
title: Connector Service Delete Request
type: object
x-speakeasy-name-override: ConnectorServiceDeleteRequest
c1.api.app.v1.ConnectorServiceDeleteResponse:
description: Empty response body. Status code indicates success.
title: Connector Service Delete Response
type: object
x-speakeasy-name-override: ConnectorServiceDeleteResponse
c1.api.app.v1.ConnectorServiceGetCredentialsResponse:
description: ConnectorServiceGetCredentialsResponse is the response returned by the get method.
properties: