-
Notifications
You must be signed in to change notification settings - Fork 35
Expand file tree
/
Copy pathauth-oas-v1-public.yaml
More file actions
4721 lines (4652 loc) · 214 KB
/
auth-oas-v1-public.yaml
File metadata and controls
4721 lines (4652 loc) · 214 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.0.3
info:
x-api-type: Shopper
x-api-family: Shopper
title: Auth
version: 1.46.0
description: |-
[Download API specification](https://developer.salesforce.com/static/commercecloud/commerce-api/auth/auth-oas-v1-public.yaml)
# API Overview
The Shopper Login and API Access Service (SLAS) enables secure access to Commerce Cloud’s Shopper APIs for a wide range of headless commerce applications.
**Important:** Before using this API, see [Authorization for Shopper APIs](https://developer.salesforce.com/docs/commerce/commerce-api/guide/authorization-for-shopper-apis.html) in the Get Started guides and the more detailed [SLAS guides](https://developer.salesforce.com/docs/commerce/commerce-api/guide/slas.html) for instructions on setting up a SLAS client, obtaining credentials, as well as flow and use case information.
For load shedding and rate limiting information, see [Load Shedding and Rate Limiting.](https://developer.salesforce.com/docs/commerce/commerce-api/guide/throttle-rates.html)
servers:
- url: https://{shortCode}.api.commercecloud.salesforce.com/shopper/auth/v1
variables:
shortCode:
default: shortCode
paths:
/organizations/{organizationId}/oauth2/login:
post:
summary: Log in a shopper with credentials that are managed by a B2C Commerce instance (B2C Commerce).
description: |-
This follows the authorization code grant flow as defined by the OAuth 2.1 standard. It also uses a proof key for code exchange (PKCE).
For PKCE values:
- The `code_verifier` string is a random string used for the `/token` endpoint request.
- The `code_challenge` is an encoded version of the `code_verifier` string using an SHA-256 hash.
The request must include a basic authorization header that contains a Base64 encoded version of the following string: `<shopperUserID>:<shopperPassword>`.
Required parameters: `code_challenge`, `channel_id`, `client_id`, and `redirect_uri`.
Optional parameters: `usid`.
The SLAS `/login` endpoint redirects back to the redirect URI and returns an authorization code.
Calls to `/login` made with the same loginId and tenantId within 1 second result in a conflict.
operationId: authenticateCustomer
parameters:
- $ref: '#/components/parameters/organizationId'
- name: Authorization
in: header
description: Base64-encoded username and password for HTTP basic authentication
required: true
schema:
type: string
example: Basic <client credentials>
requestBody:
content:
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/LoginRequest'
required: true
responses:
'303':
description: The authorization code and usid were successfuly added to the location header and sent to the callback as query parameters.
content:
application/json:
schema:
type: string
examples:
authenticateCustomerSuccess:
$ref: '#/components/examples/authenticateCustomerSuccess'
headers:
X-RateLimit-1M-Limit:
description: The 1 minute maximum number of requests permitted per hour.
schema:
type: string
X-RateLimit-1M-Remaining:
description: The 1 minute number of requests remaining in the current rate limit window.
schema:
type: string
X-RateLimit-1M-Reset:
description: The 1 minute time at which the current rate limit window resets in UTC epoch seconds.
schema:
type: string
X-RateLimit-5M-Limit:
description: The 5 minute maximum number of requests permitted per hour.
schema:
type: string
X-RateLimit-5M-Remaining:
description: The 5 minute number of requests remaining in the current rate limit window.
schema:
type: string
X-RateLimit-5M-Reset:
description: The 5 minute time at which the current rate limit window resets in UTC epoch seconds.
schema:
type: string
'400':
description: Bad request
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Oauth2ErrorResponse'
examples:
BadOrMissingClientId400:
$ref: '#/components/examples/BadOrMissingClientId400'
headers:
X-RateLimit-1M-Limit:
description: The 1 minute maximum number of requests permitted per hour.
schema:
type: string
X-RateLimit-1M-Remaining:
description: The 1 minute number of requests remaining in the current rate limit window.
schema:
type: string
X-RateLimit-1M-Reset:
description: The 1 minute time at which the current rate limit window resets in UTC epoch seconds.
schema:
type: string
X-RateLimit-5M-Limit:
description: The 5 minute maximum number of requests permitted per hour.
schema:
type: string
X-RateLimit-5M-Remaining:
description: The 5 minute number of requests remaining in the current rate limit window.
schema:
type: string
X-RateLimit-5M-Reset:
description: The 5 minute time at which the current rate limit window resets in UTC epoch seconds.
schema:
type: string
'401':
description: Unauthorized
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Oauth2ErrorResponse'
examples:
InvalidBasicAuth401:
$ref: '#/components/examples/InvalidBasicAuth401'
headers:
X-RateLimit-1M-Limit:
description: The 1 minute maximum number of requests permitted per hour.
schema:
type: string
X-RateLimit-1M-Remaining:
description: The 1 minute number of requests remaining in the current rate limit window.
schema:
type: string
X-RateLimit-1M-Reset:
description: The 1 minute time at which the current rate limit window resets in UTC epoch seconds.
schema:
type: string
X-RateLimit-5M-Limit:
description: The 5 minute maximum number of requests permitted per hour.
schema:
type: string
X-RateLimit-5M-Remaining:
description: The 5 minute number of requests remaining in the current rate limit window.
schema:
type: string
X-RateLimit-5M-Reset:
description: The 5 minute time at which the current rate limit window resets in UTC epoch seconds.
schema:
type: string
'409':
description: Conflict
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Oauth2ErrorResponse'
examples:
ConflictingCalls409:
$ref: '#/components/examples/ConflictingCalls409'
'500':
description: Internal server error
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Oauth2ErrorResponse'
examples:
InternalServerError500:
$ref: '#/components/examples/InternalServerError500'
headers:
X-RateLimit-1M-Limit:
description: The 1 minute maximum number of requests permitted per hour.
schema:
type: string
X-RateLimit-1M-Remaining:
description: The 1 minute number of requests remaining in the current rate limit window.
schema:
type: string
X-RateLimit-1M-Reset:
description: The 1 minute time at which the current rate limit window resets in UTC epoch seconds.
schema:
type: string
X-RateLimit-5M-Limit:
description: The 5 minute maximum number of requests permitted per hour.
schema:
type: string
X-RateLimit-5M-Remaining:
description: The 5 minute number of requests remaining in the current rate limit window.
schema:
type: string
X-RateLimit-5M-Reset:
description: The 5 minute time at which the current rate limit window resets in UTC epoch seconds.
schema:
type: string
/organizations/{organizationId}/oauth2/passwordless/login:
post:
summary: Allow the customer to authenticate when their identity provider is down.
description: This endpoint allows customers to authenticate when their configured identity provider is inaccessible. It provides an alternative authentication path through passwordless login methods like email or SMS verification.
operationId: authorizePasswordlessCustomer
parameters:
- $ref: '#/components/parameters/organizationId'
- $ref: '#/components/parameters/register_customer'
- name: Authorization
in: header
description: 'Base64-encoded string for HTTP Basic authentication. The string is composed of a client ID and client secret, separated by a colon (`:`), for example: `clientId:clientSecret`'
required: false
schema:
type: string
example: Basic <client credentials>
requestBody:
content:
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/PasswordlessLoginRequest'
required: true
responses:
'200':
description: The customer authenticated successfully.
content:
application/json:
schema:
type: string
headers:
X-RateLimit-1M-Limit:
description: The 1 minute maximum number of requests permitted per hour.
schema:
type: string
X-RateLimit-1M-Remaining:
description: The 1 minute number of requests remaining in the current rate limit window.
schema:
type: string
X-RateLimit-1M-Reset:
description: The 1 minute time at which the current rate limit window resets in UTC epoch seconds.
schema:
type: string
X-RateLimit-5M-Limit:
description: The 5 minute maximum number of requests permitted per hour.
schema:
type: string
X-RateLimit-5M-Remaining:
description: The 5 minute number of requests remaining in the current rate limit window.
schema:
type: string
X-RateLimit-5M-Reset:
description: The 5 minute time at which the current rate limit window resets in UTC epoch seconds.
schema:
type: string
'400':
description: Bad request
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Oauth2ErrorResponse'
examples:
BadOrMissingAccessToken400:
$ref: '#/components/examples/BadOrMissingAccessToken400'
TooManyLoginRequests400:
description: |
This error is returned specifically when mode = email and the user has exceeded the maximum number of login attempts within the rate limit window.
The client should implement exponential backoff and retry the request after the specified time period.
value:
error: invalid_request
error_description: Too many login requests were made. Please try again later.
headers:
X-RateLimit-1M-Limit:
description: The 1 minute maximum number of requests permitted per hour.
schema:
type: string
X-RateLimit-1M-Remaining:
description: The 1 minute number of requests remaining in the current rate limit window.
schema:
type: string
X-RateLimit-1M-Reset:
description: The 1 minute time at which the current rate limit window resets in UTC epoch seconds.
schema:
type: string
X-RateLimit-5M-Limit:
description: The 5 minute maximum number of requests permitted per hour.
schema:
type: string
X-RateLimit-5M-Remaining:
description: The 5 minute number of requests remaining in the current rate limit window.
schema:
type: string
X-RateLimit-5M-Reset:
description: The 5 minute time at which the current rate limit window resets in UTC epoch seconds.
schema:
type: string
'401':
description: Unauthorized
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Oauth2ErrorResponse'
examples:
Unauthorized401:
$ref: '#/components/examples/InvalidClient401'
headers:
X-RateLimit-1M-Limit:
description: The 1 minute maximum number of requests permitted per hour.
schema:
type: string
X-RateLimit-1M-Remaining:
description: The 1 minute number of requests remaining in the current rate limit window.
schema:
type: string
X-RateLimit-1M-Reset:
description: The 1 minute time at which the current rate limit window resets in UTC epoch seconds.
schema:
type: string
X-RateLimit-5M-Limit:
description: The 5 minute maximum number of requests permitted per hour.
schema:
type: string
X-RateLimit-5M-Remaining:
description: The 5 minute number of requests remaining in the current rate limit window.
schema:
type: string
X-RateLimit-5M-Reset:
description: The 5 minute time at which the current rate limit window resets in UTC epoch seconds.
schema:
type: string
'412':
description: Precondition failure
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Oauth2ErrorResponse'
examples:
DependentServiceUnavailable412:
$ref: '#/components/examples/DependentServiceUnavailable412'
headers:
X-RateLimit-1M-Limit:
description: The 1 minute maximum number of requests permitted per hour.
schema:
type: string
X-RateLimit-1M-Remaining:
description: The 1 minute number of requests remaining in the current rate limit window.
schema:
type: string
X-RateLimit-1M-Reset:
description: The 1 minute time at which the current rate limit window resets in UTC epoch seconds.
schema:
type: string
X-RateLimit-5M-Limit:
description: The 5 minute maximum number of requests permitted per hour.
schema:
type: string
X-RateLimit-5M-Remaining:
description: The 5 minute number of requests remaining in the current rate limit window.
schema:
type: string
X-RateLimit-5M-Reset:
description: The 5 minute time at which the current rate limit window resets in UTC epoch seconds.
schema:
type: string
/organizations/{organizationId}/oauth2/logout:
get:
summary: Log out a shopper.
description: |-
The shopper's access token and refresh token are revoked. If the shopper authenticated with a B2C Commerce (B2C Commerce) instance, the OCAPI JWT is also revoked. Call this endpoint for registered users that have logged in using SLAS. Do not use this endpoint for guest users.
Required header: Authorization header bearer token of the Shopper access token to log out.
Required parameters: `refresh token`, `channel_id`, and `client`.
operationId: logoutCustomer
parameters:
- $ref: '#/components/parameters/organizationId'
- $ref: '#/components/parameters/client_id'
- $ref: '#/components/parameters/refresh_token'
- name: channel_id
in: query
description: The `channel_id` parameter must be provided if the shopper authenticated using the `login` endpoint with B2C Commerce.
required: false
example: RefArch
schema:
example: RefArch
maxLength: 100
type: string
- $ref: '#/components/parameters/logout_hint'
- name: Authorization
in: header
description: Shopper access token to be revoked
required: true
schema:
type: string
example: Bearer eyJ2ZXIiOiIxLjAiLCJraWQiOiI0ZTQyNTFkOS0zM2Y2LTRjMTMtYjZmZC1mOWJkNTJmYTZhNDciLCJ0eXAiOiJqd3QiLCJjbHYiOiJKMi4xLjAiLCJhbGciOiJFUzI1NiJ9.eyJhdXQiOiJHVUlEIiwic2NwIjoic2ZjYy5wcm9kdWN0cy5ybyBzZmNjLmNhdGFsb2dzLnJvIHNmY2Muc2hvcHBlci5ydyIsInN1YiI6ImNjLXNsYXM6OnNsc2FfZGV2OjpzY2lkOjU1M2FjOGFjLTRkYjktNGVkMy04MjVjLTNhZTNiZjVkMzI3Yjo6dXNpZDoxY2E3OWZiNi0xYjIyLTRmOWItOGJiNi05YmU5NWNjMjA4NjMiLCJjdHgiOiJzbGFzLm5vdF9mb3JfZXh0ZXJuYWxfdXNlIiwiaXNzIjoic2xhcy9kZXYvc2xzYV9kZXYiLCJpc3QiOjEsImF1ZCI6ImNvbW1lcmNlY2xvdWQvZGV2L3Nsc2FfZGV2IiwibmJmIjoxNTk0NzY0MDgwLCJzdHkiOiJVc2VyIiwiaXNiIjoidWlkbzpzbGFzOjp1cG46R3Vlc3Q6OnVpZG46R3Vlc3QgVXNlciIsImV4cCI6MTU5NDc2NTkxMCwiaWF0IjoxNTk0NzY0MTEwLCJqdGkiOiJDMkMxNjM0NTE0NTEwLTE3MTQzMTg2NzY0MjcwNTcyNjQ2NTYxMzgifQ.UVYAsWXCn3hoUPy8vLlc7O96RZEHD3N3ZgdNH-ZVvJ1G-R6uJ2VPrYvwKmYXF41Ujm2bo83AYOHVqEEEPT8Kgw
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/TokenResponse'
examples:
logoutCustomerSuccess:
$ref: '#/components/examples/logoutCustomerSuccess'
headers:
X-RateLimit-1M-Limit:
description: The 1 minute maximum number of requests permitted per hour.
schema:
type: string
X-RateLimit-1M-Remaining:
description: The 1 minute number of requests remaining in the current rate limit window.
schema:
type: string
X-RateLimit-1M-Reset:
description: The 1 minute time at which the current rate limit window resets in UTC epoch seconds.
schema:
type: string
X-RateLimit-5M-Limit:
description: The 5 minute maximum number of requests permitted per hour.
schema:
type: string
X-RateLimit-5M-Remaining:
description: The 5 minute number of requests remaining in the current rate limit window.
schema:
type: string
X-RateLimit-5M-Reset:
description: The 5 minute time at which the current rate limit window resets in UTC epoch seconds.
schema:
type: string
'303':
description: The user has sent too many requests in a given amount of time, and rate limiting is in effect.
headers:
X-RateLimit-1M-Limit:
description: The 1 minute maximum number of requests permitted per hour.
schema:
type: string
X-RateLimit-1M-Remaining:
description: The 1 minute number of requests remaining in the current rate limit window.
schema:
type: string
X-RateLimit-1M-Reset:
description: The 1 minute time at which the current rate limit window resets in UTC epoch seconds.
schema:
type: string
X-RateLimit-5M-Limit:
description: The 5 minute maximum number of requests permitted per hour.
schema:
type: string
X-RateLimit-5M-Remaining:
description: The 5 minute number of requests remaining in the current rate limit window.
schema:
type: string
X-RateLimit-5M-Reset:
description: The 5 minute time at which the current rate limit window resets in UTC epoch seconds.
schema:
type: string
'400':
description: Bad request
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Oauth2ErrorResponse'
examples:
BadOrMissingClientId400:
$ref: '#/components/examples/BadOrMissingClientId400'
headers:
X-RateLimit-1M-Limit:
description: The 1 minute maximum number of requests permitted per hour.
schema:
type: string
X-RateLimit-1M-Remaining:
description: The 1 minute number of requests remaining in the current rate limit window.
schema:
type: string
X-RateLimit-1M-Reset:
description: The 1 minute time at which the current rate limit window resets in UTC epoch seconds.
schema:
type: string
X-RateLimit-5M-Limit:
description: The 5 minute maximum number of requests permitted per hour.
schema:
type: string
X-RateLimit-5M-Remaining:
description: The 5 minute number of requests remaining in the current rate limit window.
schema:
type: string
X-RateLimit-5M-Reset:
description: The 5 minute time at which the current rate limit window resets in UTC epoch seconds.
schema:
type: string
'401':
description: Unauthorized
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Oauth2ErrorResponse'
examples:
BadOrMissingClientId400:
$ref: '#/components/examples/BadOrMissingClientId400'
headers:
X-RateLimit-1M-Limit:
description: The 1 minute maximum number of requests permitted per hour.
schema:
type: string
X-RateLimit-1M-Remaining:
description: The 1 minute number of requests remaining in the current rate limit window.
schema:
type: string
X-RateLimit-1M-Reset:
description: The 1 minute time at which the current rate limit window resets in UTC epoch seconds.
schema:
type: string
X-RateLimit-5M-Limit:
description: The 5 minute maximum number of requests permitted per hour.
schema:
type: string
X-RateLimit-5M-Remaining:
description: The 5 minute number of requests remaining in the current rate limit window.
schema:
type: string
X-RateLimit-5M-Reset:
description: The 5 minute time at which the current rate limit window resets in UTC epoch seconds.
schema:
type: string
'500':
description: Internal server error
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Oauth2ErrorResponse'
examples:
InternalServerError500:
$ref: '#/components/examples/InternalServerError500'
headers:
X-RateLimit-1M-Limit:
description: The 1 minute maximum number of requests permitted per hour.
schema:
type: string
X-RateLimit-1M-Remaining:
description: The 1 minute number of requests remaining in the current rate limit window.
schema:
type: string
X-RateLimit-1M-Reset:
description: The 1 minute time at which the current rate limit window resets in UTC epoch seconds.
schema:
type: string
X-RateLimit-5M-Limit:
description: The 5 minute maximum number of requests permitted per hour.
schema:
type: string
X-RateLimit-5M-Remaining:
description: The 5 minute number of requests remaining in the current rate limit window.
schema:
type: string
X-RateLimit-5M-Reset:
description: The 5 minute time at which the current rate limit window resets in UTC epoch seconds.
schema:
type: string
/organizations/{organizationId}/oauth2/authorize:
get:
summary: Get an authorization code after authenticating a user against an identity provider (IDP).
description: |-
This is the first step of the OAuth 2.1 authorization code flow, in which a user can log in via federation to the IDP configured for the client. After successfully logging in, the user gets an authorization code via a redirect URI.
You can call this endpoint from the front channel (the browser).
operationId: authorizeCustomer
parameters:
- $ref: '#/components/parameters/organizationId'
- $ref: '#/components/parameters/redirect_uri'
- $ref: '#/components/parameters/response_type'
- $ref: '#/components/parameters/client_id'
- $ref: '#/components/parameters/scope'
- $ref: '#/components/parameters/state'
- $ref: '#/components/parameters/usid'
- $ref: '#/components/parameters/hint'
- name: channel_id
in: query
description: The channel that this request is for. For a B2C Commerce request, this is angalous to the site ID.
required: false
example: RefArch
schema:
example: RefArch
maxLength: 100
type: string
- $ref: '#/components/parameters/code_challenge'
- $ref: '#/components/parameters/ui_locales'
responses:
'303':
description: The authorization code was successfully added to the `redirect_uri`.
content:
application/json:
schema:
type: string
examples:
authorizeCustomerSuccess:
$ref: '#/components/examples/authorizeCustomerSuccess'
headers:
X-RateLimit-1M-Limit:
description: The 1 minute maximum number of requests permitted per hour.
schema:
type: string
X-RateLimit-1M-Remaining:
description: The 1 minute number of requests remaining in the current rate limit window.
schema:
type: string
X-RateLimit-1M-Reset:
description: The 1 minute time at which the current rate limit window resets in UTC epoch seconds.
schema:
type: string
X-RateLimit-5M-Limit:
description: The 5 minute maximum number of requests permitted per hour.
schema:
type: string
X-RateLimit-5M-Remaining:
description: The 5 minute number of requests remaining in the current rate limit window.
schema:
type: string
X-RateLimit-5M-Reset:
description: The 5 minute time at which the current rate limit window resets in UTC epoch seconds.
schema:
type: string
'400':
description: Bad request
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Oauth2ErrorResponse'
examples:
BadOrMissingClientId400:
$ref: '#/components/examples/BadOrMissingClientId400'
headers:
X-RateLimit-1M-Limit:
description: The 1 minute maximum number of requests permitted per hour.
schema:
type: string
X-RateLimit-1M-Remaining:
description: The 1 minute number of requests remaining in the current rate limit window.
schema:
type: string
X-RateLimit-1M-Reset:
description: The 1 minute time at which the current rate limit window resets in UTC epoch seconds.
schema:
type: string
X-RateLimit-5M-Limit:
description: The 5 minute maximum number of requests permitted per hour.
schema:
type: string
X-RateLimit-5M-Remaining:
description: The 5 minute number of requests remaining in the current rate limit window.
schema:
type: string
X-RateLimit-5M-Reset:
description: The 5 minute time at which the current rate limit window resets in UTC epoch seconds.
schema:
type: string
'401':
description: Unauthorized
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Oauth2ErrorResponse'
examples:
InvalidBasicAuth401:
$ref: '#/components/examples/InvalidBasicAuth401'
headers:
X-RateLimit-1M-Limit:
description: The 1 minute maximum number of requests permitted per hour.
schema:
type: string
X-RateLimit-1M-Remaining:
description: The 1 minute number of requests remaining in the current rate limit window.
schema:
type: string
X-RateLimit-1M-Reset:
description: The 1 minute time at which the current rate limit window resets in UTC epoch seconds.
schema:
type: string
X-RateLimit-5M-Limit:
description: The 5 minute maximum number of requests permitted per hour.
schema:
type: string
X-RateLimit-5M-Remaining:
description: The 5 minute number of requests remaining in the current rate limit window.
schema:
type: string
X-RateLimit-5M-Reset:
description: The 5 minute time at which the current rate limit window resets in UTC epoch seconds.
schema:
type: string
'500':
description: Internal Server Error
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Oauth2ErrorResponse'
examples:
InternalServerError500:
$ref: '#/components/examples/InternalServerError500'
headers:
X-RateLimit-1M-Limit:
description: The 1 minute maximum number of requests permitted per hour.
schema:
type: string
X-RateLimit-1M-Remaining:
description: The 1 minute number of requests remaining in the current rate limit window.
schema:
type: string
X-RateLimit-1M-Reset:
description: The 1 minute time at which the current rate limit window resets in UTC epoch seconds.
schema:
type: string
X-RateLimit-5M-Limit:
description: The 5 minute maximum number of requests permitted per hour.
schema:
type: string
X-RateLimit-5M-Remaining:
description: The 5 minute number of requests remaining in the current rate limit window.
schema:
type: string
X-RateLimit-5M-Reset:
description: The 5 minute time at which the current rate limit window resets in UTC epoch seconds.
schema:
type: string
/organizations/{organizationId}/oauth2/token:
post:
summary: Get the shopper or guest JWT access token and a refresh token.
description: |-
This is the second step of the OAuth 2.1 authorization code flow.
For a private client, an application is able to get an access token for the shopper through the back channel (a trusted server) by passing in the client credentials and the authorization code retrieved from the `authorize` endpoint.
For a guest user, get the shopper JWT access token and a refresh token. This is where a client appplication is able to get an access token for the guest user through the back channel (a trusted server) by passing in the client credentials.
For a public client using PKCE, an application passes a PKCE `code_verifier` that matches the `code_challenge` that was used to `authorize` the customer along with the authorization code.
When refreshing the access token with a private client ID and client secret, the refresh token is _not_ regenerated. However, when refreshing the access token with a public client ID, the refresh token is _always_ regenerated. The old refresh token is voided with every refresh call, so the refresh token on the client must be replaced to always store the new refresh token.
See the Body section for required parameters, including `grant_type` and others that depend on the value of `grant_type`.
**Important**: As of July 31, 2024**, SLAS requires the `channel_id` query parameter in token requests.
operationId: getAccessToken
parameters:
- $ref: '#/components/parameters/organizationId'
- name: Authorization
in: header
description: "Base64-encoded string for HTTP Basic authentication. The string is composed of a client ID and client secret, separated by a colon (`:`), for example: `clientId:clientSecret`. \nNot required if the grant type is `authorization_code_pkce` or `refresh_token`."
required: false
schema:
type: string
example: Basic <client credentials>
requestBody:
content:
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/TokenRequest'
required: true
responses:
'200':
description: the shopper or guest JWT access token and a refresh token were retrieved successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/TokenResponse'
examples:
getAccessTokenSuccess:
$ref: '#/components/examples/getAccessTokenSuccess'
headers:
X-RateLimit-1M-Limit:
description: The 1 minute maximum number of requests permitted per hour.
schema:
type: string
X-RateLimit-1M-Remaining:
description: The 1 minute number of requests remaining in the current rate limit window.
schema:
type: string
X-RateLimit-1M-Reset:
description: The 1 minute time at which the current rate limit window resets in UTC epoch seconds.
schema:
type: string
X-RateLimit-5M-Limit:
description: The 5 minute maximum number of requests permitted per hour.
schema:
type: string
X-RateLimit-5M-Remaining:
description: The 5 minute number of requests remaining in the current rate limit window.
schema:
type: string
X-RateLimit-5M-Reset:
description: The 5 minute time at which the current rate limit window resets in UTC epoch seconds.
schema:
type: string
'400':
description: Bad request
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Oauth2ErrorResponse'
examples:
BadOrMissingAccessToken400:
$ref: '#/components/examples/BadOrMissingAccessToken400'
headers:
X-RateLimit-1M-Limit:
description: The 1 minute maximum number of requests permitted per hour.
schema:
type: string
X-RateLimit-1M-Remaining:
description: The 1 minute number of requests remaining in the current rate limit window.
schema:
type: string
X-RateLimit-1M-Reset:
description: The 1 minute time at which the current rate limit window resets in UTC epoch seconds.
schema:
type: string
X-RateLimit-5M-Limit:
description: The 5 minute maximum number of requests permitted per hour.
schema:
type: string
X-RateLimit-5M-Remaining:
description: The 5 minute number of requests remaining in the current rate limit window.
schema:
type: string
X-RateLimit-5M-Reset:
description: The 5 minute time at which the current rate limit window resets in UTC epoch seconds.
schema:
type: string
'401':
description: Unauthorized
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Oauth2ErrorResponse'
examples:
InvalidBasicAuth401:
$ref: '#/components/examples/InvalidBasicAuth401'
headers:
X-RateLimit-1M-Limit:
description: The 1 minute maximum number of requests permitted per hour.
schema:
type: string
X-RateLimit-1M-Remaining:
description: The 1 minute number of requests remaining in the current rate limit window.
schema:
type: string
X-RateLimit-1M-Reset:
description: The 1 minute time at which the current rate limit window resets in UTC epoch seconds.
schema:
type: string
X-RateLimit-5M-Limit:
description: The 5 minute maximum number of requests permitted per hour.
schema:
type: string
X-RateLimit-5M-Remaining:
description: The 5 minute number of requests remaining in the current rate limit window.
schema:
type: string
X-RateLimit-5M-Reset:
description: The 5 minute time at which the current rate limit window resets in UTC epoch seconds.
schema:
type: string
'500':
description: Internal server error
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Oauth2ErrorResponse'
examples:
InternalServerError500:
$ref: '#/components/examples/InternalServerError500'
headers:
X-RateLimit-1M-Limit:
description: The 1 minute maximum number of requests permitted per hour.
schema:
type: string
X-RateLimit-1M-Remaining:
description: The 1 minute number of requests remaining in the current rate limit window.
schema:
type: string
X-RateLimit-1M-Reset:
description: The 1 minute time at which the current rate limit window resets in UTC epoch seconds.
schema:
type: string
X-RateLimit-5M-Limit:
description: The 5 minute maximum number of requests permitted per hour.
schema:
type: string
X-RateLimit-5M-Remaining:
description: The 5 minute number of requests remaining in the current rate limit window.
schema:
type: string
X-RateLimit-5M-Reset:
description: The 5 minute time at which the current rate limit window resets in UTC epoch seconds.
schema:
type: string
/organizations/{organizationId}/oauth2/session-bridge/token:
post:
summary: Get a shopper JWT access token for a customer using session bridging.
description: |-
For public client ID requests, you must set the grant_type to `session_bridge`.
For private client_id and secret, you must set the grant_type to `client_credentials` along with a basic authorization header.
**DEPRECATED** - As of January 31, 2024, SLAS no longer supports the SESB `dwsid` parameter for `guest` users for `session-bridge/token` calls. We recommended you transition to using a SESB `dwsgst` token.
The `dwsid` is still needed for `registered` user `session-bridge/token` calls.
**NOTE:** The registered customer Json Web Token (JWT) is available in B2C Commerce versions 25.4 and later.
operationId: getSessionBridgeAccessToken
parameters:
- $ref: '#/components/parameters/organizationId'
requestBody:
content:
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/SessionBridgeTokenRequest'
required: true
responses:
'200':
description: The shopper JWT access token was retrieved successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/TokenResponse'
examples:
getSessionBridgeAccessTokenSuccess:
$ref: '#/components/examples/getSessionBridgeAccessTokenSuccess'
headers:
X-RateLimit-1M-Limit:
description: The 1 minute maximum number of requests permitted per hour.
schema:
type: string
X-RateLimit-1M-Remaining:
description: The 1 minute number of requests remaining in the current rate limit window.
schema:
type: string
X-RateLimit-1M-Reset:
description: The 1 minute time at which the current rate limit window resets in UTC epoch seconds.
schema:
type: string
X-RateLimit-5M-Limit:
description: The 5 minute maximum number of requests permitted per hour.
schema:
type: string
X-RateLimit-5M-Remaining:
description: The 5 minute number of requests remaining in the current rate limit window.
schema:
type: string
X-RateLimit-5M-Reset:
description: The 5 minute time at which the current rate limit window resets in UTC epoch seconds.
schema:
type: string
'400':
description: Bad request
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Oauth2ErrorResponse'
examples:
BadOrMissingAccessToken400:
$ref: '#/components/examples/BadOrMissingAccessToken400'
headers:
X-RateLimit-1M-Limit:
description: The 1 minute maximum number of requests permitted per hour.
schema:
type: string
X-RateLimit-1M-Remaining:
description: The 1 minute number of requests remaining in the current rate limit window.
schema:
type: string
X-RateLimit-1M-Reset:
description: The 1 minute time at which the current rate limit window resets in UTC epoch seconds.
schema:
type: string
X-RateLimit-5M-Limit:
description: The 5 minute maximum number of requests permitted per hour.
schema:
type: string
X-RateLimit-5M-Remaining:
description: The 5 minute number of requests remaining in the current rate limit window.
schema:
type: string
X-RateLimit-5M-Reset:
description: The 5 minute time at which the current rate limit window resets in UTC epoch seconds.
schema:
type: string
'401':
description: Unauthorized
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Oauth2ErrorResponse'
examples:
Unauthorized401:
$ref: '#/components/examples/InvalidClient401'
headers:
X-RateLimit-1M-Limit:
description: The 1 minute maximum number of requests permitted per hour.
schema:
type: string
X-RateLimit-1M-Remaining:
description: The 1 minute number of requests remaining in the current rate limit window.
schema: