Skip to content

Commit 567872e

Browse files
aeneasraeneasr
committed
docs: bump to aa5ea6fd61d796191788d818dcc3371abdfc0568
1 parent 255ac7e commit 567872e

File tree

1 file changed

+255
-3
lines changed

1 file changed

+255
-3
lines changed

‎docs/reference/api.json‎

Lines changed: 255 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1401,6 +1401,10 @@
14011401
"description": "Configures the Cloudflare Turnstile site key for CAPTCHA protection\n\nThe site key is public and will be shared with the client.\n\nReach out to your account manager to enable this feature.",
14021402
"type": "string"
14031403
},
1404+
"kratos_selfservice_methods_captcha_config_legacy_inject_node": {
1405+
"description": "Configures the Ory Kratos Self-Service Methods' Captcha Enabled Setting\n\nReach out to your account manager to enable this feature.",
1406+
"type": "boolean"
1407+
},
14041408
"kratos_selfservice_methods_captcha_enabled": {
14051409
"description": "Configures the Ory Kratos Self-Service Methods' Captcha Enabled Setting\n\nReach out to your account manager to enable this feature.",
14061410
"type": "boolean"
@@ -1409,6 +1413,9 @@
14091413
"description": "Configures the Ory Kratos Code Method's lifespan\n\nThis governs the \"selfservice.methods.code.config.lifespan\" setting.",
14101414
"type": "string"
14111415
},
1416+
"kratos_selfservice_methods_code_config_max_submissions": {
1417+
"$ref": "#/components/schemas/nullInt64"
1418+
},
14121419
"kratos_selfservice_methods_code_config_missing_credential_fallback_enabled": {
14131420
"description": "Enables a fallback method required in certain legacy use cases.\n\nThis governs the \"selfservice.methods.code.config.missing_credential_fallback_enabled\" setting.",
14141421
"type": "boolean"
@@ -6087,6 +6094,10 @@
60876094
"description": "Configures the Cloudflare Turnstile site key for CAPTCHA protection\n\nThe site key is public and will be shared with the client.\n\nReach out to your account manager to enable this feature.",
60886095
"type": "string"
60896096
},
6097+
"kratos_selfservice_methods_captcha_config_legacy_inject_node": {
6098+
"description": "Configures the Ory Kratos Self-Service Methods' Captcha Enabled Setting\n\nReach out to your account manager to enable this feature.",
6099+
"type": "boolean"
6100+
},
60906101
"kratos_selfservice_methods_captcha_enabled": {
60916102
"description": "Configures the Ory Kratos Self-Service Methods' Captcha Enabled Setting\n\nReach out to your account manager to enable this feature.",
60926103
"type": "boolean"
@@ -6095,6 +6106,9 @@
60956106
"description": "Configures the Ory Kratos Code Method's lifespan\n\nThis governs the \"selfservice.methods.code.config.lifespan\" setting.",
60966107
"type": "string"
60976108
},
6109+
"kratos_selfservice_methods_code_config_max_submissions": {
6110+
"$ref": "#/components/schemas/nullInt64"
6111+
},
60986112
"kratos_selfservice_methods_code_config_missing_credential_fallback_enabled": {
60996113
"description": "Enables a fallback method required in certain legacy use cases.\n\nThis governs the \"selfservice.methods.code.config.missing_credential_fallback_enabled\" setting.",
61006114
"type": "boolean"
@@ -7601,6 +7615,9 @@
76017615
"base_url": {
76027616
"type": "string"
76037617
},
7618+
"kratos_selfservice_methods_oidc_config_providers": {
7619+
"$ref": "#/components/schemas/projectRevisionThirdPartyLoginProviders"
7620+
},
76047621
"kratos_selfservice_methods_saml_config_providers": {
76057622
"$ref": "#/components/schemas/projectRevisionSamlProviders"
76067623
},
@@ -7621,7 +7638,8 @@
76217638
"required": [
76227639
"revision_id",
76237640
"base_url",
7624-
"kratos_selfservice_methods_saml_config_providers"
7641+
"kratos_selfservice_methods_saml_config_providers",
7642+
"kratos_selfservice_methods_oidc_config_providers"
76257643
],
76267644
"type": "object"
76277645
},
@@ -9171,6 +9189,9 @@
91719189
},
91729190
"setOrganizationFromOnboardingPortalLinkBody": {
91739191
"properties": {
9192+
"kratos_selfservice_methods_oidc_config_providers": {
9193+
"$ref": "#/components/schemas/projectRevisionThirdPartyLoginProviders"
9194+
},
91749195
"kratos_selfservice_methods_saml_config_providers": {
91759196
"$ref": "#/components/schemas/projectRevisionSamlProviders"
91769197
},
@@ -9181,7 +9202,8 @@
91819202
},
91829203
"required": [
91839204
"revision_id",
9184-
"kratos_selfservice_methods_saml_config_providers"
9205+
"kratos_selfservice_methods_saml_config_providers",
9206+
"kratos_selfservice_methods_oidc_config_providers"
91859207
],
91869208
"type": "object"
91879209
},
@@ -16593,6 +16615,236 @@
1659316615
"tags": ["project"]
1659416616
}
1659516617
},
16618+
"/projects/{project_id}/organizations/{organization_id}/onboarding-portal-links": {
16619+
"get": {
16620+
"description": "Retrieves the organization onboarding portal links.",
16621+
"operationId": "getOrganizationOnboardingPortalLinks",
16622+
"parameters": [
16623+
{
16624+
"description": "Project ID\n\nThe project's ID.",
16625+
"in": "path",
16626+
"name": "project_id",
16627+
"required": true,
16628+
"schema": {
16629+
"type": "string"
16630+
}
16631+
},
16632+
{
16633+
"description": "Organization ID\n\nThe Organization's ID.",
16634+
"in": "path",
16635+
"name": "organization_id",
16636+
"required": true,
16637+
"schema": {
16638+
"type": "string"
16639+
}
16640+
}
16641+
],
16642+
"responses": {
16643+
"200": {
16644+
"content": {
16645+
"application/json": {
16646+
"schema": {
16647+
"$ref": "#/components/schemas/organizationOnboardingPortalLinksResponse"
16648+
}
16649+
}
16650+
},
16651+
"description": "organizationOnboardingPortalLinksResponse"
16652+
},
16653+
"400": {
16654+
"content": {
16655+
"application/json": {
16656+
"schema": {
16657+
"$ref": "#/components/schemas/errorGeneric"
16658+
}
16659+
}
16660+
},
16661+
"description": "errorGeneric"
16662+
},
16663+
"403": {
16664+
"content": {
16665+
"application/json": {
16666+
"schema": {
16667+
"$ref": "#/components/schemas/errorGeneric"
16668+
}
16669+
}
16670+
},
16671+
"description": "errorGeneric"
16672+
},
16673+
"default": {
16674+
"content": {
16675+
"application/json": {
16676+
"schema": {
16677+
"$ref": "#/components/schemas/errorGeneric"
16678+
}
16679+
}
16680+
},
16681+
"description": "errorGeneric"
16682+
}
16683+
},
16684+
"security": [
16685+
{
16686+
"oryWorkspaceApiKey": []
16687+
}
16688+
],
16689+
"servers": [
16690+
{
16691+
"description": "The Ory Network control plane API which is used to manage your Ory Network projects and workspaces.",
16692+
"url": "https://api.console.ory.sh"
16693+
}
16694+
],
16695+
"summary": "Get the organization onboarding portal links",
16696+
"tags": ["project"]
16697+
},
16698+
"post": {
16699+
"description": "Create a onboarding portal link for an organization.",
16700+
"operationId": "createOrganizationOnboardingPortalLink",
16701+
"parameters": [
16702+
{
16703+
"description": "Project ID\n\nThe project's ID.",
16704+
"in": "path",
16705+
"name": "project_id",
16706+
"required": true,
16707+
"schema": {
16708+
"type": "string"
16709+
}
16710+
},
16711+
{
16712+
"description": "Organization ID\n\nThe Organization's ID.",
16713+
"in": "path",
16714+
"name": "organization_id",
16715+
"required": true,
16716+
"schema": {
16717+
"type": "string"
16718+
}
16719+
}
16720+
],
16721+
"requestBody": {
16722+
"content": {
16723+
"application/json": {
16724+
"schema": {
16725+
"$ref": "#/components/schemas/createOrganizationOnboardingPortalLinkBody"
16726+
}
16727+
}
16728+
},
16729+
"x-originalParamName": "Body"
16730+
},
16731+
"responses": {
16732+
"201": {
16733+
"content": {
16734+
"application/json": {
16735+
"schema": {
16736+
"$ref": "#/components/schemas/onboardingPortalLink"
16737+
}
16738+
}
16739+
},
16740+
"description": "onboardingPortalLink"
16741+
},
16742+
"default": {
16743+
"content": {
16744+
"application/json": {
16745+
"schema": {
16746+
"$ref": "#/components/schemas/errorGeneric"
16747+
}
16748+
}
16749+
},
16750+
"description": "errorGeneric"
16751+
}
16752+
},
16753+
"security": [
16754+
{
16755+
"oryWorkspaceApiKey": []
16756+
}
16757+
],
16758+
"servers": [
16759+
{
16760+
"description": "The Ory Network control plane API which is used to manage your Ory Network projects and workspaces.",
16761+
"url": "https://api.console.ory.sh"
16762+
}
16763+
],
16764+
"summary": "Create organization onboarding portal link",
16765+
"tags": ["project"]
16766+
}
16767+
},
16768+
"/projects/{project_id}/organizations/{organization_id}/onboarding-portal-links/{onboarding_portal_link_id}": {
16769+
"delete": {
16770+
"description": "Deletes a onboarding portal link for an organization.",
16771+
"operationId": "deleteOrganizationOnboardingPortalLink",
16772+
"parameters": [
16773+
{
16774+
"in": "path",
16775+
"name": "project_id",
16776+
"required": true,
16777+
"schema": {
16778+
"type": "string"
16779+
}
16780+
},
16781+
{
16782+
"in": "path",
16783+
"name": "organization_id",
16784+
"required": true,
16785+
"schema": {
16786+
"type": "string"
16787+
}
16788+
},
16789+
{
16790+
"in": "path",
16791+
"name": "onboarding_portal_link_id",
16792+
"required": true,
16793+
"schema": {
16794+
"type": "string"
16795+
}
16796+
}
16797+
],
16798+
"responses": {
16799+
"204": {
16800+
"$ref": "#/components/responses/emptyResponse"
16801+
},
16802+
"400": {
16803+
"content": {
16804+
"application/json": {
16805+
"schema": {
16806+
"$ref": "#/components/schemas/errorGeneric"
16807+
}
16808+
}
16809+
},
16810+
"description": "errorGeneric"
16811+
},
16812+
"403": {
16813+
"content": {
16814+
"application/json": {
16815+
"schema": {
16816+
"$ref": "#/components/schemas/errorGeneric"
16817+
}
16818+
}
16819+
},
16820+
"description": "errorGeneric"
16821+
},
16822+
"default": {
16823+
"content": {
16824+
"application/json": {
16825+
"schema": {
16826+
"$ref": "#/components/schemas/errorGeneric"
16827+
}
16828+
}
16829+
},
16830+
"description": "errorGeneric"
16831+
}
16832+
},
16833+
"security": [
16834+
{
16835+
"oryWorkspaceApiKey": []
16836+
}
16837+
],
16838+
"servers": [
16839+
{
16840+
"description": "The Ory Network control plane API which is used to manage your Ory Network projects and workspaces.",
16841+
"url": "https://api.console.ory.sh"
16842+
}
16843+
],
16844+
"summary": "Delete an organization onboarding portal link",
16845+
"tags": ["project"]
16846+
}
16847+
},
1659616848
"/projects/{project_id}/revision/{revision_id}": {
1659716849
"patch": {
1659816850
"description": "This endpoints allows you to patch individual Ory Network Project configuration keys for\nOry's services (identity, permission, ...). The configuration format is fully compatible\nwith the open source projects for the respective services (e.g. Ory Kratos for Identity, Ory Keto for Permissions).\n\nThis endpoint expects the `version` key to be set in the payload. If it is unset, it\nwill try to import the config as if it is from the most recent version.\n\nIf you have an older version of a configuration, you should set the version key in the payload!\n\nWhile this endpoint is able to process all configuration items related to features (e.g. password reset),\nit does not support operational configuration items (e.g. port, tracing, logging) otherwise available in the\nopen source.\n\nFor configuration items that can not be translated to the Ory Network, this endpoint will return a list of warnings\nto help you understand which parts of your config could not be processed.",
@@ -20819,7 +21071,7 @@
2081921071
"variables": {
2082021072
"project_slug": {
2082121073
"default": "playground",
20822-
"description": "Your Ory Network Project slug. You can find it in the [Ory Network Console](https://console.ory.sh/projects/current/developers/guides)."
21074+
"description": "Your Ory Network Project slug. You can find it in the [Ory Network Console](https://console.ory.sh/projects/current/get-started)."
2082321075
}
2082421076
}
2082521077
}

0 commit comments

Comments
 (0)