Struct oauth2::IntrospectionRequest

pub struct IntrospectionRequest<'a, TE, TIR, TT> where
    TE: ErrorResponse,
    TIR: TokenIntrospectionResponse<TT>,
    TT: TokenType,  { /* fields omitted */ }

A request to introspect an access token.

See https://tools.ietf.org/html/rfc7662#section-2.1

Implementations

impl<'a, TE, TIR, TT> IntrospectionRequest<'a, TE, TIR, TT> where
    TE: ErrorResponse + 'static,
    TIR: TokenIntrospectionResponse<TT>,
    TT: TokenType, 

pub fn set_token_type_hint<V>(self, value: V) -> Self where
    V: Into<Cow<'a, str>>, 

Sets the optional token_type_hint parameter.

See: https://tools.ietf.org/html/rfc7662#section-2.1

OPTIONAL. A hint about the type of the token submitted for introspection. The protected resource MAY pass this parameter to help the authorization server optimize the token lookup. If the server is unable to locate the token using the given hint, it MUST extend its search across all of its supported token types. An authorization server MAY ignore this parameter, particularly if it is able to detect the token type automatically. Values for this field are defined in the “OAuth Token Type Hints” registry defined in OAuth Token Revocation RFC7009.

pub fn add_extra_param<N, V>(self, name: N, value: V) -> Self where
    N: Into<Cow<'a, str>>,
    V: Into<Cow<'a, str>>, 

Appends an extra param to the token introspection request.

This method allows extensions to be used without direct support from this crate. If name conflicts with a parameter managed by this crate, the behavior is undefined. In particular, do not set parameters defined by RFC 6749 or RFC 7662.

Security Warning

Callers should follow the security recommendations for any OAuth2 extensions used with this function, which are beyond the scope of RFC 6749.

pub fn request<F, RE>(
    self,
    http_client: F
) -> Result<TIR, RequestTokenError<RE, TE>> where
    F: FnOnce(HttpRequest) -> Result<HttpResponse, RE>,
    RE: Error + 'static, 

Synchronously sends the request to the authorization server and awaits a response.

pub async fn request_async<C, F, RE>(
    self,
    http_client: C
) -> Result<TIR, RequestTokenError<RE, TE>> where
    C: FnOnce(HttpRequest) -> F,
    F: Future<Output = Result<HttpResponse, RE>>,
    RE: Error + 'static, 

Asynchronously sends the request to the authorization server and returns a Future.

Trait Implementations

impl<'a, TE: Debug, TIR: Debug, TT: Debug> Debug for IntrospectionRequest<'a, TE, TIR, TT> where
    TE: ErrorResponse,
    TIR: TokenIntrospectionResponse<TT>,
    TT: TokenType, 

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

Formats the value using the given formatter.