Enum oauth2_types::errors::ClientErrorCode

pub enum ClientErrorCode {
    InvalidRequest,
    InvalidClient,
    InvalidGrant,
    UnauthorizedClient,
    UnsupportedGrantType,
    AccessDenied,
    UnsupportedResponseType,
    InvalidScope,
    ServerError,
    TemporarilyUnavailable,
    InteractionRequired,
    LoginRequired,
    AccountSelectionRequired,
    ConsentRequired,
    InvalidRequestUri,
    InvalidRequestObject,
    RequestNotSupported,
    RequestUriNotSupported,
    RegistrationNotSupported,
    InvalidRedirectUri,
    InvalidClientMetadata,
    AuthorizationPending,
    SlowDown,
    ExpiredToken,
    UnsupportedTokenType,
    Unknown(String),
}

Client error codes defined in OAuth2.0, OpenID Connect and their extensions.

Variants

InvalidRequest

invalid_request

The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed.

From RFC6749.

InvalidClient

invalid_client

Client authentication failed (e.g., unknown client, no client authentication included, or unsupported authentication method).

From RFC6749.

InvalidGrant

invalid_grant

The provided authorization grant (e.g., authorization code, resource owner credentials) or refresh token is invalid, expired, revoked, does not match the redirection URI used in the authorization request, or was issued to another client.

From RFC6749.

UnauthorizedClient

unauthorized_client

The authenticated client is not authorized to use this authorization grant type.

From RFC6749.

UnsupportedGrantType

unsupported_grant_type

The authorization grant type is not supported by the authorization server.

From RFC6749.

AccessDenied

access_denied

The resource owner or authorization server denied the request.

From RFC6749.

UnsupportedResponseType

unsupported_response_type

The authorization server does not support obtaining an authorization code using this method.

From RFC6749.

InvalidScope

invalid_scope

The requested scope is invalid, unknown, malformed, or exceeds the scope granted by the resource owner.

From RFC6749.

ServerError

server_error

The authorization server encountered an unexpected condition that prevented it from fulfilling the request.

From RFC6749.

TemporarilyUnavailable

temporarily_unavailable

The authorization server is currently unable to handle the request due to a temporary overloading or maintenance of the server.

From RFC6749.

InteractionRequired

interaction_required

The authorization server requires end-user interaction of some form to proceed.

From OpenID Connect Core 1.0.

LoginRequired

login_required

The authorization server requires end-user authentication.

From OpenID Connect Core 1.0.

AccountSelectionRequired

account_selection_required

The end-user is required to select a session at the authorization server.

From OpenID Connect Core 1.0.

ConsentRequired

consent_required

The authorization server requires end-user consent.

From OpenID Connect Core 1.0.

InvalidRequestUri

invalid_request_uri

The request_uri in the authorization request returns an error or contains invalid data.

From OpenID Connect Core 1.0.

InvalidRequestObject

invalid_request_object

The request parameter contains an invalid request object.

From OpenID Connect Core 1.0.

RequestNotSupported

request_not_supported

The authorization server does not support use of the request parameter.

From OpenID Connect Core 1.0.

RequestUriNotSupported

request_uri_not_supported

The authorization server does not support use of the request_uri parameter.

From OpenID Connect Core 1.0.

RegistrationNotSupported

registration_not_supported

The authorization server does not support use of the registration parameter.

From OpenID Connect Core 1.0.

InvalidRedirectUri

invalid_redirect_uri

The value of one or more redirection URIs is invalid.

From RFC7591.

InvalidClientMetadata

invalid_client_metadata

The value of one of the client metadata fields is invalid and the server has rejected this request.

From RFC7591.

AuthorizationPending

authorization_pending

The authorization request is still pending as the end user hasn’t yet completed the user-interaction steps.

The client should repeat the access token request to the token endpoint (a process known as polling). Before each new request, the client must wait at least the number of seconds specified by the interval parameter of the device authorization response, or 5 seconds if none was provided, and respect any increase in the polling interval required by the ClientErrorCode::SlowDown error.

From RFC8628.

SlowDown

slow_down

A variant of ClientErrorCode::AuthorizationPending, the authorization request is still pending and polling should continue, but the interval must be increased by 5 seconds for this and all subsequent requests.

From RFC8628.

ExpiredToken

expired_token

The device_code has expired, and the device authorization session has concluded.

The client may commence a new device authorization request but should wait for user interaction before restarting to avoid unnecessary polling.

From RFC8628.

UnsupportedTokenType

unsupported_token_type

The authorization server does not support the revocation of the presented token type. That is, the client tried to revoke an access token on a server not supporting this feature.

From RFC7009.

Unknown(String)

Another error code.

Implementations

impl ClientErrorCode

pub fn default_description(&self) -> &'static str

Get the default description for this ClientErrorCode.

Note that ClientErrorCode::Unknown returns an empty string.

Trait Implementations

impl Clone for ClientErrorCode

fn clone(&self) -> ClientErrorCode

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ClientErrorCode

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ClientErrorCode

where Self: FromStr, <Self as FromStr>::Err: Display,

fn deserialize<__D>(deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for ClientErrorCode

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

Formats the value using the given formatter.

impl From<ClientErrorCode> for ClientError

fn from(error: ClientErrorCode) -> Self

Converts to this type from the input type.

impl FromStr for ClientErrorCode

type Err = Infallible

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl PartialEq for ClientErrorCode

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for ClientErrorCode

where Self: Display,

fn serialize<__S>(&self, serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for ClientErrorCode

impl StructuralPartialEq for ClientErrorCode