pub struct OidcIdentityProviderConfigRequest {
pub client_id: String,
pub groups_claim: Option<String>,
pub groups_prefix: Option<String>,
pub identity_provider_config_name: String,
pub issuer_url: String,
pub required_claims: Option<HashMap<String, String>>,
pub username_claim: Option<String>,
pub username_prefix: Option<String>,
}
Expand description
An object representing an OpenID Connect (OIDC) configuration. Before associating an OIDC identity provider to your cluster, review the considerations in Authenticating users for your cluster from an OpenID Connect identity provider in the Amazon EKS User Guide.
Fields
client_id: String
This is also known as audience. The ID for the client application that makes authentication requests to the OpenID identity provider.
groups_claim: Option<String>
The JWT claim that the provider uses to return your groups.
groups_prefix: Option<String>
The prefix that is prepended to group claims to prevent clashes with existing names (such as system:
groups). For example, the value oidc:
will create group names like oidc:engineering
and oidc:infra
.
identity_provider_config_name: String
The name of the OIDC provider configuration.
issuer_url: String
The URL of the OpenID identity provider that allows the API server to discover public signing keys for verifying tokens. The URL must begin with https://
and should correspond to the iss
claim in the provider's OIDC ID tokens. Per the OIDC standard, path components are allowed but query parameters are not. Typically the URL consists of only a hostname, like https://server.example.org
or https://example.com
. This URL should point to the level below .well-known/openid-configuration
and must be publicly accessible over the internet.
required_claims: Option<HashMap<String, String>>
The key value pairs that describe required claims in the identity token. If set, each claim is verified to be present in the token with a matching value. For the maximum number of claims that you can require, see Amazon EKS service quotas in the Amazon EKS User Guide.
username_claim: Option<String>
The JSON Web Token (JWT) claim to use as the username. The default is sub
, which is expected to be a unique identifier of the end user. You can choose other claims, such as email
or name
, depending on the OpenID identity provider. Claims other than email
are prefixed with the issuer URL to prevent naming clashes with other plug-ins.
username_prefix: Option<String>
The prefix that is prepended to username claims to prevent clashes with existing names. If you do not provide this field, and username
is a value other than email
, the prefix defaults to issuerurl#
. You can use the value -
to disable all prefixing.
Trait Implementations
sourceimpl Clone for OidcIdentityProviderConfigRequest
impl Clone for OidcIdentityProviderConfigRequest
sourcefn clone(&self) -> OidcIdentityProviderConfigRequest
fn clone(&self) -> OidcIdentityProviderConfigRequest
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Default for OidcIdentityProviderConfigRequest
impl Default for OidcIdentityProviderConfigRequest
sourcefn default() -> OidcIdentityProviderConfigRequest
fn default() -> OidcIdentityProviderConfigRequest
Returns the “default value” for a type. Read more
sourceimpl PartialEq<OidcIdentityProviderConfigRequest> for OidcIdentityProviderConfigRequest
impl PartialEq<OidcIdentityProviderConfigRequest> for OidcIdentityProviderConfigRequest
sourcefn eq(&self, other: &OidcIdentityProviderConfigRequest) -> bool
fn eq(&self, other: &OidcIdentityProviderConfigRequest) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &OidcIdentityProviderConfigRequest) -> bool
fn ne(&self, other: &OidcIdentityProviderConfigRequest) -> bool
This method tests for !=
.
impl StructuralPartialEq for OidcIdentityProviderConfigRequest
Auto Trait Implementations
impl RefUnwindSafe for OidcIdentityProviderConfigRequest
impl Send for OidcIdentityProviderConfigRequest
impl Sync for OidcIdentityProviderConfigRequest
impl Unpin for OidcIdentityProviderConfigRequest
impl UnwindSafe for OidcIdentityProviderConfigRequest
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more