Skip to main content

AuthMethodUpdateOauth2

Struct AuthMethodUpdateOauth2 

Source
pub struct AuthMethodUpdateOauth2 {
Show 26 fields pub access_expires: Option<i64>, pub allowed_client_type: Option<Vec<String>>, pub audience: Option<String>, pub audit_logs_claims: Option<Vec<String>>, pub bound_client_ids: Option<Vec<String>>, pub bound_ips: Option<Vec<String>>, pub cert: Option<String>, pub cert_file_data: Option<String>, pub delete_protection: Option<String>, pub description: Option<String>, pub expiration_event_in: Option<Vec<String>>, pub force_sub_claims: Option<bool>, pub gateway_url: Option<String>, pub gw_bound_ips: Option<Vec<String>>, pub issuer: Option<String>, pub json: Option<bool>, pub jwks_json_data: Option<String>, pub jwks_uri: Option<String>, pub jwt_ttl: Option<i64>, pub name: String, pub new_name: Option<String>, pub product_type: Option<Vec<String>>, pub subclaims_delimiters: Option<Vec<String>>, pub token: Option<String>, pub uid_token: Option<String>, pub unique_identifier: String,
}
Expand description

AuthMethodUpdateOauth2 : authMethodUpdateOauth2 is a command that updates a new auth method that will be able to authenticate using Oauth2.

Fields§

§access_expires: Option<i64>

Access expiration date in Unix timestamp (select 0 for access without expiry date)

§allowed_client_type: Option<Vec<String>>

limit the auth method usage for specific client types [cli,ui,gateway-admin,sdk,mobile,extension]

§audience: Option<String>

The audience in the JWT

§audit_logs_claims: Option<Vec<String>>

Subclaims to include in audit logs, e.g "–audit-logs-claims email –audit-logs-claims username"

§bound_client_ids: Option<Vec<String>>

The clients ids that the access is restricted to

§bound_ips: Option<Vec<String>>

A CIDR whitelist with the IPs that the access is restricted to

§cert: Option<String>

CertificateFile Path to a file that contain the certificate in a PEM format.

§cert_file_data: Option<String>

CertificateFileData PEM Certificate in a Base64 format.

§delete_protection: Option<String>

Protection from accidental deletion of this object [true/false]

§description: Option<String>

Auth Method description

§expiration_event_in: Option<Vec<String>>

How many days before the expiration of the auth method would you like to be notified.

§force_sub_claims: Option<bool>

if true: enforce role-association must include sub claims

§gateway_url: Option<String>

Akeyless Gateway URL (Configuration Management port). Relevant only when the jwks-uri is accessible only from the gateway.

§gw_bound_ips: Option<Vec<String>>

A CIDR whitelist with the GW IPs that the access is restricted to

§issuer: Option<String>

Issuer URL

§json: Option<bool>

Set output format to JSON

§jwks_json_data: Option<String>

The JSON Web Key Set (JWKS) that containing the public keys that should be used to verify any JSON Web Token (JWT) issued by the authorization server. base64 encoded string

§jwks_uri: Option<String>

The URL to the JSON Web Key Set (JWKS) that containing the public keys that should be used to verify any JSON Web Token (JWT) issued by the authorization server.

§jwt_ttl: Option<i64>

Jwt TTL

§name: String

Auth Method name

§new_name: Option<String>

Auth Method new name

§product_type: Option<Vec<String>>

Choose the relevant product type for the auth method [sm, sra, pm, dp, ca]

§subclaims_delimiters: Option<Vec<String>>

A list of additional sub claims delimiters (relevant only for SAML, OIDC, OAuth2/JWT)

§token: Option<String>

Authentication token (see /auth and /configure)

§uid_token: Option<String>

The universal identity token, Required only for universal_identity authentication

§unique_identifier: String

A unique identifier (ID) value should be configured for OAuth2, LDAP and SAML authentication method types and is usually a value such as the email, username, or upn for example. Whenever a user logs in with a token, these authentication types issue a "sub claim" that contains details uniquely identifying that user. This sub claim includes a key containing the ID value that you configured, and is used to distinguish between different users from within the same organization.

Implementations§

Source§

impl AuthMethodUpdateOauth2

Source

pub fn new(name: String, unique_identifier: String) -> AuthMethodUpdateOauth2

authMethodUpdateOauth2 is a command that updates a new auth method that will be able to authenticate using Oauth2.

Trait Implementations§

Source§

impl Clone for AuthMethodUpdateOauth2

Source§

fn clone(&self) -> AuthMethodUpdateOauth2

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for AuthMethodUpdateOauth2

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for AuthMethodUpdateOauth2

Source§

fn default() -> AuthMethodUpdateOauth2

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for AuthMethodUpdateOauth2

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for AuthMethodUpdateOauth2

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

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

impl Serialize for AuthMethodUpdateOauth2

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for AuthMethodUpdateOauth2

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

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
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more