Struct ory_client::models::project_patch::ProjectPatch
source · [−]pub struct ProjectPatch {Show 22 fields
pub api_url: Option<String>,
pub application_url: Option<String>,
pub default_identity_schema_url: Option<String>,
pub error_ui_url: String,
pub kratos_custom_schema_id: Option<String>,
pub login_ui_url: String,
pub lookup_secret: Box<ProjectLookupSecretConfig>,
pub name: Option<String>,
pub password: Box<ProjectPasswordConfig>,
pub recovery: Box<ProjectRecoveryConfig>,
pub recovery_ui_url: String,
pub redirection_config: Option<Box<RedirectionConfig>>,
pub registration_ui_url: String,
pub session_after_sign_up: bool,
pub session_soft_2fa: bool,
pub settings_privileged_session_max_age_seconds: i64,
pub settings_soft_2fa: bool,
pub settings_ui_url: String,
pub totp: Box<ProjectTotpConfig>,
pub verification: Box<ProjectVerificationConfig>,
pub verification_ui_url: String,
pub webauthn: Box<ProjectWebAuthnConfig>,
}
Fields
api_url: Option<String>
URL of Project API In the future will allow to override Kratos project URL. If set, error is returned. If left empty our hosted URL is used
application_url: Option<String>
URL where your application is available. Your users will be redirected to this URL when they successfully complete a login, logout, verification, recovery, or registration flow. More fine-grained redirection patterns are available for the individual flows (login, registration, …). If left empty, our hosted URL will be used instead. It contains technical information on the identities and is useful when developing a new project or trying out Ory Cloud.
default_identity_schema_url: Option<String>
Default Identity Schema URL This represents your Ory Kratos Default Identity Schema. It is your identity’s default schema. This allows setting custom fields such as "address", specifying whether you want to log in using email or a username, and more. For more information on this topic, please check out the identity documentation. If KratosCustomSchemaID is also added to the payload, it will be preferred and replace the value of DefaultIdentitySchemaURL set by the client. The value of this field can be either any "https://" URL - for example a file hosted at GitHub, or a preset://
-prefixed string. Available presets are: preset://email preset://username preset://basic preset://blank
error_ui_url: String
Self-Service Error UI URL Sets the UI URL for the error UI. If left empty, this will use Ory’s hosted pages.
kratos_custom_schema_id: Option<String>
The Custom Schema ID The custom schema ID is a preferred field over DefaultIdentitySchemaURL, meaning it will override the DefaultIdentitySchemaURL with the custom schema’s URL instead of accepting it from the client-side. Once this field is set the given custom schema will be associated with this project.
login_ui_url: String
Self-Service Login UI URL Sets the UI URL for the login UI. If left empty, this will use Ory’s hosted pages.
lookup_secret: Box<ProjectLookupSecretConfig>
name: Option<String>
The project name. Helps you identify your project. in: body
password: Box<ProjectPasswordConfig>
recovery: Box<ProjectRecoveryConfig>
recovery_ui_url: String
Self-Service Login UI URL Sets the UI URL for the recovery UI. If left empty, this will use Ory’s hosted pages.
redirection_config: Option<Box<RedirectionConfig>>
registration_ui_url: String
Self-Service Login UI URL Sets the UI URL for the registration UI. If left empty, this will use Ory’s hosted pages.
session_after_sign_up: bool
Issue Session after Sign Up If set to true, users will receive a session after they successfully signed up. Enabling this option allows account enumeration during registration flows. Read more: https://www.ory.sh/kratos/docs/self-service/flows/user-registration#successful-registration
session_soft_2fa: bool
Enable Soft 2FA for Login Sessions
settings_privileged_session_max_age_seconds: i64
Duration in Seconds of how long a Session is Privileged Defines how long a session is considered privileged in seconds. If the session’s authenticated_at is older than the value specified here, the user needs to re-authenticate to perform certain actions (e.g. password change).
settings_soft_2fa: bool
Enable Soft 2FA for Self-Service Settings Flows
settings_ui_url: String
Self-Service Settings UI URL Sets the UI URL for the settings UI. If left empty, this will use Ory’s hosted pages.
totp: Box<ProjectTotpConfig>
verification: Box<ProjectVerificationConfig>
verification_ui_url: String
Self-Service Login UI URL Sets the UI URL for the verification UI. If left empty, this will use Ory’s hosted pages.
webauthn: Box<ProjectWebAuthnConfig>
Implementations
pub fn new(
error_ui_url: String,
login_ui_url: String,
lookup_secret: ProjectLookupSecretConfig,
password: ProjectPasswordConfig,
recovery: ProjectRecoveryConfig,
recovery_ui_url: String,
registration_ui_url: String,
session_after_sign_up: bool,
session_soft_2fa: bool,
settings_privileged_session_max_age_seconds: i64,
settings_soft_2fa: bool,
settings_ui_url: String,
totp: ProjectTotpConfig,
verification: ProjectVerificationConfig,
verification_ui_url: String,
webauthn: ProjectWebAuthnConfig
) -> ProjectPatch
Trait Implementations
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
This method tests for !=
.
Auto Trait Implementations
impl RefUnwindSafe for ProjectPatch
impl Send for ProjectPatch
impl Sync for ProjectPatch
impl Unpin for ProjectPatch
impl UnwindSafe for ProjectPatch
Blanket Implementations
Mutably borrows from an owned value. Read more
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more