pub struct IsAuthorizedWithTokenFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to IsAuthorizedWithToken
.
Makes an authorization decision about a service request described in the parameters. The principal in this request comes from an external identity source in the form of an identity token formatted as a JSON web token (JWT). The information in the parameters can also define additional context that Verified Permissions can include in the evaluation. The request is evaluated against all matching policies in the specified policy store. The result of the decision is either Allow
or Deny
, along with a list of the policies that resulted in the decision.
Verified Permissions validates each token that is specified in a request by checking its expiration date and its signature.
Tokens from an identity source user continue to be usable until they expire. Token revocation and resource deletion have no effect on the validity of a token in your policy store
Implementations§
Source§impl IsAuthorizedWithTokenFluentBuilder
impl IsAuthorizedWithTokenFluentBuilder
Sourcepub fn as_input(&self) -> &IsAuthorizedWithTokenInputBuilder
pub fn as_input(&self) -> &IsAuthorizedWithTokenInputBuilder
Access the IsAuthorizedWithToken as a reference.
Sourcepub async fn send(
self,
) -> Result<IsAuthorizedWithTokenOutput, SdkError<IsAuthorizedWithTokenError, HttpResponse>>
pub async fn send( self, ) -> Result<IsAuthorizedWithTokenOutput, SdkError<IsAuthorizedWithTokenError, HttpResponse>>
Sends the request and returns the response.
If an error occurs, an SdkError
will be returned with additional details that
can be matched against.
By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.
Sourcepub fn customize(
self,
) -> CustomizableOperation<IsAuthorizedWithTokenOutput, IsAuthorizedWithTokenError, Self>
pub fn customize( self, ) -> CustomizableOperation<IsAuthorizedWithTokenOutput, IsAuthorizedWithTokenError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
Sourcepub fn policy_store_id(self, input: impl Into<String>) -> Self
pub fn policy_store_id(self, input: impl Into<String>) -> Self
Specifies the ID of the policy store. Policies in this policy store will be used to make an authorization decision for the input.
Sourcepub fn set_policy_store_id(self, input: Option<String>) -> Self
pub fn set_policy_store_id(self, input: Option<String>) -> Self
Specifies the ID of the policy store. Policies in this policy store will be used to make an authorization decision for the input.
Sourcepub fn get_policy_store_id(&self) -> &Option<String>
pub fn get_policy_store_id(&self) -> &Option<String>
Specifies the ID of the policy store. Policies in this policy store will be used to make an authorization decision for the input.
Sourcepub fn identity_token(self, input: impl Into<String>) -> Self
pub fn identity_token(self, input: impl Into<String>) -> Self
Specifies an identity token for the principal to be authorized. This token is provided to you by the identity provider (IdP) associated with the specified identity source. You must specify either an accessToken
, an identityToken
, or both.
Must be an ID token. Verified Permissions returns an error if the token_use
claim in the submitted token isn't id
.
Sourcepub fn set_identity_token(self, input: Option<String>) -> Self
pub fn set_identity_token(self, input: Option<String>) -> Self
Specifies an identity token for the principal to be authorized. This token is provided to you by the identity provider (IdP) associated with the specified identity source. You must specify either an accessToken
, an identityToken
, or both.
Must be an ID token. Verified Permissions returns an error if the token_use
claim in the submitted token isn't id
.
Sourcepub fn get_identity_token(&self) -> &Option<String>
pub fn get_identity_token(&self) -> &Option<String>
Specifies an identity token for the principal to be authorized. This token is provided to you by the identity provider (IdP) associated with the specified identity source. You must specify either an accessToken
, an identityToken
, or both.
Must be an ID token. Verified Permissions returns an error if the token_use
claim in the submitted token isn't id
.
Sourcepub fn access_token(self, input: impl Into<String>) -> Self
pub fn access_token(self, input: impl Into<String>) -> Self
Specifies an access token for the principal to be authorized. This token is provided to you by the identity provider (IdP) associated with the specified identity source. You must specify either an accessToken
, an identityToken
, or both.
Must be an access token. Verified Permissions returns an error if the token_use
claim in the submitted token isn't access
.
Sourcepub fn set_access_token(self, input: Option<String>) -> Self
pub fn set_access_token(self, input: Option<String>) -> Self
Specifies an access token for the principal to be authorized. This token is provided to you by the identity provider (IdP) associated with the specified identity source. You must specify either an accessToken
, an identityToken
, or both.
Must be an access token. Verified Permissions returns an error if the token_use
claim in the submitted token isn't access
.
Sourcepub fn get_access_token(&self) -> &Option<String>
pub fn get_access_token(&self) -> &Option<String>
Specifies an access token for the principal to be authorized. This token is provided to you by the identity provider (IdP) associated with the specified identity source. You must specify either an accessToken
, an identityToken
, or both.
Must be an access token. Verified Permissions returns an error if the token_use
claim in the submitted token isn't access
.
Sourcepub fn action(self, input: ActionIdentifier) -> Self
pub fn action(self, input: ActionIdentifier) -> Self
Specifies the requested action to be authorized. Is the specified principal authorized to perform this action on the specified resource.
Sourcepub fn set_action(self, input: Option<ActionIdentifier>) -> Self
pub fn set_action(self, input: Option<ActionIdentifier>) -> Self
Specifies the requested action to be authorized. Is the specified principal authorized to perform this action on the specified resource.
Sourcepub fn get_action(&self) -> &Option<ActionIdentifier>
pub fn get_action(&self) -> &Option<ActionIdentifier>
Specifies the requested action to be authorized. Is the specified principal authorized to perform this action on the specified resource.
Sourcepub fn resource(self, input: EntityIdentifier) -> Self
pub fn resource(self, input: EntityIdentifier) -> Self
Specifies the resource for which the authorization decision is made. For example, is the principal allowed to perform the action on the resource?
Sourcepub fn set_resource(self, input: Option<EntityIdentifier>) -> Self
pub fn set_resource(self, input: Option<EntityIdentifier>) -> Self
Specifies the resource for which the authorization decision is made. For example, is the principal allowed to perform the action on the resource?
Sourcepub fn get_resource(&self) -> &Option<EntityIdentifier>
pub fn get_resource(&self) -> &Option<EntityIdentifier>
Specifies the resource for which the authorization decision is made. For example, is the principal allowed to perform the action on the resource?
Sourcepub fn context(self, input: ContextDefinition) -> Self
pub fn context(self, input: ContextDefinition) -> Self
Specifies additional context that can be used to make more granular authorization decisions.
Sourcepub fn set_context(self, input: Option<ContextDefinition>) -> Self
pub fn set_context(self, input: Option<ContextDefinition>) -> Self
Specifies additional context that can be used to make more granular authorization decisions.
Sourcepub fn get_context(&self) -> &Option<ContextDefinition>
pub fn get_context(&self) -> &Option<ContextDefinition>
Specifies additional context that can be used to make more granular authorization decisions.
Sourcepub fn entities(self, input: EntitiesDefinition) -> Self
pub fn entities(self, input: EntitiesDefinition) -> Self
Specifies the list of resources and their associated attributes that Verified Permissions can examine when evaluating the policies.
You can't include principals in this parameter, only resource and action entities. This parameter can't include any entities of a type that matches the user or group entity types that you defined in your identity source.
-
The
IsAuthorizedWithToken
operation takes principal attributes from only theidentityToken
oraccessToken
passed to the operation. -
For action entities, you can include only their
Identifier
andEntityType
.
Sourcepub fn set_entities(self, input: Option<EntitiesDefinition>) -> Self
pub fn set_entities(self, input: Option<EntitiesDefinition>) -> Self
Specifies the list of resources and their associated attributes that Verified Permissions can examine when evaluating the policies.
You can't include principals in this parameter, only resource and action entities. This parameter can't include any entities of a type that matches the user or group entity types that you defined in your identity source.
-
The
IsAuthorizedWithToken
operation takes principal attributes from only theidentityToken
oraccessToken
passed to the operation. -
For action entities, you can include only their
Identifier
andEntityType
.
Sourcepub fn get_entities(&self) -> &Option<EntitiesDefinition>
pub fn get_entities(&self) -> &Option<EntitiesDefinition>
Specifies the list of resources and their associated attributes that Verified Permissions can examine when evaluating the policies.
You can't include principals in this parameter, only resource and action entities. This parameter can't include any entities of a type that matches the user or group entity types that you defined in your identity source.
-
The
IsAuthorizedWithToken
operation takes principal attributes from only theidentityToken
oraccessToken
passed to the operation. -
For action entities, you can include only their
Identifier
andEntityType
.
Trait Implementations§
Source§impl Clone for IsAuthorizedWithTokenFluentBuilder
impl Clone for IsAuthorizedWithTokenFluentBuilder
Source§fn clone(&self) -> IsAuthorizedWithTokenFluentBuilder
fn clone(&self) -> IsAuthorizedWithTokenFluentBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreAuto Trait Implementations§
impl Freeze for IsAuthorizedWithTokenFluentBuilder
impl !RefUnwindSafe for IsAuthorizedWithTokenFluentBuilder
impl Send for IsAuthorizedWithTokenFluentBuilder
impl Sync for IsAuthorizedWithTokenFluentBuilder
impl Unpin for IsAuthorizedWithTokenFluentBuilder
impl !UnwindSafe for IsAuthorizedWithTokenFluentBuilder
Blanket Implementations§
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§unsafe fn clone_to_uninit(&self, dst: *mut T)
unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)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 moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the foreground set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red()
and
green()
, which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg()
:
use yansi::{Paint, Color};
painted.fg(Color::White);
Set foreground color to white using white()
.
use yansi::Paint;
painted.white();
Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Returns self
with the
fg()
set to
Color::BrightBlack
.
§Example
println!("{}", value.bright_black());
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Returns self
with the
fg()
set to
Color::BrightGreen
.
§Example
println!("{}", value.bright_green());
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Returns self
with the
fg()
set to
Color::BrightYellow
.
§Example
println!("{}", value.bright_yellow());
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Returns self
with the
fg()
set to
Color::BrightMagenta
.
§Example
println!("{}", value.bright_magenta());
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Returns self
with the
fg()
set to
Color::BrightWhite
.
§Example
println!("{}", value.bright_white());
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the background set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red()
and
on_green()
, which have the same functionality but
are pithier.
§Example
Set background color to red using fg()
:
use yansi::{Paint, Color};
painted.bg(Color::Red);
Set background color to red using on_red()
.
use yansi::Paint;
painted.on_red();
Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightBlack
.
§Example
println!("{}", value.on_bright_black());
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightGreen
.
§Example
println!("{}", value.on_bright_green());
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightYellow
.
§Example
println!("{}", value.on_bright_yellow());
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightBlue
.
§Example
println!("{}", value.on_bright_blue());
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightMagenta
.
§Example
println!("{}", value.on_bright_magenta());
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightCyan
.
§Example
println!("{}", value.on_bright_cyan());
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightWhite
.
§Example
println!("{}", value.on_bright_white());
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute
value
.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold()
and
underline()
, which have the same functionality
but are pithier.
§Example
Make text bold using attr()
:
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);
Make text bold using using bold()
.
use yansi::Paint;
painted.bold();
Source§fn underline(&self) -> Painted<&T>
fn underline(&self) -> Painted<&T>
Returns self
with the
attr()
set to
Attribute::Underline
.
§Example
println!("{}", value.underline());
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Returns self
with the
attr()
set to
Attribute::RapidBlink
.
§Example
println!("{}", value.rapid_blink());
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi
Quirk
value
.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask()
and
wrap()
, which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk()
:
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);
Enable wrapping using wrap()
.
use yansi::Paint;
painted.wrap();
Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition
value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted
only when both stdout
and stderr
are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);