From a1c3d615dff56e5df61f5a1f37dc6606c2866692 Mon Sep 17 00:00:00 2001 From: "auth0-docs-automation[bot]" <266159893+auth0-docs-automation[bot]@users.noreply.github.com> Date: Tue, 17 Mar 2026 16:53:53 +0000 Subject: [PATCH] chore: update `MyAccount` API OAS artifacts --- main/docs.json | 21 + ...t-of-a-supported-authentication-method.mdx | 5 + .../delete-an-authentication-method-by-id.mdx | 5 + .../get-a-list-of-authentication-methods.mdx | 5 + .../get-an-authentication-method-by-id.mdx | 5 + ...t-of-a-supported-authentication-method.mdx | 5 + ...ails-of-an-authentication-method-by-id.mdx | 5 + .../complete-a-connected-account-request.mdx | 5 + .../create-a-connected-account-request.mdx | 5 + .../delete-a-connected-account-by-id.mdx | 5 + ...ble-connections-for-connected-accounts.mdx | 5 + .../get-a-list-of-connected-accounts.mdx | 5 + .../consents/get-a-consent-by-id.mdx | 15 + .../myaccount/consents/list-user-consents.mdx | 15 + .../factors/get-the-status-of-all-factors.mdx | 5 + ...t-of-a-supported-authentication-method.mdx | 5 + .../delete-an-authentication-method-by-id.mdx | 5 + .../get-a-list-of-authentication-methods.mdx | 5 + .../get-an-authentication-method-by-id.mdx | 5 + ...t-of-a-supported-authentication-method.mdx | 5 + ...ails-of-an-authentication-method-by-id.mdx | 5 + .../complete-a-connected-account-request.mdx | 5 + .../create-a-connected-account-request.mdx | 5 + .../delete-a-connected-account-by-id.mdx | 5 + ...ble-connections-for-connected-accounts.mdx | 5 + .../get-a-list-of-connected-accounts.mdx | 5 + .../consents/get-a-consent-by-id.mdx | 15 + .../myaccount/consents/list-user-consents.mdx | 15 + .../factors/get-the-status-of-all-factors.mdx | 5 + ...t-of-a-supported-authentication-method.mdx | 5 + .../delete-an-authentication-method-by-id.mdx | 5 + .../get-a-list-of-authentication-methods.mdx | 5 + .../get-an-authentication-method-by-id.mdx | 5 + ...t-of-a-supported-authentication-method.mdx | 5 + ...ails-of-an-authentication-method-by-id.mdx | 5 + .../complete-a-connected-account-request.mdx | 5 + .../create-a-connected-account-request.mdx | 5 + .../delete-a-connected-account-by-id.mdx | 5 + ...ble-connections-for-connected-accounts.mdx | 5 + .../get-a-list-of-connected-accounts.mdx | 5 + .../consents/get-a-consent-by-id.mdx | 15 + .../myaccount/consents/list-user-consents.mdx | 15 + .../factors/get-the-status-of-all-factors.mdx | 5 + .../docs/oas/myaccount/myaccount-api-oas.json | 521 +++++++++++++++++- 44 files changed, 804 insertions(+), 8 deletions(-) create mode 100644 main/docs/api/myaccount/consents/get-a-consent-by-id.mdx create mode 100644 main/docs/api/myaccount/consents/list-user-consents.mdx create mode 100644 main/docs/fr-ca/api/myaccount/consents/get-a-consent-by-id.mdx create mode 100644 main/docs/fr-ca/api/myaccount/consents/list-user-consents.mdx create mode 100644 main/docs/ja-jp/api/myaccount/consents/get-a-consent-by-id.mdx create mode 100644 main/docs/ja-jp/api/myaccount/consents/list-user-consents.mdx diff --git a/main/docs.json b/main/docs.json index 61d45fa34..3266553a6 100644 --- a/main/docs.json +++ b/main/docs.json @@ -2542,6 +2542,13 @@ "docs/api/myaccount/connected-accounts/get-a-list-of-available-connections-for-connected-accounts", "docs/api/myaccount/connected-accounts/delete-a-connected-account-by-id" ] + }, + { + "group": "Consents", + "pages": [ + "docs/api/myaccount/consents/list-user-consents", + "docs/api/myaccount/consents/get-a-consent-by-id" + ] } ] } @@ -5288,6 +5295,13 @@ "docs/fr-ca/api/myaccount/connected-accounts/get-a-list-of-available-connections-for-connected-accounts", "docs/fr-ca/api/myaccount/connected-accounts/delete-a-connected-account-by-id" ] + }, + { + "group": "Consents", + "pages": [ + "docs/fr-ca/api/myaccount/consents/list-user-consents", + "docs/fr-ca/api/myaccount/consents/get-a-consent-by-id" + ] } ] } @@ -7745,6 +7759,13 @@ "docs/ja-jp/api/myaccount/connected-accounts/get-a-list-of-available-connections-for-connected-accounts", "docs/ja-jp/api/myaccount/connected-accounts/delete-a-connected-account-by-id" ] + }, + { + "group": "Consents", + "pages": [ + "docs/ja-jp/api/myaccount/consents/list-user-consents", + "docs/ja-jp/api/myaccount/consents/get-a-consent-by-id" + ] } ] } diff --git a/main/docs/api/myaccount/authentication-methods/confirm-the-enrollment-of-a-supported-authentication-method.mdx b/main/docs/api/myaccount/authentication-methods/confirm-the-enrollment-of-a-supported-authentication-method.mdx index 9e6bc5e26..47c39f52e 100644 --- a/main/docs/api/myaccount/authentication-methods/confirm-the-enrollment-of-a-supported-authentication-method.mdx +++ b/main/docs/api/myaccount/authentication-methods/confirm-the-enrollment-of-a-supported-authentication-method.mdx @@ -3,6 +3,11 @@ openapi: myaccount-api-oas post /authentication-methods/{authentication_method_i playground: simple --- +{/* +OAS version: 1.421.0 +Snippet version: 0.0.2 +*/} + import { ApiReleaseLifecycle } from "/snippets/ApiReleaseLifecycle.jsx"; import { Scopes } from "/snippets/ApiScopes.jsx"; diff --git a/main/docs/api/myaccount/authentication-methods/delete-an-authentication-method-by-id.mdx b/main/docs/api/myaccount/authentication-methods/delete-an-authentication-method-by-id.mdx index 7c7a3a069..711880d8b 100644 --- a/main/docs/api/myaccount/authentication-methods/delete-an-authentication-method-by-id.mdx +++ b/main/docs/api/myaccount/authentication-methods/delete-an-authentication-method-by-id.mdx @@ -3,6 +3,11 @@ openapi: myaccount-api-oas delete /authentication-methods/{authentication_method playground: simple --- +{/* +OAS version: 1.421.0 +Snippet version: 0.0.2 +*/} + import { ApiReleaseLifecycle } from "/snippets/ApiReleaseLifecycle.jsx"; import { Scopes } from "/snippets/ApiScopes.jsx"; diff --git a/main/docs/api/myaccount/authentication-methods/get-a-list-of-authentication-methods.mdx b/main/docs/api/myaccount/authentication-methods/get-a-list-of-authentication-methods.mdx index 28cbcbc75..dbd00f645 100644 --- a/main/docs/api/myaccount/authentication-methods/get-a-list-of-authentication-methods.mdx +++ b/main/docs/api/myaccount/authentication-methods/get-a-list-of-authentication-methods.mdx @@ -3,6 +3,11 @@ openapi: myaccount-api-oas get /authentication-methods playground: simple --- +{/* +OAS version: 1.421.0 +Snippet version: 0.0.2 +*/} + import { ApiReleaseLifecycle } from "/snippets/ApiReleaseLifecycle.jsx"; import { Scopes } from "/snippets/ApiScopes.jsx"; diff --git a/main/docs/api/myaccount/authentication-methods/get-an-authentication-method-by-id.mdx b/main/docs/api/myaccount/authentication-methods/get-an-authentication-method-by-id.mdx index 53e3d7511..1730ca989 100644 --- a/main/docs/api/myaccount/authentication-methods/get-an-authentication-method-by-id.mdx +++ b/main/docs/api/myaccount/authentication-methods/get-an-authentication-method-by-id.mdx @@ -3,6 +3,11 @@ openapi: myaccount-api-oas get /authentication-methods/{authentication_method_id playground: simple --- +{/* +OAS version: 1.421.0 +Snippet version: 0.0.2 +*/} + import { ApiReleaseLifecycle } from "/snippets/ApiReleaseLifecycle.jsx"; import { Scopes } from "/snippets/ApiScopes.jsx"; diff --git a/main/docs/api/myaccount/authentication-methods/start-the-enrollment-of-a-supported-authentication-method.mdx b/main/docs/api/myaccount/authentication-methods/start-the-enrollment-of-a-supported-authentication-method.mdx index c78fad65a..40f59da7d 100644 --- a/main/docs/api/myaccount/authentication-methods/start-the-enrollment-of-a-supported-authentication-method.mdx +++ b/main/docs/api/myaccount/authentication-methods/start-the-enrollment-of-a-supported-authentication-method.mdx @@ -3,6 +3,11 @@ openapi: myaccount-api-oas post /authentication-methods playground: simple --- +{/* +OAS version: 1.421.0 +Snippet version: 0.0.2 +*/} + import { ApiReleaseLifecycle } from "/snippets/ApiReleaseLifecycle.jsx"; import { Scopes } from "/snippets/ApiScopes.jsx"; diff --git a/main/docs/api/myaccount/authentication-methods/update-details-of-an-authentication-method-by-id.mdx b/main/docs/api/myaccount/authentication-methods/update-details-of-an-authentication-method-by-id.mdx index d23a826be..750cd3fa9 100644 --- a/main/docs/api/myaccount/authentication-methods/update-details-of-an-authentication-method-by-id.mdx +++ b/main/docs/api/myaccount/authentication-methods/update-details-of-an-authentication-method-by-id.mdx @@ -3,6 +3,11 @@ openapi: myaccount-api-oas patch /authentication-methods/{authentication_method_ playground: simple --- +{/* +OAS version: 1.421.0 +Snippet version: 0.0.2 +*/} + import { ApiReleaseLifecycle } from "/snippets/ApiReleaseLifecycle.jsx"; import { Scopes } from "/snippets/ApiScopes.jsx"; diff --git a/main/docs/api/myaccount/connected-accounts/complete-a-connected-account-request.mdx b/main/docs/api/myaccount/connected-accounts/complete-a-connected-account-request.mdx index 8c64d4a60..06e00331d 100644 --- a/main/docs/api/myaccount/connected-accounts/complete-a-connected-account-request.mdx +++ b/main/docs/api/myaccount/connected-accounts/complete-a-connected-account-request.mdx @@ -3,6 +3,11 @@ openapi: myaccount-api-oas post /connected-accounts/complete playground: simple --- +{/* +OAS version: 1.421.0 +Snippet version: 0.0.2 +*/} + import { ApiReleaseLifecycle } from "/snippets/ApiReleaseLifecycle.jsx"; import { Scopes } from "/snippets/ApiScopes.jsx"; diff --git a/main/docs/api/myaccount/connected-accounts/create-a-connected-account-request.mdx b/main/docs/api/myaccount/connected-accounts/create-a-connected-account-request.mdx index 37ec18e4b..e470664f2 100644 --- a/main/docs/api/myaccount/connected-accounts/create-a-connected-account-request.mdx +++ b/main/docs/api/myaccount/connected-accounts/create-a-connected-account-request.mdx @@ -3,6 +3,11 @@ openapi: myaccount-api-oas post /connected-accounts/connect playground: simple --- +{/* +OAS version: 1.421.0 +Snippet version: 0.0.2 +*/} + import { ApiReleaseLifecycle } from "/snippets/ApiReleaseLifecycle.jsx"; import { Scopes } from "/snippets/ApiScopes.jsx"; diff --git a/main/docs/api/myaccount/connected-accounts/delete-a-connected-account-by-id.mdx b/main/docs/api/myaccount/connected-accounts/delete-a-connected-account-by-id.mdx index 180df7477..79d98f619 100644 --- a/main/docs/api/myaccount/connected-accounts/delete-a-connected-account-by-id.mdx +++ b/main/docs/api/myaccount/connected-accounts/delete-a-connected-account-by-id.mdx @@ -3,6 +3,11 @@ openapi: myaccount-api-oas delete /connected-accounts/accounts/{id} playground: simple --- +{/* +OAS version: 1.421.0 +Snippet version: 0.0.2 +*/} + import { ApiReleaseLifecycle } from "/snippets/ApiReleaseLifecycle.jsx"; import { Scopes } from "/snippets/ApiScopes.jsx"; diff --git a/main/docs/api/myaccount/connected-accounts/get-a-list-of-available-connections-for-connected-accounts.mdx b/main/docs/api/myaccount/connected-accounts/get-a-list-of-available-connections-for-connected-accounts.mdx index c1450d8ae..7a7e11e2e 100644 --- a/main/docs/api/myaccount/connected-accounts/get-a-list-of-available-connections-for-connected-accounts.mdx +++ b/main/docs/api/myaccount/connected-accounts/get-a-list-of-available-connections-for-connected-accounts.mdx @@ -3,6 +3,11 @@ openapi: myaccount-api-oas get /connected-accounts/connections playground: simple --- +{/* +OAS version: 1.421.0 +Snippet version: 0.0.2 +*/} + import { ApiReleaseLifecycle } from "/snippets/ApiReleaseLifecycle.jsx"; import { Scopes } from "/snippets/ApiScopes.jsx"; diff --git a/main/docs/api/myaccount/connected-accounts/get-a-list-of-connected-accounts.mdx b/main/docs/api/myaccount/connected-accounts/get-a-list-of-connected-accounts.mdx index c9dff7e0e..f4856e02a 100644 --- a/main/docs/api/myaccount/connected-accounts/get-a-list-of-connected-accounts.mdx +++ b/main/docs/api/myaccount/connected-accounts/get-a-list-of-connected-accounts.mdx @@ -3,6 +3,11 @@ openapi: myaccount-api-oas get /connected-accounts/accounts playground: simple --- +{/* +OAS version: 1.421.0 +Snippet version: 0.0.2 +*/} + import { ApiReleaseLifecycle } from "/snippets/ApiReleaseLifecycle.jsx"; import { Scopes } from "/snippets/ApiScopes.jsx"; diff --git a/main/docs/api/myaccount/consents/get-a-consent-by-id.mdx b/main/docs/api/myaccount/consents/get-a-consent-by-id.mdx new file mode 100644 index 000000000..2e576d251 --- /dev/null +++ b/main/docs/api/myaccount/consents/get-a-consent-by-id.mdx @@ -0,0 +1,15 @@ +--- +openapi: myaccount-api-oas get /consents/{consent_id} +playground: simple +--- + +{/* +OAS version: 1.421.0 +Snippet version: 0.0.2 +*/} + +import { ApiReleaseLifecycle } from "/snippets/ApiReleaseLifecycle.jsx"; +import { Scopes } from "/snippets/ApiScopes.jsx"; + + + \ No newline at end of file diff --git a/main/docs/api/myaccount/consents/list-user-consents.mdx b/main/docs/api/myaccount/consents/list-user-consents.mdx new file mode 100644 index 000000000..27d3bc3d5 --- /dev/null +++ b/main/docs/api/myaccount/consents/list-user-consents.mdx @@ -0,0 +1,15 @@ +--- +openapi: myaccount-api-oas get /consents +playground: simple +--- + +{/* +OAS version: 1.421.0 +Snippet version: 0.0.2 +*/} + +import { ApiReleaseLifecycle } from "/snippets/ApiReleaseLifecycle.jsx"; +import { Scopes } from "/snippets/ApiScopes.jsx"; + + + \ No newline at end of file diff --git a/main/docs/api/myaccount/factors/get-the-status-of-all-factors.mdx b/main/docs/api/myaccount/factors/get-the-status-of-all-factors.mdx index 260d10a82..45bb6abca 100644 --- a/main/docs/api/myaccount/factors/get-the-status-of-all-factors.mdx +++ b/main/docs/api/myaccount/factors/get-the-status-of-all-factors.mdx @@ -3,6 +3,11 @@ openapi: myaccount-api-oas get /factors playground: simple --- +{/* +OAS version: 1.421.0 +Snippet version: 0.0.2 +*/} + import { ApiReleaseLifecycle } from "/snippets/ApiReleaseLifecycle.jsx"; import { Scopes } from "/snippets/ApiScopes.jsx"; diff --git a/main/docs/fr-ca/api/myaccount/authentication-methods/confirm-the-enrollment-of-a-supported-authentication-method.mdx b/main/docs/fr-ca/api/myaccount/authentication-methods/confirm-the-enrollment-of-a-supported-authentication-method.mdx index 9e6bc5e26..47c39f52e 100644 --- a/main/docs/fr-ca/api/myaccount/authentication-methods/confirm-the-enrollment-of-a-supported-authentication-method.mdx +++ b/main/docs/fr-ca/api/myaccount/authentication-methods/confirm-the-enrollment-of-a-supported-authentication-method.mdx @@ -3,6 +3,11 @@ openapi: myaccount-api-oas post /authentication-methods/{authentication_method_i playground: simple --- +{/* +OAS version: 1.421.0 +Snippet version: 0.0.2 +*/} + import { ApiReleaseLifecycle } from "/snippets/ApiReleaseLifecycle.jsx"; import { Scopes } from "/snippets/ApiScopes.jsx"; diff --git a/main/docs/fr-ca/api/myaccount/authentication-methods/delete-an-authentication-method-by-id.mdx b/main/docs/fr-ca/api/myaccount/authentication-methods/delete-an-authentication-method-by-id.mdx index 7c7a3a069..711880d8b 100644 --- a/main/docs/fr-ca/api/myaccount/authentication-methods/delete-an-authentication-method-by-id.mdx +++ b/main/docs/fr-ca/api/myaccount/authentication-methods/delete-an-authentication-method-by-id.mdx @@ -3,6 +3,11 @@ openapi: myaccount-api-oas delete /authentication-methods/{authentication_method playground: simple --- +{/* +OAS version: 1.421.0 +Snippet version: 0.0.2 +*/} + import { ApiReleaseLifecycle } from "/snippets/ApiReleaseLifecycle.jsx"; import { Scopes } from "/snippets/ApiScopes.jsx"; diff --git a/main/docs/fr-ca/api/myaccount/authentication-methods/get-a-list-of-authentication-methods.mdx b/main/docs/fr-ca/api/myaccount/authentication-methods/get-a-list-of-authentication-methods.mdx index 28cbcbc75..dbd00f645 100644 --- a/main/docs/fr-ca/api/myaccount/authentication-methods/get-a-list-of-authentication-methods.mdx +++ b/main/docs/fr-ca/api/myaccount/authentication-methods/get-a-list-of-authentication-methods.mdx @@ -3,6 +3,11 @@ openapi: myaccount-api-oas get /authentication-methods playground: simple --- +{/* +OAS version: 1.421.0 +Snippet version: 0.0.2 +*/} + import { ApiReleaseLifecycle } from "/snippets/ApiReleaseLifecycle.jsx"; import { Scopes } from "/snippets/ApiScopes.jsx"; diff --git a/main/docs/fr-ca/api/myaccount/authentication-methods/get-an-authentication-method-by-id.mdx b/main/docs/fr-ca/api/myaccount/authentication-methods/get-an-authentication-method-by-id.mdx index 53e3d7511..1730ca989 100644 --- a/main/docs/fr-ca/api/myaccount/authentication-methods/get-an-authentication-method-by-id.mdx +++ b/main/docs/fr-ca/api/myaccount/authentication-methods/get-an-authentication-method-by-id.mdx @@ -3,6 +3,11 @@ openapi: myaccount-api-oas get /authentication-methods/{authentication_method_id playground: simple --- +{/* +OAS version: 1.421.0 +Snippet version: 0.0.2 +*/} + import { ApiReleaseLifecycle } from "/snippets/ApiReleaseLifecycle.jsx"; import { Scopes } from "/snippets/ApiScopes.jsx"; diff --git a/main/docs/fr-ca/api/myaccount/authentication-methods/start-the-enrollment-of-a-supported-authentication-method.mdx b/main/docs/fr-ca/api/myaccount/authentication-methods/start-the-enrollment-of-a-supported-authentication-method.mdx index c78fad65a..40f59da7d 100644 --- a/main/docs/fr-ca/api/myaccount/authentication-methods/start-the-enrollment-of-a-supported-authentication-method.mdx +++ b/main/docs/fr-ca/api/myaccount/authentication-methods/start-the-enrollment-of-a-supported-authentication-method.mdx @@ -3,6 +3,11 @@ openapi: myaccount-api-oas post /authentication-methods playground: simple --- +{/* +OAS version: 1.421.0 +Snippet version: 0.0.2 +*/} + import { ApiReleaseLifecycle } from "/snippets/ApiReleaseLifecycle.jsx"; import { Scopes } from "/snippets/ApiScopes.jsx"; diff --git a/main/docs/fr-ca/api/myaccount/authentication-methods/update-details-of-an-authentication-method-by-id.mdx b/main/docs/fr-ca/api/myaccount/authentication-methods/update-details-of-an-authentication-method-by-id.mdx index d23a826be..750cd3fa9 100644 --- a/main/docs/fr-ca/api/myaccount/authentication-methods/update-details-of-an-authentication-method-by-id.mdx +++ b/main/docs/fr-ca/api/myaccount/authentication-methods/update-details-of-an-authentication-method-by-id.mdx @@ -3,6 +3,11 @@ openapi: myaccount-api-oas patch /authentication-methods/{authentication_method_ playground: simple --- +{/* +OAS version: 1.421.0 +Snippet version: 0.0.2 +*/} + import { ApiReleaseLifecycle } from "/snippets/ApiReleaseLifecycle.jsx"; import { Scopes } from "/snippets/ApiScopes.jsx"; diff --git a/main/docs/fr-ca/api/myaccount/connected-accounts/complete-a-connected-account-request.mdx b/main/docs/fr-ca/api/myaccount/connected-accounts/complete-a-connected-account-request.mdx index 8c64d4a60..06e00331d 100644 --- a/main/docs/fr-ca/api/myaccount/connected-accounts/complete-a-connected-account-request.mdx +++ b/main/docs/fr-ca/api/myaccount/connected-accounts/complete-a-connected-account-request.mdx @@ -3,6 +3,11 @@ openapi: myaccount-api-oas post /connected-accounts/complete playground: simple --- +{/* +OAS version: 1.421.0 +Snippet version: 0.0.2 +*/} + import { ApiReleaseLifecycle } from "/snippets/ApiReleaseLifecycle.jsx"; import { Scopes } from "/snippets/ApiScopes.jsx"; diff --git a/main/docs/fr-ca/api/myaccount/connected-accounts/create-a-connected-account-request.mdx b/main/docs/fr-ca/api/myaccount/connected-accounts/create-a-connected-account-request.mdx index 37ec18e4b..e470664f2 100644 --- a/main/docs/fr-ca/api/myaccount/connected-accounts/create-a-connected-account-request.mdx +++ b/main/docs/fr-ca/api/myaccount/connected-accounts/create-a-connected-account-request.mdx @@ -3,6 +3,11 @@ openapi: myaccount-api-oas post /connected-accounts/connect playground: simple --- +{/* +OAS version: 1.421.0 +Snippet version: 0.0.2 +*/} + import { ApiReleaseLifecycle } from "/snippets/ApiReleaseLifecycle.jsx"; import { Scopes } from "/snippets/ApiScopes.jsx"; diff --git a/main/docs/fr-ca/api/myaccount/connected-accounts/delete-a-connected-account-by-id.mdx b/main/docs/fr-ca/api/myaccount/connected-accounts/delete-a-connected-account-by-id.mdx index 180df7477..79d98f619 100644 --- a/main/docs/fr-ca/api/myaccount/connected-accounts/delete-a-connected-account-by-id.mdx +++ b/main/docs/fr-ca/api/myaccount/connected-accounts/delete-a-connected-account-by-id.mdx @@ -3,6 +3,11 @@ openapi: myaccount-api-oas delete /connected-accounts/accounts/{id} playground: simple --- +{/* +OAS version: 1.421.0 +Snippet version: 0.0.2 +*/} + import { ApiReleaseLifecycle } from "/snippets/ApiReleaseLifecycle.jsx"; import { Scopes } from "/snippets/ApiScopes.jsx"; diff --git a/main/docs/fr-ca/api/myaccount/connected-accounts/get-a-list-of-available-connections-for-connected-accounts.mdx b/main/docs/fr-ca/api/myaccount/connected-accounts/get-a-list-of-available-connections-for-connected-accounts.mdx index c1450d8ae..7a7e11e2e 100644 --- a/main/docs/fr-ca/api/myaccount/connected-accounts/get-a-list-of-available-connections-for-connected-accounts.mdx +++ b/main/docs/fr-ca/api/myaccount/connected-accounts/get-a-list-of-available-connections-for-connected-accounts.mdx @@ -3,6 +3,11 @@ openapi: myaccount-api-oas get /connected-accounts/connections playground: simple --- +{/* +OAS version: 1.421.0 +Snippet version: 0.0.2 +*/} + import { ApiReleaseLifecycle } from "/snippets/ApiReleaseLifecycle.jsx"; import { Scopes } from "/snippets/ApiScopes.jsx"; diff --git a/main/docs/fr-ca/api/myaccount/connected-accounts/get-a-list-of-connected-accounts.mdx b/main/docs/fr-ca/api/myaccount/connected-accounts/get-a-list-of-connected-accounts.mdx index c9dff7e0e..f4856e02a 100644 --- a/main/docs/fr-ca/api/myaccount/connected-accounts/get-a-list-of-connected-accounts.mdx +++ b/main/docs/fr-ca/api/myaccount/connected-accounts/get-a-list-of-connected-accounts.mdx @@ -3,6 +3,11 @@ openapi: myaccount-api-oas get /connected-accounts/accounts playground: simple --- +{/* +OAS version: 1.421.0 +Snippet version: 0.0.2 +*/} + import { ApiReleaseLifecycle } from "/snippets/ApiReleaseLifecycle.jsx"; import { Scopes } from "/snippets/ApiScopes.jsx"; diff --git a/main/docs/fr-ca/api/myaccount/consents/get-a-consent-by-id.mdx b/main/docs/fr-ca/api/myaccount/consents/get-a-consent-by-id.mdx new file mode 100644 index 000000000..2e576d251 --- /dev/null +++ b/main/docs/fr-ca/api/myaccount/consents/get-a-consent-by-id.mdx @@ -0,0 +1,15 @@ +--- +openapi: myaccount-api-oas get /consents/{consent_id} +playground: simple +--- + +{/* +OAS version: 1.421.0 +Snippet version: 0.0.2 +*/} + +import { ApiReleaseLifecycle } from "/snippets/ApiReleaseLifecycle.jsx"; +import { Scopes } from "/snippets/ApiScopes.jsx"; + + + \ No newline at end of file diff --git a/main/docs/fr-ca/api/myaccount/consents/list-user-consents.mdx b/main/docs/fr-ca/api/myaccount/consents/list-user-consents.mdx new file mode 100644 index 000000000..27d3bc3d5 --- /dev/null +++ b/main/docs/fr-ca/api/myaccount/consents/list-user-consents.mdx @@ -0,0 +1,15 @@ +--- +openapi: myaccount-api-oas get /consents +playground: simple +--- + +{/* +OAS version: 1.421.0 +Snippet version: 0.0.2 +*/} + +import { ApiReleaseLifecycle } from "/snippets/ApiReleaseLifecycle.jsx"; +import { Scopes } from "/snippets/ApiScopes.jsx"; + + + \ No newline at end of file diff --git a/main/docs/fr-ca/api/myaccount/factors/get-the-status-of-all-factors.mdx b/main/docs/fr-ca/api/myaccount/factors/get-the-status-of-all-factors.mdx index 260d10a82..45bb6abca 100644 --- a/main/docs/fr-ca/api/myaccount/factors/get-the-status-of-all-factors.mdx +++ b/main/docs/fr-ca/api/myaccount/factors/get-the-status-of-all-factors.mdx @@ -3,6 +3,11 @@ openapi: myaccount-api-oas get /factors playground: simple --- +{/* +OAS version: 1.421.0 +Snippet version: 0.0.2 +*/} + import { ApiReleaseLifecycle } from "/snippets/ApiReleaseLifecycle.jsx"; import { Scopes } from "/snippets/ApiScopes.jsx"; diff --git a/main/docs/ja-jp/api/myaccount/authentication-methods/confirm-the-enrollment-of-a-supported-authentication-method.mdx b/main/docs/ja-jp/api/myaccount/authentication-methods/confirm-the-enrollment-of-a-supported-authentication-method.mdx index 9e6bc5e26..47c39f52e 100644 --- a/main/docs/ja-jp/api/myaccount/authentication-methods/confirm-the-enrollment-of-a-supported-authentication-method.mdx +++ b/main/docs/ja-jp/api/myaccount/authentication-methods/confirm-the-enrollment-of-a-supported-authentication-method.mdx @@ -3,6 +3,11 @@ openapi: myaccount-api-oas post /authentication-methods/{authentication_method_i playground: simple --- +{/* +OAS version: 1.421.0 +Snippet version: 0.0.2 +*/} + import { ApiReleaseLifecycle } from "/snippets/ApiReleaseLifecycle.jsx"; import { Scopes } from "/snippets/ApiScopes.jsx"; diff --git a/main/docs/ja-jp/api/myaccount/authentication-methods/delete-an-authentication-method-by-id.mdx b/main/docs/ja-jp/api/myaccount/authentication-methods/delete-an-authentication-method-by-id.mdx index 7c7a3a069..711880d8b 100644 --- a/main/docs/ja-jp/api/myaccount/authentication-methods/delete-an-authentication-method-by-id.mdx +++ b/main/docs/ja-jp/api/myaccount/authentication-methods/delete-an-authentication-method-by-id.mdx @@ -3,6 +3,11 @@ openapi: myaccount-api-oas delete /authentication-methods/{authentication_method playground: simple --- +{/* +OAS version: 1.421.0 +Snippet version: 0.0.2 +*/} + import { ApiReleaseLifecycle } from "/snippets/ApiReleaseLifecycle.jsx"; import { Scopes } from "/snippets/ApiScopes.jsx"; diff --git a/main/docs/ja-jp/api/myaccount/authentication-methods/get-a-list-of-authentication-methods.mdx b/main/docs/ja-jp/api/myaccount/authentication-methods/get-a-list-of-authentication-methods.mdx index 28cbcbc75..dbd00f645 100644 --- a/main/docs/ja-jp/api/myaccount/authentication-methods/get-a-list-of-authentication-methods.mdx +++ b/main/docs/ja-jp/api/myaccount/authentication-methods/get-a-list-of-authentication-methods.mdx @@ -3,6 +3,11 @@ openapi: myaccount-api-oas get /authentication-methods playground: simple --- +{/* +OAS version: 1.421.0 +Snippet version: 0.0.2 +*/} + import { ApiReleaseLifecycle } from "/snippets/ApiReleaseLifecycle.jsx"; import { Scopes } from "/snippets/ApiScopes.jsx"; diff --git a/main/docs/ja-jp/api/myaccount/authentication-methods/get-an-authentication-method-by-id.mdx b/main/docs/ja-jp/api/myaccount/authentication-methods/get-an-authentication-method-by-id.mdx index 53e3d7511..1730ca989 100644 --- a/main/docs/ja-jp/api/myaccount/authentication-methods/get-an-authentication-method-by-id.mdx +++ b/main/docs/ja-jp/api/myaccount/authentication-methods/get-an-authentication-method-by-id.mdx @@ -3,6 +3,11 @@ openapi: myaccount-api-oas get /authentication-methods/{authentication_method_id playground: simple --- +{/* +OAS version: 1.421.0 +Snippet version: 0.0.2 +*/} + import { ApiReleaseLifecycle } from "/snippets/ApiReleaseLifecycle.jsx"; import { Scopes } from "/snippets/ApiScopes.jsx"; diff --git a/main/docs/ja-jp/api/myaccount/authentication-methods/start-the-enrollment-of-a-supported-authentication-method.mdx b/main/docs/ja-jp/api/myaccount/authentication-methods/start-the-enrollment-of-a-supported-authentication-method.mdx index c78fad65a..40f59da7d 100644 --- a/main/docs/ja-jp/api/myaccount/authentication-methods/start-the-enrollment-of-a-supported-authentication-method.mdx +++ b/main/docs/ja-jp/api/myaccount/authentication-methods/start-the-enrollment-of-a-supported-authentication-method.mdx @@ -3,6 +3,11 @@ openapi: myaccount-api-oas post /authentication-methods playground: simple --- +{/* +OAS version: 1.421.0 +Snippet version: 0.0.2 +*/} + import { ApiReleaseLifecycle } from "/snippets/ApiReleaseLifecycle.jsx"; import { Scopes } from "/snippets/ApiScopes.jsx"; diff --git a/main/docs/ja-jp/api/myaccount/authentication-methods/update-details-of-an-authentication-method-by-id.mdx b/main/docs/ja-jp/api/myaccount/authentication-methods/update-details-of-an-authentication-method-by-id.mdx index d23a826be..750cd3fa9 100644 --- a/main/docs/ja-jp/api/myaccount/authentication-methods/update-details-of-an-authentication-method-by-id.mdx +++ b/main/docs/ja-jp/api/myaccount/authentication-methods/update-details-of-an-authentication-method-by-id.mdx @@ -3,6 +3,11 @@ openapi: myaccount-api-oas patch /authentication-methods/{authentication_method_ playground: simple --- +{/* +OAS version: 1.421.0 +Snippet version: 0.0.2 +*/} + import { ApiReleaseLifecycle } from "/snippets/ApiReleaseLifecycle.jsx"; import { Scopes } from "/snippets/ApiScopes.jsx"; diff --git a/main/docs/ja-jp/api/myaccount/connected-accounts/complete-a-connected-account-request.mdx b/main/docs/ja-jp/api/myaccount/connected-accounts/complete-a-connected-account-request.mdx index 8c64d4a60..06e00331d 100644 --- a/main/docs/ja-jp/api/myaccount/connected-accounts/complete-a-connected-account-request.mdx +++ b/main/docs/ja-jp/api/myaccount/connected-accounts/complete-a-connected-account-request.mdx @@ -3,6 +3,11 @@ openapi: myaccount-api-oas post /connected-accounts/complete playground: simple --- +{/* +OAS version: 1.421.0 +Snippet version: 0.0.2 +*/} + import { ApiReleaseLifecycle } from "/snippets/ApiReleaseLifecycle.jsx"; import { Scopes } from "/snippets/ApiScopes.jsx"; diff --git a/main/docs/ja-jp/api/myaccount/connected-accounts/create-a-connected-account-request.mdx b/main/docs/ja-jp/api/myaccount/connected-accounts/create-a-connected-account-request.mdx index 37ec18e4b..e470664f2 100644 --- a/main/docs/ja-jp/api/myaccount/connected-accounts/create-a-connected-account-request.mdx +++ b/main/docs/ja-jp/api/myaccount/connected-accounts/create-a-connected-account-request.mdx @@ -3,6 +3,11 @@ openapi: myaccount-api-oas post /connected-accounts/connect playground: simple --- +{/* +OAS version: 1.421.0 +Snippet version: 0.0.2 +*/} + import { ApiReleaseLifecycle } from "/snippets/ApiReleaseLifecycle.jsx"; import { Scopes } from "/snippets/ApiScopes.jsx"; diff --git a/main/docs/ja-jp/api/myaccount/connected-accounts/delete-a-connected-account-by-id.mdx b/main/docs/ja-jp/api/myaccount/connected-accounts/delete-a-connected-account-by-id.mdx index 180df7477..79d98f619 100644 --- a/main/docs/ja-jp/api/myaccount/connected-accounts/delete-a-connected-account-by-id.mdx +++ b/main/docs/ja-jp/api/myaccount/connected-accounts/delete-a-connected-account-by-id.mdx @@ -3,6 +3,11 @@ openapi: myaccount-api-oas delete /connected-accounts/accounts/{id} playground: simple --- +{/* +OAS version: 1.421.0 +Snippet version: 0.0.2 +*/} + import { ApiReleaseLifecycle } from "/snippets/ApiReleaseLifecycle.jsx"; import { Scopes } from "/snippets/ApiScopes.jsx"; diff --git a/main/docs/ja-jp/api/myaccount/connected-accounts/get-a-list-of-available-connections-for-connected-accounts.mdx b/main/docs/ja-jp/api/myaccount/connected-accounts/get-a-list-of-available-connections-for-connected-accounts.mdx index c1450d8ae..7a7e11e2e 100644 --- a/main/docs/ja-jp/api/myaccount/connected-accounts/get-a-list-of-available-connections-for-connected-accounts.mdx +++ b/main/docs/ja-jp/api/myaccount/connected-accounts/get-a-list-of-available-connections-for-connected-accounts.mdx @@ -3,6 +3,11 @@ openapi: myaccount-api-oas get /connected-accounts/connections playground: simple --- +{/* +OAS version: 1.421.0 +Snippet version: 0.0.2 +*/} + import { ApiReleaseLifecycle } from "/snippets/ApiReleaseLifecycle.jsx"; import { Scopes } from "/snippets/ApiScopes.jsx"; diff --git a/main/docs/ja-jp/api/myaccount/connected-accounts/get-a-list-of-connected-accounts.mdx b/main/docs/ja-jp/api/myaccount/connected-accounts/get-a-list-of-connected-accounts.mdx index c9dff7e0e..f4856e02a 100644 --- a/main/docs/ja-jp/api/myaccount/connected-accounts/get-a-list-of-connected-accounts.mdx +++ b/main/docs/ja-jp/api/myaccount/connected-accounts/get-a-list-of-connected-accounts.mdx @@ -3,6 +3,11 @@ openapi: myaccount-api-oas get /connected-accounts/accounts playground: simple --- +{/* +OAS version: 1.421.0 +Snippet version: 0.0.2 +*/} + import { ApiReleaseLifecycle } from "/snippets/ApiReleaseLifecycle.jsx"; import { Scopes } from "/snippets/ApiScopes.jsx"; diff --git a/main/docs/ja-jp/api/myaccount/consents/get-a-consent-by-id.mdx b/main/docs/ja-jp/api/myaccount/consents/get-a-consent-by-id.mdx new file mode 100644 index 000000000..2e576d251 --- /dev/null +++ b/main/docs/ja-jp/api/myaccount/consents/get-a-consent-by-id.mdx @@ -0,0 +1,15 @@ +--- +openapi: myaccount-api-oas get /consents/{consent_id} +playground: simple +--- + +{/* +OAS version: 1.421.0 +Snippet version: 0.0.2 +*/} + +import { ApiReleaseLifecycle } from "/snippets/ApiReleaseLifecycle.jsx"; +import { Scopes } from "/snippets/ApiScopes.jsx"; + + + \ No newline at end of file diff --git a/main/docs/ja-jp/api/myaccount/consents/list-user-consents.mdx b/main/docs/ja-jp/api/myaccount/consents/list-user-consents.mdx new file mode 100644 index 000000000..27d3bc3d5 --- /dev/null +++ b/main/docs/ja-jp/api/myaccount/consents/list-user-consents.mdx @@ -0,0 +1,15 @@ +--- +openapi: myaccount-api-oas get /consents +playground: simple +--- + +{/* +OAS version: 1.421.0 +Snippet version: 0.0.2 +*/} + +import { ApiReleaseLifecycle } from "/snippets/ApiReleaseLifecycle.jsx"; +import { Scopes } from "/snippets/ApiScopes.jsx"; + + + \ No newline at end of file diff --git a/main/docs/ja-jp/api/myaccount/factors/get-the-status-of-all-factors.mdx b/main/docs/ja-jp/api/myaccount/factors/get-the-status-of-all-factors.mdx index 260d10a82..45bb6abca 100644 --- a/main/docs/ja-jp/api/myaccount/factors/get-the-status-of-all-factors.mdx +++ b/main/docs/ja-jp/api/myaccount/factors/get-the-status-of-all-factors.mdx @@ -3,6 +3,11 @@ openapi: myaccount-api-oas get /factors playground: simple --- +{/* +OAS version: 1.421.0 +Snippet version: 0.0.2 +*/} + import { ApiReleaseLifecycle } from "/snippets/ApiReleaseLifecycle.jsx"; import { Scopes } from "/snippets/ApiScopes.jsx"; diff --git a/main/docs/oas/myaccount/myaccount-api-oas.json b/main/docs/oas/myaccount/myaccount-api-oas.json index 2a15b4434..216495234 100644 --- a/main/docs/oas/myaccount/myaccount-api-oas.json +++ b/main/docs/oas/myaccount/myaccount-api-oas.json @@ -32,6 +32,11 @@ "name": "authentication-methods", "description": "Authentication Methods", "x-displayName": "Authentication Methods" + }, + { + "name": "consents", + "description": "Consents", + "x-displayName": "Consents" } ], "paths": { @@ -215,6 +220,9 @@ "403": { "$ref": "#/components/responses/Forbidden" }, + "415": { + "$ref": "#/components/responses/UnsupportedMediaType" + }, "429": { "$ref": "#/components/responses/TooManyRequests" } @@ -432,6 +440,9 @@ "403": { "$ref": "#/components/responses/Forbidden" }, + "415": { + "$ref": "#/components/responses/UnsupportedMediaType" + }, "429": { "$ref": "#/components/responses/TooManyRequests" } @@ -516,6 +527,9 @@ "403": { "$ref": "#/components/responses/Forbidden" }, + "415": { + "$ref": "#/components/responses/UnsupportedMediaType" + }, "429": { "$ref": "#/components/responses/TooManyRequests" } @@ -575,6 +589,9 @@ "403": { "$ref": "#/components/responses/Forbidden" }, + "415": { + "$ref": "#/components/responses/UnsupportedMediaType" + }, "429": { "$ref": "#/components/responses/TooManyRequests" } @@ -634,6 +651,9 @@ "403": { "$ref": "#/components/responses/Forbidden" }, + "415": { + "$ref": "#/components/responses/UnsupportedMediaType" + }, "429": { "$ref": "#/components/responses/TooManyRequests" } @@ -888,6 +908,122 @@ } ] } + }, + "/consents": { + "get": { + "description": "Retrieve the list of consents for the authenticated user.", + "operationId": "getConsents", + "x-operation-request-parameters-name": "GetConsentsRequestParameters", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ListConsentsResponseContent" + } + } + }, + "description": "Successfully retrieved consents", + "headers": { + "x-ratelimit-limit": { + "$ref": "#/components/headers/XRateLimitLimitHeader" + }, + "x-ratelimit-reset": { + "$ref": "#/components/headers/XRateLimitResetHeader" + }, + "x-ratelimit-remaining": { + "$ref": "#/components/headers/XRateLimitRemainingHeader" + } + } + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "429": { + "$ref": "#/components/responses/TooManyRequests" + } + }, + "security": [ + { + "Bearer-DPoP": [ + "read:me:consents" + ] + } + ], + "tags": [ + "consents" + ], + "summary": "List user consents", + "x-release-lifecycle": "planned", + "x-operation-group": "Consents", + "x-operation-name": "list", + "x-codeSamples": [] + } + }, + "/consents/{consent_id}": { + "get": { + "description": "Retrieve a specific consent for the authenticated user by ID.", + "operationId": "getConsent", + "x-operation-request-parameters-name": "GetConsentRequestParameters", + "parameters": [ + { + "$ref": "#/components/parameters/PathConsentId" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GetConsentResponseContent" + } + } + }, + "description": "Successfully retrieved consent", + "headers": { + "x-ratelimit-limit": { + "$ref": "#/components/headers/XRateLimitLimitHeader" + }, + "x-ratelimit-reset": { + "$ref": "#/components/headers/XRateLimitResetHeader" + }, + "x-ratelimit-remaining": { + "$ref": "#/components/headers/XRateLimitRemainingHeader" + } + } + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "429": { + "$ref": "#/components/responses/TooManyRequests" + } + }, + "security": [ + { + "Bearer-DPoP": [ + "read:me:consents" + ] + } + ], + "tags": [ + "consents" + ], + "summary": "Get a consent by ID", + "x-release-lifecycle": "planned", + "x-operation-group": "Consents", + "x-operation-name": "get", + "x-codeSamples": [] + } } }, "components": { @@ -1492,8 +1628,38 @@ ], "additionalProperties": false }, + "Connection": { + "description": "Name of the database connection", + "type": "string", + "minLength": 1, + "maxLength": 128, + "pattern": "^[a-zA-Z0-9-]+$" + }, + "IdentityUserId": { + "description": "Identity provider user ID", + "type": "string", + "minLength": 1, + "maxLength": 255, + "pattern": "^\\S+$" + }, + "IdentityAuthenticationMethodBase": { + "type": "object", + "properties": { + "connection": { + "$ref": "#/components/schemas/Connection" + }, + "identity_user_id": { + "$ref": "#/components/schemas/IdentityUserId" + } + } + }, "CreatePasskeyAuthenticationMethod": { "title": "Passkey enrollment payload", + "allOf": [ + { + "$ref": "#/components/schemas/IdentityAuthenticationMethodBase" + } + ], "type": "object", "properties": { "type": { @@ -1501,14 +1667,6 @@ "const": "passkey", "default": "passkey", "type": "string" - }, - "connection": { - "description": "Connection name", - "type": "string" - }, - "identity_user_id": { - "description": "The ID of the user identity linked with the authentication method", - "type": "string" } }, "required": [ @@ -1641,6 +1799,29 @@ ], "additionalProperties": false }, + "CreatePasswordAuthenticationMethod": { + "title": "Password authentication method creation payload", + "allOf": [ + { + "$ref": "#/components/schemas/IdentityAuthenticationMethodBase" + } + ], + "type": "object", + "properties": { + "type": { + "description": "Authentication method type (factor)", + "const": "password", + "default": "password", + "type": "string" + }, + "connection": true, + "identity_user_id": true + }, + "required": [ + "type" + ], + "additionalProperties": false + }, "CreateAuthenticationMethodRequestContent": { "description": "Request content for creating an authentication method", "oneOf": [ @@ -1675,6 +1856,10 @@ { "$ref": "#/components/schemas/CreatePhoneAuthenticationMethod", "title": "phone" + }, + { + "$ref": "#/components/schemas/CreatePasswordAuthenticationMethod", + "title": "password" } ], "type": "object", @@ -1913,6 +2098,200 @@ } ] }, + "PasswordCharacterTypeEnum": { + "type": "string", + "enum": [ + "uppercase", + "lowercase", + "number", + "special" + ], + "description": "Character type for password complexity requirements" + }, + "PasswordCharacterTypeRuleEnum": { + "type": "string", + "enum": [ + "all", + "three_of_four" + ], + "description": "How character types are enforced in password complexity" + }, + "PasswordIdenticalCharactersEnum": { + "type": "string", + "enum": [ + "allow", + "block" + ], + "description": "Whether to allow 3 or more consecutive identical characters" + }, + "PasswordSequentialCharactersEnum": { + "type": "string", + "enum": [ + "allow", + "block" + ], + "description": "Whether to allow sequential characters" + }, + "PasswordMaxLengthExceededEnum": { + "type": "string", + "enum": [ + "truncate", + "error" + ], + "description": "Behavior when password exceeds maximum length" + }, + "PasswordComplexityPolicy": { + "type": "object", + "description": "Password complexity requirements", + "properties": { + "min_length": { + "type": "integer", + "description": "Minimum password length" + }, + "character_types": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PasswordCharacterTypeEnum" + }, + "description": "Required character types" + }, + "character_type_rule": { + "$ref": "#/components/schemas/PasswordCharacterTypeRuleEnum" + }, + "identical_characters": { + "$ref": "#/components/schemas/PasswordIdenticalCharactersEnum" + }, + "sequential_characters": { + "$ref": "#/components/schemas/PasswordSequentialCharactersEnum" + }, + "max_length_exceeded": { + "$ref": "#/components/schemas/PasswordMaxLengthExceededEnum" + } + }, + "required": [ + "min_length", + "character_types", + "character_type_rule", + "identical_characters", + "sequential_characters", + "max_length_exceeded" + ], + "additionalProperties": false + }, + "PasswordProfileDataPolicy": { + "type": "object", + "description": "Settings for blocking personal information in passwords", + "properties": { + "active": { + "type": "boolean", + "description": "Whether to block personal information (name, email, etc.) in passwords" + }, + "blocked_fields": { + "type": "array", + "items": { + "type": "string" + }, + "description": "User profile fields to block from passwords (e.g., 'name', 'email', 'user_metadata.first')" + } + }, + "required": [ + "active", + "blocked_fields" + ], + "additionalProperties": false + }, + "PasswordHistoryPolicy": { + "type": "object", + "description": "Password history enforcement settings", + "properties": { + "active": { + "type": "boolean", + "description": "Whether password history is enforced" + }, + "size": { + "type": "integer", + "description": "Number of previous passwords to remember and prevent reuse" + } + }, + "required": [ + "active", + "size" + ], + "additionalProperties": false + }, + "PasswordDictionaryDefaultEnum": { + "type": "string", + "enum": [ + "en_10k", + "en_100k" + ], + "description": "Default dictionary to use for checking weak passwords" + }, + "PasswordDictionaryPolicy": { + "type": "object", + "description": "Dictionary checking settings to block weak or banned passwords", + "properties": { + "active": { + "type": "boolean", + "description": "Whether dictionary checking is enabled" + }, + "default": { + "$ref": "#/components/schemas/PasswordDictionaryDefaultEnum" + } + }, + "required": [ + "active", + "default" + ], + "additionalProperties": false + }, + "PasswordAuthenticationMethodPolicy": { + "type": "object", + "description": "The password policy configuration for the connection in flexible format.", + "properties": { + "complexity": { + "$ref": "#/components/schemas/PasswordComplexityPolicy" + }, + "profile_data": { + "$ref": "#/components/schemas/PasswordProfileDataPolicy" + }, + "history": { + "$ref": "#/components/schemas/PasswordHistoryPolicy" + }, + "dictionary": { + "$ref": "#/components/schemas/PasswordDictionaryPolicy" + } + }, + "required": [ + "complexity", + "profile_data", + "history", + "dictionary" + ], + "additionalProperties": false + }, + "PasswordCreationResponse": { + "title": "Password enrollment information", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The unique identifier for the password authentication method." + }, + "policy": { + "$ref": "#/components/schemas/PasswordAuthenticationMethodPolicy" + }, + "auth_session": { + "type": "string", + "description": "The unique session identifier for the password change operation." + } + }, + "required": [ + "id", + "policy", + "auth_session" + ] + }, "CreateAuthenticationMethodResponseContent": { "anyOf": [ { @@ -1930,6 +2309,9 @@ }, { "$ref": "#/components/schemas/RecoveryCodeCreationResponse" + }, + { + "$ref": "#/components/schemas/PasswordCreationResponse" } ] }, @@ -2108,6 +2490,26 @@ ], "additionalProperties": false }, + "VerifyPasswordAuthenticationMethod": { + "title": "Password verification payload", + "type": "object", + "properties": { + "auth_session": { + "type": "string", + "description": "The unique session identifier for the password change operation as returned by POST /authentication-methods" + }, + "new_password": { + "type": "string", + "minLength": 1, + "description": "The new password to set for the user" + } + }, + "required": [ + "auth_session", + "new_password" + ], + "additionalProperties": false + }, "VerifyWebAuthnPlatformAuthenticationMethod": { "title": "WebAuthn Platform verification payload", "properties": { @@ -2236,6 +2638,10 @@ "$ref": "#/components/schemas/VerifyPasskeyAuthenticationMethod", "x-type": "passkey" }, + { + "$ref": "#/components/schemas/VerifyPasswordAuthenticationMethod", + "x-type": "password" + }, { "$ref": "#/components/schemas/VerifyWebAuthnPlatformAuthenticationMethod", "x-type": "webauthn-platform" @@ -2701,6 +3107,86 @@ "type": "string", "description": "The unique identifier for a connected account", "pattern": "^cac_[A-Za-z0-9]+$" + }, + "ConsentDetails": { + "type": "object", + "description": "Details of the consent request", + "properties": { + "binding_message": { + "type": "string", + "description": "A human-readable identifier or message intended to be displayed on both the consumption device and the authentication device to interlock them together for the transaction by way of a visual cue for the end-user." + }, + "audience": { + "type": "string", + "description": "The audience (API identifier) that the consent was granted for." + }, + "scope": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The scopes that were requested for this consent." + } + }, + "additionalProperties": false + }, + "Consent": { + "type": "object", + "description": "A consent record representing user authorization for a specific client and scope.", + "properties": { + "id": { + "type": "string", + "description": "The unique identifier of the consent.", + "example": "cns_abc123def456" + }, + "client_id": { + "type": "string", + "description": "The client ID that the consent was granted to." + }, + "requested_details": { + "$ref": "#/components/schemas/ConsentDetails" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time when the consent was created." + }, + "expires_at": { + "type": "string", + "format": "date-time", + "description": "The date and time when the consent expires." + } + }, + "required": [ + "id", + "client_id", + "created_at", + "expires_at" + ], + "additionalProperties": false + }, + "ListConsentsResponseContent": { + "type": "object", + "properties": { + "consents": { + "type": "array", + "description": "List of consents for the authenticated user.", + "items": { + "$ref": "#/components/schemas/Consent" + } + } + }, + "required": [ + "consents" + ], + "additionalProperties": false + }, + "GetConsentResponseContent": { + "allOf": [ + { + "$ref": "#/components/schemas/Consent" + } + ] } }, "responses": { @@ -2761,6 +3247,16 @@ } } }, + "UnsupportedMediaType": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + }, + "description": "Unsupported Media Type." + }, "NotFound": { "content": { "application/json": { @@ -2863,6 +3359,15 @@ "schema": { "$ref": "#/components/schemas/ConnectedAccountId" } + }, + "PathConsentId": { + "in": "path", + "name": "consent_id", + "required": true, + "schema": { + "type": "string" + }, + "description": "The ID of the consent to retrieve" } } }