@leancodepl/kratos

/** * Ory APIs * # Introduction Documentation for all public and administrative Ory APIs. Administrative APIs can only be accessed with a valid Personal Access Token. Public APIs are mostly used in browsers. ## SDKs This document describes the APIs available in the Ory Network. The APIs are available as SDKs for the following languages: | Language | Download SDK | Documentation | | -------------- | ---------------------------------------------------------------- | ------------------------------------------------------------------------------------ | | Dart | [pub.dev](https://pub.dev/packages/ory_client) | [README](https://github.com/ory/sdk/blob/master/clients/client/dart/README.md) | | .NET | [nuget.org](https://www.nuget.org/packages/Ory.Client/) | [README](https://github.com/ory/sdk/blob/master/clients/client/dotnet/README.md) | | Elixir | [hex.pm](https://hex.pm/packages/ory_client) | [README](https://github.com/ory/sdk/blob/master/clients/client/elixir/README.md) | | Go | [github.com](https://github.com/ory/client-go) | [README](https://github.com/ory/sdk/blob/master/clients/client/go/README.md) | | Java | [maven.org](https://search.maven.org/artifact/sh.ory/ory-client) | [README](https://github.com/ory/sdk/blob/master/clients/client/java/README.md) | | JavaScript | [npmjs.com](https://www.npmjs.com/package/@ory/client) | [README](https://github.com/ory/sdk/blob/master/clients/client/typescript/README.md) | | JavaScript (With fetch) | [npmjs.com](https://www.npmjs.com/package/@ory/client-fetch) | [README](https://github.com/ory/sdk/blob/master/clients/client/typescript-fetch/README.md) | | PHP | [packagist.org](https://packagist.org/packages/ory/client) | [README](https://github.com/ory/sdk/blob/master/clients/client/php/README.md) | | Python | [pypi.org](https://pypi.org/project/ory-client/) | [README](https://github.com/ory/sdk/blob/master/clients/client/python/README.md) | | Ruby | [rubygems.org](https://rubygems.org/gems/ory-client) | [README](https://github.com/ory/sdk/blob/master/clients/client/ruby/README.md) | | Rust | [crates.io](https://crates.io/crates/ory-client) | [README](https://github.com/ory/sdk/blob/master/clients/client/rust/README.md) | * * The version of the OpenAPI document: v1.20.10 * Contact: support@ory.sh * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import type { NormalizedProjectRevisionCourierChannel } from './NormalizedProjectRevisionCourierChannel'; import type { KetoNamespace } from './KetoNamespace'; import type { NormalizedProjectRevisionScimClient } from './NormalizedProjectRevisionScimClient'; import type { NormalizedProjectRevisionIdentitySchema } from './NormalizedProjectRevisionIdentitySchema'; import type { NormalizedProjectRevisionThirdPartyProvider } from './NormalizedProjectRevisionThirdPartyProvider'; import type { NormalizedProjectRevisionHook } from './NormalizedProjectRevisionHook'; import type { NormalizedProjectRevisionSAMLProvider } from './NormalizedProjectRevisionSAMLProvider'; import type { NormalizedProjectRevisionTokenizerTemplate } from './NormalizedProjectRevisionTokenizerTemplate'; /** * Create project (normalized) request payload * @export * @interface CreateProjectNormalizedPayload */ export interface CreateProjectNormalizedPayload { /** * Holds the default locale for the account experience. * @type {string} * @memberof CreateProjectNormalizedPayload */ account_experience_default_locale?: string; /** * Holds the URL to the account experience's dark theme favicon (currently unused). * @type {string} * @memberof CreateProjectNormalizedPayload */ account_experience_favicon_dark?: string; /** * Holds the URL to the account experience's favicon. * @type {string} * @memberof CreateProjectNormalizedPayload */ account_experience_favicon_light?: string; /** * Holds the URL to the account experience's language behavior. * * Can be one of: * `respect_accept_language`: Respect the `Accept-Language` header. * `force_default`: Force the default language. * @type {string} * @memberof CreateProjectNormalizedPayload */ account_experience_locale_behavior?: string; /** * Holds the URL to the account experience's dark theme logo (currently unused). * @type {string} * @memberof CreateProjectNormalizedPayload */ account_experience_logo_dark?: string; /** * Holds the URL to the account experience's logo. * @type {string} * @memberof CreateProjectNormalizedPayload */ account_experience_logo_light?: string; /** * Holds the URL to the account experience's dark theme variables. * @type {string} * @memberof CreateProjectNormalizedPayload */ account_experience_theme_variables_dark?: string; /** * Holds the URL to the account experience's light theme variables. * @type {string} * @memberof CreateProjectNormalizedPayload */ account_experience_theme_variables_light?: string; /** * The Project's Revision Creation Date * @type {Date} * @memberof CreateProjectNormalizedPayload */ readonly created_at?: Date; /** * Whether to disable the account experience welcome screen, which is hosted under `/ui/welcome`. * @type {boolean} * @memberof CreateProjectNormalizedPayload */ disable_account_experience_welcome_screen?: boolean; /** * Whether the new account experience is enabled and reachable. * @type {boolean} * @memberof CreateProjectNormalizedPayload */ enable_ax_v2?: boolean; /** * * prod Production * stage Staging * dev Development * @type {string} * @memberof CreateProjectNormalizedPayload */ environment: CreateProjectNormalizedPayloadEnvironmentEnum; /** * * eu-central EUCentral * asia-northeast AsiaNorthEast * us-east USEast * us-west USWest * us US * global Global * @type {string} * @memberof CreateProjectNormalizedPayload */ home_region?: CreateProjectNormalizedPayloadHomeRegionEnum; /** * * @type {Array<string>} * @memberof CreateProjectNormalizedPayload */ hydra_oauth2_allowed_top_level_claims?: Array<string>; /** * Automatically grant authorized OAuth2 Scope in OAuth2 Client Credentials Flow. * * Each OAuth2 Client is allowed to request a predefined OAuth2 Scope (for example `read write`). If this option is enabled, the full * scope is automatically granted when performing the OAuth2 Client Credentials flow. * * If disabled, the OAuth2 Client has to request the scope in the OAuth2 request by providing the `scope` query parameter. * * Setting this option to true is common if you need compatibility with MITREid. * * This governs the "oauth2.client_credentials.default_grant_allowed_scope" setting. * @type {boolean} * @memberof CreateProjectNormalizedPayload */ hydra_oauth2_client_credentials_default_grant_allowed_scope?: boolean; /** * Set to true if you want to exclude claim `nbf (not before)` part of access token. * * This governs the "oauth2.exclude_not_before_claim" setting. * @type {boolean} * @memberof CreateProjectNormalizedPayload */ hydra_oauth2_exclude_not_before_claim?: boolean; /** * Configures if the issued at (`iat`) claim is required in the JSON Web Token (JWT) Profile for OAuth 2.0 Client Authentication and Authorization Grants (RFC7523). * * If set to `false`, the `iat` claim is required. Set this value to `true` only after careful consideration. * * This governs the "oauth2.grant.jwt.iat_optional" setting. * @type {boolean} * @memberof CreateProjectNormalizedPayload */ hydra_oauth2_grant_jwt_iat_optional?: boolean; /** * Configures if the JSON Web Token ID (`jti`) claim is required in the JSON Web Token (JWT) Profile for OAuth 2.0 Client Authentication and Authorization Grants (RFC7523). * * If set to `false`, the `jti` claim is required. Set this value to `true` only after careful consideration. * * This governs the "oauth2.grant.jwt.jti_optional" setting. * @type {boolean} * @memberof CreateProjectNormalizedPayload */ hydra_oauth2_grant_jwt_jti_optional?: boolean; /** * Configures what the maximum age of a JWT assertion used in the JSON Web Token (JWT) Profile for OAuth 2.0 Client Authentication and Authorization Grants (RFC7523) can be. * * This feature uses the `exp` claim and `iat` claim to calculate assertion age. Assertions exceeding the max age will be denied. * * Useful as a safety measure and recommended to keep below 720h. * * This governs the "oauth2.grant.jwt.max_ttl" setting. * @type {string} * @memberof CreateProjectNormalizedPayload */ hydra_oauth2_grant_jwt_max_ttl?: string; /** * Configures the OAuth2 Grant Refresh Token Rotation Grace Period * * If set to `null` or `"0s"`, the graceful refresh token rotation is disabled. * * This governs the "oauth2.grant.refresh_token_rotation_grace_period" setting. * @type {string} * @memberof CreateProjectNormalizedPayload */ hydra_oauth2_grant_refresh_token_rotation_grace_period?: string; /** * Set to false if you don't want to mirror custom claims under 'ext'. * * This governs the "oauth2.mirror_top_level_claims" setting. * @type {boolean} * @memberof CreateProjectNormalizedPayload */ hydra_oauth2_mirror_top_level_claims?: boolean; /** * Configures whether PKCE should be enforced for all OAuth2 Clients. * * This governs the "oauth2.pkce.enforced" setting. * @type {boolean} * @memberof CreateProjectNormalizedPayload */ hydra_oauth2_pkce_enforced?: boolean; /** * Configures whether PKCE should be enforced for OAuth2 Clients without a client secret (public clients). * * This governs the "oauth2.pkce.enforced_for_public_clients" setting. * @type {boolean} * @memberof CreateProjectNormalizedPayload */ hydra_oauth2_pkce_enforced_for_public_clients?: boolean; /** * Sets the Refresh Token Hook Endpoint. If set this endpoint will be called during the OAuth2 Token Refresh grant update the OAuth2 Access Token claims. * * This governs the "oauth2.refresh_token_hook" setting. * @type {string} * @memberof CreateProjectNormalizedPayload */ hydra_oauth2_refresh_token_hook?: string; /** * Sets the token hook endpoint for all grant types. If set it will be called while providing token to customize claims. * * This governs the "oauth2.token_hook.url" setting. * @type {string} * @memberof CreateProjectNormalizedPayload */ hydra_oauth2_token_hook?: string; /** * * @type {Array<string>} * @memberof CreateProjectNormalizedPayload */ hydra_oidc_dynamic_client_registration_default_scope?: Array<string>; /** * Configures OpenID Connect Dynamic Client Registration. * * This governs the "oidc.dynamic_client_registration.enabled" setting. * @type {boolean} * @memberof CreateProjectNormalizedPayload */ hydra_oidc_dynamic_client_registration_enabled?: boolean; /** * Configures OpenID Connect Discovery and overwrites the pairwise algorithm * * This governs the "oidc.subject_identifiers.pairwise_salt" setting. * @type {string} * @memberof CreateProjectNormalizedPayload */ hydra_oidc_subject_identifiers_pairwise_salt?: string; /** * * @type {Array<string>} * @memberof CreateProjectNormalizedPayload */ hydra_oidc_subject_identifiers_supported_types?: Array<string>; /** * * @type {Array<string>} * @memberof CreateProjectNormalizedPayload */ hydra_secrets_cookie?: Array<string>; /** * * @type {Array<string>} * @memberof CreateProjectNormalizedPayload */ hydra_secrets_system?: Array<string>; /** * Configures the Ory Hydra Cookie Same Site Legacy Workaround * * This governs the "serve.cookies.same_site_legacy_workaround" setting. * @type {boolean} * @memberof CreateProjectNormalizedPayload */ hydra_serve_cookies_same_site_legacy_workaround?: boolean; /** * Configures the Ory Hydra Cookie Same Site Mode * * This governs the "serve.cookies.same_site_mode" setting. * @type {string} * @memberof CreateProjectNormalizedPayload */ hydra_serve_cookies_same_site_mode?: string; /** * Defines access token type * * This governs the "strategies.access_token" setting. * opaque Oauth2AccessTokenStrategyOpaque * jwt Oauth2AccessTokenStrategyJwt * @type {string} * @memberof CreateProjectNormalizedPayload */ hydra_strategies_access_token?: CreateProjectNormalizedPayloadHydraStrategiesAccessTokenEnum; /** * Define the claim to use as the scope in the access token. * * This governs the "strategies.jwt.scope_claim" setting: * * list: The scope claim is an array of strings named `scope`: `{ "scope": ["read", "write"] }` * string: The scope claim is a space delimited list of strings named `scp`: `{ "scp": "read write" }` * both: The scope claim is both a space delimited list and an array of strings named `scope` and `scp`: `{ "scope": ["read", "write"], "scp": "read write" }` * list OAuth2JWTScopeClaimList * string OAuth2JWTScopeClaimString * both OAuth2JWTScopeClaimBoth * @type {string} * @memberof CreateProjectNormalizedPayload */ hydra_strategies_jwt_scope_claim?: CreateProjectNormalizedPayloadHydraStrategiesJwtScopeClaimEnum; /** * Defines how scopes are matched. For more details have a look at https://github.com/ory/fosite#scopes * * This governs the "strategies.scope" setting. * exact Oauth2ScopeStrategyExact * wildcard Oauth2ScopeStrategyWildcard * @type {string} * @memberof CreateProjectNormalizedPayload */ hydra_strategies_scope?: CreateProjectNormalizedPayloadHydraStrategiesScopeEnum; /** * This governs the "ttl.access_token" setting. * @type {string} * @memberof CreateProjectNormalizedPayload */ hydra_ttl_access_token?: string; /** * Configures how long refresh tokens are valid. * * Set to -1 for refresh tokens to never expire. This is not recommended! * * This governs the "ttl.auth_code" setting. * @type {string} * @memberof CreateProjectNormalizedPayload */ hydra_ttl_auth_code?: string; /** * This governs the "ttl.id_token" setting. * @type {string} * @memberof CreateProjectNormalizedPayload */ hydra_ttl_id_token?: string; /** * Configures how long a user login and consent flow may take. * * This governs the "ttl.login_consent_request" setting. * @type {string} * @memberof CreateProjectNormalizedPayload */ hydra_ttl_login_consent_request?: string; /** * Configures how long refresh tokens are valid. * * Set to -1 for refresh tokens to never expire. This is not recommended! * * This governs the "ttl.refresh_token" setting. * @type {string} * @memberof CreateProjectNormalizedPayload */ hydra_ttl_refresh_token?: string; /** * Sets the OAuth2 Consent Endpoint URL of the OAuth2 User Login & Consent flow. * * Defaults to the Ory Account Experience if left empty. * * This governs the "urls.consent" setting. * @type {string} * @memberof CreateProjectNormalizedPayload */ hydra_urls_consent?: string; /** * Sets the OAuth2 Error URL of the OAuth2 User Login & Consent flow. * * Defaults to the Ory Account Experience if left empty. * * This governs the "urls.error" setting. * @type {string} * @memberof CreateProjectNormalizedPayload */ hydra_urls_error?: string; /** * Sets the OAuth2 Login Endpoint URL of the OAuth2 User Login & Consent flow. * * Defaults to the Ory Account Experience if left empty. * * This governs the "urls.login" setting. * @type {string} * @memberof CreateProjectNormalizedPayload */ hydra_urls_login?: string; /** * Sets the logout endpoint. * * Defaults to the Ory Account Experience if left empty. * * This governs the "urls.logout" setting. * @type {string} * @memberof CreateProjectNormalizedPayload */ hydra_urls_logout?: string; /** * When an OAuth2-related user agent requests to log out, they will be redirected to this url afterwards per default. * * Defaults to the Ory Account Experience in development and your application in production mode when a custom domain is connected. * * This governs the "urls.post_logout_redirect" setting. * @type {string} * @memberof CreateProjectNormalizedPayload */ hydra_urls_post_logout_redirect?: string; /** * Sets the OAuth2 Registration Endpoint URL of the OAuth2 User Login & Consent flow. * * Defaults to the Ory Account Experience if left empty. * * This governs the "urls.registration" setting. * @type {string} * @memberof CreateProjectNormalizedPayload */ hydra_urls_registration?: string; /** * This value will be used as the issuer in access and ID tokens. It must be specified and using HTTPS protocol, unless the development mode is enabled. * * On the Ory Network it will be very rare that you want to modify this value. If left empty, it will default to the correct value for the Ory Network. * * This governs the "urls.self.issuer" setting. * @type {string} * @memberof CreateProjectNormalizedPayload */ hydra_urls_self_issuer?: string; /** * * @type {Array<string>} * @memberof CreateProjectNormalizedPayload */ hydra_webfinger_jwks_broadcast_keys?: Array<string>; /** * Configures OpenID Connect Discovery and overwrites the OAuth2 Authorization URL. * * This governs the "webfinger.oidc.discovery.auth_url" setting. * @type {string} * @memberof CreateProjectNormalizedPayload */ hydra_webfinger_oidc_discovery_auth_url?: string; /** * Configures OpenID Connect Discovery and overwrites the OpenID Connect Dynamic Client Registration Endpoint. * * This governs the "webfinger.oidc.discovery.client_registration_url" setting. * @type {string} * @memberof CreateProjectNormalizedPayload */ hydra_webfinger_oidc_discovery_client_registration_url?: string; /** * Configures OpenID Connect Discovery and overwrites the JWKS URL. * * This governs the "webfinger.oidc.discovery.jwks_url" setting. * @type {string} * @memberof CreateProjectNormalizedPayload */ hydra_webfinger_oidc_discovery_jwks_url?: string; /** * * @type {Array<string>} * @memberof CreateProjectNormalizedPayload */ hydra_webfinger_oidc_discovery_supported_claims?: Array<string>; /** * * @type {Array<string>} * @memberof CreateProjectNormalizedPayload */ hydra_webfinger_oidc_discovery_supported_scope?: Array<string>; /** * Configures OpenID Connect Discovery and overwrites the OAuth2 Token URL. * * This governs the "webfinger.oidc.discovery.token_url" setting. * @type {string} * @memberof CreateProjectNormalizedPayload */ hydra_webfinger_oidc_discovery_token_url?: string; /** * Configures OpenID Connect Discovery and overwrites userinfo endpoint to be advertised at the OpenID Connect Discovery endpoint /.well-known/openid-configuration. Defaults to Ory Hydra's userinfo endpoint at /userinfo. Set this value if you want to handle this endpoint yourself. * * This governs the "webfinger.oidc.discovery.userinfo_url" setting. * @type {string} * @memberof CreateProjectNormalizedPayload */ hydra_webfinger_oidc_discovery_userinfo_url?: string; /** * The revision ID. * @type {string} * @memberof CreateProjectNormalizedPayload */ readonly id?: string; /** * The Revisions' Keto Namespace Configuration * * The string is a URL pointing to an OPL file with the configuration. * @type {string} * @memberof CreateProjectNormalizedPayload */ keto_namespace_configuration?: string; /** * * @type {Array<KetoNamespace>} * @memberof CreateProjectNormalizedPayload */ keto_namespaces?: Array<KetoNamespace>; /** * Configures the Ory Kratos Cookie SameSite Attribute * * This governs the "cookies.same_site" setting. * @type {string} * @memberof CreateProjectNormalizedPayload */ kratos_cookies_same_site?: string; /** * * @type {Array<NormalizedProjectRevisionCourierChannel>} * @memberof CreateProjectNormalizedPayload */ kratos_courier_channels?: Array<NormalizedProjectRevisionCourierChannel>; /** * The delivery strategy to use when sending emails * * `smtp`: Use SMTP server * `http`: Use the built in HTTP client to send the email to some remote service * @type {string} * @memberof CreateProjectNormalizedPayload */ kratos_courier_delivery_strategy?: string; /** * The location of the API key to use in the HTTP email sending service's authentication * * `header`: Send the key value pair as a header * `cookie`: Send the key value pair as a cookie * This governs the "courier.http.auth.config.in" setting * @type {string} * @memberof CreateProjectNormalizedPayload */ kratos_courier_http_request_config_auth_api_key_in?: string; /** * The name of the API key to use in the HTTP email sending service's authentication * * This governs the "courier.http.auth.config.name" setting * @type {string} * @memberof CreateProjectNormalizedPayload */ kratos_courier_http_request_config_auth_api_key_name?: string; /** * The value of the API key to use in the HTTP email sending service's authentication * * This governs the "courier.http.auth.config.value" setting * @type {string} * @memberof CreateProjectNormalizedPayload */ kratos_courier_http_request_config_auth_api_key_value?: string; /** * The password to use for basic auth in the HTTP email sending service's authentication * * This governs the "courier.http.auth.config.password" setting * @type {string} * @memberof CreateProjectNormalizedPayload */ kratos_courier_http_request_config_auth_basic_auth_password?: string; /** * The user to use for basic auth in the HTTP email sending service's authentication * * This governs the "courier.http.auth.config.user" setting * @type {string} * @memberof CreateProjectNormalizedPayload */ kratos_courier_http_request_config_auth_basic_auth_user?: string; /** * The authentication type to use while contacting the remote HTTP email sending service * * `basic_auth`: Use Basic Authentication * `api_key`: Use API Key Authentication in a header or cookie * @type {string} * @memberof CreateProjectNormalizedPayload */ kratos_courier_http_request_config_auth_type?: string; /** * The Jsonnet template to generate the body to send to the remote HTTP email sending service * * Should be valid Jsonnet and base64 encoded * * This governs the "courier.http.body" setting * @type {string} * @memberof CreateProjectNormalizedPayload */ kratos_courier_http_request_config_body?: string; /** * NullJSONRawMessage represents a json.RawMessage that works well with JSON, SQL, and Swagger and is NULLable- * @type {object} * @memberof CreateProjectNormalizedPayload */ kratos_courier_http_request_config_headers?: object | null; /** * The http METHOD to use when calling the remote HTTP email sending service * @type {string} * @memberof CreateProjectNormalizedPayload */ kratos_courier_http_request_config_method?: string; /** * The URL of the remote HTTP email sending service * * This governs the "courier.http.url" setting * @type {string} * @memberof CreateProjectNormalizedPayload */ kratos_courier_http_request_config_url?: string; /** * Configures the Ory Kratos SMTP Connection URI * * This governs the "courier.smtp.connection_uri" setting. * @type {string} * @memberof CreateProjectNormalizedPayload */ kratos_courier_smtp_connection_uri?: string; /** * Configures the Ory Kratos SMTP From Address * * This governs the "courier.smtp.from_address" setting. * @type {string} * @memberof CreateProjectNormalizedPayload */ kratos_courier_smtp_from_address?: string; /** * Configures the Ory Kratos SMTP From Name * * This governs the "courier.smtp.from_name" setting. * @type {string} * @memberof CreateProjectNormalizedPayload */ kratos_courier_smtp_from_name?: string; /** * NullJSONRawMessage represents a json.RawMessage that works well with JSON, SQL, and Swagger and is NULLable- * @type {object} * @memberof CreateProjectNormalizedPayload */ kratos_courier_smtp_headers?: object | null; /** * Configures the local_name to use in SMTP connections * * This governs the "courier.smtp.local_name" setting. * @type {string} * @memberof CreateProjectNormalizedPayload */ kratos_courier_smtp_local_name?: string; /** * Configures the Ory Kratos Valid Login via Code Email Body HTML Template * * This governs the "courier.smtp.templates.login_code.valid.email.body.html" setting. * @type {string} * @memberof CreateProjectNormalizedPayload */ kratos_courier_templates_login_code_valid_email_body_html?: string; /** * Configures the Ory Kratos Valid Login via Code Email Body Plaintext Template * * This governs the "courier.smtp.templates.login_code.valid.email.body.plaintext" setting. * @type {string} * @memberof CreateProjectNormalizedPayload */ kratos_courier_templates_login_code_valid_email_body_plaintext?: string; /** * Configures the Ory Kratos Valid Login via Code Email Subject Template * * This governs the "courier.smtp.templates.login_code.valid.email.subject" setting. * @type {string} * @memberof CreateProjectNormalizedPayload */ kratos_courier_templates_login_code_valid_email_subject?: string; /** * Configures the Ory Kratos Valid Login via Code SMS plain text body * * This governs the "courier.smtp.templates.login_code.valid.sms.plaintext" setting. * @type {string} * @memberof CreateProjectNormalizedPayload */ kratos_courier_templates_login_code_valid_sms_body_plaintext?: string; /** * Configures the Ory Kratos Invalid Recovery via Code Email Body HTML Template * * This governs the "courier.smtp.templates.recovery_code.invalid.email.body.html" setting. * @type {string} * @memberof CreateProjectNormalizedPayload */ kratos_courier_templates_recovery_code_invalid_email_body_html?: string; /** * Configures the Ory Kratos Invalid Recovery via Code Email Body Plaintext Template * * This governs the "courier.smtp.templates.recovery_code.invalid.email.body.plaintext" setting. * @type {string} * @memberof CreateProjectNormalizedPayload */ kratos_courier_templates_recovery_code_invalid_email_body_plaintext?: string; /** * Configures the Ory Kratos Invalid Recovery via Code Email Subject Template * * This governs the "courier.smtp.templates.recovery_code.invalid.email.body.html" setting. * @type {string} * @memberof CreateProjectNormalizedPayload */ kratos_courier_templates_recovery_code_invalid_email_subject?: string; /** * Configures the Ory Kratos Valid Recovery via Code Email Body HTML Template * * This governs the "courier.smtp.templates.recovery_code.valid.email.body.html" setting. * @type {string} * @memberof CreateProjectNormalizedPayload */ kratos_courier_templates_recovery_code_valid_email_body_html?: string; /** * Configures the Ory Kratos Valid Recovery via Code Email Body Plaintext Template * * This governs the "courier.smtp.templates.recovery_code.valid.email.body.plaintext" setting. * @type {string} * @memberof CreateProjectNormalizedPayload */ kratos_courier_templates_recovery_code_valid_email_body_plaintext?: string; /** * Configures the Ory Kratos Valid Recovery via Code Email Subject Template * * This governs the "courier.smtp.templates.recovery_code.valid.email.subject" setting. * @type {string} * @memberof CreateProjectNormalizedPayload */ kratos_courier_templates_recovery_code_valid_email_subject?: string; /** * Configures the Ory Kratos Invalid Recovery Email Body HTML Template * * This governs the "courier.smtp.templates.recovery.invalid.email.body.html" setting. * @type {string} * @memberof CreateProjectNormalizedPayload */ kratos_courier_templates_recovery_invalid_email_body_html?: string; /** * Configures the Ory Kratos Invalid Recovery Email Body Plaintext Template * * This governs the "courier.smtp.templates.recovery.invalid.email.body.plaintext" setting. * @type {string} * @memberof CreateProjectNormalizedPayload */ kratos_courier_templates_recovery_invalid_email_body_plaintext?: string; /** * Configures the Ory Kratos Invalid Recovery Email Subject Template * * This governs the "courier.smtp.templates.recovery.invalid.email.body.html" setting. * @type {string} * @memberof CreateProjectNormalizedPayload */ kratos_courier_templates_recovery_invalid_email_subject?: string; /** * Configures the Ory Kratos Valid Recovery Email Body HTML Template * * This governs the "courier.smtp.templates.recovery.valid.email.body.html" setting. * @type {string} * @memberof CreateProjectNormalizedPayload */ kratos_courier_templates_recovery_valid_email_body_html?: string; /** * Configures the Ory Kratos Valid Recovery Email Body Plaintext Template * * This governs the "courier.smtp.templates.recovery.valid.email.body.plaintext" setting. * @type {string} * @memberof CreateProjectNormalizedPayload */ kratos_courier_templates_recovery_valid_email_body_plaintext?: string; /** * Configures the Ory Kratos Valid Recovery Email Subject Template * * This governs the "courier.smtp.templates.recovery.valid.email.subject" setting. * @type {string} * @memberof CreateProjectNormalizedPayload */ kratos_courier_templates_recovery_valid_email_subject?: string; /** * Configures the Ory Kratos Valid Registration via Code Email Body HTML Template * * This governs the "courier.smtp.templates.registration_code.valid.email.body.html" setting. * @type {string} * @memberof CreateProjectNormalizedPayload */ kratos_courier_templates_registration_code_valid_email_body_html?: string; /** * Configures the Ory Kratos Valid Registration via Code Email Body Plaintext Template * * This governs the "courier.smtp.templates.registration_code.valid.email.body.plaintext" setting. * @type {string} * @memberof CreateProjectNormalizedPayload */ kratos_courier_templates_registration_code_valid_email_body_plaintext?: string; /** * Configures the Ory Kratos Valid Registration via Code Email Subject Template * * This governs the "courier.smtp.templates.registration_code.valid.email.subject" setting. * @type {string} * @memberof CreateProjectNormalizedPayload */ kratos_courier_templates_registration_code_valid_email_subject?: string; /** * Configures the Ory Kratos Valid Registration via Code Email Subject Template * * This governs the "courier.smtp.templates.registration_code.valid.sms.body.plaintext" setting. * @type {string} * @memberof CreateProjectNormalizedPayload */ kratos_courier_templates_registration_code_valid_sms_body_plaintext?: string; /** * Configures the Ory Kratos Invalid Verification via Code Email Body HTML Template * * This governs the "courier.smtp.templates.verification_code.invalid.email.body.html" setting. * @type {string} * @memberof CreateProjectNormalizedPayload */ kratos_courier_templates_verification_code_invalid_email_body_html?: string; /** * Configures the Ory Kratos Invalid Verification via Code Email Body Plaintext Template * * This governs the "courier.smtp.templates.verification_code.invalid.email.body.plaintext" setting. * @type {string} * @memberof CreateProjectNormalizedPayload */ kratos_courier_templates_verification_code_invalid_email_body_plaintext?: string; /** * Configures the Ory Kratos Invalid Verification via Code Email Subject Template * * This governs the "courier.smtp.templates.verification_code.invalid.email.subject" setting. * @type {string} * @memberof CreateProjectNormalizedPayload */ kratos_courier_templates_verification_code_invalid_email_subject?: string; /** * Configures the Ory Kratos Valid Verification via Code Email Body HTML Template * * This governs the "courier.smtp.templates.verification_code.valid.email.body.html" setting. * @type {string} * @memberof CreateProjectNormalizedPayload */ kratos_courier_templates_verification_code_valid_email_body_html?: string; /** * Configures the Ory Kratos Valid Verification via Code Email Body Plaintext Template * * This governs the "courier.smtp.templates.verification_code.valid.email.body.plaintext" setting. * @type {string} * @memberof CreateProjectNormalizedPayload */ kratos_courier_templates_verification_code_valid_email_body_plaintext?: string; /** * Configures the Ory Kratos Valid Verification via Code Email Subject Template * * This governs the "courier.smtp.templates.verification_code.valid.email.subject" setting. * @type {string} * @memberof CreateProjectNormalizedPayload */ kratos_courier_templates_verification_code_valid_email_subject?: string; /** * Configures the Ory Kratos Valid Verification via Code SMS Body Plaintext * * This governs the "courier.smtp.templates.verification_code.valid.sms.body.plaintext" setting. * @type {string} * @memberof CreateProjectNormalizedPayload */ kratos_courier_templates_verification_code_valid_sms_body_plaintext?: string; /** * Configures the Ory Kratos Invalid Verification Email Body HTML Template * * This governs the "courier.smtp.templates.verification.invalid.email.body.html" setting. * @type {string} * @memberof CreateProjectNormalizedPayload */ kratos_courier_templates_verification_invalid_email_body_html?: string; /** * Configures the Ory Kratos Invalid Verification Email Body Plaintext Template * * This governs the "courier.smtp.templates.verification.invalid.email.body.plaintext" setting. * @type {string} * @memberof CreateProjectNormalizedPayload */ kratos_courier_templates_verification_invalid_email_body_plaintext?: string; /** * Configures the Ory Kratos Invalid Verification Email Subject Template * * This governs the "courier.smtp.templates.verification.invalid.email.subject" setting. * @type {string} * @memberof CreateProjectNormalizedPayload */ kratos_courier_templates_verification_invalid_email_subject?: string; /** * Configures the Ory Kratos Valid Verification Email Body HTML Template * * This governs the "courier.smtp.templates.verification.valid.email.body.html" setting. * @type {string} * @memberof CreateProjectNormalizedPayload */ kratos_courier_templates_verification_valid_email_body_html?: string; /** * Configures the Ory Kratos Valid Verification Email Body Plaintext Template * * This governs the "courier.smtp.templates.verification.valid.email.body.plaintext" setting. * @type {string} * @memberof CreateProjectNormalizedPayload */ kratos_courier_templates_verification_valid_email_body_plaintext?: string; /** * Configures the Ory Kratos Valid Verification Email Subject Template * * This governs the "courier.smtp.templates.verification.valid.email.subject" setting. * @type {string} * @memberof CreateProjectNormalizedPayload */ kratos_courier_templates_verification_valid_email_subject?: string; /** * Configures the Ory Kratos Session caching feature flag * * This governs the "feature_flags.cacheable_sessions" setting. * @type {boolean} * @memberof CreateProjectNormalizedPayload */ kratos_feature_flags_cacheable_sessions?: boolean; /** * Configures the Ory Kratos Session caching max-age feature flag * * This governs the "feature_flags.cacheable_sessions_max_age" setting. * @type {string} * @memberof CreateProjectNormalizedPayload */ kratos_feature_flags_cacheable_sessions_max_age?: string; /** * Configures the Ory Kratos Faster Session Extend setting * * If enabled allows faster session extension by skipping the session lookup and returning 201 instead of 200. * Disabling this feature will be deprecated in the future. * * This governs the "feature_flags.faster_session_extend" setting. * @type {boolean} * @memberof CreateProjectNormalizedPayload */ kratos_feature_flags_faster_session_extend?: boolean; /** * Configures the Ory Kratos Session use_continue_with_transitions flag * * This governs the "feature_flags.use_continue_with_transitions" setting. * @type {boolean} * @memberof CreateProjectNormalizedPayload */ kratos_feature_flags_use_continue_with_transitions?: boolean; /** * * @type {Array<NormalizedProjectRevisionIdentitySchema>} * @memberof CreateProjectNormalizedPayload */ kratos_identity_schemas?: Array<NormalizedProjectRevisionIdentitySchema>; /** * NullJSONRawMessage represents a json.RawMessage that works well with JSON, SQL, and Swagger and is NULLable- * @type {object} * @memberof CreateProjectNormalizedPayload */ kratos_oauth2_provider_headers?: object | null; /** * Kratos OAuth2 Provider Override Return To * * Enabling this allows Kratos to set the return_to parameter automatically to the OAuth2 request URL on the login flow, allowing complex flows such as recovery to continue to the initial OAuth2 flow. * @type {boolean} * @memberof CreateProjectNormalizedPayload */ kratos_oauth2_provider_override_return_to?: boolean; /** * The Revisions' OAuth2 Provider Integration URL * * This governs the "oauth2_provider.url" setting. * @type {string} * @memberof CreateProjectNormalizedPayload */ kratos_oauth2_provider_url?: string; /** * Configures the default read consistency level for identity APIs * * This governs the `preview.default_read_consistency_level` setting. * * The read consistency level determines the consistency guarantee for reads: * * strong (slow): The read is guaranteed to return the most recent data committed at the start of the read. * eventual (very fast): The result will return data that is about 4.8 seconds old. * * Setting the default consistency level to `eventual` may cause regressions in the future as we add consistency * controls to more APIs. Currently, the following APIs will be affected by this setting: * * `GET /admin/identities` * * Defaults to "strong" for new and existing projects. This feature is in preview. Use with caution. * @type {string} * @memberof CreateProjectNormalizedPayload */ kratos_preview_default_read_consistency_level?: string; /** * * @type {Array<string>} * @memberof CreateProjectNormalizedPayload */ kratos_secrets_cipher?: Array<string>; /** * * @type {Array<string>} * @memberof CreateProjectNormalizedPayload */ kratos_secrets_cookie?: Array<string>; /** * * @type {Array<string>} * @memberof CreateProjectNormalizedPayload */ kratos_secrets_default?: Array<string>; /** * * @type {Array<string>} * @memberof CreateProjectNormalizedPayload */ kratos_selfservice_allowed_return_urls?: Array<string>; /** * Configures the Ory Kratos Default Return URL * * This governs the "selfservice.allowed_return_urls" setting. * @type {string} * @memberof CreateProjectNormalizedPayload */ kratos_selfservice_default_browser_return_url?: string; /** * Configures the Ory Kratos Error UI URL * * This governs the "selfservice.flows.error.ui_url" setting. * @type {string} * @memberof CreateProjectNormalizedPayload */ kratos_selfservice_flows_error_ui_url?: string; /** * Configures the Ory Kratos Login After Password Default Return URL * * This governs the "selfservice.flows.code.after.password.default_browser_return_url" setting. * @type {string} * @memberof CreateProjectNormalizedPayload */ kratos_selfservice_flows_login_after_code_default_browser_return_url?: string; /** * Configures the Ory Kratos Login Default Return URL * * This governs the "selfservice.flows.login.after.default_browser_return_url" setting. * @type {string} * @memberof CreateProjectNormalizedPayload */ kratos_selfservice_flows_login_after_default_browser_return_url?: string; /** * Configures the Ory Kratos Login After Password Default Return URL * * This governs the "selfservice.flows.lookup_secret.after.password.default_browser_return_url" setting. * @type {string} * @memberof CreateProjectNormalizedPayload */ kratos_selfservice_flows_login_after_lookup_secret_default_browser_return_url?: string; /** * Configures the Ory Kratos Login After OIDC Default Return URL * * This governs the "selfservice.flows.login.after.oidc.default_browser_return_url" setting. * @type {string} * @memberof CreateProjectNormalizedPayload */ kratos_selfservice_flows_login_after_oidc_default_browser_return_url?: string; /** * Configures the Ory Kratos Login After Passkey Default Return URL * * This governs the "selfservice.flows.login.after.passkey.default_browser_return_url" setting. * @type {string} * @memberof CreateProjectNormalizedPayload */ kratos_selfservice_flows_login_after_passkey_default_browser_return_url?: string; /** * Configures the Ory Kratos Login After Password Default Return URL * * This governs the "selfservice.flows.login.after.password.default_browser_return_url" setting. * @type {string} * @memberof CreateProjectNormalizedPayload */ kratos_selfservice_flows_login_after_password_default_browser_return_url?: string; /** * Configures the Ory Kratos Login After Password Default Return URL * * This governs the "selfservice.flows.totp.after.password.default_browser_return_url" setting. * @type {string} * @memberof CreateProjectNormalizedPayload */ kratos_selfservice_flows_login_after_totp_default_browser_return_url?: string; /** * Configures the Ory Kratos Login After WebAuthn Default Return URL * * This governs the "selfservice.flows.login.after.webauthn.default_browser_return_url" setting. * @type {string} * @memberof CreateProjectNormalizedPayload */ kratos_selfservice_flows_login_after_webauthn_default_browser_return_url?: string; /** * Configures the Ory Kratos Login Lifespan * * This governs the "selfservice.flows.login.lifespan" setting. * @type {string} * @memberof CreateProjectNormalizedPayload */ kratos_selfservice_flows_login_lifespan?: string; /** * Configures the Ory Kratos Login UI URL * * This governs the "selfservice.flows.login.ui_url" setting. * @type {string} * @memberof CreateProjectNormalizedPayload */ kratos_selfservice_flows_login_ui_url?: string; /** * Configures the Ory Kratos Logout Default Return URL * * This governs the "selfservice.flows.logout.after.default_browser_return_url" setting. * @type {string} * @memberof CreateProjectNormalizedPayload */ kratos_selfservice_flows_logout_after_default_browser_return_url?: string; /** * Configures the Ory Kratos Recovery Default Return URL * * This governs the "selfservice.flows.recovery.after.default_browser_return_url" setting. * @type {string} * @memberof CreateProjectNormalizedPayload */ kratos_selfservice_flows_recovery_after_default_browser_return_url?: string; /** * Configures the Ory Kratos Recovery Enabled Setting * * This governs the "selfservice.flows.recovery.enabled" setting. * @type {boolean} * @memberof CreateProjectNormalizedPayload */ kratos_selfservice_flows_recovery_enabled?: boolean; /** * Configures the Ory Kratos Recovery Lifespan * * This governs the "selfservice.flows.recovery.lifespan" setting. * @type {string} * @memberof CreateProjectNormalizedPayload */ kratos_selfservice_flows_recovery_lifespan?: string; /** * Configures whether to notify unknown recipients of a Ory Kratos recovery flow * * This governs the "selfservice.flows.recovery.notify_unknown_recipients" setting. * @type {boolean} * @memberof CreateProjectNormalizedPayload */ kratos_selfservice_flows_recovery_notify_unknown_recipients?: boolean; /** * Configures the Ory Kratos Recovery UI URL * * This governs the "selfservice.flows.recovery.ui_url" setting. * @type {string} * @memberof CreateProjectNormalizedPayload */ kratos_selfservice_flows_recovery_ui_url?: string; /** * Configures the Ory Kratos Recovery strategy to use ("link" or "code") * * This governs the "selfservice.flows.recovery.use" setting. * link SelfServiceMessageVerificationStrategyLink * code SelfServiceMessageVerificationStrategyCode * @type {string} * @memberof CreateProjectNormalizedPayload */ kratos_selfservice_flows_recovery_use?: CreateProjectNormalizedPayloadKratosSelfserviceFlowsRecoveryUseEnum; /** * Configures the Ory Kratos Registration After Code Default Return URL * * This governs the "selfservice.flows.registration.after.code.default_browser_return_url" setting. * @type {string} * @memberof CreateProjectNormalizedPayload */ kratos_selfservice_flows_registration_after_code_default_browser_return_url?: string; /** * Configures the Ory Kratos Registration Default Return URL * * This governs the "selfservice.flows.registration.after.default_browser_return_url" setting. * @type {string} * @memberof CreateProjectNormalizedPayload */ kratos_selfservice_flows_registration_after_default_browser_return_url?: string; /** * Configures the Ory Kratos Registration After OIDC Default Return URL * * This governs the "selfservice.flows.registration.after.oidc.default_browser_return_url" setting. * @type {string} * @memberof CreateProjectNormalizedPayload */ kratos_selfservice_flows_registration_after_oidc_default_browser_return_url?: string; /** * Configures the Ory Kratos Registration After Passkey Default Return URL * * This governs the "selfservice.flows.registration.after.password.default_browser_return_url" setting. * @type {string} * @memberof CreateProjectNormalizedPayload */ kratos_selfservice_flows_registration_after_passkey_default_browser_return_url?: string; /** * Configures the Ory Kratos Registration After Password Default Return URL * * This governs the "selfservice.flows.registration.after.password.default_browser_return_url" setting. * @type {string} * @memberof CreateProjectNormalizedPay