Enum AuthError 

#[non_exhaustive]
pub enum AuthError {
    Request(Error),
    AccessDenied,
    InvalidGrant,
    InvalidClient,
    InvalidUrl(ParseError),
    Region(RegionError),
    InvalidCrn(InvalidCrn),
    MissingWorkspaceCrn,
    NotAuthenticated,
    TokenExpired,
    InvalidAccessKey(InvalidAccessKey),
    InvalidToken(String),
    Server(String),
    Store(ProfileError),
}

Errors that can occur during an authentication flow.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Request(Error)

The HTTP request to the auth server failed (network error, timeout, etc.).

AccessDenied

The user denied the authorization request.

InvalidGrant

The grant type was rejected by the server.

InvalidClient

The client ID is not recognized.

InvalidUrl(ParseError)

A URL could not be parsed.

Region(RegionError)

The requested region is not supported.

InvalidCrn(InvalidCrn)

The workspace CRN could not be parsed.

MissingWorkspaceCrn

An access key was provided but the workspace CRN is missing.

Set the CS_WORKSPACE_CRN environment variable or call AutoStrategyBuilder::with_workspace_crn.

NotAuthenticated

No credentials are available (e.g. not logged in, no access key configured).

TokenExpired

A token (access token or device code) has expired.

InvalidAccessKey(InvalidAccessKey)

The access key string is malformed (e.g. missing CSAK prefix or . separator).

InvalidToken(String)

The JWT could not be decoded or its claims are malformed.

Server(String)

An unexpected error was returned by the auth server.

Store(ProfileError)

A token store operation failed.

Trait Implementations

impl Debug for AuthError

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

Formats the value using the given formatter.

impl Diagnostic for AuthError

fn code<'a>(&'a self) -> Option<Box<dyn Display + 'a>>

Unique diagnostic code that can be used to look up more information about this Diagnostic. Ideally also globally unique, and documented in the toplevel crate’s documentation for easy searching. Rust path format (foo::bar::baz) is recommended, but more classic codes like E0123 or enums will work just fine.

fn severity(&self) -> Option<Severity>

Diagnostic severity. This may be used by ReportHandlers to change the display format of this diagnostic.

fn help<'a>(&'a self) -> Option<Box<dyn Display + 'a>>

Additional help text related to this Diagnostic. Do you have any advice for the poor soul who’s just run into this issue?

fn url<'a>(&'a self) -> Option<Box<dyn Display + 'a>>

URL to visit for a more detailed explanation/help about this Diagnostic.

fn source_code(&self) -> Option<&dyn SourceCode>

Source code to apply this Diagnostic’s Diagnostic::labels to.

fn labels(&self) -> Option<Box<dyn Iterator<Item = LabeledSpan> + '_>>

Labels to apply to this Diagnostic’s Diagnostic::source_code

fn related<'a>( &'a self, ) -> Option<Box<dyn Iterator<Item = &'a dyn Diagnostic> + 'a>>

Additional related Diagnostics.

fn diagnostic_source(&self) -> Option<&dyn Diagnostic>

The cause of the error.

impl Display for AuthError

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

Formats the value using the given formatter.

impl Error for AuthError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl From<AuthError> for CtsClientError

fn from(source: AuthError) -> Self

Converts to this type from the input type.

impl From<AuthError> for Error

fn from(source: AuthError) -> Self

Converts to this type from the input type.

impl From<AuthError> for ZeroKMSBuilderError

fn from(source: AuthError) -> Self

Converts to this type from the input type.

impl From<AutoRefreshError> for AuthError

fn from(err: AutoRefreshError) -> AuthError

Converts to this type from the input type.

impl From<Error> for AuthError

fn from(source: Error) -> AuthError

Converts to this type from the input type.

impl From<Infallible> for AuthError

fn from(never: Infallible) -> AuthError

Converts to this type from the input type.

impl From<InvalidAccessKey> for AuthError

fn from(source: InvalidAccessKey) -> AuthError

Converts to this type from the input type.

impl From<ParseError> for AuthError

fn from(source: ParseError) -> AuthError

Converts to this type from the input type.

impl From<ProfileError> for AuthError

fn from(source: ProfileError) -> AuthError

Converts to this type from the input type.

impl From<RegionError> for AuthError

fn from(source: RegionError) -> AuthError

Converts to this type from the input type.