Enum ErrorCode 

#[non_exhaustive]
pub enum ErrorCode {
    InvalidRequest,
    InvalidClient,
    InvalidGrant,
    UnauthorizedClient,
    UnsupportedGrantType,
    InvalidScope,
    UnsupportedPopKey,
    IncompatibleAceProfiles,
    Other(i32),
}

Error code specifying what went wrong for a token request, as specified in section 5.2 of RFC 6749 and section 5.8.3 of RFC 9200.

An error code is used in the ErrorResponse.

Example

For example, if you wish to indicate in your error response that the client is not authorized:

let request = ErrorResponse::builder()
    .error(ErrorCode::UnauthorizedClient)
    .build()?;

It’s also possible to use your own value for a custom error code, as defined in section 8.4 of RFC 9200:

let request = ErrorResponse::builder()
    // Values less than 65536 marked as private use.
    .error(ErrorCode::Other(-99999))
    .build()?;

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.

InvalidRequest

The request is missing a required parameter, includes an unsupported parameter value (other than grant type), repeats a parameter, includes multiple credentials, utilizes more than one mechanism for authenticating the client, or is otherwise malformed.

InvalidClient

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

InvalidGrant

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.

UnauthorizedClient

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

UnsupportedGrantType

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

InvalidScope

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

UnsupportedPopKey

The client submitted an asymmetric key in the token request that the RS cannot process.

IncompatibleAceProfiles

The client and the RS it has requested an access token for do not share a common profile.

Other(i32)

An unspecified error code along with its representation in CBOR.

See section 8.4 of RFC 9200 for details.

Trait Implementations

impl Clone for ErrorCode

fn clone(&self) -> ErrorCode

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ErrorCode

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

Formats the value using the given formatter.

impl From<ErrorCode> for i32

fn from(code: ErrorCode) -> Self

Converts to this type from the input type.

impl From<i32> for ErrorCode

fn from(value: i32) -> Self

Converts to this type from the input type.

impl Hash for ErrorCode

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for ErrorCode

fn eq(&self, other: &ErrorCode) -> 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 Copy for ErrorCode

impl Eq for ErrorCode

impl StructuralPartialEq for ErrorCode