ory_client/models/session_authentication_method.rs
1/*
2 * Ory APIs
3 *
4 * # 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) |
5 *
6 * The version of the OpenAPI document: v1.22.40
7 * Contact: support@ory.sh
8 * Generated by: https://openapi-generator.tech
9 */
10
11use crate::models;
12use serde::{Deserialize, Serialize};
13
14/// SessionAuthenticationMethod : A singular authenticator used during authentication / login.
15#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)]
16pub struct SessionAuthenticationMethod {
17 #[serde(rename = "aal", skip_serializing_if = "Option::is_none")]
18 pub aal: Option<models::AuthenticatorAssuranceLevel>,
19 /// When the authentication challenge was completed.
20 #[serde(rename = "completed_at", skip_serializing_if = "Option::is_none")]
21 pub completed_at: Option<String>,
22 /// The method used in this authenticator. password CredentialsTypePassword oidc CredentialsTypeOIDC totp CredentialsTypeTOTP lookup_secret CredentialsTypeLookup webauthn CredentialsTypeWebAuthn code CredentialsTypeCodeAuth passkey CredentialsTypePasskey profile CredentialsTypeProfile saml CredentialsTypeSAML deviceauthn CredentialsTypeDeviceAuthn identifier_first CredentialsTypeIdentifierFirst link_recovery CredentialsTypeRecoveryLink CredentialsTypeRecoveryLink is a special credential type linked to the link strategy (recovery flow). It is not used within the credentials object itself. code_recovery CredentialsTypeRecoveryCode
23 #[serde(rename = "method", skip_serializing_if = "Option::is_none")]
24 pub method: Option<MethodEnum>,
25 /// The Organization id used for authentication
26 #[serde(rename = "organization", skip_serializing_if = "Option::is_none")]
27 pub organization: Option<String>,
28 /// OIDC or SAML provider id used for authentication
29 #[serde(rename = "provider", skip_serializing_if = "Option::is_none")]
30 pub provider: Option<String>,
31 /// UpstreamACR is the `acr` claim reported by the upstream OIDC provider, if any. Populated only for OIDC login methods when the upstream ID token contained an `acr` claim.
32 #[serde(rename = "upstream_acr", skip_serializing_if = "Option::is_none")]
33 pub upstream_acr: Option<String>,
34 /// UpstreamAMR is the `amr` claim reported by the upstream OIDC provider, if any. Populated only for OIDC login methods when the upstream ID token contained an `amr` claim.
35 #[serde(rename = "upstream_amr", skip_serializing_if = "Option::is_none")]
36 pub upstream_amr: Option<Vec<String>>,
37}
38
39impl SessionAuthenticationMethod {
40 /// A singular authenticator used during authentication / login.
41 pub fn new() -> SessionAuthenticationMethod {
42 SessionAuthenticationMethod {
43 aal: None,
44 completed_at: None,
45 method: None,
46 organization: None,
47 provider: None,
48 upstream_acr: None,
49 upstream_amr: None,
50 }
51 }
52}
53/// The method used in this authenticator. password CredentialsTypePassword oidc CredentialsTypeOIDC totp CredentialsTypeTOTP lookup_secret CredentialsTypeLookup webauthn CredentialsTypeWebAuthn code CredentialsTypeCodeAuth passkey CredentialsTypePasskey profile CredentialsTypeProfile saml CredentialsTypeSAML deviceauthn CredentialsTypeDeviceAuthn identifier_first CredentialsTypeIdentifierFirst link_recovery CredentialsTypeRecoveryLink CredentialsTypeRecoveryLink is a special credential type linked to the link strategy (recovery flow). It is not used within the credentials object itself. code_recovery CredentialsTypeRecoveryCode
54#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
55pub enum MethodEnum {
56 #[serde(rename = "password")]
57 Password,
58 #[serde(rename = "oidc")]
59 Oidc,
60 #[serde(rename = "totp")]
61 Totp,
62 #[serde(rename = "lookup_secret")]
63 LookupSecret,
64 #[serde(rename = "webauthn")]
65 Webauthn,
66 #[serde(rename = "code")]
67 Code,
68 #[serde(rename = "passkey")]
69 Passkey,
70 #[serde(rename = "profile")]
71 Profile,
72 #[serde(rename = "saml")]
73 Saml,
74 #[serde(rename = "deviceauthn")]
75 Deviceauthn,
76 #[serde(rename = "identifier_first")]
77 IdentifierFirst,
78 #[serde(rename = "link_recovery")]
79 LinkRecovery,
80 #[serde(rename = "code_recovery")]
81 CodeRecovery,
82}
83
84impl Default for MethodEnum {
85 fn default() -> MethodEnum {
86 Self::Password
87 }
88}
89