diff --git a/docs/reference/api.json b/docs/reference/api.json index 66dbd41a7..0e6e4035f 100644 --- a/docs/reference/api.json +++ b/docs/reference/api.json @@ -124,21 +124,19 @@ } }, "schemas": { - "CORS": { + "AttributesCountDatapoint": { "properties": { - "enabled": { - "description": "Whether CORS is enabled for this endpoint.", - "type": "boolean" + "count": { + "description": "Count of the attribute value for given key", + "format": "int64", + "type": "integer" }, - "origins": { - "description": "The allowed origins. Use `*` to allow all origins. A wildcard can also be used in the subdomain, i.e. `https://*.example.com` will allow all origins on all subdomains of `example.com`.", - "items": { - "type": "string" - }, - "type": "array" + "name": { + "description": "Name of the attribute value for given key", + "type": "string" } }, - "required": ["enabled", "origins"], + "required": ["name", "count"], "type": "object" }, "CodeAddressType": { @@ -397,6 +395,26 @@ "title": "RecoveryAddressType must not exceed 16 characters as that is the limitation in the SQL Schema.", "type": "string" }, + "SessionActivityDatapoint": { + "properties": { + "country": { + "description": "Country of the events", + "type": "string" + }, + "failed": { + "description": "Number of events that failed in the given timeframe", + "format": "int64", + "type": "integer" + }, + "succeeded": { + "description": "Number of events that succeeded in the given timeframe", + "format": "int64", + "type": "integer" + } + }, + "required": ["succeeded", "failed", "country"], + "type": "object" + }, "SourcePosition": { "properties": { "Line": { @@ -619,6 +637,18 @@ }, "type": "object" }, + "consistencyRequestParameters": { + "description": "Control API consistency guarantees", + "properties": { + "consistency": { + "description": "Read Consistency Level (preview)\n\nThe read consistency level determines the consistency guarantee for reads:\n\nstrong (slow): The read is guaranteed to return the most recent data committed at the start of the read.\neventual (very fast): The result will return data that is about 4.8 seconds old.\n\nThe default consistency guarantee can be changed in the Ory Network Console or using the Ory CLI with\n`ory patch project --replace '/previews/default_read_consistency_level=\"strong\"'`.\n\nSetting the default consistency level to `eventual` may cause regressions in the future as we add consistency\ncontrols to more APIs. Currently, the following APIs will be affected by this setting:\n\n`GET /admin/identities`\n\nThis feature is in preview and only available in Ory Network.\n ConsistencyLevelUnset ConsistencyLevelUnset is the unset / default consistency level.\nstrong ConsistencyLevelStrong ConsistencyLevelStrong is the strong consistency level.\neventual ConsistencyLevelEventual ConsistencyLevelEventual is the eventual consistency level using follower read timestamps.", + "enum": ["", "strong", "eventual"], + "type": "string", + "x-go-enum-desc": " ConsistencyLevelUnset ConsistencyLevelUnset is the unset / default consistency level.\nstrong ConsistencyLevelStrong ConsistencyLevelStrong is the strong consistency level.\neventual ConsistencyLevelEventual ConsistencyLevelEventual is the eventual consistency level using follower read timestamps." + } + }, + "type": "object" + }, "continueWith": { "discriminator": { "mapping": { @@ -1267,6 +1297,21 @@ }, "type": "object" }, + "getAttributesCountResponse": { + "description": "Response of the getAttributesCount endpoint", + "properties": { + "data": { + "description": "The list of data points.", + "items": { + "$ref": "#/components/schemas/AttributesCountDatapoint" + }, + "readOnly": true, + "type": "array" + } + }, + "required": ["data"], + "type": "object" + }, "getManagedIdentitySchemaLocation": { "description": "Ory Identity Schema Location", "properties": { @@ -1301,6 +1346,21 @@ "required": ["data"], "type": "object" }, + "getSessionActivityResponse": { + "description": "Response of the getSessionActivity endpoint", + "properties": { + "data": { + "description": "The list of data points.", + "items": { + "$ref": "#/components/schemas/SessionActivityDatapoint" + }, + "readOnly": true, + "type": "array" + } + }, + "required": ["data"], + "type": "object" + }, "healthNotReadyStatus": { "properties": { "errors": { @@ -2495,7 +2555,7 @@ "type": "string" }, "hydra_oauth2_token_hook": { - "description": "Sets the token hook endpoint for all grant types. If set it will be called while providing token to customize claims.\n\nThis governs the \"oauth2.token_hook\" setting.", + "description": "Sets the token hook endpoint for all grant types. If set it will be called while providing token to customize claims.\n\nThis governs the \"oauth2.token_hook.url\" setting.", "type": "string" }, "hydra_oidc_dynamic_client_registration_default_scope": { @@ -2645,9 +2705,6 @@ "keto_namespaces": { "$ref": "#/components/schemas/KetoNamespaces" }, - "keto_read_max_depth": { - "$ref": "#/components/schemas/NullInt" - }, "kratos_cookies_same_site": { "description": "Configures the Ory Kratos Cookie SameSite Attribute\n\nThis governs the \"cookies.same_site\" setting.", "type": "string" @@ -2855,6 +2912,10 @@ "description": "The Revisions' OAuth2 Provider Integration URL\n\nThis governs the \"oauth2_provider.url\" setting.", "type": "string" }, + "kratos_preview_default_read_consistency_level": { + "description": "Configures the default read consistency level for identity APIs\n\nThis governs the `preview.default_read_consistency_level` setting.\n\nThe read consistency level determines the consistency guarantee for reads:\n\nstrong (slow): The read is guaranteed to return the most recent data committed at the start of the read.\neventual (very fast): The result will return data that is about 4.8 seconds old.\n\nSetting the default consistency level to `eventual` may cause regressions in the future as we add consistency\ncontrols to more APIs. Currently, the following APIs will be affected by this setting:\n\n`GET /admin/identities`\n\nDefaults to \"strong\" for new and existing projects. This feature is in preview. Use with caution.", + "type": "string" + }, "kratos_secrets_cipher": { "$ref": "#/components/schemas/StringSliceJSONFormat" }, @@ -2875,9 +2936,6 @@ "description": "Configures the Ory Kratos Error UI URL\n\nThis governs the \"selfservice.flows.error.ui_url\" setting.", "type": "string" }, - "kratos_selfservice_flows_hooks": { - "$ref": "#/components/schemas/projectRevisionHooks" - }, "kratos_selfservice_flows_login_after_code_default_browser_return_url": { "description": "Configures the Ory Kratos Login After Password Default Return URL\n\nThis governs the \"selfservice.flows.code.after.password.default_browser_return_url\" setting.", "type": "string" @@ -3182,6 +3240,9 @@ "format": "uuid", "type": "string" }, + "project_revision_hooks": { + "$ref": "#/components/schemas/projectRevisionHooks" + }, "serve_admin_cors_allowed_origins": { "$ref": "#/components/schemas/StringSliceJSONFormat" }, @@ -4457,10 +4518,10 @@ "project": { "properties": { "cors_admin": { - "$ref": "#/components/schemas/CORS" + "$ref": "#/components/schemas/projectCors" }, "cors_public": { - "$ref": "#/components/schemas/CORS" + "$ref": "#/components/schemas/projectCors" }, "id": { "description": "The project's ID.", @@ -4901,6 +4962,23 @@ "title": "ProjectBrandingThemes is a list of ProjectBrandingTheme.", "type": "array" }, + "projectCors": { + "properties": { + "enabled": { + "description": "Whether CORS is enabled for this endpoint.", + "type": "boolean" + }, + "origins": { + "description": "The allowed origins. Use `*` to allow all origins. A wildcard can also be used in the subdomain, i.e. `https://*.example.com` will allow all origins on all subdomains of `example.com`.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "required": ["enabled", "origins"], + "type": "object" + }, "projectHost": { "properties": { "host": { @@ -5538,6 +5616,7 @@ "link_recovery", "code_recovery", "password", + "code", "totp", "oidc", "webauthn", @@ -5634,10 +5713,10 @@ "setProject": { "properties": { "cors_admin": { - "$ref": "#/components/schemas/CORS" + "$ref": "#/components/schemas/projectCors" }, "cors_public": { - "$ref": "#/components/schemas/CORS" + "$ref": "#/components/schemas/projectCors" }, "name": { "description": "The name of the project.", @@ -7915,6 +7994,16 @@ "type": "string" } }, + { + "description": "Read Consistency Level (preview)\n\nThe read consistency level determines the consistency guarantee for reads:\n\nstrong (slow): The read is guaranteed to return the most recent data committed at the start of the read.\neventual (very fast): The result will return data that is about 4.8 seconds old.\n\nThe default consistency guarantee can be changed in the Ory Network Console or using the Ory CLI with\n`ory patch project --replace '/previews/default_read_consistency_level=\"strong\"'`.\n\nSetting the default consistency level to `eventual` may cause regressions in the future as we add consistency\ncontrols to more APIs. Currently, the following APIs will be affected by this setting:\n\n`GET /admin/identities`\n\nThis feature is in preview and only available in Ory Network.\n ConsistencyLevelUnset ConsistencyLevelUnset is the unset / default consistency level.\nstrong ConsistencyLevelStrong ConsistencyLevelStrong is the strong consistency level.\neventual ConsistencyLevelEventual ConsistencyLevelEventual is the eventual consistency level using follower read timestamps.", + "in": "query", + "name": "consistency", + "schema": { + "enum": ["", "strong", "eventual"], + "type": "string" + }, + "x-go-enum-desc": " ConsistencyLevelUnset ConsistencyLevelUnset is the unset / default consistency level.\nstrong ConsistencyLevelStrong ConsistencyLevelStrong is the strong consistency level.\neventual ConsistencyLevelEventual ConsistencyLevelEventual is the eventual consistency level using follower read timestamps." + }, { "description": "CredentialsIdentifier is the identifier (username, email) of the credentials to look up using exact match.\nOnly one of CredentialsIdentifier and CredentialsIdentifierSimilar can be used.", "in": "query", @@ -11688,7 +11777,7 @@ } }, { - "description": "The start time of the time window", + "description": "The start RFC3339 date of the time window", "in": "query", "name": "from", "required": true, @@ -11698,7 +11787,7 @@ } }, { - "description": "The end time of the time window", + "description": "The end RFC3339 date of the time window", "in": "query", "name": "to", "required": true,