pub struct KanidmOAuth2ClientSpec {Show 13 fields
pub kanidm_ref: KanidmRef,
pub displayname: String,
pub origin: String,
pub redirect_url: Vec<String>,
pub public: bool,
pub scope_map: Option<BTreeSet<KanidmScopeMap>>,
pub sup_scope_map: Option<BTreeSet<KanidmScopeMap>>,
pub claim_map: Option<BTreeSet<KanidmClaimMap>>,
pub strict_redirect_url: Option<bool>,
pub prefer_short_username: Option<bool>,
pub allow_localhost_redirect: Option<bool>,
pub allow_insecure_client_disable_pkce: Option<bool>,
pub jwt_legacy_crypto_enable: Option<bool>,
}Expand description
The KanidmOAuth2Client custom resource definition (CRD) defines an OAuth2 client integration in Kanidm. This resource allows you to configure OAuth2 clients that can interact with the Kanidm authorization server. The CRD supports various configurations, including scope maps, claim maps, and other OAuth2 client settings. More info: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
Fields§
§kanidm_ref: KanidmRef§displayname: StringSet the display name for the OAuth2 client.
origin: StringSet the landing page (home page) of the client. The landing page is where users will be redirected to from the Kanidm application portal.
redirect_url: Vec<String>Set the URL where the application expects OAuth2 requests to be sent.
public: boolCreate a new OAuth2 public client that requires PKCE. You should prefer using confidential client types if possible over public ones.
Public clients have many limitations and can not access all API’s of OAuth2. For example rfc7662 token introspection requires client authentication.
This cannot be changed after creation. Default value is false.
This field is immutable.
If public is false, the operator will create a secret containing the client secret with
the name <oauth2-client-name>-kanidm-oauth2-credentials in the same namespace as the OAuth2 client.
scope_map: Option<BTreeSet<KanidmScopeMap>>Main scope map for the OAuth2 client. For an authorization to proceed, all scopes requested by the client must be available in the final scope set that is granted to the account.
sup_scope_map: Option<BTreeSet<KanidmScopeMap>>Supplementary scope maps for the OAuth2 client. These function the same as scope maps where membership of a group provides a set of scopes to the account. However these scopes are NOT consulted during authorization decisions made by Kanidm. These scopes exist to allow optional properties to be provided (such as personal information about a subset of accounts to be revealed) or so that the service may make its own authorization decisions based on the provided scopes.
claim_map: Option<BTreeSet<KanidmClaimMap>>Mapping from a group to a custom claims that it provides to members.
strict_redirect_url: Option<bool>Enable strict validation of redirect URLs. Previously redirect URLs only validated the origin of the URL matched. When enabled, redirect URLs must match exactly.
Enabled by default.
prefer_short_username: Option<bool>Use the ‘name’ attribute instead of ‘spn’ for the preferred_username.
Disabled by default.
allow_localhost_redirect: Option<bool>Allow public clients to redirect to localhost.
Just public clients can allow localhost redirect. Disabled by default.
allow_insecure_client_disable_pkce: Option<bool>Disable PKCE on this oauth2 client to work around insecure clients that may not support it. You should request the client to enable PKCE!
Public clients cannot disable PKCE. PKCE is enabled by default.
jwt_legacy_crypto_enable: Option<bool>Enable legacy signing crypto on this oauth2 client. This defaults to being disabled. You only need to enable this for openid clients that do not support modern cryptographic operations.
Disabled by default.
Trait Implementations§
Source§impl Clone for KanidmOAuth2ClientSpec
impl Clone for KanidmOAuth2ClientSpec
Source§fn clone(&self) -> KanidmOAuth2ClientSpec
fn clone(&self) -> KanidmOAuth2ClientSpec
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for KanidmOAuth2ClientSpec
impl Debug for KanidmOAuth2ClientSpec
Source§impl Default for KanidmOAuth2ClientSpec
impl Default for KanidmOAuth2ClientSpec
Source§fn default() -> KanidmOAuth2ClientSpec
fn default() -> KanidmOAuth2ClientSpec
Source§impl<'de> Deserialize<'de> for KanidmOAuth2ClientSpec
impl<'de> Deserialize<'de> for KanidmOAuth2ClientSpec
Source§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>,
Source§impl JsonSchema for KanidmOAuth2ClientSpec
impl JsonSchema for KanidmOAuth2ClientSpec
Source§fn schema_id() -> Cow<'static, str>
fn schema_id() -> Cow<'static, str>
Source§fn json_schema(generator: &mut SchemaGenerator) -> Schema
fn json_schema(generator: &mut SchemaGenerator) -> Schema
Source§fn inline_schema() -> bool
fn inline_schema() -> bool
$ref keyword. Read moreSource§impl PartialEq for KanidmOAuth2ClientSpec
impl PartialEq for KanidmOAuth2ClientSpec
Source§impl Serialize for KanidmOAuth2ClientSpec
impl Serialize for KanidmOAuth2ClientSpec
impl StructuralPartialEq for KanidmOAuth2ClientSpec
Auto Trait Implementations§
impl Freeze for KanidmOAuth2ClientSpec
impl RefUnwindSafe for KanidmOAuth2ClientSpec
impl Send for KanidmOAuth2ClientSpec
impl Sync for KanidmOAuth2ClientSpec
impl Unpin for KanidmOAuth2ClientSpec
impl UnwindSafe for KanidmOAuth2ClientSpec
Blanket Implementations§
Source§impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
Source§impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> FutureExt for T
impl<T> FutureExt for T
Source§fn with_context(self, otel_cx: Context) -> WithContext<Self>
fn with_context(self, otel_cx: Context) -> WithContext<Self>
Source§fn with_current_context(self) -> WithContext<Self>
fn with_current_context(self) -> WithContext<Self>
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read more