Struct AuthServer 

pub struct AuthServer {
    pub client_id: String,
    pub issuer: String,
    pub scopes: Option<Vec<String>>,
}

OAuth 2.0 authorization server.

Fields

client_id: String

OAuth 2.0 client id.

issuer: String

OAuth 2.0 issuer URL.

This is the base URL of the identity provider. For Okta, this usually looks like https://example.okta.com/oauth2/default. For Cognito, it might look like https://cognito-idp.us-west-2.amazonaws.com/us-west-2_example.

Note that this is technically distinct from the issuer field in [OidcDiscovery], which is the canonical URI that the identity provider uses to sign and validate tokens, but the OpenID specification requires that they match exactly, and that they match the iss claim in Tokens issued by this identity provider.

scopes: Option<Vec<String>>

OAuth 2.0 scopes to request during authorization requests. If not specified, supported_scopes from the discovery document hosted at issuer will be used. The scope openid is always requested, even if not present in this list.

Implementations

impl AuthServer

pub fn get_client_id(&self) -> &str

Get the configured OAuth OIDC client id.

pub fn py_set_client_id(&mut self, client_id: String)

Set an OAuth OIDC client id.

pub fn get_issuer(&self) -> &str

Get the OAuth OIDC issuer URL.

pub fn py_set_issuer(&mut self, issuer: String)

Set an OAuth OIDC issuer URL.

impl AuthServer

pub const fn new( client_id: String, issuer: String, scopes: Option<Vec<String>>, ) -> Self

Create a new AuthServer with a client_id and issuer and an optional list of scopes.

If scopes is None, all scopes_supported from the issuer’s discovery document will be used when requesting authorization tokens. Note that the required scope openid is always requested, even if scopes is provided but does not contain it.

pub async fn new_with_discovery_supported_scopes( client_id: String, issuer: String, ) -> Result<Self, DiscoveryError>

Create a new AuthServer with the specified client_id and issuer, populating scopes with all scopes_supported fetched from the issuer’s discovery document.

Errors

Returns an error if the discovery document cannot be fetched or parsed.

Trait Implementations

impl Clone for AuthServer

fn clone(&self) -> AuthServer

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AuthServer

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

Formats the value using the given formatter.

impl Default for AuthServer

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for AuthServer

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl IntoPy<Py<PyAny>> for AuthServer

fn into_py(self, py: Python<'_>) -> PyObject

Performs the conversion.

impl PartialEq for AuthServer

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

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for AuthServer

const IS_BASETYPE: bool = false

#[pyclass(subclass)]

const IS_SUBCLASS: bool = false

#[pyclass(extends=…)]

const IS_MAPPING: bool = false

#[pyclass(mapping)]

const IS_SEQUENCE: bool = false

#[pyclass(sequence)]

type BaseType = PyAny

Base class

type ThreadChecker = SendablePyClass<AuthServer>

This handles following two situations:

type Inventory = Pyo3MethodsInventoryForAuthServer

type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::MutableChild

Immutable or mutable

type Dict = PyClassDummySlot

Specify this class has #[pyclass(dict)] or not.

type WeakRef = PyClassDummySlot

Specify this class has #[pyclass(weakref)] or not.

type BaseNativeType = PyAny

The closest native ancestor. This is PyAny by default, and when you declare #[pyclass(extends=PyDict)], it’s PyDict.

fn items_iter() -> PyClassItemsIter

fn doc(py: Python<'_>) -> PyResult<&'static CStr>

Rendered class doc

fn lazy_type_object() -> &'static LazyTypeObject<Self>

fn dict_offset() -> Option<isize>

fn weaklist_offset() -> Option<isize>

impl PyClassNewTextSignature<AuthServer> for PyClassImplCollector<AuthServer>

fn new_text_signature(self) -> Option<&'static str>

impl<'a, 'py> PyFunctionArgument<'a, 'py> for &'a AuthServer

type Holder = Option<PyRef<'py, AuthServer>>

fn extract(obj: &'py PyAny, holder: &'a mut Self::Holder) -> PyResult<Self>

impl<'a, 'py> PyFunctionArgument<'a, 'py> for &'a mut AuthServer

type Holder = Option<PyRefMut<'py, AuthServer>>

fn extract(obj: &'py PyAny, holder: &'a mut Self::Holder) -> PyResult<Self>

impl PyTypeInfo for AuthServer

const NAME: &'static str = "AuthServer"

Class name.

const MODULE: Option<&'static str> = ::core::option::Option::None

Module name, if any.

type AsRefTarget = PyCell<AuthServer>

Utility type to make Py::as_ref work.

fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject

Returns the PyTypeObject instance for this type.

fn type_object(py: Python<'_>) -> &PyType

Returns the safe abstraction over the type object.

fn is_type_of(object: &PyAny) -> bool

Checks if object is an instance of this type or a subclass of this type.

fn is_exact_type_of(object: &PyAny) -> bool

Checks if object is an instance of this type.

impl Serialize for AuthServer

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 AuthServer

impl StructuralPartialEq for AuthServer