|
39 | 39 | url: https://www.apache.org/licenses/LICENSE-2.0.html |
40 | 40 | termsOfService: /ptos |
41 | 41 | title: Ory APIs |
42 | | - version: v1.16.5 |
| 42 | + version: v1.16.6 |
43 | 43 | servers: |
44 | 44 | - url: "https://{project_slug}.projects.oryapis.com/" |
45 | 45 | variables: |
@@ -5439,6 +5439,94 @@ paths: |
5439 | 5439 | - frontend |
5440 | 5440 | x-accepts: |
5441 | 5441 | - application/json |
| 5442 | + /self-service/fed-cm/parameters: |
| 5443 | + get: |
| 5444 | + description: This endpoint returns a list of all available FedCM providers. |
| 5445 | + It is only supported on the Ory Network. |
| 5446 | + operationId: createFedcmFlow |
| 5447 | + responses: |
| 5448 | + "200": |
| 5449 | + content: |
| 5450 | + application/json: |
| 5451 | + schema: |
| 5452 | + $ref: '#/components/schemas/createFedcmFlowResponse' |
| 5453 | + description: createFedcmFlowResponse |
| 5454 | + "400": |
| 5455 | + content: |
| 5456 | + application/json: |
| 5457 | + schema: |
| 5458 | + $ref: '#/components/schemas/errorGeneric' |
| 5459 | + description: errorGeneric |
| 5460 | + default: |
| 5461 | + content: |
| 5462 | + application/json: |
| 5463 | + schema: |
| 5464 | + $ref: '#/components/schemas/errorGeneric' |
| 5465 | + description: errorGeneric |
| 5466 | + summary: Get FedCM Parameters |
| 5467 | + tags: |
| 5468 | + - frontend |
| 5469 | + x-accepts: |
| 5470 | + - application/json |
| 5471 | + /self-service/fed-cm/token: |
| 5472 | + post: |
| 5473 | + description: |- |
| 5474 | + Use this endpoint to submit a token from a FedCM provider through |
| 5475 | + `navigator.credentials.get` and log the user in. The parameters from |
| 5476 | + `navigator.credentials.get` must have come from `GET |
| 5477 | + self-service/fed-cm/parameters`. |
| 5478 | + operationId: updateFedcmFlow |
| 5479 | + requestBody: |
| 5480 | + content: |
| 5481 | + application/json: |
| 5482 | + schema: |
| 5483 | + $ref: '#/components/schemas/UpdateFedcmFlowBody' |
| 5484 | + application/x-www-form-urlencoded: |
| 5485 | + schema: |
| 5486 | + $ref: '#/components/schemas/UpdateFedcmFlowBody' |
| 5487 | + required: true |
| 5488 | + x-originalParamName: Body |
| 5489 | + responses: |
| 5490 | + "200": |
| 5491 | + content: |
| 5492 | + application/json: |
| 5493 | + schema: |
| 5494 | + $ref: '#/components/schemas/successfulNativeLogin' |
| 5495 | + description: successfulNativeLogin |
| 5496 | + "303": |
| 5497 | + description: |- |
| 5498 | + Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is |
| 5499 | + typically 201. |
| 5500 | + "400": |
| 5501 | + content: |
| 5502 | + application/json: |
| 5503 | + schema: |
| 5504 | + $ref: '#/components/schemas/loginFlow' |
| 5505 | + description: loginFlow |
| 5506 | + "410": |
| 5507 | + content: |
| 5508 | + application/json: |
| 5509 | + schema: |
| 5510 | + $ref: '#/components/schemas/errorGeneric' |
| 5511 | + description: errorGeneric |
| 5512 | + "422": |
| 5513 | + content: |
| 5514 | + application/json: |
| 5515 | + schema: |
| 5516 | + $ref: '#/components/schemas/errorBrowserLocationChangeRequired' |
| 5517 | + description: errorBrowserLocationChangeRequired |
| 5518 | + default: |
| 5519 | + content: |
| 5520 | + application/json: |
| 5521 | + schema: |
| 5522 | + $ref: '#/components/schemas/errorGeneric' |
| 5523 | + description: errorGeneric |
| 5524 | + summary: Submit a FedCM token |
| 5525 | + tags: |
| 5526 | + - frontend |
| 5527 | + x-content-type: application/json |
| 5528 | + x-accepts: |
| 5529 | + - application/json |
5442 | 5530 | /self-service/login: |
5443 | 5531 | post: |
5444 | 5532 | description: |- |
@@ -10607,6 +10695,64 @@ components: |
10607 | 10695 | - name |
10608 | 10696 | - timestamp |
10609 | 10697 | type: object |
| 10698 | + Provider: |
| 10699 | + example: |
| 10700 | + domain_hint: domain_hint |
| 10701 | + login_hint: login_hint |
| 10702 | + config_url: config_url |
| 10703 | + fields: |
| 10704 | + - fields |
| 10705 | + - fields |
| 10706 | + nonce: nonce |
| 10707 | + parameters: |
| 10708 | + key: parameters |
| 10709 | + client_id: client_id |
| 10710 | + properties: |
| 10711 | + client_id: |
| 10712 | + description: "The RP's client identifier, issued by the IdP." |
| 10713 | + type: string |
| 10714 | + config_url: |
| 10715 | + description: A full path of the IdP config file. |
| 10716 | + type: string |
| 10717 | + domain_hint: |
| 10718 | + description: |- |
| 10719 | + By specifying one of domain_hints values provided by the accounts endpoints, |
| 10720 | + the FedCM dialog selectively shows the specified account. |
| 10721 | + type: string |
| 10722 | + fields: |
| 10723 | + description: |- |
| 10724 | + Array of strings that specifies the user information ("name", " email", |
| 10725 | + "picture") that RP needs IdP to share with them. |
| 10726 | + |
| 10727 | + Note: Field API is supported by Chrome 132 and later. |
| 10728 | + items: |
| 10729 | + type: string |
| 10730 | + type: array |
| 10731 | + login_hint: |
| 10732 | + description: |- |
| 10733 | + By specifying one of login_hints values provided by the accounts endpoints, |
| 10734 | + the FedCM dialog selectively shows the specified account. |
| 10735 | + type: string |
| 10736 | + nonce: |
| 10737 | + description: |- |
| 10738 | + A random string to ensure the response is issued for this specific request. |
| 10739 | + Prevents replay attacks. |
| 10740 | + type: string |
| 10741 | + parameters: |
| 10742 | + additionalProperties: |
| 10743 | + type: string |
| 10744 | + description: |- |
| 10745 | + Custom object that allows to specify additional key-value parameters: |
| 10746 | + scope: A string value containing additional permissions that RP needs to |
| 10747 | + request, for example " drive.readonly calendar.readonly" |
| 10748 | + nonce: A random string to ensure the response is issued for this specific |
| 10749 | + request. Prevents replay attacks. |
| 10750 | + |
| 10751 | + Other custom key-value parameters. |
| 10752 | + |
| 10753 | + Note: parameters is supported from Chrome 132. |
| 10754 | + type: object |
| 10755 | + type: object |
10610 | 10756 | RFC6749ErrorJson: |
10611 | 10757 | properties: |
10612 | 10758 | error: |
@@ -10706,6 +10852,27 @@ components: |
10706 | 10852 | UUID: |
10707 | 10853 | format: uuid4 |
10708 | 10854 | type: string |
| 10855 | + UpdateFedcmFlowBody: |
| 10856 | + example: |
| 10857 | + csrf_token: csrf_token |
| 10858 | + nonce: nonce |
| 10859 | + token: token |
| 10860 | + properties: |
| 10861 | + csrf_token: |
| 10862 | + description: CSRFToken is the anti-CSRF token. |
| 10863 | + type: string |
| 10864 | + nonce: |
| 10865 | + description: |- |
| 10866 | + Nonce is the nonce that was used in the `navigator.credentials.get` call. If |
| 10867 | + specified, it must match the `nonce` claim in the token. |
| 10868 | + type: string |
| 10869 | + token: |
| 10870 | + description: Token contains the result of `navigator.credentials.get`. |
| 10871 | + type: string |
| 10872 | + required: |
| 10873 | + - csrf_token |
| 10874 | + - token |
| 10875 | + type: object |
10709 | 10876 | Usage: |
10710 | 10877 | properties: |
10711 | 10878 | GenericUsage: |
@@ -11302,6 +11469,7 @@ components: |
11302 | 11469 | - $ref: '#/components/schemas/continueWithSettingsUi' |
11303 | 11470 | - $ref: '#/components/schemas/continueWithRecoveryUi' |
11304 | 11471 | - $ref: '#/components/schemas/continueWithRedirectBrowserTo' |
| 11472 | + type: object |
11305 | 11473 | continueWithRecoveryUi: |
11306 | 11474 | description: "Indicates, that the UI flow could be continued by showing a recovery\ |
11307 | 11475 | \ ui" |
@@ -11509,6 +11677,40 @@ components: |
11509 | 11677 | - topic_arn |
11510 | 11678 | - type |
11511 | 11679 | type: object |
| 11680 | + createFedcmFlowResponse: |
| 11681 | + description: Contains a list of all available FedCM providers. |
| 11682 | + example: |
| 11683 | + csrf_token: csrf_token |
| 11684 | + providers: |
| 11685 | + - domain_hint: domain_hint |
| 11686 | + login_hint: login_hint |
| 11687 | + config_url: config_url |
| 11688 | + fields: |
| 11689 | + - fields |
| 11690 | + - fields |
| 11691 | + nonce: nonce |
| 11692 | + parameters: |
| 11693 | + key: parameters |
| 11694 | + client_id: client_id |
| 11695 | + - domain_hint: domain_hint |
| 11696 | + login_hint: login_hint |
| 11697 | + config_url: config_url |
| 11698 | + fields: |
| 11699 | + - fields |
| 11700 | + - fields |
| 11701 | + nonce: nonce |
| 11702 | + parameters: |
| 11703 | + key: parameters |
| 11704 | + client_id: client_id |
| 11705 | + properties: |
| 11706 | + csrf_token: |
| 11707 | + type: string |
| 11708 | + providers: |
| 11709 | + items: |
| 11710 | + $ref: '#/components/schemas/Provider' |
| 11711 | + type: array |
| 11712 | + title: CreateFedcmFlowResponse |
| 11713 | + type: object |
11512 | 11714 | createIdentityBody: |
11513 | 11715 | description: Create Identity Body |
11514 | 11716 | properties: |
|
0 commit comments