Struct OidcIdentityProviderConfigRequestBuilder 

#[non_exhaustive]
pub struct OidcIdentityProviderConfigRequestBuilder { /* private fields */ }

A builder for OidcIdentityProviderConfigRequest.

Implementations

impl OidcIdentityProviderConfigRequestBuilder

pub fn identity_provider_config_name(self, input: impl Into<String>) -> Self

The name of the OIDC provider configuration.

This field is required.

pub fn set_identity_provider_config_name(self, input: Option<String>) -> Self

The name of the OIDC provider configuration.

pub fn get_identity_provider_config_name(&self) -> &Option<String>

The name of the OIDC provider configuration.

pub fn issuer_url(self, input: impl Into<String>) -> Self

The URL of the OIDC 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. Based on 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.

This field is required.

pub fn set_issuer_url(self, input: Option<String>) -> Self

The URL of the OIDC 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. Based on 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.

pub fn get_issuer_url(&self) -> &Option<String>

The URL of the OIDC 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. Based on 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.

pub fn client_id(self, input: impl Into<String>) -> Self

This is also known as audience. The ID for the client application that makes authentication requests to the OIDC identity provider.

This field is required.

pub fn set_client_id(self, input: Option<String>) -> Self

This is also known as audience. The ID for the client application that makes authentication requests to the OIDC identity provider.

pub fn get_client_id(&self) -> &Option<String>

This is also known as audience. The ID for the client application that makes authentication requests to the OIDC identity provider.

pub fn username_claim(self, input: impl Into<String>) -> Self

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 OIDC identity provider. Claims other than email are prefixed with the issuer URL to prevent naming clashes with other plug-ins.

pub fn set_username_claim(self, input: Option<String>) -> Self

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 OIDC identity provider. Claims other than email are prefixed with the issuer URL to prevent naming clashes with other plug-ins.

pub fn get_username_claim(&self) -> &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 OIDC identity provider. Claims other than email are prefixed with the issuer URL to prevent naming clashes with other plug-ins.

pub fn username_prefix(self, input: impl Into<String>) -> Self

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.

pub fn set_username_prefix(self, input: Option<String>) -> Self

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.

pub fn get_username_prefix(&self) -> &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.

pub fn groups_claim(self, input: impl Into<String>) -> Self

The JWT claim that the provider uses to return your groups.

pub fn set_groups_claim(self, input: Option<String>) -> Self

The JWT claim that the provider uses to return your groups.

pub fn get_groups_claim(&self) -> &Option<String>

The JWT claim that the provider uses to return your groups.

pub fn groups_prefix(self, input: impl Into<String>) -> Self

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.

pub fn set_groups_prefix(self, input: Option<String>) -> Self

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.

pub fn get_groups_prefix(&self) -> &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.

pub fn required_claims(self, k: impl Into<String>, v: impl Into<String>) -> Self

Adds a key-value pair to required_claims.

To override the contents of this collection use set_required_claims.

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.

pub fn set_required_claims(self, input: Option<HashMap<String, String>>) -> Self

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.

pub fn get_required_claims(&self) -> &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.

pub fn build(self) -> Result<OidcIdentityProviderConfigRequest, BuildError>

Consumes the builder and constructs a OidcIdentityProviderConfigRequest. This method will fail if any of the following fields are not set:

• identity_provider_config_name
• issuer_url
• client_id

Trait Implementations

impl Clone for OidcIdentityProviderConfigRequestBuilder

fn clone(&self) -> OidcIdentityProviderConfigRequestBuilder

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for OidcIdentityProviderConfigRequestBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for OidcIdentityProviderConfigRequestBuilder

fn default() -> OidcIdentityProviderConfigRequestBuilder

Returns the “default value” for a type.

impl PartialEq for OidcIdentityProviderConfigRequestBuilder

fn eq(&self, other: &OidcIdentityProviderConfigRequestBuilder) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for OidcIdentityProviderConfigRequestBuilder