Skip to content

Commit

Permalink
docs: bump to c8888bb2d52b26382105be840b834ee8b0e107d1
Browse files Browse the repository at this point in the history
  • Loading branch information
@aeneasr
aeneasr committed Feb 6, 2025
1 parent 8092e60 commit f6e7be0
Showing 1 changed file with 194 additions and 1 deletion.
195 changes: 194 additions & 1 deletion docs/reference/api.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1947,6 +1947,45 @@
"required": ["name", "timestamp", "attributes"],
"type": "object"
},
"Provider": {
"properties": {
"client_id": {
"description": "The RP's client identifier, issued by the IdP.",
"type": "string"
},
"config_url": {
"description": "A full path of the IdP config file.",
"type": "string"
},
"domain_hint": {
"description": "By specifying one of domain_hints values provided by the accounts endpoints,\nthe FedCM dialog selectively shows the specified account.",
"type": "string"
},
"fields": {
"description": "Array of strings that specifies the user information (\"name\", \" email\",\n\"picture\") that RP needs IdP to share with them.\n\nNote: Field API is supported by Chrome 132 and later.",
"items": {
"type": "string"
},
"type": "array"
},
"login_hint": {
"description": "By specifying one of login_hints values provided by the accounts endpoints,\nthe FedCM dialog selectively shows the specified account.",
"type": "string"
},
"nonce": {
"description": "A random string to ensure the response is issued for this specific request.\nPrevents replay attacks.",
"type": "string"
},
"parameters": {
"additionalProperties": {
"type": "string"
},
"description": "Custom object that allows to specify additional key-value parameters:\nscope: A string value containing additional permissions that RP needs to\nrequest, for example \" drive.readonly calendar.readonly\"\nnonce: A random string to ensure the response is issued for this specific\nrequest. Prevents replay attacks.\n\nOther custom key-value parameters.\n\nNote: parameters is supported from Chrome 132.",
"type": "object"
}
},
"type": "object"
},
"RFC6749ErrorJson": {
"properties": {
"error": {
Expand Down Expand Up @@ -2056,6 +2095,24 @@
"format": "uuid4",
"type": "string"
},
"UpdateFedcmFlowBody": {
"properties": {
"csrf_token": {
"description": "CSRFToken is the anti-CSRF token.",
"type": "string"
},
"nonce": {
"description": "Nonce is the nonce that was used in the `navigator.credentials.get` call. If\nspecified, it must match the `nonce` claim in the token.",
"type": "string"
},
"token": {
"description": "Token contains the result of `navigator.credentials.get`.",
"type": "string"
}
},
"required": ["token", "csrf_token"],
"type": "object"
},
"Usage": {
"properties": {
"GenericUsage": {
Expand Down Expand Up @@ -2667,7 +2724,8 @@
{
"$ref": "#/components/schemas/continueWithRedirectBrowserTo"
}
]
],
"type": "object"
},
"continueWithRecoveryUi": {
"description": "Indicates, that the UI flow could be continued by showing a recovery ui",
Expand Down Expand Up @@ -2860,6 +2918,22 @@
"required": ["type", "topic_arn", "role_arn"],
"type": "object"
},
"createFedcmFlowResponse": {
"description": "Contains a list of all available FedCM providers.",
"properties": {
"csrf_token": {
"type": "string"
},
"providers": {
"items": {
"$ref": "#/components/schemas/Provider"
},
"type": "array"
}
},
"title": "CreateFedcmFlowResponse",
"type": "object"
},
"createIdentityBody": {
"description": "Create Identity Body",
"properties": {
Expand Down Expand Up @@ -16887,6 +16961,125 @@
"tags": ["frontend"]
}
},
"/self-service/fed-cm/parameters": {
"get": {
"description": "This endpoint returns a list of all available FedCM providers. It is only supported on the Ory Network.",
"operationId": "createFedcmFlow",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/createFedcmFlowResponse"
}
}
},
"description": "createFedcmFlowResponse"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorGeneric"
}
}
},
"description": "errorGeneric"
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorGeneric"
}
}
},
"description": "errorGeneric"
}
},
"summary": "Get FedCM Parameters",
"tags": ["frontend"]
}
},
"/self-service/fed-cm/token": {
"post": {
"description": "Use this endpoint to submit a token from a FedCM provider through\n`navigator.credentials.get` and log the user in. The parameters from\n`navigator.credentials.get` must have come from `GET\nself-service/fed-cm/parameters`.",
"operationId": "updateFedcmFlow",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateFedcmFlowBody"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/UpdateFedcmFlowBody"
}
}
},
"required": true,
"x-originalParamName": "Body"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/successfulNativeLogin"
}
}
},
"description": "successfulNativeLogin"
},
"303": {
"$ref": "#/components/responses/emptyResponse"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/loginFlow"
}
}
},
"description": "loginFlow"
},
"410": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorGeneric"
}
}
},
"description": "errorGeneric"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorBrowserLocationChangeRequired"
}
}
},
"description": "errorBrowserLocationChangeRequired"
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorGeneric"
}
}
},
"description": "errorGeneric"
}
},
"summary": "Submit a FedCM token",
"tags": ["frontend"]
}
},
"/self-service/login": {
"post": {
"description": "Use this endpoint to complete a login flow. This endpoint\nbehaves differently for API and browser flows.\n\nAPI flows expect `application/json` to be sent in the body and responds with\nHTTP 200 and a application/json body with the session token on success;\nHTTP 410 if the original flow expired with the appropriate error messages set and optionally a `use_flow_id` parameter in the body;\nHTTP 400 on form validation errors.\n\nBrowser flows expect a Content-Type of `application/x-www-form-urlencoded` or `application/json` to be sent in the body and respond with\na HTTP 303 redirect to the post/after login URL or the `return_to` value if it was set and if the login succeeded;\na HTTP 303 redirect to the login UI URL with the flow ID containing the validation errors otherwise.\n\nBrowser flows with an accept header of `application/json` will not redirect but instead respond with\nHTTP 200 and a application/json body with the signed in identity and a `Set-Cookie` header on success;\nHTTP 303 redirect to a fresh login flow if the original flow expired with the appropriate error messages set;\nHTTP 400 on form validation errors.\n\nIf this endpoint is called with `Accept: application/json` in the header, the response contains the flow without a redirect. In the\ncase of an error, the `error.id` of the JSON response body can be one of:\n\n`session_already_available`: The user is already signed in.\n`security_csrf_violation`: Unable to fetch the flow because a CSRF violation occurred.\n`security_identity_mismatch`: The requested `?return_to` address is not allowed to be used. Adjust this in the configuration!\n`browser_location_change_required`: Usually sent when an AJAX request indicates that the browser needs to open a specific URL.\nMost likely used in Social Sign In flows.\n\nMore information can be found at [Ory Kratos User Login](https://www.ory.sh/docs/kratos/self-service/flows/user-login) and [User Registration Documentation](https://www.ory.sh/docs/kratos/self-service/flows/user-registration).",
Expand Down

0 comments on commit f6e7be0

Please sign in to comment.