-
Notifications
You must be signed in to change notification settings - Fork 732
Expand file tree
/
Copy pathopenapi.yaml
More file actions
1504 lines (1462 loc) · 45.4 KB
/
openapi.yaml
File metadata and controls
1504 lines (1462 loc) · 45.4 KB
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.1.0
info:
title: CDP Public API
version: 1.0.0
license:
name: Apache-2.0
url: https://www.apache.org/licenses/LICENSE-2.0
description: >
Public REST API for the Community Data Platform (CDP). Provides transactional
endpoints for identity verification, work experience management, project
affiliations, and contributor lookup.
Two authentication methods are supported depending on the endpoint:
- **OAuth 2.0 Bearer (Auth0)** — used by LFX One for member, organization,
and affiliation management endpoints.
- **Static API Key** — bearer token with scopes managed in the CDP database.
servers:
- url: https://cm.lfx.dev/api/v1
description: Production
- url: https://lf-staging.crowd.dev/api/v1
description: Staging
security: []
tags:
- name: Members
description: Resolve member profiles by identity.
- name: Member Identities
description: Manage and verify member identities across platforms.
- name: Maintainer Roles
description: Retrieve maintainer roles for a member.
- name: Work Experiences
description: Manage and verify member work experiences (organization affiliations).
- name: Project Affiliations
description: View and override per-project affiliation data for a member.
- name: Organizations
description: Look up and create organizations.
- name: Affiliations
description: Bulk contributor affiliation lookups by GitHub handle.
paths:
# ──────────────────────────────────────────────
# Members
# ──────────────────────────────────────────────
/members/resolve:
post:
operationId: resolveMember
summary: Resolve a CDP member profile
description: >
Resolve a `memberId` from one or more identities. LFX One should always
call this first to obtain the CDP member ID before using other endpoints.
Returns 404 if no matching profile exists, or 409 if the provided
identities belong to different profiles.
tags:
- Members
security:
- OAuth2Bearer:
- read:members
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- lfids
properties:
lfids:
type: array
description: LFX IDs to search for.
minItems: 1
items:
type: string
minLength: 1
emails:
type: array
description: Optional email addresses to include in the lookup.
items:
type: string
format: email
example:
lfids:
- abc123
emails:
- user@example.com
responses:
'200':
description: Member resolved successfully.
content:
application/json:
schema:
type: object
required:
- memberId
properties:
memberId:
type: string
format: uuid
example:
memberId: 550e8400-e29b-41d4-a716-446655440000
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
description: No matching member profile found.
content:
application/json:
schema:
$ref: '#/components/schemas/HttpError'
example:
error:
code: NOT_FOUND
message: Member not found
'409':
description: The provided identities belong to different member profiles.
content:
application/json:
schema:
$ref: '#/components/schemas/HttpError'
example:
error:
code: CONFLICT
message: Conflicting identities
# ──────────────────────────────────────────────
# Member Identities
# ──────────────────────────────────────────────
/members/{memberId}/identities:
get:
operationId: getMemberIdentities
summary: List member identities
description: Retrieve all identities for a member profile.
tags:
- Member Identities
security:
- OAuth2Bearer:
- read:member-identities
parameters:
- $ref: '#/components/parameters/MemberId'
responses:
'200':
description: Identities retrieved successfully.
content:
application/json:
schema:
type: object
required:
- identities
properties:
identities:
type: array
items:
$ref: '#/components/schemas/MemberIdentity'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/MemberNotFound'
post:
operationId: createMemberIdentity
summary: Add a new identity
description: >
Add a new identity to a member profile. Returns 409 if the identity
already exists on this member or is verified on another member.
tags:
- Member Identities
security:
- OAuth2Bearer:
- write:member-identities
parameters:
- $ref: '#/components/parameters/MemberId'
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- value
- platform
- type
- source
- verified
properties:
value:
type: string
minLength: 1
description: Identity value (e.g. username, email address).
platform:
type: string
minLength: 1
description: Platform name (e.g. github, linkedin).
type:
type: string
enum:
- username
- email
description: Identity type.
source:
type: string
minLength: 1
description: Source system that created this identity.
verified:
type: boolean
description: Whether the identity is verified.
verifiedBy:
type: string
description: Required when `verified` is true. Identifier of who verified.
example:
value: johndoe
platform: github
type: username
source: lfxOne
verified: true
verifiedBy: admin@lfx.dev
responses:
'201':
description: Identity created.
content:
application/json:
schema:
$ref: '#/components/schemas/MemberIdentity'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/MemberNotFound'
'409':
description: Identity already exists on this member or is verified on another.
content:
application/json:
schema:
$ref: '#/components/schemas/HttpError'
example:
error:
code: CONFLICT
message: Identity already exists on this member
/members/{memberId}/identities/{identityId}:
patch:
operationId: verifyMemberIdentity
summary: Verify or reject an identity
description: >
Set an identity as verified or rejected. When rejected (`verified: false`),
the identity is either soft-deleted (no linked activities) or unmerged to
a new profile (has linked activities).
tags:
- Member Identities
security:
- OAuth2Bearer:
- write:member-identities
parameters:
- $ref: '#/components/parameters/MemberId'
- name: identityId
in: path
required: true
description: UUID of the identity to verify or reject.
schema:
type: string
format: uuid
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- verified
- verifiedBy
properties:
verified:
type: boolean
description: >
`true` to verify the identity, `false` to reject it.
verifiedBy:
type: string
description: Identifier of who performed the verification.
example:
verified: true
verifiedBy: admin@lfx.dev
responses:
'200':
description: >
Identity updated. Returned when verifying, or when rejecting an
identity that has linked activities (triggers unmerge).
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/MemberIdentity'
- type: object
properties:
unmergedToMemberId:
type: string
format: uuid
description: >
Present only when rejection triggered an unmerge. The
new member profile ID that the identity was moved to.
'204':
description: >
Identity rejected and deleted (no linked activities). No response body.
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
description: Member or identity not found.
content:
application/json:
schema:
$ref: '#/components/schemas/HttpError'
'409':
description: Identity is already verified on another member.
content:
application/json:
schema:
$ref: '#/components/schemas/HttpError'
example:
error:
code: CONFLICT
message: Identity already verified on another member
# ──────────────────────────────────────────────
# Maintainer Roles
# ──────────────────────────────────────────────
/members/{memberId}/maintainer-roles:
get:
operationId: getMemberMaintainerRoles
summary: List maintainer roles
description: Retrieve all maintainer roles for a member across projects.
tags:
- Maintainer Roles
security:
- OAuth2Bearer:
- read:maintainer-roles
parameters:
- $ref: '#/components/parameters/MemberId'
responses:
'200':
description: Maintainer roles retrieved successfully.
content:
application/json:
schema:
type: object
required:
- maintainerRoles
properties:
maintainerRoles:
type: array
items:
$ref: '#/components/schemas/MaintainerRole'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/MemberNotFound'
# ──────────────────────────────────────────────
# Work Experiences
# ──────────────────────────────────────────────
/members/{memberId}/work-experiences:
get:
operationId: getMemberWorkExperiences
summary: List work experiences
description: Retrieve all work experiences for a member.
tags:
- Work Experiences
security:
- OAuth2Bearer:
- read:work-experiences
parameters:
- $ref: '#/components/parameters/MemberId'
responses:
'200':
description: Work experiences retrieved successfully.
content:
application/json:
schema:
type: object
required:
- memberId
- workExperiences
properties:
memberId:
type: string
format: uuid
workExperiences:
type: array
items:
$ref: '#/components/schemas/WorkExperience'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/MemberNotFound'
post:
operationId: createMemberWorkExperience
summary: Add a work experience
description: >
Add a new work experience to a member profile. Returns 409 if a work
experience with the same dates already exists.
tags:
- Work Experiences
security:
- OAuth2Bearer:
- write:work-experiences
parameters:
- $ref: '#/components/parameters/MemberId'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/WorkExperienceInput'
example:
organizationId: 550e8400-e29b-41d4-a716-446655440000
jobTitle: Senior Engineer
verified: true
verifiedBy: admin@lfx.dev
source: lfxOne
startDate: '2020-01-01T00:00:00.000Z'
endDate: null
responses:
'201':
description: Work experience created.
content:
application/json:
schema:
$ref: '#/components/schemas/WorkExperience'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/MemberNotFound'
'409':
description: A work experience with the same dates already exists.
content:
application/json:
schema:
$ref: '#/components/schemas/HttpError'
example:
error:
code: CONFLICT
message: A work experience with the same dates already exists
/members/{memberId}/work-experiences/{workExperienceId}:
put:
operationId: updateMemberWorkExperience
summary: Update a work experience
description: Replace all fields of an existing work experience.
tags:
- Work Experiences
security:
- OAuth2Bearer:
- write:work-experiences
parameters:
- $ref: '#/components/parameters/MemberId'
- $ref: '#/components/parameters/WorkExperienceId'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/WorkExperienceInput'
responses:
'200':
description: Work experience updated.
content:
application/json:
schema:
$ref: '#/components/schemas/WorkExperience'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
description: Member or work experience not found.
content:
application/json:
schema:
$ref: '#/components/schemas/HttpError'
patch:
operationId: verifyMemberWorkExperience
summary: Verify or reject a work experience
description: >
Set a work experience as verified or rejected. When rejected
(`verified: false`), the work experience is soft-deleted and
affiliations are recalculated.
tags:
- Work Experiences
security:
- OAuth2Bearer:
- write:work-experiences
parameters:
- $ref: '#/components/parameters/MemberId'
- $ref: '#/components/parameters/WorkExperienceId'
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- verified
- verifiedBy
properties:
verified:
type: boolean
description: >
`true` to verify, `false` to reject (soft-delete).
verifiedBy:
type: string
description: Identifier of who performed the verification.
example:
verified: true
verifiedBy: admin@lfx.dev
responses:
'200':
description: Work experience updated.
content:
application/json:
schema:
$ref: '#/components/schemas/WorkExperience'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
description: Member or work experience not found.
content:
application/json:
schema:
$ref: '#/components/schemas/HttpError'
delete:
operationId: deleteMemberWorkExperience
summary: Delete a work experience
description: >
Soft-delete a work experience from a member profile. Affiliations are
automatically recalculated.
tags:
- Work Experiences
security:
- OAuth2Bearer:
- write:work-experiences
parameters:
- $ref: '#/components/parameters/MemberId'
- $ref: '#/components/parameters/WorkExperienceId'
responses:
'204':
description: Work experience deleted. No response body.
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
description: Member or work experience not found.
content:
application/json:
schema:
$ref: '#/components/schemas/HttpError'
# ──────────────────────────────────────────────
# Project Affiliations
# ──────────────────────────────────────────────
/members/{memberId}/project-affiliations:
get:
operationId: getMemberProjectAffiliations
summary: List project affiliations
description: >
Retrieve per-project affiliation data for a member, including maintainer
roles and resolved affiliations. Affiliations come from project-level
overrides when available, otherwise from work experiences.
tags:
- Project Affiliations
security:
- OAuth2Bearer:
- read:project-affiliations
parameters:
- $ref: '#/components/parameters/MemberId'
responses:
'200':
description: Project affiliations retrieved successfully.
content:
application/json:
schema:
type: object
required:
- projectAffiliations
properties:
projectAffiliations:
type: array
items:
$ref: '#/components/schemas/ProjectAffiliation'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/MemberNotFound'
/members/{memberId}/project-affiliations/{projectId}:
patch:
operationId: patchMemberProjectAffiliation
summary: Override project affiliations
description: >
Replace all project-level affiliation overrides for a member on a
specific project. Pass an empty `affiliations` array to clear overrides
(falling back to work experience-based affiliations).
tags:
- Project Affiliations
security:
- OAuth2Bearer:
- write:project-affiliations
parameters:
- $ref: '#/components/parameters/MemberId'
- name: projectId
in: path
required: true
description: UUID of the project (segment ID).
schema:
type: string
format: uuid
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- affiliations
properties:
affiliations:
type: array
description: >
Affiliation overrides. Pass an empty array to clear.
items:
type: object
required:
- organizationId
- dateStart
properties:
organizationId:
type: string
format: uuid
dateStart:
type: string
format: date-time
description: Start date of the affiliation period.
dateEnd:
type:
- string
- 'null'
format: date-time
description: End date, or null if currently active.
verifiedBy:
type: string
maxLength: 255
description: Required when `affiliations` is non-empty.
example:
affiliations:
- organizationId: 550e8400-e29b-41d4-a716-446655440000
dateStart: '2020-01-01T00:00:00.000Z'
dateEnd: null
verifiedBy: admin@lfx.dev
responses:
'200':
description: Project affiliations updated.
content:
application/json:
schema:
$ref: '#/components/schemas/ProjectAffiliation'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
description: Member or project not found.
content:
application/json:
schema:
$ref: '#/components/schemas/HttpError'
# ──────────────────────────────────────────────
# Organizations
# ──────────────────────────────────────────────
/organizations:
get:
operationId: getOrganization
summary: Look up an organization by domain
description: Find a verified organization by its primary domain.
tags:
- Organizations
security:
- OAuth2Bearer:
- read:organizations
parameters:
- name: domain
in: query
required: true
description: Primary domain of the organization.
schema:
type: string
minLength: 1
example: linuxfoundation.org
responses:
'200':
description: Organization found.
content:
application/json:
schema:
$ref: '#/components/schemas/Organization'
example:
id: 550e8400-e29b-41d4-a716-446655440000
name: Linux Foundation
logo: https://example.com/logo.png
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
description: No verified organization found for the given domain.
content:
application/json:
schema:
$ref: '#/components/schemas/HttpError'
example:
error:
code: NOT_FOUND
message: Organization not found
post:
operationId: createOrganization
summary: Create an organization
description: >
Create a new organization with a verified primary domain. If an
organization with the same domain already exists, it returns the
existing one.
tags:
- Organizations
security:
- OAuth2Bearer:
- write:organizations
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- name
- domain
- source
- logo
properties:
name:
type: string
minLength: 1
description: Display name of the organization.
domain:
type: string
minLength: 1
description: Primary domain of the organization.
source:
type: string
minLength: 1
description: Source system creating the organization.
logo:
type: string
format: uri
description: URL of the organization's logo.
example:
name: Acme Corp
domain: acme.com
source: lfxOne
logo: https://example.com/logo.png
responses:
'201':
description: Organization created (or existing one returned).
content:
application/json:
schema:
type: object
required:
- id
- name
properties:
id:
type: string
format: uuid
name:
type: string
example:
id: 550e8400-e29b-41d4-a716-446655440000
name: Acme Corp
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
# ──────────────────────────────────────────────
# Affiliations (Static API Key)
# ──────────────────────────────────────────────
/affiliations:
post:
operationId: getBulkAffiliations
summary: Bulk contributor lookup
description: >
Look up affiliation data for up to 100 GitHub handles in a single
request. Handles that have no matching LFX profile are returned in the
`notFound` array.
tags:
- Affiliations
security:
- StaticApiKey: []
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- githubHandles
properties:
githubHandles:
type: array
description: >
List of GitHub login handles to look up (case-insensitive).
minItems: 1
maxItems: 100
items:
type: string
minLength: 1
example:
githubHandles:
- torvalds
- gvanrossum
parameters:
- name: page
in: query
description: Page number (1-based).
schema:
type: integer
minimum: 1
default: 1
- name: pageSize
in: query
description: Number of contributors to return per page.
schema:
type: integer
minimum: 1
maximum: 100
default: 20
responses:
'200':
description: Affiliations resolved successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/BulkAffiliationsResponse'
example:
total: 2
totalFound: 2
page: 1
pageSize: 20
contributorsInPage: 2
contributors:
- githubHandle: torvalds
name: Linus Torvalds
emails:
- torvalds@linux-foundation.org
affiliations:
- organization: Linux Foundation
startDate: '2007-01-01T00:00:00.000Z'
endDate: null
notFound: []
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'429':
$ref: '#/components/responses/TooManyRequests'
/affiliations/{githubHandle}:
get:
operationId: getAffiliationByHandle
summary: Single contributor lookup
description: >
Look up affiliation data for one developer by GitHub handle. Useful for
debugging and ad-hoc queries.
tags:
- Affiliations
security:
- StaticApiKey: []
parameters:
- name: githubHandle
in: path
required: true
description: GitHub login handle (case-insensitive).
schema:
type: string
minLength: 1
example: torvalds
responses:
'200':
description: Developer found.
content:
application/json:
schema:
$ref: '#/components/schemas/Contributor'
example:
githubHandle: torvalds
name: Linus Torvalds
emails:
- torvalds@linux-foundation.org
affiliations:
- organization: Linux Foundation
startDate: '2007-01-01T00:00:00.000Z'
endDate: null
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
description: No LFX profile found for the given GitHub handle.
content:
application/json:
schema:
$ref: '#/components/schemas/HttpError'
example:
error:
code: NOT_FOUND
message: "No LFX profile found for GitHub login 'nonexistent-user'."
'429':
$ref: '#/components/responses/TooManyRequests'
components:
securitySchemes:
OAuth2Bearer:
type: oauth2
description: >
OAuth 2.0 client credentials flow via Auth0. The consuming service
obtains a JWT using its client ID and secret, then passes it as
`Authorization: Bearer <token>`
flows:
clientCredentials:
tokenUrl: https://linuxfoundation.auth0.com/oauth/token
scopes:
read:members: Read member profiles
read:member-identities: Read member identities
write:member-identities: Create and verify member identities
read:maintainer-roles: Read maintainer roles
read:work-experiences: Read work experiences
write:work-experiences: Create, update, verify, and delete work experiences
read:project-affiliations: Read project affiliations
write:project-affiliations: Override project affiliations
read:organizations: Look up organizations
write:organizations: Create organizations
StaticApiKey:
type: http
scheme: bearer
description: >
Static API key — pass as `Authorization: Bearer <token>`. Keys are
managed in the CDP database with SHA-256 hashing, expiration, and
revocation support.
parameters:
MemberId:
name: memberId
in: path
required: true
description: UUID of the member.
schema:
type: string
format: uuid