-
Notifications
You must be signed in to change notification settings - Fork 5
/
openapi.yaml
8825 lines (8615 loc) · 225 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
openapi: 3.0.0
info:
title: Factorial API
description: >-
Open Api Specifications available at
[https://github.com/factorialco/oas](https://github.com/factorialco/oasLooking)
Guides and support available at
[https://help.factorialhr.com/integrations](https://help.factorialhr.com/integrations)
# Authentication
The public API provides two methods of authentication, ApiKeys and OAuth2.
The following sections provide information regarding each one and their
intent.
## OAuth2
> OAuth2 is used to identify individual users, not applications or
platforms.
OAuth2 is available for authenticating to the public API and making requests
via third parties **on behalf of a user**. All actions are authored on
behalf of the user that creates the token. This means the intent is to be
used mainly to do submit actions the actual user is performing on an
alternative interface.
To generate a token you will require opening an authorization dialog that
returns a code, this code can then be exchanged for a token.
### Configuration
In order to create an OAuth application, you must be an admin, head over to
your [personal repository of OAuth
applications](https://api.factorialhr.com/oauth/applications), click on `New
application` and follow the creation process.
The Factorial API enforces the same permissions at the user level than the
Factorial web application. This means that Factorial API users will only be
able to perform the same actions they are allowed to do in the Factorial
platform.
Next step will be to generate the Authorization Code you will need in order
to generate an OAuth2 Token.
### OAuth2 Code Generation
Should be generated via browser by opening the following url. The user
should be already logged in to Factorial beforehand.
`https://api.factorialhr.com/oauth/authorize?client_id=&redirect_uri=&response_type=code&scope=`
YOUR_CLIENT_ID: OAuth2 Application Id
REDIRECT_URI: OAuth2 Redirect URL
#### State Parameter
An optional query parameter called `state` can be added to the code
generation url. Any string can be used and will be sent on the callback url.
> Authorization protocols provide a `state` parameter that allows you to
restore the previous state of your application. The `state` parameter
preserves some state objects set by the client in the Authorization request
and makes it available to the client in the response.
### OAuth2 Token Generation
Once you have the authorization code, you can request their access token to
Factorial.
`curl -X POST 'https://api.factorialhr.com/oauth/token' -d
'client_id=&client_secret=&code=&grant_type=authorization_code&redirect_uri='`
YOUR_CLIENT_ID: OAuth2 Application Id
YOUR_CLIENT_SECRET: OAuth2 Application Secret
AUTHORIZATION_CODE: OAuth2 CODE
REDIRECT_URI: OAuth2 Redirect URL
> You can generate only one OAuth2 token per Code, that means that if you
want to generate a new token for a Code that already have one you should
refresh your token.
Every time a new token is generated a refresh token is generated as well, so
that you can use it on the OAuth2 Refresh Token, and an expire date is also
provided.
### OAuth2 Refresh Token
You can generate a new token under the same Code with a new expire date (you
can do it as many times as you need). A refresh token is also returned here
so that you can use it on the OAuth2 Refresh Token again.
`curl -X POST 'https://api.factorialhr.com/oauth/token' -d
'client_id=&client_secret=&refresh_token=&grant_type=refresh_token'`
YOUR_CLIENT_ID: OAuth2 Application Id
YOUR_CLIENT_SECRET: OAuth2 Application Secret
REFRESH_TOKEN: OAuth2 Refresh Token
### OAuth2 Revoke Token
You can revoke an access/refresh token if you do not want it to be active
anylonger. This can happen in cases where you have refreshed your token and
would like to revoke the previous token if you haven't used the new token
yet, as using the new token automatically revokes the previous one.
`curl -X POST 'https://api.factorialhr.com/oauth/revoke' -d
'client_id=&client_secret=&token='`
YOUR_CLIENT_ID: OAuth2 Application Id
YOUR_CLIENT_SECRET: OAuth2 Application Secret
TOKEN: OAuth2 Access/Refresh Token (whichever you wish to revoke)
### OAuth2 Token Usage
The generated token is the credential for performing authenticated requests
to Factorial. This token should be included in the Authorization header
prefixed with the word Bearer and a separating space.
As an example, if your token is `12345` then the header content should be
`Bearer 12345`.
### Maintaining a persistent connection
To maintain a persistent connection, you should not let the token expire.
You can avoid this by simply refreshing your token before the expiration
date. This will give you another token with a new expiration date, before
that token expires you should refresh it again, and so on...
If you want to do this automatically, you should provide something in your
code that will help you perform the update every time the token expires.
Otherwise, you would have to do the update manually and make sure you
refresh your token before the expiration date to maintain the connection.
## ApiKeys
> API keys are used to identify systems, not the individual users that
access.
ApiKeys have **TOTAL ACCESS** to everything and never expire. Its the
creators responsibility to generate them and store them securely.
### Generation
In the `Core>Keys` section of this documentation you can access the apis for
managing this resource.
### Usage
ApiKeys are a single string of symbols that must be added as a custom header
on the request. The header name must be `x-api-key` and the key must be the
value without any prefixes.
### Disclaimer
ApiKey management require full admin permissions as the resource itself
allows for full admin access to the entire platform on behalf of the company
and not of a user, therefore any operations are not linked to any user in
particular.
# Development
## SDKs
Coming soon
## Sandbox
A sandbox/demo environment is available for testing integrations via public
API calls. Developers can request provisioning with full access to a demo
company where to test code before actually interacting with a production
environment.
Contact your account manager or account executive to request this
environment and get OAuth2 credentials for generating tokens.
Note: the domain for sandbox is different than that from production. Sandbox
base domain is `http://api.demo.factorialhr.com`
## Postman
Click the "Run in Postman" button to open the full list of endpoints on your
Postman workspace as a Postman Collection.
Inside the collection lookout for the Collection's Variables, configure your
variables accordingly.
### Delegating Token Generation To Postman
Coming soon
# Changelog
Coming soon
# How to...
## Custom Fields
Custom fields are useful when you want to add some fields that are not the
default ones, to every employee of the company.
For that, you have to create via Factorial App the base custom field in
order to have all the employees with it. That option is available in
customization, inside the company menu
Once you have that, via API, you can [Create a value for a custom
field](https://apidoc.factorialhr.com/#72f3f786-e37d-4e80-ada2-0beedd03b171)
to each employee. You should know the custom field id in order to make that,
you can check it by [getting a collection of custom
fields](https://apidoc.factorialhr.com/#f98dae5a-a8d0-474e-a181-7e9603409b42)
version: 1.0.0
x-konfig-ignore:
potential-incorrect-type: true
servers:
- url: https://api.factorialhr.com/api
- url: https://api.demo.factorial.dev/api
tags:
- name: Employee
- name: Leave
- name: Shift
- name: Task
- name: Post
- name: Webhook
- name: Team
- name: Document
- name: Compensation
- name: Workplace
- name: Folder
- name: CustomField
- name: CustomFieldValue
- name: Candidate
- name: Supplement
- name: Table
- name: User
- name: Location
- name: Key
- name: Attendance
- name: ContractVersion
- name: Contract
- name: Integration
- name: Break
- name: Holiday
- name: LegalEntity
- name: FamilySituation
- name: Application
- name: Message
- name: Policy
- name: Expense
- name: Taxonomy
- name: IntegrationCode
- name: CustomTable
- name: Event
paths:
/v1/employees:
get:
tags:
- Employee
summary: Get employees from a company
operationId: Employee_getEmployees
security:
- apikey: []
description: >-
Only `admins` can see all the employees' information, `regular users`
will get a restricted version of the payload as a response based on the
permission set by the admin
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/EmployeeGetEmployeesResponse'
post:
tags:
- Employee
summary: Create employee
operationId: Employee_createEmployee
description: Create employee
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/EmployeeCreateEmployeeRequest'
responses:
'201':
description: Created
content:
application/json:
schema:
$ref: '#/components/schemas/Employee'
/v1/employees/{id}:
get:
tags:
- Employee
summary: Get employee
operationId: Employee_getEmployeeById
description: >-
Only admins can see all the employees' information, regular users will
get a restricted version of the payload as a response based on the
permission set by the admin
parameters:
- description: (Required)
name: id
in: path
schema:
type: string
required: true
example: 5
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Employee'
put:
tags:
- Employee
summary: Update employee
operationId: Employee_updateById
description: Update employee
parameters:
- description: (Required)
name: id
in: path
schema:
type: string
required: true
example: 5
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/EmployeeUpdateByIdRequest'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Employee'
/v1/employees/{id}/terminate:
post:
tags:
- Employee
summary: Terminate employee
operationId: Employee_terminateEmployee
description: Terminate employee
parameters:
- description: (Required)
name: id
in: path
schema:
type: string
required: true
example: 5
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/EmployeeTerminateEmployeeRequest'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Employee'
/v1/employees/{id}/unterminate:
post:
tags:
- Employee
summary: Unterminate employee
operationId: Employee_unterminateEmployee
description: Unterminate employee
parameters:
- description: (Required)
name: id
in: path
schema:
type: string
required: true
example: 5
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Employee'
/v2/core/employees:
get:
tags:
- Employee
summary: Get employees from a company
operationId: Employee_getAllEmployees
security:
- apikey: []
description: >-
Only `admins` can see all the employees' information, `regular users`
will get a restricted version of the payload as a response based on the
permission set by the admin
parameters:
- description: Retrieves the list of employees by full names
name: full_text_name
in: query
schema:
type: string
example: Bob Stone
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/EmployeeGetAllEmployeesResponse'
post:
tags:
- Employee
summary: Create employee
operationId: Employee_createNew
security:
- apikey: []
description: Create employee
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/EmployeeCreateNewRequest'
responses:
'201':
description: Created
content:
application/json:
schema:
$ref: '#/components/schemas/Employee_v2'
/v2/core/employees/{id}:
get:
tags:
- Employee
summary: Get employee
operationId: Employee_getById
security:
- apikey: []
description: >-
Only admins can see all the employees' information, regular users will
get a restricted version of the payload as a response based on the
permission set by the admin
parameters:
- description: (Required)
name: id
in: path
schema:
type: string
required: true
example: 5
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Employee_v2'
put:
tags:
- Employee
summary: Update employee
operationId: Employee_updateEmployeeById
security:
- apikey: []
description: Update employee
parameters:
- description: (Required)
name: id
in: path
schema:
type: string
required: true
example: 5
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/EmployeeUpdateEmployeeByIdRequest'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Employee_v2'
/v2/core/employees/{id}/invite:
post:
tags:
- Employee
summary: Invite employee
operationId: Employee_sendInvitationEmail
security:
- apikey: []
description: >-
When inviting an employee an email is sent to their email. You can
resend the email as long as the employee has not accepted the invitation
yet.
parameters:
- description: (Required)
name: id
in: path
schema:
type: string
required: true
example: 5
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Employee_v2'
/v2/core/employees/{id}/email:
put:
tags:
- Employee
summary: Change employee email
operationId: Employee_changeEmail
security:
- apikey: []
description: >-
Changes the email only if the employee has not been confirmed and it
does not exist another employee with the requested email.
parameters:
- description: (Required)
name: id
in: path
schema:
type: string
required: true
example: 5
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/EmployeeChangeEmailRequest'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Employee_v2'
/v2/core/employees/{id}/terminate:
post:
tags:
- Employee
summary: Terminate employee
operationId: Employee_setTerminationDetails
security:
- apikey: []
description: >-
Set the termination date and other termination related parameters for an
employee. The employee will finally terminate on the date provided.
parameters:
- description: (Required)
name: id
in: path
schema:
type: string
required: true
example: 5
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/EmployeeSetTerminationDetailsRequest'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Employee_v2'
/v2/core/employees/{id}/unterminate:
post:
tags:
- Employee
summary: Unterminate employee
operationId: Employee_unterminatePost
security:
- apikey: []
description: Unterminate the employee
parameters:
- description: (Required)
name: id
in: path
schema:
type: string
required: true
example: 5
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Employee_v2'
/v2/core/webhooks:
get:
tags:
- User
summary: Get a list of all subscribed webhooks for current user
operationId: User_subscribedWebhooksList
security:
- apikey: []
description: Get a list of all subscribed webhooks for current user
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/UserSubscribedWebhooksListResponse'
post:
tags:
- Webhook
summary: Create a webhook
operationId: Webhook_subscriptionCreate
security:
- apikey: []
description: >-
> Creates a subscription for a determined webhook type. If webhook
already exists, it just changes the target_url.
## Webhooks Types
| **Subscription Type** | **Information** |
| --- | --- |
| Authentication::Events::AccessInvited | When creating a new employee,
optionally you can send an invitation to create an account in Factorial.
If you send an invitation, this event gets triggered. |
| Employees::Events::EmployeeCreated | When creating a new employee,
after submitting the form, this event gets triggered. |
| Employees::Events::EmployeeUpdated| When updating personal protected
employee information such has birthday, this event gets triggered. |
| Employees::Events::EmployeeTerminated | When terminating an employee,
after submitting the form, this event gets triggered |
| Employees::Events::EmployeeUnterminated | When un terminating an
employee, after submitting the form, this event gets triggered |
| Attendance::Events::ClockIn | When the user clocks in and starts the
timer, this event is triggered. |
| Attendance::Events::ClockOut | When the user clocks out and stops the
timer, this event is triggered |
| Attendance::Events::AttendanceShiftCreated | When the user creates a
shift, this event is triggered |
| Attendance::Events::AttendanceShiftUpdated | When the user edits a
shift, this event is triggered |
| Attendance::Events::AttendanceShiftDeleted | When the user deletes a
shift, this event is triggered |
| Ats::Events::ApplicationCreated | When a candidate applies for a
posting. |
| Ats::Events::ApplicationUpdated | When a candidates application for a
posting suffers changes. |
| Ats::Events::JobPostingCreated | When a job posting is created. |
| Ats::Events::JobPostingUpdated | When a job posting is updated. |
| Ats::Events::JobPostingDeleted | When a job posting is deleted. |
| Timeoff::Events::LeaveCreated | When a Timeoff Leave is created. |
| Timeoff::Events::LeaveDestroyed | When a Timeoff Leave is destroyed. |
| Timeoff::Events::LeaveUpdated | When a Timeoff Leave suffers any
changes. |
| Timeoff::Events::LeaveApproved | When a Timeoff Leave is explicitly
approved. |
| Timeoff::Events::LeaveRejected | When a Timeoff Leave is rejected. |
| Documents::Events::Created | When a document is created. |
| Tasks::Events::Created | When a task is created. |
| Contracts::Events::ContractVersionCreated | When a contract version is
created. |
| Payroll::Events::SupplementCreated | When a payroll supplement is
created. |
| Payroll::Events::SupplementUpdated | When a payroll supplement is
updated. |
| Payroll::Events::SupplementDeleted | When a payroll supplement is
deleted. |
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/WebhookSubscriptionCreateRequest'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/WebhookSubscriptionCreateResponse'
/v2/core/webhooks/{id}:
put:
tags:
- Webhook
summary: Update a Webhook
operationId: Webhook_updateWebhookById
security:
- apikey: []
description: Update a Webook
parameters:
- description: (Required)
name: id
in: path
schema:
type: string
required: true
example: 1
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/WebhookUpdateWebhookByIdRequest'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Webhook_v2'
delete:
tags:
- Webhook
summary: Delete a Webhook
operationId: Webhook_deleteWebhook
security:
- apikey: []
description: Delete a Webook
parameters:
- description: (Required)
name: id
in: path
schema:
type: string
required: true
example: 1
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Webhook_v2'
/v1/me:
get:
tags:
- User
summary: Get information about current user
operationId: User_infoGet
description: After token grant, get information of the token holder
responses:
'200':
description: OK
/v1/locations:
get:
tags:
- Location
summary: Get all locations
operationId: Location_getAllLocations
security:
- apikey: []
description: Get all locations
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/LocationGetAllLocationsResponse'
/v1/locations/{id}:
get:
tags:
- Location
summary: Get a Location by ID
operationId: Location_getById
security:
- apikey: []
description: Get a Location by ID
parameters:
- description: (Required)
name: id
in: path
schema:
type: string
required: true
example: 1
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Location'
/v1/company_holidays:
get:
tags:
- Holiday
summary: Get all company holidays
operationId: Holiday_getAllCompanyHolidays
security:
- apikey: []
description: Get all company holidays
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/HolidayGetAllCompanyHolidaysResponse'
/v1/company_holidays/{id}:
get:
tags:
- Holiday
summary: Get a company holiday by ID
operationId: Holiday_getById
security:
- apikey: []
description: Get a company holiday by ID
parameters:
- description: (Required)
name: id
in: path
schema:
type: string
required: true
example: 5
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/CompanyHoliday'
/v1/core/teams:
get:
tags:
- Team
summary: Get teams
operationId: Team_getAllTeams
security:
- apikey: []
description: Get teams
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/TeamGetAllTeamsResponse'
post:
tags:
- Team
summary: Create a team
operationId: Team_createNewTeam
security:
- apikey: []
description: Create a team with a given name
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/TeamCreateNewTeamRequest'
responses:
'201':
description: Created
content:
application/json:
schema:
$ref: '#/components/schemas/Team'
/v1/core/teams/{id}:
get:
tags:
- Team
summary: Get a team by ID
operationId: Team_getById
security:
- apikey: []
description: Get a team by ID
parameters:
- description: (Required)
name: id
in: path
schema:
type: string
required: true
example: 1
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/TeamGetByIdResponse'
put:
tags:
- Team
summary: Update a team
operationId: Team_updateTeamById
security:
- apikey: []